Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / message / urtMessageInit.uml @ dd31cb03

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

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

    
30
note
31
  -- **message** : urt_message_t* --
32
  The message to initialize.
33
  Must not be ""NULL"".
34
  -- **payload** : void* --
35
  May be ""NULL"" for messages without payload.
36
  ====
37
  -- **return** : void --
38
endnote
39

    
40
/'### PROCEDURE ##############################################################'/
41

    
42
start
43
:initialize members;
44
note
45
  * **next** ← ""NULL""
46
  * **payload** ← payload
47
  * **originTime** ← 0
48
  * **numHrtConsumbersLeft** ← 0
49
  .. URT_CFG_PUBSUB_PROFILING == true ..
50
  * **numConsumersLeft** ← 0
51
endnote
52
stop
53

    
54
/'### OUTRO ##################################################################'/
55

    
56
@enduml