urtware / doc / activitydiagrams / request / frtrequest / urtFrtRequestRetrieve.uml @ 5c6cb22f
History | View | Annotate | Download (2.67 KB)
| 1 | 2d315870 | 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 | title **µRtWare**\nurtFrtRequestRetrieve()\n |
||
| 27 | |||
| 28 | /'### PARAMETERS & RETURN ####################################################'/ |
||
| 29 | |||
| 30 | note |
||
| 31 | -- **request** : urt_frtrequest_t* -- |
||
| 32 | The request to retrieve. |
||
| 33 | Must not be ""NULL"". |
||
| 34 | ==== |
||
| 35 | -- **return** : urt_status_t -- |
||
| 36 | Typcially returns ""URT_STATUS_OK"". |
||
| 37 | Returns ""URT_STATUS_REQUEST_BADOWNER"" if the request had to be removed from a service. |
||
| 38 | endnote |
||
| 39 | |||
| 40 | /'### PROCEDURE ##############################################################'/ |
||
| 41 | |||
| 42 | start |
||
| 43 | :lock request; |
||
| 44 | if (Request is owned by a service?) then (yes) |
||
| 45 | fork |
||
| 46 | 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 | fork again |
||
| 61 | if (This was the final FRT/SRT request?) then (yes) |
||
| 62 | if (There are FRT or SRT requests left in the queue?) then (yes) |
||
| 63 | :set ""requestQueue_fsrtBack"" to ""prev""; |
||
| 64 | else (no) |
||
| 65 | :set ""requestQueue_fsrtBack"" to ""NULL""; |
||
| 66 | endif |
||
| 67 | else (no) |
||
| 68 | endif |
||
| 69 | endfork |
||
| 70 | :unlock service; |
||
| 71 | } |
||
| 72 | fork again |
||
| 73 | :set ""owner"" to ""NULL""; |
||
| 74 | endfork |
||
| 75 | stop |
||
| 76 | note |
||
| 77 | Returns ""URT_STATUS_REQUEST_BADOWNER"". |
||
| 78 | endnote |
||
| 79 | else (no) |
||
| 80 | stop |
||
| 81 | note |
||
| 82 | Returns ""URT_STATUS_OK"". |
||
| 83 | endnote |
||
| 84 | endif |
||
| 85 | |||
| 86 | /'### OUTRO ##################################################################'/ |
||
| 87 | |||
| 88 | @enduml |