Revision ee83a495 doc/activitydiagrams/message/urtMessageInit.uml
| doc/activitydiagrams/message/urtMessageInit.uml | ||
|---|---|---|
| 25 | 25 |
|
| 26 | 26 |
title **µRtWare**\nurtMessageInit()\n |
| 27 | 27 |
|
| 28 |
!include ../../functions.iuml
|
|
| 28 |
/'### PARAMETERS & RETURN ####################################################'/
|
|
| 29 | 29 |
|
| 30 |
/'### PARAMETERS & START #####################################################'/ |
|
| 31 |
|
|
| 32 |
start |
|
| 33 | 30 |
note |
| 34 |
-- ""**message** : urt_message_t*"" --
|
|
| 31 |
-- **message** : urt_message_t* --
|
|
| 35 | 32 |
The message to initialize. |
| 36 | 33 |
Must not be ""NULL"". |
| 37 |
-- ""**payload** : void*"" --
|
|
| 34 |
-- **payload** : void* --
|
|
| 38 | 35 |
May be ""NULL"" for messages without payload. |
| 39 |
end note |
|
| 36 |
==== |
|
| 37 |
-- **return** : urt_status_t -- |
|
| 38 |
Always returns ""URT_STATUS_OK"". |
|
| 39 |
endnote |
|
| 40 | 40 |
|
| 41 | 41 |
/'### PROCEDURE ##############################################################'/ |
| 42 | 42 |
|
| 43 |
start |
|
| 43 | 44 |
:initialize members; |
| 44 |
|
|
| 45 |
/'### STOP & RETURN ##########################################################'/ |
|
| 46 |
|
|
| 45 |
note |
|
| 46 |
**next** ← ""NULL"" |
|
| 47 |
**payload** ← payload |
|
| 48 |
**originTime** ← 0 |
|
| 49 |
**numHrtConsumbersLeft** ← 0 |
|
| 50 |
.. URT_CFG_PUBSUB_PROFILING == true .. |
|
| 51 |
**numConsumersLeft** ← 0 |
|
| 52 |
endnote |
|
| 47 | 53 |
stop |
| 48 | 54 |
note |
| 49 |
-- **return** ""urt_status_t"" -- |
|
| 50 | 55 |
Returns ""URT_STATUS_OK"". |
| 51 |
end note
|
|
| 56 |
endnote |
|
| 52 | 57 |
|
| 53 | 58 |
/'### OUTRO ##################################################################'/ |
| 54 | 59 |
|
Also available in: Unified diff