async_loop_config

Summary

Public attributes

data
void *
Data to pass to the callback functions.
default_accessors
If specified, these functions will be used to register the loop as the default dispatcher on the thread on which they are called and will be used to automatically unregister the loop when it is destroyed.
epilogue
async_loop_callback_t *
A function to call after the dispatcher invokes each handler, or NULL if none.
irq_support
bool
True if IRQs should be supported.
make_default_for_current_thread
bool
If true, then uses default_accessors.setter to register the loop as the default dispatcher for the thread upon which the loop was created.
prologue
async_loop_callback_t *
A function to call before the dispatcher invokes each handler, or NULL if none.

Public attributes

data

void * async_loop_config::data

Data to pass to the callback functions.

default_accessors

async_loop_default_accessors_t async_loop_config::default_accessors

If specified, these functions will be used to register the loop as the default dispatcher on the thread on which they are called and will be used to automatically unregister the loop when it is destroyed.

If NULL, the loop will not do this. The loop's creator is then responsible for retrieving the loop's dispatcher using |async_loop_get_dispatcher()| and passing it around explicitly.

It is an error for only one of the functions to be non-NULL.

Note that the loop can be used even without setting it as the current thread's default.

epilogue

async_loop_callback_t * async_loop_config::epilogue

A function to call after the dispatcher invokes each handler, or NULL if none.

irq_support

bool async_loop_config::irq_support

True if IRQs should be supported.

make_default_for_current_thread

bool async_loop_config::make_default_for_current_thread

If true, then uses default_accessors.setter to register the loop as the default dispatcher for the thread upon which the loop was created.

TRANSITIONAL BEHAVIOR: If default_accesors are not specified and this flag is true, then behaves as if async_get_default_dispatcher/async_set_default_dispatcher were specified as the default_accessors.

prologue

async_loop_callback_t * async_loop_config::prologue

A function to call before the dispatcher invokes each handler, or NULL if none.