Statistics
| Branch: | Revision:

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

History | View | Annotate | Download (2.214 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**\nurtNrtRequestSubmit()\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 be used for this call.
33
  Must not be ""NULL"".
34
  Must have been acquired before.
35 ee83a495 Thomas Schöpping
  -- **service** : urt_service_t* --
36 2d315870 Thomas Schöpping
  The service to be called.
37 7491c395 Thomas Schöpping
  Must not be ""NULL"".
38 ee83a495 Thomas Schöpping
  ====
39
  -- **return** : urt_status_t --
40 2d315870 Thomas Schöpping
  Always returns ""URT_STATUS_OK"".
41 ee83a495 Thomas Schöpping
endnote
42 7491c395 Thomas Schöpping
43
/'### PROCEDURE ##############################################################'/
44
45 ee83a495 Thomas Schöpping
start
46 2d315870 Thomas Schöpping
:lock service;
47
fork
48
  partition "append request" {
49
    fork
50
      if (Service already holds requests?) then (yes)
51
        fork
52
          :set the ""prev"" pointer of this request to ""requestQueue_back"";
53
        fork again
54
          :set the ""next"" pointer of the last request to this request;
55
        endfork
56
      else (no)
57
        :set the ""requestQueue_front"" pointer to this request;
58
      endif
59
    fork again
60
      :set the ""requestQueue_back"" pointer to this request;
61
    endfork
62
  }
63
fork again
64
  :set the service as request owner;
65
endfork
66
:unlock request;
67
:fire event (@service);
68
:unlock service;
69 7491c395 Thomas Schöpping
stop
70
note
71 2d315870 Thomas Schöpping
  Returns ""URT_STATUS_OK"".
72 ee83a495 Thomas Schöpping
endnote
73 7491c395 Thomas Schöpping
74
/'### OUTRO ##################################################################'/
75
76
@enduml