Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / subscriber / frtsubscriber / urtFrtSubscriberFetchLatestMessage.uml @ dd31cb03

History | View | Annotate | Download (3.378 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 dd31cb03 Thomas Schöpping
!include ../functions.iuml
29 e87bd7c7 Thomas Schöpping
30 ee83a495 Thomas Schöpping
/'### PARAMETERS & RETURN ####################################################'/
31 7491c395 Thomas Schöpping
32
note
33 ee83a495 Thomas Schöpping
  -- **subscriber** : urt_frtsubscriber_t* --
34 dd31cb03 Thomas Schöpping
  The FRT subscriber that shall fetch the latest 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 dd31cb03 Thomas Schöpping
  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
  Returns ""URT_STATUS_JITTERVIOLATION"" if the message's latency violated the maximum expected jitter.
50 ee83a495 Thomas Schöpping
endnote
51 7491c395 Thomas Schöpping
52
/'### PROCEDURE ##############################################################'/
53
54 ee83a495 Thomas Schöpping
start
55
if (Associated to a topic?) then (yes)
56
  :lock topic;
57 e87bd7c7 Thomas Schöpping
  $find_latest_message()
58 dd31cb03 Thomas Schöpping
  if (Timestamp equals local copy?) then (yes)
59
    :unlock topic;
60
    stop
61
    note
62
      Returns ""URT_STATUS_FETCH_NOMESSAGE"".
63
    endnote
64
  else (no)
65
    fork
66
      $fetch_message()
67
    fork again
68
      :calculate message latency;
69
      note
70
        Can be optimized in case all flags are disabled.
71
      endnote
72
      fork
73
        #EEEEEE:..//URT_CFG_PUBSUB_PROFILING == true//..\naccumulate ""sumLatencies"" value;
74
      fork again
75
        partition "//URT_CFG_PUBSUB_QOS_JITTERCHECKS == true || URT_CFG_PUBSUB_PROFILING == true//" #EEEEEE {
76
          if (Latency is lower than ""minLatency"" but within allowed jitter range?) then (yes)
77
            #EEEEEE:update ""minLatency"" value;
78
          elseif (Latency is greater than ""maxLatency"" but within allowed jitter range?) then (yes)
79
            #EEEEEE:update ""maxLatency"" value;
80
          else (no)
81
          endif
82
        }
83
      fork again
84
        if (Optional ""latency"" output argument given?) then (yes)
85
          :set ""latency"" value;
86
        else (no)
87
        endif
88
      fork again
89
      endfork
90
    endfork
91
    :unlock topic;
92
    stop
93
    note
94
      Returns ""URT_STATUS_OK"" or ""URT_STATUS_JITTERVIOLATION"".
95
    endnote
96
  endif
97 ee83a495 Thomas Schöpping
else (no)
98
  stop
99
  note
100 dd31cb03 Thomas Schöpping
    Returns ""URT_STATUS_FETCH_NOTOPIC"".
101 ee83a495 Thomas Schöpping
  endnote
102 7491c395 Thomas Schöpping
endif
103
104
/'### OUTRO ##################################################################'/
105
106
@enduml