Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / subscriber / urtSubscriberSubscribeSrt.uml @ 7491c395

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

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

    
30
/'### PARAMETERS & START #####################################################'/
31

    
32
start
33
note
34
  -- ""**subscriber** : urt_subscriber_t*"" --
35
  The subscriber which shall subscribe to a topic.
36
  Must not be ""NULL"".
37
  -- ""**topic** : urt_topic_t*"" --
38
  The topic to subscribe to.
39
  Must not be ""NULL"".
40
  -- ""**messages** : urt_message_t*"" --
41
  List of messages to be contributed to the topic.
42
  Those messages must not be associated to another topic.
43
  Once a message was contributed, it cannot be removed from the topic anymore.
44
  -- ""**usefulnesscb** : urt_srtusefulnessfunc_t*"" --
45
  Pointer to a function to calculate usefulness of a message.
46
  Must not be ""NULL"".
47
  -- ""**cbparams** : void*"" --
48
  Optional parameters for the usefulness callback.
49
  May be ""NULL"" if the callback expects no parameters.
50
end note
51

    
52
/'### PROCEDURE ##############################################################'/
53

    
54
if (Is topic already set?) then (yes)
55
  :return ""URT_STATUS_ERROR"";
56
else (no)
57
  fork
58
    :set SRT data;
59
  fork again
60
    :set topic;
61
  endfork
62
  :lock topic;
63
  fork
64
    if (Messages to contribute?) then (yes)
65
      partition "contribute messages" {
66
        :set next pointer of topic's latest message to first message to contribute;
67
        :set next pointer of last message to contribute to the message after the topic's latest message;
68
      }
69
    else (no)
70
    endif
71
  fork again
72
    :set message pointer to topic's latest message;
73
  fork again
74
    :register to topic's event source;
75
  endfork
76
  :unlock topic;
77
  :return ""URT_STATUS_OK"";
78
endif
79

    
80
/'### STOP & RETURN ##########################################################'/
81

    
82
stop
83
note
84
  -- **return** ""urt_status_t"" --
85
  Returns ""URT_STATUS_ERROR"" if the subscriber was already associated to a topic.
86
end note
87

    
88
/'### OUTRO ##################################################################'/
89

    
90
@enduml