async_context_freertos

Functions

bool async_context_freertos_init (async_context_freertos_t *self, async_context_freertos_config_t *config)
 Initialize an async_context_freertos instance using the specified configuration. More...
 
static async_context_freertos_config_t async_context_freertos_default_config (void)
 Return a copy of the default configuration object used by async_context_freertos_init_with_defaults() More...
 
static bool async_context_freertos_init_with_defaults (async_context_freertos_t *self)
 Initialize an async_context_freertos instance with default values. More...
 

Detailed Description

async_context_freertos provides an implementation of async_context that handles asynchronous work in a separate FreeRTOS task.

Function Documentation

◆ async_context_freertos_default_config()

static async_context_freertos_config_t async_context_freertos_default_config ( void  )
inlinestatic

Return a copy of the default configuration object used by async_context_freertos_init_with_defaults()

The caller can then modify just the settings it cares about, and call async_context_freertos_init()

Returns
the default configuration object

◆ async_context_freertos_init()

bool async_context_freertos_init ( async_context_freertos_t self,
async_context_freertos_config_t config 
)

Initialize an async_context_freertos instance using the specified configuration.

If this method succeeds (returns true), then the async_context is available for use and can be de-initialized by calling async_context_deinit().

Parameters
selfa pointer to async_context_freertos structure to initialize
configthe configuration object specifying characteristics for the async_context
Returns
true if initialization is successful, false otherwise

◆ async_context_freertos_init_with_defaults()

static bool async_context_freertos_init_with_defaults ( async_context_freertos_t self)
inlinestatic

Initialize an async_context_freertos instance with default values.

If this method succeeds (returns true), then the async_context is available for use and can be de-initialized by calling async_context_deinit().

Parameters
selfa pointer to async_context_freertos structure to initialize
Returns
true if initialization is successful, false otherwise