Detailed Description

Data Structures
struct	mmagic_controller_init_args
	Initialization structure for mmagic_controller. More...

Macros
#define	MMAGIC_CONTROLLER_ARGS_INIT { 0 }
	Initializer for mmagic_controller_init_args. More...

Typedefs
typedef void(*	mmagic_controller_agent_start_cb_t) (struct mmagic_controller controller, void arg)
	Prototype for callback function invoked whenever any time a event that the agent has started is received. More...

Functions
struct mmagic_controller *	mmagic_controller_init (const struct mmagic_controller_init_args *args)
	Initialize the Controller. More...

void	mmagic_controller_deinit (struct mmagic_controller *controller)
	Deinitialize the Controller. More...

Macro Definition Documentation

#define MMAGIC_CONTROLLER_ARGS_INIT { 0 }

Definition at line 548 of file mmagic_controller.h.

typedef void(* mmagic_controller_agent_start_cb_t) (struct mmagic_controller *controller, void *arg)

Prototype for callback function invoked whenever any time a event that the agent has started is received.

Note: This callback will execute in the context of the Controller data link receive thread.

Parameters

controller	Reference to the the controller handle.
arg	User argument that was given when the callback was registered.

Definition at line 532 of file mmagic_controller.h.

void mmagic_controller_deinit ( struct mmagic_controller * controller )

Deinitialize the Controller.

Any resources used will be freed.

Parameters

controller Reference to the controller handle.

struct mmagic_controller * mmagic_controller_init ( const struct mmagic_controller_init_args * args )

Initialize the Controller.

Parameters

args	Reference to the initialization arguments for the mmagic_controller. May be `NULL`, in which case default values will be used.

Returns: Reference to the created controller handle on success. Null on error.