Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / subscriber / frtsubscriber / urtFrtSubscriberSubscribe.uml @ 2d315870

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

    
28
!include ../../functions.iuml
29

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

    
32
note
33
  -- **subscriber** : urt_frtsubscriber_t* --
34
  The FRT 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
  -- **deadline** : urt_delay_t --
45
  Maximum latency to consume messages.
46
  A value of 0 indicates that latency is of no concern.
47
  -- **jitter** : urt_delay_t --
48
  Maximum allowed jitter (difference between maximum and minimum latency) when consuming messages.
49
  A value of 0 indicates that jitter is of no concern.
50
  ====
51
  -- **return** : urt_status_t --
52
  Returns ""URT_STATUS_OK"" on success.
53
  Returns ""URT_STATUS_SUBSCRIBE_TOPICSET"" if the subscriber is already associated to a topic.
54
endnote
55

    
56
/'### PROCEDURE ##############################################################'/
57

    
58
start
59
if (Is topic already set?) then (yes)
60
  stop
61
  note
62
    Returns ""URT_STATUS_SUBSCRIBE_TOPICSET"".
63
  endnote
64
else (no)
65
  fork
66
    :set topic;
67
  fork again
68
    #EEEEEE:initialize members;
69
    note #EEEEEE
70
      -- urt_basesubscriber_t --
71
      .. URT_CFG_PUBSUB_PROFILING == true ..
72
      * **sumLatencies** ← 0
73
      * **numMessagesReceived** ← 0
74
      -- urt_frtsubscriber_t --
75
      .. URT_CFG_PUBSUB_QOS_DEADLINECHECKS == true ..
76
      * **deadlineOffset** ← deadline
77
      .. URT_CFG_PUBSUB_QOS_JITTERCHECKS == true ..
78
      * **maxJitter** ← jitter
79
      .. URT_CFG_PUBSUB_QOS_JITTERCHECKS == true || URT_CFG_PUBSUB_PROFILING == true ..
80
      * **minLatency** ← ""URT_DELAY_INFINITE""
81
      * **maxLatency** ← ""URT_DELAY_IMMEDIATE""
82
    endnote
83
  endfork
84
  :lock topic;
85
  fork
86
    if (Messages to contribute?) then (yes)
87
      $contribute_messages()
88
    else (no)
89
    endif
90
  fork again
91
    fork
92
      :set message pointer to topic's latest message;
93
    fork again
94
      :copy timestamp from topic's latest message;
95
    endfork
96
  fork again
97
    :register to topic's event source;
98
  fork again
99
    #EEEEEE:..//URT_CFG_PUBSUB_PROFILING == true//..\nincrement counter of subscribers (@topic);
100
  endfork
101
  :unlock topic;
102
  stop
103
  note
104
    Returns ""URT_STATUS_OK"".
105
  endnote
106
endif
107

    
108
/'### OUTRO ##################################################################'/
109

    
110
@enduml