Statistics
| Branch: | Revision:

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

History | View | Annotate | Download (3.79 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**\nurtFrtSubscriberFetchNextMessage()\n
27

    
28
!include ../functions.iuml
29

    
30
/'### PARAMETERS & RETURN ####################################################'/
31

    
32
note
33
  -- **subscriber** : urt_frtsubscriber_t* --
34
  The FRT 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
  Returns ""URT_STATUS_JITTERVIOLATION"" if the message's latency violated the maximum expected jitter.
50
endnote
51

    
52
/'### PROCEDURE ##############################################################'/
53

    
54
start
55
if (Associated to a topic?) then (yes)
56
  :lock topic;
57
  if (Timestamp of last read message equals local copy?) then (yes)
58
    if (Next message is younger?) then (yes)
59
      :proceed to next message;
60
    else (no)
61
      :unlock topic;
62
      stop
63
      note
64
        Returns ""URT_STATUS_FETCH_NOMESSAGE"".
65
      endnote
66
    endif
67
  else (no)
68
    partition "find oldest message" {
69
      repeat
70
        :proceed to next message;
71
      repeat while (Timestamp of next message is younger?) is (yes)
72
    }
73
  endif
74
  fork
75
    $fetch_message()
76
  fork again
77
    :calculate message latency;
78
    note
79
      Can be optimized in case all flags are disabled.
80
    endnote
81
    fork
82
      #EEEEEE:..//URT_CFG_PUBSUB_PROFILING == true//..\naccumulate ""sumLatencies"" value;
83
    fork again
84
      partition "//URT_CFG_PUBSUB_QOS_JITTERCHECKS == true || URT_CFG_PUBSUB_PROFILING == true//" #EEEEEE {
85
        if (Latency is lower than ""minLatency"" but within allowed jitter range?) then (yes)
86
          #EEEEEE:update ""minLatency"" value;
87
        elseif (Latency is greater than ""maxLatency"" but within allowed jitter range?) then (yes)
88
          #EEEEEE:update ""maxLatency"" value;
89
        else (no)
90
        endif
91
      }
92
    fork again
93
      if (Optional ""latency"" output argument given?) then (yes)
94
        :set ""latency"" value;
95
      else (no)
96
      endif
97
    endfork
98
  fork again
99
    partition "//URT_CFG_PUBSUB_PROFILING == true//" #EEEEEE {
100
      fork
101
        #EEEEEE:decrement counter of consumers left (@message);
102
      fork again
103
        #EEEEEE:increment counter of received messages;
104
      endfork
105
    }
106
  endfork
107
  :unlock topic;
108
  stop
109
  note
110
    Returns ""URT_STATUS_OK"" or ""URT_STATUS_JITTERVIOLATION"".
111
  endnote
112
else (no)
113
  stop
114
  note
115
    Returns ""URT_STATUS_FETCH_NOTOPIC"".
116
  endnote
117
endif
118

    
119
/'### OUTRO ##################################################################'/
120

    
121
@enduml