Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / request / nrtrequest / urtNrtRequestRetrieve.uml @ 2d315870

History | View | Annotate | Download (2.346 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 2d315870 Thomas Schöpping
title **µRtWare**\nurtNrtRequestRetrieve()\n
27 7491c395 Thomas Schöpping
28 ee83a495 Thomas Schöpping
/'### PARAMETERS & RETURN ####################################################'/
29 7491c395 Thomas Schöpping
30
note
31 2d315870 Thomas Schöpping
  -- **request** : urt_nrtrequest_t* --
32
  The request to retrieve.
33 7491c395 Thomas Schöpping
  Must not be ""NULL"".
34 ee83a495 Thomas Schöpping
  ====
35
  -- **return** : urt_status_t --
36 2d315870 Thomas Schöpping
  Typcially returns ""URT_STATUS_OK"".
37
  Returns ""URT_STATUS_REQUEST_BADOWNER"" if the request had to be removed from a service.
38 ee83a495 Thomas Schöpping
endnote
39 7491c395 Thomas Schöpping
40
/'### PROCEDURE ##############################################################'/
41
42 ee83a495 Thomas Schöpping
start
43 2d315870 Thomas Schöpping
:lock request;
44
if (Request is owned by a service?) then (yes)
45 dd31cb03 Thomas Schöpping
  fork
46 2d315870 Thomas Schöpping
    partition "unqueue request" {
47
      :lock service;
48
      fork
49
        if (This was the first request in the queue?) then (yes)
50
          :set ""requestQueue_front"" to ""next"";
51
        else (no)
52
          :set ""prev"" of preceeding request to ""prev"" of this reuqest;
53
        endif
54
      fork again
55
        if (This was the final request in the queue?) then (yes)
56
          :set ""requestQueue_back"" to ""prev"";
57
        else (no)
58
          :set ""next"" of preceeding request to ""next"" of this reuqest;
59
        endif
60
      endfork
61
      :unlock service;
62
    }
63 dd31cb03 Thomas Schöpping
  fork again
64 2d315870 Thomas Schöpping
    :set ""owner"" to ""NULL"";
65 dd31cb03 Thomas Schöpping
  endfork
66 2d315870 Thomas Schöpping
  stop
67
  note
68
    Returns ""URT_STATUS_REQUEST_BADOWNER"".
69
  endnote
70
else (no)
71
  stop
72
  note
73
    Returns ""URT_STATUS_OK"".
74
  endnote
75
endif
76 7491c395 Thomas Schöpping
77
/'### OUTRO ##################################################################'/
78
79
@enduml