Mistake on this page? Email us
registry_listing_s Struct Reference

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

#include <lwm2m_types.h>

Data Fields

registry_path_t path
 
uint8_t listing_type
 
uint8_t value_set
 This bit is set as 1 if a value is available for the current Resource.
 
uint8_t parameters_set
 This bit is set as 1 if observation parameters are available for the current Resource.
 
uint8_t registered
 This bit is set if the Resource has been registered.
 
uint8_t set_registered
 This bit MUST be set as 0, unless the user wants to set the registered bit as 1.
 
struct registry_object_s * object
 For internal use only, MUST NOT be accessed from application.
 
struct registry_object_s * object_instance
 For internal use only, MUST NOT be accessed from application.
 
struct registry_object_s * resource
 For internal use only, MUST NOT be accessed from application.
 
struct registry_object_s * resource_instance
 For internal use only, MUST NOT be accessed from application.
 

Detailed Description

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.

Field Documentation

uint8_t registry_listing_s::listing_type

This field MUST be set as REGISTRY_LISTING_ALL, REGISTRY_LISTING_DIRECTORY or REGISTRY_LISTING_RECURSIVE.

registry_path_t registry_listing_s::path

Before the first function call, this path MUST be set if listing_type is set as REGISTRY_LISTING_DIRECTORY or REGISTRY_LISTING_RECURSIVE.

After a successful function call, the path is the path of the current Object.


The documentation for this struct was generated from the following file: