Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / subscriber / urtNrtSubscriberSubscribe.uml @ e87bd7c7

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

    
28
!include ../functions.iuml
29

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

    
32
note
33
  -- **subscriber** : urt_nrtsubscriber_t* --
34
  The NRT subscriber which shall subscribe to a topic.
35
  Must not be ""NULL"".
36
  -- **topic** : urt_topic_t* --
37
  The topic to subscribe 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** : urt_status_t --
46
  Returns ""URT_STATUS_OK"" on success.
47
  Returns ""URT_STATUS_ERROR"" if the subscriber is already associated to a topic.
48
endnote
49

    
50
/'### PROCEDURE ##############################################################'/
51

    
52
start
53
if (Is topic already set?) then (yes)
54
  stop
55
  note
56
    Returns ""URT_STATUS_ERROR"".
57
  endnote
58
else (no)
59
  :set topic;
60
  :lock topic;
61
  fork
62
    if (Messages to contribute?) then (yes)
63
      $contribute_messages()
64
    else (no)
65
    endif
66
  fork again
67
    fork
68
      :set message pointer to topic's latest message;
69
    fork again
70
      :copy timestamp from topic's latest message;
71
    endfork
72
  fork again
73
    :register to topic's event source;
74
  endfork
75
  :unlock topic;
76
  stop
77
  note
78
    Returns ""URT_STATUS_OK"".
79
  endnote
80
endif
81

    
82
/'### OUTRO ##################################################################'/
83

    
84
@enduml