Statistics
| Branch: | Revision:

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

History | View | Annotate | Download (1.9 KB)

1 7491c395 Thomas Schöpping
/'
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 ee83a495 Thomas Schöpping
title **µRtWare**\nurtServiceCall()\n
27 7491c395 Thomas Schöpping
28 ee83a495 Thomas Schöpping
/'### PARAMETERS & RETURN ####################################################'/
29 7491c395 Thomas Schöpping
30
note
31 ee83a495 Thomas Schöpping
  -- **service** : urt_service_t* --
32
  The service to call.
33 7491c395 Thomas Schöpping
  Must not be ""NULL"".
34 ee83a495 Thomas Schöpping
  -- **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 return 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 7491c395 Thomas Schöpping
48
/'### PROCEDURE ##############################################################'/
49
50 ee83a495 Thomas Schöpping
start
51 e87bd7c7 Thomas Schöpping
:execute the service ""callback"" function;
52 7491c395 Thomas Schöpping
stop
53
note
54 ee83a495 Thomas Schöpping
  Returns the return value of the callback.
55
endnote
56 7491c395 Thomas Schöpping
57
/'### OUTRO ##################################################################'/
58
59
@enduml