urtware / doc / activitydiagrams / publisher / urtPublisherInit.uml @ e87bd7c7
History | View | Annotate | Download (2.134 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 | title **µRtWare**\nurtPublisherInit()\n |
||
27 | |||
28 | e87bd7c7 | Thomas Schöpping | !include ../functions.iuml |
29 | |||
30 | ee83a495 | Thomas Schöpping | /'### PARAMETERS & RETURN ####################################################'/ |
31 | 7491c395 | Thomas Schöpping | |
32 | note |
||
33 | ee83a495 | Thomas Schöpping | -- **publisher** : urt_publisher_t* -- |
34 | 7491c395 | Thomas Schöpping | The publisher to initialize. |
35 | Must not be ""NULL"". |
||
36 | ee83a495 | Thomas Schöpping | -- **topic** : urt_topic_t* -- |
37 | 7491c395 | Thomas Schöpping | The topic, this publisher is associated to. |
38 | Must not be ""NULL"". |
||
39 | ee83a495 | Thomas Schöpping | -- **messages** : urt_message_t* -- |
40 | ""NULL"" terminated list of messages to contribute to the topic. |
||
41 | Messages must not be associated to another topic. |
||
42 | Once a message has been contributed, it cannot be removed later. |
||
43 | May be ""NULL"" (no messages to contribute). |
||
44 | ==== |
||
45 | -- **return** : urt_status_t -- |
||
46 | Always returns ""URT_STATUS_OK"". |
||
47 | endnote |
||
48 | 7491c395 | Thomas Schöpping | |
49 | /'### PROCEDURE ##############################################################'/ |
||
50 | |||
51 | ee83a495 | Thomas Schöpping | start |
52 | 7491c395 | Thomas Schöpping | :initialize members; |
53 | ee83a495 | Thomas Schöpping | note |
54 | **topic** ← topic |
||
55 | .. URT_CFG_PUBSUB_PROFILING == true .. |
||
56 | **publishAttempts** ← 0 |
||
57 | **publishFails** ← 0 |
||
58 | endnote |
||
59 | 7491c395 | Thomas Schöpping | if (Messages to contribute?) then (yes) |
60 | :lock topic; |
||
61 | e87bd7c7 | Thomas Schöpping | $contribute_messages() |
62 | 7491c395 | Thomas Schöpping | :unlock topic; |
63 | else (no) |
||
64 | endif |
||
65 | stop |
||
66 | note |
||
67 | Returns ""URT_STATUS_OK"". |
||
68 | ee83a495 | Thomas Schöpping | endnote |
69 | 7491c395 | Thomas Schöpping | |
70 | /'### OUTRO ##################################################################'/ |
||
71 | |||
72 | @enduml |