Notes
This module provides an abstraction for receiving pointers from an opaque source.
Include
ao_async.h |
ao_time.h |
stdbool.h |
Types
ao_recv_ptr_t
typedef struct ao_recv_ptr_t ao_recv_ptr_t;
Represents the receiving of a pointer.
ao_recv_ptr_proc_t
typedef void (* ao_recv_ptr_proc_t)
(
ao_recv_ptr_t * recv
);
Represents a function beginning or ending a receiving of a pointer.
Structs
ao_recv_ptr_t
struct ao_recv_ptr_t
{
ao_async_t async;
ao_recv_ptr_proc_t begin;
ao_recv_ptr_proc_t end;
void * parameter;
void * volatile ptr;
bool volatile result;
};
async |
The asynchronous event. |
begin |
The function beginning the receiving. |
end |
The function ending the receiving. |
parameter |
An additional parameter. |
ptr |
The received pointer. |
result |
The result. |
Functions
ao_recv_ptr
ao_recv_ptr_from
void ao_recv_ptr (ao_recv_ptr_t * r, ao_time_t timeout);
void ao_recv_ptr_from(ao_recv_ptr_t * r, ao_time_t timeout, ao_time_t beginning);
Receives a pointer in a blocking fashion with a timeout and an optional beginning.
ao_recv_ptr_forever
void ao_recv_ptr_forever(ao_recv_ptr_t * r);
Receives a pointer indefinitely in a blocking fashion.
ao_recv_ptr_try
void ao_recv_ptr_try(ao_recv_ptr_t * r);
Receives a pointer in a non-blocking fashion.
ao_recv_ptr_begin
ao_recv_ptr_end
void ao_recv_ptr_begin(ao_recv_ptr_t * r);
void ao_recv_ptr_end (ao_recv_ptr_t * r);
Begins or ends, respectively, a receiving of a pointer.