urtware / doc / activitydiagrams / subscriber / srtsubscriber / urtSrtSubscriberFetchLatestMessage.uml @ 17d978fe
History | View | Annotate | Download (3.132 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**\nurtSrtSubscriberFetchLatestMessage()\n |
| 27 |
|
| 28 |
!include ../functions.iuml |
| 29 |
|
| 30 |
/'### PARAMETERS & RETURN ####################################################'/ |
| 31 |
|
| 32 |
note |
| 33 |
-- **subscriber** : urt_srtsubscriber_t* -- |
| 34 |
The SRT subscriber that shall fetch the message. |
| 35 |
Must not be ""NULL"". |
| 36 |
-- **payload** : void* -- |
| 37 |
Pointer where to copy the payload to. |
| 38 |
May be ""NULL"" for messages without payload. |
| 39 |
-- **bytes** : size_t -- |
| 40 |
Payload size in bytes. |
| 41 |
-- **latency** : urt_delay_t* -- |
| 42 |
The latency can be returned by reference. |
| 43 |
May be ""NULL"". |
| 44 |
==== |
| 45 |
-- **return** : urt_status_t -- |
| 46 |
Returns ""URT_STATUS_OK"" on success. |
| 47 |
Returns ""URT_STATUS_FETCH_NOTOPIC"" if the subscriber is not associated to a topic. |
| 48 |
Retruns ""URT_STATUS_FETCH_NOMESSAGE"" if there is no new message to fetch. |
| 49 |
endnote |
| 50 |
|
| 51 |
/'### PROCEDURE ##############################################################'/ |
| 52 |
|
| 53 |
start |
| 54 |
if (Associated to a topic?) then (yes) |
| 55 |
:lock topic; |
| 56 |
$find_latest_message() |
| 57 |
if (Timestamp equals local copy?) then (yes) |
| 58 |
:unlock topic; |
| 59 |
stop |
| 60 |
note |
| 61 |
Returns ""URT_STATUS_FETCH_NOMESSAGE"". |
| 62 |
endnote |
| 63 |
else (no) |
| 64 |
fork |
| 65 |
$fetch_message() |
| 66 |
fork again |
| 67 |
:calculate message latency; |
| 68 |
note |
| 69 |
Can be optimized in case all flags are disabled. |
| 70 |
endnote |
| 71 |
fork |
| 72 |
#EEEEEE:..//URT_CFG_PUBSUB_PROFILING == true//..\naccumulate ""sumLatencies"" value; |
| 73 |
fork again |
| 74 |
partition "//URT_CFG_PUBSUB_PROFILING == true//" #EEEEEE {
|
| 75 |
if (Latency is lower than ""minLatency""?) then (yes) |
| 76 |
#EEEEEE:update ""minLatency"" value; |
| 77 |
elseif (Latency is greater than ""maxLatency""?) then (yes) |
| 78 |
#EEEEEE:update ""maxLatency"" value; |
| 79 |
else (no) |
| 80 |
endif |
| 81 |
} |
| 82 |
fork again |
| 83 |
if (Optional ""latency"" output argument given?) then (yes) |
| 84 |
:set ""latency"" value; |
| 85 |
else (no) |
| 86 |
endif |
| 87 |
fork again |
| 88 |
endfork |
| 89 |
endfork |
| 90 |
:unlock topic; |
| 91 |
stop |
| 92 |
note |
| 93 |
Returns ""URT_STATUS_OK"". |
| 94 |
endnote |
| 95 |
endif |
| 96 |
else (no) |
| 97 |
stop |
| 98 |
note |
| 99 |
Returns ""URT_STATUS_FETCH_NOTOPIC"". |
| 100 |
endnote |
| 101 |
endif |
| 102 |
|
| 103 |
/'### OUTRO ##################################################################'/ |
| 104 |
|
| 105 |
@enduml |