Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / service / urtServiceCall.uml @ dd31cb03

History | View | Annotate | Download (2.475 KB)

1
/'
2
µRtWare is a lightweight publish/subscribe middleware for real-time
3
applications. It was developed as part of the software habitat for the
4
Autonomous Mini Robot [1] (AMiRo) but can be used for other purposes as well.
5

    
6
Copyright (C) 2018..2020  Thomas Schöpping et al.
7

    
8
This program is free software: you can redistribute it and/or modify
9
it under the terms of the GNU General Public License as published by
10
the Free Software Foundation, either version 3 of the License, or
11
(at your option) any later version.
12

    
13
This program is distributed in the hope that it will be useful,
14
but WITHOUT ANY WARRANTY; without even the implied warranty of
15
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
GNU General Public License for more details.
17

    
18
You should have received a copy of the GNU General Public License
19
along with this program.  If not, see <http://www.gnu.org/licenses/>.
20
'/
21

    
22
/'### INTRO ##################################################################'/
23

    
24
@startuml
25

    
26
title **µRtWare**\nurtServiceCall()\n
27

    
28
/'### PARAMETERS & RETURN ####################################################'/
29

    
30
note
31
  -- **service** : urt_service_t* --
32
  The service to call.
33
  Must not be ""NULL"".
34
  -- **arg** : void* --
35
  Optional argument for the service call.
36
  May be ""NULL"" if the service expects no arguments.
37
  -- **ret** : void* --
38
  Pointer to an optional output value.
39
  May be ""NULL"".
40
  -- **timeout** : urt_delay_t --
41
  Timeout delay to be propagated to the callback function.
42
  Whether timeout is considered depends on the callback function.
43
  ====
44
  -- **return** : urt_status_t --
45
  Returns the exact output status of the service call.
46
endnote
47

    
48
/'### PROCEDURE ##############################################################'/
49

    
50
start
51
#EEEEEE:..//URT_CFG_RPC_PROFILING == true//..\nincrement call counter;
52
:execute the service ""callback"" function;
53
partition "//URT_CFG_RPC_PROFILING == true//" #EEEEEE {
54
  fork
55
    #EEEEEE:accumulate sum of durations;
56
  fork again
57
    if (Calback returned ""URT_STATUS_SERVICE_TIMEOUT""?) then (yes)
58
      #EEEEEE:increment timeout counter;
59
    else (no)
60
    endif
61
  fork again
62
    if (Duration was shorter than ""minDuration""?) then (yes)
63
      #EEEEEE:update ""minDuration"" value;
64
    elseif (Duration was longer than ""maxDuration""?) then (yes)
65
      #EEEEEE:update ""maxDuration"" value;
66
    else (no)
67
    endif
68
  endfork
69
}
70
stop
71
note
72
  Returns the return value of the callback.
73
endnote
74

    
75
/'### OUTRO ##################################################################'/
76

    
77
@enduml