Statistics
| Branch: | Revision:

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

History | View | Annotate | Download (2.09 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**\nurtFrtSubscriberFetchLatestMessage()\n
27 7491c395 Thomas Schöpping
28 e87bd7c7 Thomas Schöpping
!include ./functions.iuml
29
30 ee83a495 Thomas Schöpping
/'### PARAMETERS & RETURN ####################################################'/
31 7491c395 Thomas Schöpping
32
note
33 ee83a495 Thomas Schöpping
  -- **subscriber** : urt_frtsubscriber_t* --
34
  The FRT subscriber that shall fetch the message.
35 7491c395 Thomas Schöpping
  Must not be ""NULL"".
36 ee83a495 Thomas Schöpping
  -- **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_ERROR"" if the subscriber is not associated to a topic.
48
endnote
49 7491c395 Thomas Schöpping
50
/'### PROCEDURE ##############################################################'/
51
52 ee83a495 Thomas Schöpping
start
53
if (Associated to a topic?) then (yes)
54
  :lock topic;
55 e87bd7c7 Thomas Schöpping
  $find_latest_message()
56
  $fetch_message()
57 ee83a495 Thomas Schöpping
  :unlock topic;
58
  stop
59
  note
60
    Returns ""URT_STATUS_OK"".
61
  endnote
62
else (no)
63
  stop
64
  note
65
    Returns ""URT_STATUS_ERROR"".
66
  endnote
67 7491c395 Thomas Schöpping
endif
68
69
/'### OUTRO ##################################################################'/
70
71
@enduml