Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / publisher / urtPublisherInit.uml @ 7491c395

History | View | Annotate | Download (2.145 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 & START #####################################################'/
31

    
32
start
33
note
34
  -- ""**publisher** : urt_publisher_t*"" --
35
  The publisher to initialize.
36
  Must not be ""NULL"".
37
  -- ""**topic** : urt_topic_t*"" --
38
  The topic, this publisher is associated to.
39
  Must not be ""NULL"".
40
  -- ""**messages** : urt_message_t*"" --
41
  A ""NULL"" terminated list of messages to contribute to the topic.
42
  May be ""NULL"" (no messages are contributed).
43
end note
44

    
45
/'### PROCEDURE ##############################################################'/
46

    
47
:initialize members;
48
if (Messages to contribute?) then (yes)
49
  :lock topic;
50
  partition "contribute messages" {
51
    :set next pointer of topic's latest message to first message to contribute;
52
    :set next pointer of last message to contribute to the message after the topic's latest message;
53
  }
54
  :unlock topic;
55
else (no)
56
endif
57

    
58
/'### STOP & RETURN ##########################################################'/
59

    
60
stop
61
note
62
  -- **return** ""urt_status_t"" --
63
  Returns ""URT_STATUS_OK"".
64
end note
65

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

    
68
@enduml