Morse M2M Agent/CLI Common API

Detailed Description

This API is common use by both the MMAGIC M2M Agent and CLI.

Macros
#define	CONTROL_STREAM   0
	The stream ID of the control stream. More...
#define	MMAGIC_SYS_MAX_APP_VERSION_LENGTH   (31)
	Maximum length of the app_version string (excluding null terminator). More...

Typedefs
typedef bool(*	mmagic_set_deep_sleep_mode_cb_t) (enum mmagic_deep_sleep_mode mode, void *cb_arg)
	Typedef for callback function that is invoked by MMAGIC to request a change in deep sleep mode. More...

Macro Definition Documentation

CONTROL_STREAM

#define CONTROL_STREAM   0

The stream ID of the control stream.

Definition at line 224 of file mmagic.h.

MMAGIC_SYS_MAX_APP_VERSION_LENGTH

#define MMAGIC_SYS_MAX_APP_VERSION_LENGTH   (31)

Maximum length of the app_version string (excluding null terminator).

Definition at line 227 of file mmagic.h.

Typedef Documentation

mmagic_set_deep_sleep_mode_cb_t

typedef bool(* mmagic_set_deep_sleep_mode_cb_t) (enum mmagic_deep_sleep_mode mode, void *cb_arg)

Typedef for callback function that is invoked by MMAGIC to request a change in deep sleep mode.

Parameters

mode	The requested mode.
cb_arg	Opaque argument that was provided when the callback was registered.

Returns

true if the mode was set successfully; false on failure (e.g., unsupported mode).

Definition at line 238 of file mmagic.h.