Statistics
| Branch: | Revision:

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

History | View | Annotate | Download (2.827 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**\nurtSrtSubscriberSubscribe()\n
27 7491c395 Thomas Schöpping
28 e87bd7c7 Thomas Schöpping
!include ../functions.iuml
29
30 ee83a495 Thomas Schöpping
/'### PARAMETERS & RETURN ####################################################'/
31 7491c395 Thomas Schöpping
32
note
33 ee83a495 Thomas Schöpping
  -- **subscriber** : urt_srtsubscriber_t* --
34
  The SRT 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
  -- **usefulnesscb** : urt_srtusefulnessfunc_t* --
45 7491c395 Thomas Schöpping
  Pointer to a function to calculate usefulness of a message.
46
  Must not be ""NULL"".
47 ee83a495 Thomas Schöpping
  -- **cbparams** : void* --
48 7491c395 Thomas Schöpping
  Optional parameters for the usefulness callback.
49
  May be ""NULL"" if the callback expects no parameters.
50 ee83a495 Thomas Schöpping
  ====
51
  -- **return** : urt_status_t --
52
  Returns ""URT_STATUS_OK"" on success.
53
  Returns ""URT_STATUS_ERROR"" if the subscriber is already associated to a topic.
54
endnote
55 7491c395 Thomas Schöpping
56
/'### PROCEDURE ##############################################################'/
57
58 ee83a495 Thomas Schöpping
start
59 7491c395 Thomas Schöpping
if (Is topic already set?) then (yes)
60 ee83a495 Thomas Schöpping
  stop
61
  note
62
    Returns ""URT_STATUS_ERROR"".
63
  endnote
64 7491c395 Thomas Schöpping
else (no)
65
  fork
66
    :set topic;
67 ee83a495 Thomas Schöpping
  fork again
68
    :set usefulness callback;
69
  fork again
70
    :set callback parameter;
71 7491c395 Thomas Schöpping
  endfork
72 ee83a495 Thomas Schöpping
  :lock topic;
73 7491c395 Thomas Schöpping
  fork
74 ee83a495 Thomas Schöpping
    if (Messages to contribute?) then (yes)
75 e87bd7c7 Thomas Schöpping
      $contribute_messages()
76 ee83a495 Thomas Schöpping
    else (no)
77
    endif
78
  fork again
79 c22d21ad Thomas Schöpping
    fork
80
      :set message pointer to topic's latest message;
81 ee83a495 Thomas Schöpping
    fork again
82
      :copy timestamp from topic's latest message;
83 c22d21ad Thomas Schöpping
    endfork
84 7491c395 Thomas Schöpping
  fork again
85
    :register to topic's event source;
86
  endfork
87 ee83a495 Thomas Schöpping
  :unlock topic;
88
  stop
89
  note
90
    Returns ""URT_STATUS_OK"".
91
  endnote
92 7491c395 Thomas Schöpping
endif
93
94
/'### OUTRO ##################################################################'/
95
96
@enduml