Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / request / hrtrequest / urtHrtRequestAcquire.uml @ 2d315870

History | View | Annotate | Download (1.583 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**\nurtHrtRequestAcquire()\n
27
28
!include ../functions.iuml
29 7491c395 Thomas Schöpping
30 ee83a495 Thomas Schöpping
/'### PARAMETERS & RETURN ####################################################'/
31 7491c395 Thomas Schöpping
32
note
33 2d315870 Thomas Schöpping
  -- **request** : urt_hrtrequest_t* --
34
  The HRT request to be acquired.
35 7491c395 Thomas Schöpping
  Must not be ""NULL"".
36 ee83a495 Thomas Schöpping
  ====
37
  -- **return** : urt_status_t --
38 2d315870 Thomas Schöpping
  Returns ""URT_STATUS_OK"" in case of success.
39
  Returns ""URT_STATUS_REQUEST_BADOWNER"" if the request is aloready owned by a service.
40 ee83a495 Thomas Schöpping
endnote
41 7491c395 Thomas Schöpping
42
/'### PROCEDURE ##############################################################'/
43
44 2d315870 Thomas Schöpping
$acquire_request()
45 7491c395 Thomas Schöpping
46
/'### OUTRO ##################################################################'/
47
48
@enduml