urtware / doc / activitydiagrams / subscriber / urtNrtSubscriberSubscribe.uml @ ee83a495
History | View | Annotate | Download (2.442 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**\nurtNrtSubscriberSubscribe()\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_nrtsubscriber_t* -- |
32 | The NRT subscriber which shall subscribe to a topic. |
||
33 | 7491c395 | Thomas Schöpping | Must not be ""NULL"". |
34 | ee83a495 | Thomas Schöpping | -- **topic** : urt_topic_t* -- |
35 | 7491c395 | Thomas Schöpping | The topic to subscribe to. |
36 | Must not be ""NULL"". |
||
37 | ee83a495 | Thomas Schöpping | -- **messages** : urt_message_t* -- |
38 | ""NULL"" terminated list of messages to contribute to the topic. |
||
39 | Messages must not be associated to another topic. |
||
40 | Once a message has been contributed, it cannot be removed later. |
||
41 | May be ""NULL"" (no messages to contribute). |
||
42 | ==== |
||
43 | -- **return** : urt_status_t -- |
||
44 | Returns ""URT_STATUS_OK"" on success. |
||
45 | Returns ""URT_STATUS_ERROR"" if the subscriber is already associated to a topic. |
||
46 | endnote |
||
47 | 7491c395 | Thomas Schöpping | |
48 | /'### PROCEDURE ##############################################################'/ |
||
49 | |||
50 | ee83a495 | Thomas Schöpping | start |
51 | 7491c395 | Thomas Schöpping | if (Is topic already set?) then (yes) |
52 | ee83a495 | Thomas Schöpping | stop |
53 | note |
||
54 | Returns ""URT_STATUS_ERROR"". |
||
55 | endnote |
||
56 | 7491c395 | Thomas Schöpping | else (no) |
57 | ee83a495 | Thomas Schöpping | :set topic; |
58 | :lock topic; |
||
59 | 7491c395 | Thomas Schöpping | fork |
60 | ee83a495 | Thomas Schöpping | if (Messages to contribute?) then (yes) |
61 | !include ../contributemessages.iuml |
||
62 | else (no) |
||
63 | endif |
||
64 | 7491c395 | Thomas Schöpping | fork again |
65 | c22d21ad | Thomas Schöpping | fork |
66 | :set message pointer to topic's latest message; |
||
67 | ee83a495 | Thomas Schöpping | fork again |
68 | :copy timestamp from topic's latest message; |
||
69 | c22d21ad | Thomas Schöpping | endfork |
70 | 7491c395 | Thomas Schöpping | fork again |
71 | :register to topic's event source; |
||
72 | endfork |
||
73 | ee83a495 | Thomas Schöpping | :unlock topic; |
74 | stop |
||
75 | note |
||
76 | Returns ""URT_STATUS_OK"". |
||
77 | endnote |
||
78 | 7491c395 | Thomas Schöpping | endif |
79 | |||
80 | /'### OUTRO ##################################################################'/ |
||
81 | |||
82 | @enduml |