urtware / doc / activitydiagrams / subscriber / srtsubscriber / urtSrtSubscriberInit.uml @ dd31cb03
History | View | Annotate | Download (1.89 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**\nurtSrtSubscriberInit()\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 | -- **subscriber** : urt_srtsubscriber_t* -- |
32 | The SRT subscriber to initialize. |
||
33 | 7491c395 | Thomas Schöpping | Must not be ""NULL"". |
34 | ee83a495 | Thomas Schöpping | ==== |
35 | dd31cb03 | Thomas Schöpping | -- **return** : void -- |
36 | ee83a495 | Thomas Schöpping | endnote |
37 | 7491c395 | Thomas Schöpping | |
38 | /'### PROCEDURE ##############################################################'/ |
||
39 | |||
40 | ee83a495 | Thomas Schöpping | start |
41 | 7491c395 | Thomas Schöpping | :initialize members; |
42 | ee83a495 | Thomas Schöpping | note |
43 | -- urt_basesubscriber_t -- |
||
44 | dd31cb03 | Thomas Schöpping | * **topic** ← ""NULL"" |
45 | * urtEventListenerInit(**evtListener**) |
||
46 | * **lastMessage** ← ""NULL"" |
||
47 | * **lastMessageTime** ← 0 |
||
48 | ee83a495 | Thomas Schöpping | .. URT_CFG_PUBSUB_PROFILING == true .. |
49 | dd31cb03 | Thomas Schöpping | * **sumLatencies** ← 0 |
50 | * **numMessagesReceived** ← 0 |
||
51 | ee83a495 | Thomas Schöpping | -- urt_srtsubscriber_t -- |
52 | dd31cb03 | Thomas Schöpping | * **usefulnesscb** ← ""NULL"" |
53 | * **cbparams** ← ""NULL"" |
||
54 | ee83a495 | Thomas Schöpping | .. URT_CFG_PUBSUB_PROFILING == true .. |
55 | dd31cb03 | Thomas Schöpping | * **minLatency** ← 0xF..F |
56 | * **maxLatency** ← 0 |
||
57 | ee83a495 | Thomas Schöpping | endnote |
58 | 7491c395 | Thomas Schöpping | stop |
59 | |||
60 | /'### OUTRO ##################################################################'/ |
||
61 | |||
62 | @enduml |