4.10.16 nxo_condition
Keywords: onyx

Next: 4.10.17 nxo_dict Up: 4.10 Classes Previous: 4.10.15 nxo_class Contents Index
Subsections

- 4.10.16.1 API

##
4.10.16 nxo_condition

The nxo_condition class is a subclass of the nxo class.

### 4.10.16.1 API

void nxo_condition_new(cw_nxo_t *a_nxo):

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

void nxo_condition_signal(cw_nxo_t *a_nxo):

  Input(s):
    a_nxo:
      Pointer to a condition nxo.
  Output(s):
    None.
  Exception(s):
    None.
  Description:
    Signal one thread waiting on a_nxo, if there are any waiters.

void nxo_condition_broadcast(cw_nxo_t *a_nxo):

  Input(s):
    a_nxo:
      Pointer to a condition nxo.
  Output(s):
    None.
  Exception(s):
    None.
  Description:
    Signal all threads waiting on a_nxo.

void nxo_condition_wait(cw_nxo_t *a_nxo, cw_nxo_t *a_mutex):

  Input(s):
    a_nxo:
      Pointer to a condition nxo.
    a_mutex:
      Pointer to a mutex nxo.
  Output(s):
    None.
  Exception(s):
    None.
  Description:
    Wait for a_nxo.

bool nxo_condition_timedwait(cw_nxo_t *a_nxo, cw_nxo_t *a_mutex, const struct timespec *a_timeout):

  Input(s):
    a_nxo:
      Pointer to a condition nxo.
    a_mutex:
      Pointer to a mutex nxo.
    a_timeout:
      Timeout, specified as an absolute time interval.
  Output(s):
    retval:
      false:
        Success.
      true:
        Timeout.
  Exception(s):
    None.
  Description:
    Wait for a_nxo for at least a_timeout.

Next: 4.10.17 nxo_dict Up: 4.10 Classes Previous: 4.10.15 nxo_class Contents Index