Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / subscriber / hrtsubscriber / urtHrtSubscriberInit.uml @ dd31cb03

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

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

    
30
note
31
  -- ""**subscriber** : urt_hrtsubscriber_t*"" --
32
  The HRT subscriber to initialize.
33
  Must not be ""NULL"".
34
  ====
35
  -- **return** : void --
36
endnote
37

    
38
/'### PROCEDURE ##############################################################'/
39

    
40
start
41
:initialize members;
42
note
43
  -- urt_basesubscriber_t --
44
  * **topic** ← ""NULL""
45
  * urtEventListenerInit(**evtListener**)
46
  * **lastMessage** ← ""NULL""
47
  * **lastMessageTime** ← 0
48
  .. URT_CFG_PUBSUB_PROFILING == true ..
49
  * **sumLatencies** ← 0
50
  * **numMessagesReceived** ← 0
51
  -- urt_hrtsubscriber_t --
52
  * **next** ← ""NULL""
53
  .. URT_CFG_PUBSUB_QOS_DEADLINECHECKS == true ..
54
  * **deadlineOffset** ← 0
55
  * urtTimerInit(**qosDeadlineTimer**)
56
  .. URT_CFG_PUBSUB_QOS_RATECHECK == true ..
57
  * **expectedRate** ← 0
58
  .. URT_CFG_PUBSUB_QOS_JITTERCHECK == true ..
59
  * **maxJitter** ← 0
60
  .. URT_CFG_PUBSUB_QOS_JITTERCHECKS == true || URT_CFG_PUBSUB_PROFILING == true ..
61
  * **minLatency** ← 0xF..F
62
  * **maxLatency** ← 0
63
endnote
64
stop
65

    
66
/'### OUTRO ##################################################################'/
67

    
68
@enduml