Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / publisher / urtPublisherInit.uml @ dd31cb03

History | View | Annotate | Download (2.06 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**\nurtPublisherInit()\n
27

    
28
!include ../functions.iuml
29

    
30
/'### PARAMETERS & RETURN ####################################################'/
31

    
32
note
33
  -- **publisher** : urt_publisher_t* --
34
  The publisher to initialize.
35
  Must not be ""NULL"".
36
  -- **topic** : urt_topic_t* --
37
  The topic, this publisher is associated to.
38
  Must not be ""NULL"".
39
  -- **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** : void --
46
endnote
47

    
48
/'### PROCEDURE ##############################################################'/
49

    
50
start
51
:initialize members;
52
note
53
  * **topic** ← topic
54
  .. URT_CFG_PUBSUB_PROFILING == true ..
55
  * **publishAttempts** ← 0
56
  * **publishFails** ← 0
57
endnote
58
if (Messages to contribute?) then (yes)
59
  :lock topic;
60
  $contribute_messages()
61
  :unlock topic;
62
else (no)
63
endif
64
stop
65

    
66
/'### OUTRO ##################################################################'/
67

    
68
@enduml