Include

Types

ao_threshold_t

typedef struct ao_threshold_t ao_threshold_t;

Represents a threshold.

ao_threshold_wait_t

typedef struct ao_threshold_wait_t ao_threshold_wait_t;

Represents the waiting for a threshold match.

ao_threshold_adjust_t

typedef ao_uint_t (* ao_threshold_adjust_t)
(
    ao_uint_t value_old,
    void *    parameter
);

Represents a function to adjust a threshold value. The function takes the old value and an additional parameter and returns the new value.

ao_threshold_match_t

typedef bool (* ao_threshold_match_t)
(
    ao_uint_t value_old,
    ao_uint_t value_new,
    void *    parameter
);

Represents a function to check whether a specific threshold value is a match. The function takes both the old and the new value of a threshold as well as an additional parameter.

Structs

ao_threshold_t

struct ao_threshold_t
{
    ao_threshold_adjust_t adjust;
    void *                adjust_parameter;
    ao_threshold_match_t  match;
    void *                match_parameter;
    ao_uint_t             value;
    ao_list_t             wait;
};

ao_threshold_wait_t

struct ao_threshold_wait_t
{
    ao_async_t         async;
    bool      volatile result;
    ao_threshold_t *   threshold;
    ao_list_node_t     threshold_wait_node;
    ao_uint_t volatile value_new;
    ao_uint_t volatile value_old;
};

Functions

ao_threshold_adjust

void ao_threshold_adjust(ao_threshold_t * t, ao_threshold_adjust_t a, void * ap);

Adjusts a threshold.

ao_threshold_add

void ao_threshold_add(ao_threshold_t * t, ao_uint_t x);

Updates a threshold’s value. This functions adds the threshold’s value and the specified value.

ao_threshold_and

void ao_threshold_and(ao_threshold_t * t, ao_uint_t x);

Updates a threshold’s value. This functions performs a bitwise AND with the specified value.

ao_threshold_decrement

void ao_threshold_decrement(ao_threshold_t * t);

Updates a threshold’s value. This functions decrements the threshold’s value.

ao_threshold_divide

void ao_threshold_divide(ao_threshold_t * t, ao_uint_t x);

Updates a threshold’s value. This functions divides the threshold’s value by the specified value.

ao_threshold_increment

void ao_threshold_increment(ao_threshold_t * t);

Updates a threshold’s value. This functions increments the threshold’s value.

ao_threshold_max

void ao_threshold_max(ao_threshold_t * t);

Updates a threshold’s value. This functions sets the threshold’s value to the maximum possible value.

ao_threshold_min

void ao_threshold_min(ao_threshold_t * t);

Updates a threshold’s value. This functions sets the threshold’s value to the minimum possible value, i.e. zero.

ao_threshold_modulo

void ao_threshold_modulo(ao_threshold_t * t, ao_uint_t x);

Updates a threshold’s value. This functions sets the threshold’s value to the remainder of it divided by the specified value.

ao_threshold_multiply

void ao_threshold_multiply(ao_threshold_t * t, ao_uint_t x);

Updates a threshold’s value. This functions multiplies the threshold’s value with the specified value.

ao_threshold_nand

void ao_threshold_nand(ao_threshold_t * t, ao_uint_t x);

Updates a threshold’s value. This functions performs a bitwise NAND with the specified value.

ao_threshold_nor

void ao_threshold_nor(ao_threshold_t * t, ao_uint_t x);

Updates a threshold’s value. This functions performs a bitwise NOR with the specified value.

ao_threshold_not

void ao_threshold_not(ao_threshold_t * t);

Updates a threshold’s value. This functions performs a bitwise inversion on the threshold’s value.

ao_threshold_or

void ao_threshold_or(ao_threshold_t * t, ao_uint_t x);

Updates a threshold’s value. This functions performs a bitwise OR with the specified value.

ao_threshold_set

void ao_threshold_set(ao_threshold_t * t, ao_uint_t x);

Updates a threshold’s value. This functions sets the threshold’s value to the specified value.

ao_threshold_subtract

void ao_threshold_subtract(ao_threshold_t * t, ao_uint_t x);

Updates a threshold’s value. This functions subtracts the specified value from the threshold’s value.

ao_threshold_subtract_from

void ao_threshold_subtract_from(ao_threshold_t * t, ao_uint_t x);

Updates a threshold’s value. This functions subtracts the threshold’s value from the specified value.

ao_threshold_xnor

void ao_threshold_xnor(ao_threshold_t * t, ao_uint_t x);

Updates a threshold’s value. This functions performs a bitwise XNOR with the specified value.

ao_threshold_xor

void ao_threshold_xor(ao_threshold_t * t, ao_uint_t x);

Updates a threshold’s value. This functions performs a bitwise XOR with the specified value.

ao_threshold_wait

ao_threshold_wait_from

bool ao_threshold_wait     (ao_threshold_wait_t * w, ao_time_t timeout);
bool ao_threshold_wait_from(ao_threshold_wait_t * w, ao_time_t timeout, ao_time_t beginning);

Waits for a threshold match in a blocking fashion with a timeout and an optional beginning.

ao_threshold_wait_forever

bool ao_threshold_wait_forever(ao_threshold_wait_t * w);

Waits for a threshold match indefinitely in a blocking fashion.

ao_threshold_wait_try

bool ao_threshold_wait_try(ao_threshold_wait_t * w);

Waits for a threshold match in a non-blocking fashion.

ao_threshold_wait_begin

ao_threshold_wait_end

void ao_threshold_wait_begin(ao_threshold_wait_t * w);
void ao_threshold_wait_end  (ao_threshold_wait_t * w);

Begins or ends, respectively, a waiting for a threshold match.