Notes

This module defines auto-reset events.

Include

Types

ao_are_t

typedef struct ao_are_t ao_are_t;

Represents an auto-reset event.

ao_are_wait_t

typedef struct ao_are_wait_t ao_are_wait_t;

Represents the waiting for an auto-reset event.

Structs

ao_are_t

struct ao_are_t
{
    bool      state;
    ao_list_t wait;
};

ao_are_wait_t

struct ao_are_wait_t
{
    ao_are_t *     are;
    ao_list_node_t are_wait_node;
    ao_async_t     async;
    bool volatile  result;
};

Functions

ao_are_set

void ao_are_set(ao_are_t * a);

Sets an auto-reset event, i.e. set its state to true. Eventually, this wakes up the first waiting task.

ao_are_wait

ao_are_wait_from

bool ao_are_wait     (ao_are_t * a, ao_time_t timeout);
bool ao_are_wait_from(ao_are_t * a, ao_time_t timeout, ao_time_t beginning);

Waits for an auto-reset event in a blocking fashion with a timeout and optional beginning.

ao_are_wait_forever

bool ao_are_wait_forever(ao_are_t * a);

Waits for an auto-reset event indefinitely in a blocking fashion.

ao_are_wait_try

bool ao_are_wait_try(ao_are_t * a);

Waits for an auto-reset event in a non-blocking fashion.

ao_are_wait_begin

ao_are_wait_end

void ao_are_wait_begin(ao_are_wait_t * w);
void ao_are_wait_end  (ao_are_wait_t * w);

Begins or ends, respectively, a waiting for an auto-reset event.