Internal Fixture Interfaces.

Classes
struct	uic_fixt_setup_step
struct	uic_fixt_shutdown_step

Typedefs
typedef struct uic_fixt_setup_step	uic_fixt_setup_step_t
typedef struct uic_fixt_shutdown_step	uic_fixt_shutdown_step_t

Functions
sl_status_t	uic_fixt_setup_loop (const uic_fixt_setup_step_t *fixt_app_setup)
int	uic_fixt_shutdown_loop (const uic_fixt_shutdown_step_t *fixt_app_shutdown)

Variables
static uic_fixt_shutdown_step_t	uic_fixt_shutdown_steps_list []

Detailed Description

Internal part of Unify Component Fixture Set Up and Tear Down.

Typedef Documentation

uic_fixt_setup_step_t

typedef struct uic_fixt_setup_step uic_fixt_setup_step_t

Struct to hold the component pre-initializers (fixture setup).

These functions are executed in order before entering the Unify main loop.

uic_fixt_shutdown_step_t

typedef struct uic_fixt_shutdown_step uic_fixt_shutdown_step_t

Struct to hold the system tear-down functions.

A component is not required to have a tear-down function just because it has an initializer function (or vice versa). If a component has a Contiki process, teardown of the component should be done by handling the Contiki event PROCESS_EVENT_EXIT

Function Documentation

uic_fixt_setup_loop()

sl_status_t uic_fixt_setup_loop

(

const uic_fixt_setup_step_t *

fixt_app_setup

)

Loop over the set-up functions.

Returns

false if any of the set-up steps return false.

uic_fixt_shutdown_loop()

int uic_fixt_shutdown_loop

(

const uic_fixt_shutdown_step_t *

fixt_app_shutdown

)

Loop over the tear-down steps.

Returns

Number of issues detected during shutdown.

Variable Documentation

uic_fixt_shutdown_steps_list

uic_fixt_shutdown_step_t uic_fixt_shutdown_steps_list[]

static

Initial value:

= {{uic_mqtt_teardown, "Unify MQTT Client"},
     {uic_stdin_teardown, "Unify STDIN"},
     {NULL, "Terminator"}}

Final tear-down steps.

Functions to take down components and free allocated resources. The function are executed in order, after all contiki processes have been stopped.