urtware / doc / activitydiagrams / publisher / urtPublisherInit.uml @ ee83a495
History | View | Annotate | Download (2.119 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 | ee83a495 | Thomas Schöpping | /'### PARAMETERS & RETURN ####################################################'/ |
29 | 7491c395 | Thomas Schöpping | |
30 | note |
||
31 | ee83a495 | Thomas Schöpping | -- **publisher** : urt_publisher_t* -- |
32 | 7491c395 | Thomas Schöpping | The publisher to initialize. |
33 | Must not be ""NULL"". |
||
34 | ee83a495 | Thomas Schöpping | -- **topic** : urt_topic_t* -- |
35 | 7491c395 | Thomas Schöpping | The topic, this publisher is associated 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 | Always returns ""URT_STATUS_OK"". |
||
45 | endnote |
||
46 | 7491c395 | Thomas Schöpping | |
47 | /'### PROCEDURE ##############################################################'/ |
||
48 | |||
49 | ee83a495 | Thomas Schöpping | start |
50 | 7491c395 | Thomas Schöpping | :initialize members; |
51 | ee83a495 | Thomas Schöpping | note |
52 | **topic** ← topic |
||
53 | .. URT_CFG_PUBSUB_PROFILING == true .. |
||
54 | **publishAttempts** ← 0 |
||
55 | **publishFails** ← 0 |
||
56 | endnote |
||
57 | 7491c395 | Thomas Schöpping | if (Messages to contribute?) then (yes) |
58 | :lock topic; |
||
59 | ee83a495 | Thomas Schöpping | !include ../contributemessages.iuml |
60 | 7491c395 | Thomas Schöpping | :unlock topic; |
61 | else (no) |
||
62 | endif |
||
63 | stop |
||
64 | note |
||
65 | Returns ""URT_STATUS_OK"". |
||
66 | ee83a495 | Thomas Schöpping | endnote |
67 | 7491c395 | Thomas Schöpping | |
68 | /'### OUTRO ##################################################################'/ |
||
69 | |||
70 | @enduml |