4.10.24 nxo_mutex
Keywords: onyx

Next: 4.10.25 nxo_name Up: 4.10 Classes Previous: 4.10.23 nxo_mark Contents Index
Subsections

- 4.10.24.1 API

##
4.10.24 nxo_mutex

The nxo_mutex class is a subclass of the nxo class.

### 4.10.24.1 API

void nxo_mutex_new(cw_nxo_t *a_nxo):

  Input(s):
    a_nxo:
      Pointer to a mutex nxo.
  Output(s):
    None.
  Exception(s):
    CW_ONYXX_OOM.
  Description:
    Constructor.

void nxo_mutex_lock(cw_nxo_t *a_nxo):

  Input(s):
    a_nxo:
      Pointer to a mutex nxo.
  Output(s):
    None.
  Exception(s):
    None.
  Description:
    Lock a_nxo.

bool nxo_mutex_trylock(cw_nxo_t *a_nxo):

  Input(s):
    a_nxo:
      Pointer to a mutex nxo.
  Output(s):
    retval:
      false:
        Success.
      true:
        Failure.
  Exception(s):
    None.
  Description:
    Try to lock a_nxo, but return immediately with an error if unable to do so.

void nxo_mutex_unlock(cw_nxo_t *a_nxo):

  Input(s):
    a_nxo:
      Pointer to a mutex nxo.
  Output(s):
    None.
  Exception(s):
    None.
  Description:
    Unlock a_nxo.

Next: 4.10.25 nxo_name Up: 4.10 Classes Previous: 4.10.23 nxo_mark Contents Index