AMiRo-OS

/'

µRtWare is a lightweight publish/subscribe middleware for real-time

applications. It was developed as part of the software habitat for the

Autonomous Mini Robot [1] (AMiRo) but can be used for other purposes as well.

Copyright (C) 2018..2020  Thomas Schöpping et al.

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see <http://www.gnu.org/licenses/>.

'/

/'### INTRO ##################################################################'/

@startuml

title **µRtWare**\nurtServiceTryAcquireRequest()\n

/'### PARAMETERS & RETURN ####################################################'/

note

  -- **service** : urt_service_t* --

  The service that shall acquire the request.

  Must not be ""NULL"".

  -- **request** : urt_baserequest_t* --

  The request to be acquired.

  Must not be ""NULL"".

  ====

  -- **return** : urt_status_t --

  Returns ""URT_STATUS_OK"" in case of success.

  Returns ""URT_STATUS_REQUEST_BADOWNER"" if the service has lost ownership of the request.

  Returns ""URT_STATUS_REQUEST_LOCKED"" if the request's mutex is already locked.

endnote

/'### PROCEDURE ##############################################################'/

start

:lock request;

note

  Does not block.

endnote

if (Request could be locked?) then (yes)

  if (This service is owner of the request?) then (yes)

    stop

    note

      Returns ""URT_STATUS_OK"".

    endnote

  else (no)

    :unlock request;

    stop

    note

      Returns ""URT_STATUS_REQUEST_BADOWNER"".

    endnote

  endif

else (no)

  stop

  note

    Returns ""URT_STATUS_REQUEST_LOCKED"".

  endnote

endif

/'### OUTRO ##################################################################'/

@enduml