Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / subscriber / nrtsubscriber / urtNrtSubscriberFetchNextMessage.uml @ dd31cb03

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

    
28
!include ../functions.iuml
29

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

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

    
118
/'### OUTRO ##################################################################'/
119

    
120
@enduml