Statistics
| Branch: | Revision:

urtware / doc / classdiagrams / rpc.uml @ dd31cb03

History | View | Annotate | Download (2.81 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**\nRemote Procedure Call System
27

    
28
!include ./functions.iuml
29

    
30
/'### ENTITIES ###############################################################'/
31

    
32
!startsub ENTITIES
33

    
34
/' Function type to be called when executing an RPC. '/
35
$function("urt_servicefunc_t") {
36
  urt_servicefunc_t (arg : void*, ret : void*, timeout : urt_delay_t) : urt_status_t
37
}
38

    
39
/' Service structure type. '/
40
$structure("urt_service_t") {
41
    'Pointer to the next service in a list.
42
  + {field} next : urt_service_t*
43
    'Identifier of the service.
44
  + {field} id : urt_serviceid_t
45
    'Mutex lock for exclusive access.'
46
  + {field} lock : urt_osMutex_t
47
    'Callback function to be executed by the service.
48
  + {field} callback : urt_servicefunc_t*
49
  .. URT_CFG_RPC_PROFILING == true ..
50
    'Sum of all durations.
51
  + {field} sumDurations : uint64_t
52
    'Number of executed calls.
53
  + {field} numCalls : uint64_t
54
    'Number of failed calls due to timeout.
55
  + {field} numTimeouts : uint64_t
56
    'Minimum duration ever detected (to calculate jitter).
57
  + {field} minDuration : urt_delay_t
58
    'Maximum duration ever detected (to calculate jitter).
59
  + {field} maxDuration : urt_delay_t
60
  __
61
    'Initializes a urt_service_t object.
62
  + {method} urtServiceInit(service : urt_service_t*, id : urt_serviceid_t, callback : urt_servicefunc_t*) : urt_status_t
63
    'Executes an RPC with given arguments and return parameters as well as a timout, in case the RPC may delay execution significantly.
64
  + {method} urtServiceCall(service : urt_service_t*, arg : void*, ret : void*, timeout : urt_delay_t) : urt_status_t
65
}
66

    
67
!endsub
68

    
69
/'### DEPENDENCIES & LAYOUT ##################################################'/
70

    
71
!startsub DEPENDENCIES
72

    
73
urt_service_t "1" o-- "0..1" urt_service_t
74
urt_service_t "1" o-- "0..1" urt_servicefunc_t
75

    
76
!endsub
77

    
78
/'### OUTRO ##################################################################'/
79

    
80
@enduml
81