rom/exec/attemptsemaphore.c

   1 /*
   2     Copyright © 1995-2015, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Try to lock a sempahore.
   6     Lang: english
   7 */
   8
   9 #include <exec/semaphores.h>
  10 #include <proto/exec.h>
  11
  12 #include "exec_intern.h"
  13 #include "exec_util.h"
  14 #include "semaphores.h"
  15
  16 /*****************************************************************************
  17
  18     NAME */
  19
  20         AROS_LH1(ULONG, AttemptSemaphore,
  21
  22 /*  SYNOPSIS */
  23         AROS_LHA(struct SignalSemaphore *, sigSem, A0),
  24
  25 /*  LOCATION */
  26         struct ExecBase *, SysBase, 96, Exec)
  27
  28 /*  FUNCTION
  29         Tries to get an exclusive lock on a signal semaphore. If the semaphore
  30         is already in use by another task, this function does not wait but
  31         returns false instead.
  32
  33     INPUTS
  34         sigSem - Pointer so semaphore structure.
  35
  36     RESULT
  37         TRUE if the semaphore could be obtained, FALSE otherwise.
  38
  39     NOTES
  40         The lock must be freed with ReleaseSemaphore().
  41
  42     EXAMPLE
  43
  44     BUGS
  45
  46     SEE ALSO
  47         ReleaseSemaphore()
  48
  49     INTERNALS
  50
  51 *****************************************************************************/
  52 {
  53     AROS_LIBFUNC_INIT
  54
  55     struct TraceLocation tp = CURRENT_LOCATION("AttemptSemaphore");
  56     struct Task *ThisTask = GET_THIS_TASK;
  57
  58     return InternalAttemptSemaphore(sigSem, ThisTask, &tp, SysBase);
  59
  60     AROS_LIBFUNC_EXIT
  61 } /* AttemptSemaphore */