Statistics
| Branch: | Revision:

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

History | View | Annotate | Download (2.13 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**\nurtHrtSubscriberInit()\n
27 7491c395 Thomas Schöpping
28 ee83a495 Thomas Schöpping
/'### PARAMETERS & RETURN ####################################################'/
29 7491c395 Thomas Schöpping
30
note
31 ee83a495 Thomas Schöpping
  -- ""**subscriber** : urt_hrtsubscriber_t*"" --
32
  The HRT subscriber to initialize.
33 7491c395 Thomas Schöpping
  Must not be ""NULL"".
34 ee83a495 Thomas Schöpping
endnote
35 7491c395 Thomas Schöpping
36
/'### PROCEDURE ##############################################################'/
37
38 ee83a495 Thomas Schöpping
start
39 7491c395 Thomas Schöpping
:initialize members;
40 ee83a495 Thomas Schöpping
note
41
  -- urt_basesubscriber_t --
42
  **topic** ← ""NULL""
43
  urtEventListenerInit(**evtListener**)
44
  **lastMessage** ← ""NULL""
45
  **lastMessageTime** ← 0
46
  .. URT_CFG_PUBSUB_PROFILING == true ..
47
  **sumLatencies** ← 0
48
  **numMessagesReceived** ← 0
49
  -- urt_hrtsubscriber_t --
50
  **next** ← ""NULL""
51
  .. URT_CFG_PUBSUB_QOS_DEADLINECHECKS == true ..
52
  **deadlineOffset** ← 0
53
  urtTimerInit(**qosDeadlineTimer**)
54
  .. URT_CFG_PUBSUB_QOS_RATECHECK == true ..
55
  **expectedRate** ← 0
56
  .. URT_CFG_PUBSUB_QOS_JITTERCHECK == true ..
57
  **maxJitter** ← 0
58
  .. URT_CFG_PUBSUB_QOS_JITTERCHECKS == true || URT_CFG_PUBSUB_PROFILING == true ..
59
  **minLatency** ← 0xF..F
60
  **maxLatency** ← 0
61
endnote
62 7491c395 Thomas Schöpping
stop
63
note
64
  Returns ""URT_STATUS_OK"".
65 ee83a495 Thomas Schöpping
endnote
66 7491c395 Thomas Schöpping
67
/'### OUTRO ##################################################################'/
68
69
@enduml