Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / subscriber / urtSrtSubscriberFetchLatestMessage.uml @ ee83a495

History | View | Annotate | Download (2.078 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
/'### PARAMETERS & RETURN ####################################################'/
29

    
30
note
31
  -- **subscriber** : urt_srtsubscriber_t* --
32
  The SRT subscriber that shall fetch the message.
33
  Must not be ""NULL"".
34
  -- **payload** : void* --
35
  Pointer where to copy the payload to.
36
  May be ""NULL"" for messages without payload.
37
  -- **bytes** : size_t --
38
  Payload size in bytes.
39
  -- **latency** : urt_delay_t* --
40
  The latency can be returned by reference.
41
  May be ""NULL"".
42
  ====
43
  -- **return** : urt_status_t --
44
  Returns ""URT_STATUS_OK"" on success.
45
  Returns ""URT_STATUS_ERROR"" if the subscriber is not associated to a topic.
46
endnote
47

    
48
/'### PROCEDURE ##############################################################'/
49

    
50
start
51
if (Associated to a topic?) then (yes)
52
  :lock topic;
53
  !include findlatestmessage.iuml
54
  !include fetchmessage.iuml
55
  :unlock topic;
56
  stop
57
  note
58
    Returns ""URT_STATUS_OK"".
59
  endnote
60
else (no)
61
  stop
62
  note
63
    Returns ""URT_STATUS_ERROR"".
64
  endnote
65
endif
66

    
67
/'### OUTRO ##################################################################'/
68

    
69
@enduml