Revision e87bd7c7 doc/activitydiagrams/core/urtCoreStopNodes.uml
| doc/activitydiagrams/core/urtCoreStopNodes.uml | ||
|---|---|---|
| 28 | 28 |
/'### PARAMETERS & RETURN ####################################################'/ |
| 29 | 29 |
|
| 30 | 30 |
note |
| 31 |
-- //void// -- |
|
| 31 |
-- **reason** : urt_status_t -- |
|
| 32 |
The reason why the function was called. |
|
| 33 |
For normal shutdown ""URT_STATUS_OK"" should be used. |
|
| 32 | 34 |
==== |
| 33 | 35 |
-- **return** : urt_status_t -- |
| 36 |
Always returns ""URT_STATUS_OK"". |
|
| 34 | 37 |
endnote |
| 35 | 38 |
|
| 36 | 39 |
/'### PROCEDURE ##############################################################'/ |
| 37 | 40 |
|
| 38 | 41 |
start |
| 42 |
:lock core; |
|
| 43 |
if (Current ""_status"" value is smaller than specified reason?) then (yes) |
|
| 44 |
:set core's ""_status"" value to argument; |
|
| 45 |
else (no) |
|
| 46 |
endif |
|
| 47 |
:access first node in core's list of nodes; |
|
| 48 |
while (Current node is not ""NULL""?) is (yes) |
|
| 49 |
:request node to terminate; |
|
| 50 |
:proceed to next node; |
|
| 51 |
endwhile (no) |
|
| 52 |
:broadcast control event (terminate); |
|
| 53 |
:unlock core; |
|
| 39 | 54 |
stop |
| 55 |
note |
|
| 56 |
Returns ""URT_STATUS_OK"". |
|
| 57 |
endnote |
|
| 40 | 58 |
|
| 41 | 59 |
/'### OUTRO ##################################################################'/ |
| 42 | 60 |
|
Also available in: Unified diff