Statistics
| Branch: | Revision:

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

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

    
28
!include ../functions.iuml
29

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

    
32
note
33
  -- **subscriber** : urt_hrtsubscriber_t* --
34
  The HRT 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
  -- **rate** : urt-delay_t
51
  Expected minimum rate of new messages (= mamximum time between consecutive messages).
52
  A value of 0 indicates, that rate is of no concern.
53
  ====
54
  -- **return** : urt_status_t --
55
  Returns ""URT_STATUS_OK"" on success.
56
  Returns ""URT_STATUS_ERROR"" if the subscriber is already associated to a topic.
57
endnote
58

    
59
/'### PROCEDURE ##############################################################'/
60

    
61
start
62
if (Is topic already set?) then (yes)
63
  stop
64
  note
65
    Returns ""URT_STATUS_ERROR"".
66
  endnote
67
else (no)
68
  fork
69
    :set topic;
70
  fork again
71
    :set deadline offset;
72
  fork again
73
    :set maximum jitter;
74
  fork again
75
    :set expected rate;
76
  endfork
77
  :lock topic;
78
  fork
79
    if (Messages to contribute?) then (yes)
80
      $contribute_messages()
81
    else (no)
82
    endif
83
  fork again
84
    fork
85
      :set message pointer to topic's latest message;
86
    fork again
87
      :copy timestamp from topic's latest message;
88
    endfork
89
  fork again
90
    :register to topic's event source;
91
  fork again
92
    fork
93
      :insert self to topic's list of HRT subscribers;
94
    fork again
95
      :increment topic's counter of HRT subscribers;
96
    endfork
97
  endfork
98
  :unlock topic;
99
  stop
100
  note
101
    Returns ""URT_STATUS_OK"".
102
  endnote
103
endif
104

    
105
/'### OUTRO ##################################################################'/
106

    
107
@enduml