Enums and types for LwM2M interface. More...

Data Structures
struct	registry_callback_token_s
	Client Lite internal callbacks always associate with a token to enable multiple ongoing callbacks. More...

struct	registry_available_parameters_s
	Structure for marking the observation parameters available inside the associated structure. More...

union	registry_observation_value_u
	Union for carrying previous integer or floating point value of the observed Resource. More...

struct	registry_data_opaque_s
	Structure for keeping opaque data in a registry item. More...

union	registry_data_generic_u
	Common name for storing either opaque or string data of Resources. More...

struct	registry_generic_value_s
	All non-primitive data in registry item values is stored through this structure. More...

union	registry_object_value_u
	All resource values are stored through this common name. More...

struct	registry_path_s
	Describes the path of an item in the LwM2M Object registry. More...

struct	registry_listing_s
	This data structure is used when searching or otherwise iterating the LwM2M Object hierarchy in the registry. More...

Typedefs
typedef enum registry_callback_type_e	registry_callback_type_t
	Type of the resource callback call.

typedef enum registry_removal_type_e	registry_removal_type_t
	Resource remove mode.

typedef enum registry_notification_status_e	registry_notification_status_t
	Notification status codes.

typedef struct registry_callback_token_s	registry_callback_token_t
	Client Lite internal callbacks always associate with a token to enable multiple ongoing callbacks.

typedef struct registry_available_parameters_s	registry_available_parameters_t
	Structure for marking the observation parameters available inside the associated structure.

typedef union registry_observation_value_u	registry_observation_value_t
	Union for carrying previous integer or floating point value of the observed Resource.

typedef struct registry_data_opaque_s	registry_data_opaque_t
	Structure for keeping opaque data in a registry item.

typedef union registry_data_generic_u	registry_data_generic_t
	Common name for storing either opaque or string data of Resources.

typedef struct registry_generic_value_s	registry_generic_value_t
	All non-primitive data in registry item values is stored through this structure.

typedef union registry_object_value_u	registry_object_value_t
	All resource values are stored through this common name.

typedef struct registry_path_s	registry_path_t
	Describes the path of an item in the LwM2M Object registry. More...

typedef enum registry_status_e	registry_status_t
	Possible status codes for registry functions.

typedef enum registry_event_listen_mode_e	registry_event_listen_mode_t
	These values are used for indicating what kind of events are listened from the registry. More...

typedef enum listing_type_e	listing_type_t
	Used for selecting the listing type before calling the listing function, and for internal state information internally.

typedef struct registry_listing_s	registry_listing_t
	This data structure is used when searching or otherwise iterating the LwM2M Object hierarchy in the registry. More...

Enumerations
enum	registry_callback_type_e { REGISTRY_CALLBACK_NONE = 0, REGISTRY_CALLBACK_VALUE_UPDATED = 1, REGISTRY_CALLBACK_EXECUTE, REGISTRY_CALLBACK_BLOCKMESSAGE_INCOMING, REGISTRY_CALLBACK_BLOCKMESSAGE_OUTGOING, REGISTRY_CALLBACK_NOTIFICATION_STATUS, REGISTRY_CALLBACK_ITEM_REMOVED, REGISTRY_CALLBACK_ITEM_REPLACED, REGISTRY_CALLBACK_ITEM_ADDED }
	Type of the resource callback call. More...

enum	registry_removal_type_e { REGISTRY_REMOVE, REGISTRY_REMOVE_FOR_REPLACEMENT, REGISTRY_REMOVE_SKIP_CALLBACK }
	Resource remove mode. More...

enum	registry_notification_status_e { NOTIFICATION_STATUS_IGNORE = -1, NOTIFICATION_STATUS_INIT = 0, NOTIFICATION_STATUS_BUILD_ERROR, NOTIFICATION_STATUS_RESEND_QUEUE_FULL, NOTIFICATION_STATUS_SENT, NOTIFICATION_STATUS_DELIVERED, NOTIFICATION_STATUS_SEND_FAILED, NOTIFICATION_STATUS_SUBSCRIBED, NOTIFICATION_STATUS_UNSUBSCRIBED, NOTIFICATION_STATUS_NOT_REGISTERED }
	Notification status codes. More...

enum	registry_status_e { REGISTRY_STATUS_NO_DATA = 1, REGISTRY_STATUS_OK = 0, REGISTRY_STATUS_NOT_FOUND = (-1), REGISTRY_STATUS_NO_MEMORY = (-2), REGISTRY_STATUS_INVALID_INPUT = (-3), REGISTRY_STATUS_ALREADY_EXISTS = (-4) }
	Possible status codes for registry functions. More...

enum	registry_event_listen_mode_e { REGISTRY_EVENT_LISTEN_VALUE_CHANGES = 1, REGISTRY_EVENT_LISTEN_CREATE_REMOVE = 2, REGISTRY_EVENT_LISTEN_EVERY_EVENT = 3 }
	These values are used for indicating what kind of events are listened from the registry. More...

enum	listing_type_e { REGISTRY_LISTING_IN_PROGRESS = 0, REGISTRY_LISTING_ALL = 1, REGISTRY_LISTING_DIRECTORY = 2, REGISTRY_LISTING_RECURSIVE = 3, REGISTRY_LISTING_DIRECTORY_IN_PROGRESS = 4 }
	Used for selecting the listing type before calling the listing function, and for internal state information internally. More...

Detailed Description

Enums and types for LwM2M interface.

Typedef Documentation

typedef enum registry_event_listen_mode_e registry_event_listen_mode_t

These values are used for indicating what kind of events are listened from the registry.

Note: registry_event_listen_mode_t uses bitmask values, REGISTRY_EVENT_LISTEN_EVERY_EVENT sets all the bits.

typedef struct registry_listing_s registry_listing_t

This data structure is used when searching or otherwise iterating the LwM2M Object hierarchy in the registry.

Note: Required fields MUST be set before the first function call to the applicable function is made.; After the a call, the fields MUST NOT changed unless a completely new listing is being started.

typedef struct registry_path_s registry_path_t

Describes the path of an item in the LwM2M Object registry.

Note: Field path_type must be read before reading other fields, except object_id, to check if they are available.

Enumeration Type Documentation

enum listing_type_e

Used for selecting the listing type before calling the listing function, and for internal state information internally.

Enumerator
REGISTRY_LISTING_IN_PROGRESS	Internal state, Must not be set by user.
REGISTRY_LISTING_ALL	List everything stored to registry.
REGISTRY_LISTING_DIRECTORY	List one directory.
REGISTRY_LISTING_RECURSIVE	List everything located under the given path.
REGISTRY_LISTING_DIRECTORY_IN_PROGRESS	Internal state. Must not be set by user.

enum registry_callback_type_e

Type of the resource callback call.

Enumerator
REGISTRY_CALLBACK_NONE	Callback type not set.
REGISTRY_CALLBACK_VALUE_UPDATED	Value change.
REGISTRY_CALLBACK_EXECUTE	Execute received for the Resource.
REGISTRY_CALLBACK_BLOCKMESSAGE_INCOMING	Message block received for the Resource.
REGISTRY_CALLBACK_BLOCKMESSAGE_OUTGOING	Message block is being sent.
REGISTRY_CALLBACK_NOTIFICATION_STATUS	Notification status has changed.
REGISTRY_CALLBACK_ITEM_REMOVED	Registry Object, Resource or Instance was removed.
REGISTRY_CALLBACK_ITEM_REPLACED	Registry Object, Resource or Instance was removed, but will be added again.
REGISTRY_CALLBACK_ITEM_ADDED	Registry Object, Resource or Instance was added.

enum registry_event_listen_mode_e

These values are used for indicating what kind of events are listened from the registry.

Note: registry_event_listen_mode_t uses bitmask values, REGISTRY_EVENT_LISTEN_EVERY_EVENT sets all the bits.

Enumerator
REGISTRY_EVENT_LISTEN_VALUE_CHANGES	Request events from value changes.
REGISTRY_EVENT_LISTEN_CREATE_REMOVE	Request events from Object creation removal.
REGISTRY_EVENT_LISTEN_EVERY_EVENT	Request all available events.

enum registry_notification_status_e

Notification status codes.

Enumerator
NOTIFICATION_STATUS_IGNORE	Ignored status.
NOTIFICATION_STATUS_INIT	Initial state.
NOTIFICATION_STATUS_BUILD_ERROR	CoAP message building fails.
NOTIFICATION_STATUS_RESEND_QUEUE_FULL	CoAP resend queue full.
NOTIFICATION_STATUS_SENT	Notification sent to the server but ACK not yet received.
NOTIFICATION_STATUS_DELIVERED	Received ACK from server.
NOTIFICATION_STATUS_SEND_FAILED	Message sending failed (retransmission completed).
NOTIFICATION_STATUS_SUBSCRIBED	Server has started the observation.
NOTIFICATION_STATUS_UNSUBSCRIBED	Server has stopped the observation (RESET message or GET with observe 1).
NOTIFICATION_STATUS_NOT_REGISTERED	Failed due to not being registered.

enum registry_removal_type_e

Resource remove mode.

Enumerator
REGISTRY_REMOVE	Normal remove operation.
REGISTRY_REMOVE_FOR_REPLACEMENT	Resource is replaced with a new one.
REGISTRY_REMOVE_SKIP_CALLBACK	Do not call removal callback function.

enum registry_status_e

Possible status codes for registry functions.

Enumerator
REGISTRY_STATUS_NO_DATA	There is no data to be read.
REGISTRY_STATUS_OK	No errors.
REGISTRY_STATUS_NOT_FOUND	Resource not found.
REGISTRY_STATUS_NO_MEMORY	Out of memory.
REGISTRY_STATUS_INVALID_INPUT	Invalid input parameter or data.
REGISTRY_STATUS_ALREADY_EXISTS	Resource already created.

Documentation

Data Structures

Typedefs

Enumerations

Detailed Description

Typedef Documentation

Enumeration Type Documentation