Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / subscriber / nrtsubscriber / urtNrtSubscriberSubscribe.uml @ 2d315870

History | View | Annotate | Download (3 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 ee83a495 Thomas Schöpping
title **µRtWare**\nurtNrtSubscriberSubscribe()\n
27 7491c395 Thomas Schöpping
28 dd31cb03 Thomas Schöpping
!include ../../functions.iuml
29 e87bd7c7 Thomas Schöpping
30 ee83a495 Thomas Schöpping
/'### PARAMETERS & RETURN ####################################################'/
31 7491c395 Thomas Schöpping
32
note
33 ee83a495 Thomas Schöpping
  -- **subscriber** : urt_nrtsubscriber_t* --
34
  The NRT subscriber which shall subscribe to a topic.
35 7491c395 Thomas Schöpping
  Must not be ""NULL"".
36 ee83a495 Thomas Schöpping
  -- **topic** : urt_topic_t* --
37 7491c395 Thomas Schöpping
  The topic to subscribe 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
  Returns ""URT_STATUS_OK"" on success.
47 dd31cb03 Thomas Schöpping
  Returns ""URT_STATUS_SUBSCRIBE_TOPICSET"" if the subscriber is already associated to a topic.
48 ee83a495 Thomas Schöpping
endnote
49 7491c395 Thomas Schöpping
50
/'### PROCEDURE ##############################################################'/
51
52 ee83a495 Thomas Schöpping
start
53 7491c395 Thomas Schöpping
if (Is topic already set?) then (yes)
54 ee83a495 Thomas Schöpping
  stop
55
  note
56 dd31cb03 Thomas Schöpping
    Returns ""URT_STATUS_SUBSCRIBE_TOPICSET"".
57 ee83a495 Thomas Schöpping
  endnote
58 7491c395 Thomas Schöpping
else (no)
59 dd31cb03 Thomas Schöpping
  fork
60
    :set topic;
61
  fork again
62
    #EEEEEE:initialize members;
63
    note #EEEEEE
64
      -- urt_basesubscriber_t --
65
      .. URT_CFG_PUBSUB_PROFILING == true ..
66
      * **sumLatencies** ← 0
67
      * **numMessagesReceived** ← 0
68
      -- urt_nrtsubscriber_t --
69
      .. URT_CFG_PUBSUB_PROFILING == true ..
70 2d315870 Thomas Schöpping
      * **minLatency** ← ""URT_DELAY_INFINITE""
71
      * **maxLatency** ← ""URT_DELAY_IMMEDIATE""
72 dd31cb03 Thomas Schöpping
    endnote
73
  endfork
74 ee83a495 Thomas Schöpping
  :lock topic;
75 7491c395 Thomas Schöpping
  fork
76 ee83a495 Thomas Schöpping
    if (Messages to contribute?) then (yes)
77 e87bd7c7 Thomas Schöpping
      $contribute_messages()
78 ee83a495 Thomas Schöpping
    else (no)
79
    endif
80 7491c395 Thomas Schöpping
  fork again
81 c22d21ad Thomas Schöpping
    fork
82
      :set message pointer to topic's latest message;
83 ee83a495 Thomas Schöpping
    fork again
84
      :copy timestamp from topic's latest message;
85 c22d21ad Thomas Schöpping
    endfork
86 7491c395 Thomas Schöpping
  fork again
87
    :register to topic's event source;
88 dd31cb03 Thomas Schöpping
  fork again
89
    #EEEEEE:..//URT_CFG_PUBSUB_PROFILING == true//..\nincrement counter of subscribers (@topic);
90 7491c395 Thomas Schöpping
  endfork
91 ee83a495 Thomas Schöpping
  :unlock topic;
92
  stop
93
  note
94
    Returns ""URT_STATUS_OK"".
95
  endnote
96 7491c395 Thomas Schöpping
endif
97
98
/'### OUTRO ##################################################################'/
99
100
@enduml