Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / subscriber / urtSrtSubscriberInit.uml @ ee83a495

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

    
28
/'### PARAMETERS & RETURN ####################################################'/
29

    
30
note
31
  -- **subscriber** : urt_srtsubscriber_t* --
32
  The SRT subscriber to initialize.
33
  Must not be ""NULL"".
34
  ====
35
  -- **return** : urt_status_t --
36
  Always returns ""URT_STATUS_OK"".
37
endnote
38

    
39
/'### PROCEDURE ##############################################################'/
40

    
41
start
42
:initialize members;
43
note
44
  -- urt_basesubscriber_t --
45
  **topic** ← ""NULL""
46
  urtEventListenerInit(**evtListener**)
47
  **lastMessage** ← ""NULL""
48
  **lastMessageTime** ← 0
49
  .. URT_CFG_PUBSUB_PROFILING == true ..
50
  **sumLatencies** ← 0
51
  **numMessagesReceived** ← 0
52
  -- urt_srtsubscriber_t --
53
  **usefulnesscb** ← ""NULL""
54
  **cbparams** ← ""NULL""
55
  .. URT_CFG_PUBSUB_PROFILING == true ..
56
  **minLatency** ← 0xF..F
57
  **maxLatency** ← 0
58
endnote
59
stop
60
note
61
  Returns ""URT_STATUS_OK"".
62
endnote
63

    
64
/'### OUTRO ##################################################################'/
65

    
66
@enduml