#include <m2mobjectinstance.h>

Inherits M2MBase, and M2MObjectInstanceCallback.

Public Types
enum	BaseType
	Enum to define the type of object. More...
enum	Observation
	Enum to define observation level. More...
enum	Mode
	Enum defining an operation that can be supported by a given resource. More...
enum	Operation
	Enum defining an operation that can be supported by a given resource. More...
Public Member Functions
M2MResource *	create_static_resource (const String &resource_name, const String &resource_type, M2MResourceInstance::ResourceType type, const uint8_t *value, const uint8_t value_length, bool multiple_instance=false)
	Creates a static resource for a given mbed Client Inteface object.
M2MResource *	create_dynamic_resource (const String &resource_name, const String &resource_type, M2MResourceInstance::ResourceType type, bool observable, bool multiple_instance=false)
	Creates a dynamic resource for a given mbed Client Inteface object.
M2MResourceInstance *	create_static_resource_instance (const String &resource_name, const String &resource_type, M2MResourceInstance::ResourceType type, const uint8_t *value, const uint8_t value_length, uint16_t instance_id)
	Creates a static resource instance for a given mbed Client Inteface object.
M2MResourceInstance *	create_dynamic_resource_instance (const String &resource_name, const String &resource_type, M2MResourceInstance::ResourceType type, bool observable, uint16_t instance_id)
	Creates a dynamic resource instance for a given mbed Client Inteface object.
virtual bool	remove_resource (const String &name)
	Removes the resource with the given name.
virtual bool	remove_resource_instance (const String &resource_name, uint16_t instance_id)
	Removes the resource instance with the given name.
virtual M2MResource *	resource (const String &name) const
	Returns resource with the given name.
virtual const M2MResourceList &	resources () const
	Returns a list of M2MResourceBase objects.
virtual uint16_t	resource_count () const
	Returns the total number of resources with the object.
virtual uint16_t	resource_count (const String &resource) const
	Returns the total number of single resource instances.
virtual M2MBase::BaseType	base_type () const
	Returns object type.
virtual void	add_observation_level (M2MBase::Observation observation_level)
	Adds the observation level for the object.
virtual void	remove_observation_level (M2MBase::Observation observation_level)
	Removes the observation level from the object.
virtual sn_coap_hdr_s *	handle_get_request (nsdl_s nsdl, sn_coap_hdr_s received_coap_header, M2MObservationHandler *observation_handler=NULL)
	Handles GET request for the registered objects.
virtual sn_coap_hdr_s *	handle_put_request (nsdl_s nsdl, sn_coap_hdr_s received_coap_header, M2MObservationHandler *observation_handler=NULL)
	Handles PUT request for the registered objects.
virtual sn_coap_hdr_s *	handle_post_request (nsdl_s nsdl, sn_coap_hdr_s received_coap_header, M2MObservationHandler *observation_handler=NULL)
	Handles GET request for the registered objects.
virtual void	set_operation (M2MBase::Operation operation)
	Sets the operation type for an object.
virtual void	set_interface_description (const String &description)
	Sets the interface description of the object.
virtual void	set_resource_type (const String &resource_type)
	Sets the resource type of the object.
virtual void	set_coap_content_type (const uint8_t content_type)
	Sets the CoAP content type of the object.
virtual void	set_observable (bool observable)
	Sets the observable mode for the object.
virtual void	set_under_observation (bool observed, M2MObservationHandler *handler)
	Sets the object under observation.
virtual void	set_observation_token (const uint8_t *token, const uint8_t length)
	Sets the observation token value.
virtual void	set_instance_id (const uint16_t instance_id)
	Sets the instance ID of the object.
virtual void	set_observation_number (const uint16_t observation_number)
	Sets the observation number of the object.
virtual M2MBase::Operation	operation () const
	Returns the operation type of the object.
virtual const String &	name () const
	Returns the object name.
virtual int32_t	name_id () const
	Returns the object name in integer.
virtual uint16_t	instance_id () const
	Returns the object's Instance ID.
virtual const String &	interface_description () const
	Returns the interface description of the object.
virtual const String &	resource_type () const
	Returns the resource type of the object.
virtual uint8_t	coap_content_type () const
	Returns the CoAP content type of the object.
virtual bool	is_observable () const
	Returns the observation status of the object.
virtual M2MBase::Observation	observation_level () const
	Returns the observation level of the object.
virtual void	get_observation_token (uint8_t *&token, uint32_t &token_length)
	Provides the observation token of the object.
virtual Mode	mode () const
	Returns the mode of the resource.
virtual uint16_t	observation_number () const
	Returns the observation number.
virtual bool	handle_observation_attribute (char *&query)
	Parses the received query for the notification attribute.
Protected Member Functions
virtual void	observation_to_be_sent ()
	Observation callback to be sent to the server due to a change in the observed parameter.
virtual void	set_base_type (M2MBase::BaseType type)
	Sets the Base type for object.
virtual void	remove_resource_from_coap (const String &resource_name)
	Removes resource from the CoAP structure.
virtual void	remove_object_from_coap ()
	Removes object from NSDL list.
virtual void *	memory_alloc (uint16_t size)
	Memory Allocation required for libCoap.
virtual void	memory_free (void *ptr)
	Memory free functions required for libCoap.
M2MReportHandler *	report_handler ()
	Returns Report Handler object.
M2MObservationHandler *	observation_handler ()
	Returns Observation Handler object.
Friends
class	M2MObject

Detailed Description

M2MObjectInstance.

This class is the instance class for mbed Client Objects. All defined LWM2M object models can be created based on it. This class also holds all resource instances associated with the given object.

Definition at line 38 of file m2mobjectinstance.h.

Member Enumeration Documentation

enum BaseType [inherited]

Enum to define the type of object.

Definition at line 45 of file m2mbase.h.

enum Mode [inherited]

Enum defining an operation that can be supported by a given resource.

Definition at line 71 of file m2mbase.h.

enum Observation [inherited]

Enum to define observation level.

Definition at line 55 of file m2mbase.h.

enum Operation [inherited]

Enum defining an operation that can be supported by a given resource.

Definition at line 81 of file m2mbase.h.

Member Function Documentation

void add_observation_level ( M2MBase::Observation observation_level ) [virtual]

Adds the observation level for the object.

Parameters:

observation_level,Level of observation.

Reimplemented from M2MBase.

Definition at line 357 of file m2mobjectinstance.cpp.

M2MBase::BaseType base_type ( ) const [virtual]

Returns object type.

Returns:: BaseType.

Reimplemented from M2MBase.

Definition at line 352 of file m2mobjectinstance.cpp.

uint8_t coap_content_type ( ) const [virtual, inherited]

Returns the CoAP content type of the object.

Returns:: Content type of the object.

Definition at line 261 of file m2mbase.cpp.

M2MResource * create_dynamic_resource	(	const String &	resource_name,
		const String &	resource_type,
		M2MResourceInstance::ResourceType	type,
		bool	observable,
		bool	multiple_instance = `false`
	)

Creates a dynamic resource for a given mbed Client Inteface object.

With this, the client can respond to different queries from the server (GET,PUT etc). This type of resource is also observable and carries callbacks.

Parameters:

resource_name,Name	of the resource.
resource_type,Type	of the resource.
observable,Indication,whether	the resource is observable or not.
multiple_instance,Resource	can have multiple instances, default is false.

Returns:: M2MResource, Resource for managing other client operations.

Definition at line 99 of file m2mobjectinstance.cpp.

M2MResourceInstance * create_dynamic_resource_instance	(	const String &	resource_name,
		const String &	resource_type,
		M2MResourceInstance::ResourceType	type,
		bool	observable,
		uint16_t	instance_id
	)

Creates a dynamic resource instance for a given mbed Client Inteface object.

With this, the client can respond to different queries from the server (GET,PUT etc). This type of resource is also observable and carries callbacks.

Parameters:

resource_name,Name	of the resource.
resource_type,Type	of the resource.
observable,Indicates,whether	the resource is observable or not.
instance_id,Instance	Id of the resource.

Returns:: M2MResourceInstance, Resource Instance for managing other client operations.

Definition at line 160 of file m2mobjectinstance.cpp.

M2MResource * create_static_resource	(	const String &	resource_name,
		const String &	resource_type,
		M2MResourceInstance::ResourceType	type,
		const uint8_t *	value,
		const uint8_t	value_length,
		bool	multiple_instance = `false`
	)

Creates a static resource for a given mbed Client Inteface object.

With this, the client can respond to server's GET methods with the provided value.

Parameters:

resource_name,Name	of the resource.
resource_type,Type	of the resource.
value,Pointer	to the value of the resource.
value_length,Length	of the value in the pointer.
multiple_instance,Resource	can have multiple instances, default is false.

Returns:: M2MResource, Resource for managing other client operations.

Definition at line 76 of file m2mobjectinstance.cpp.

M2MResourceInstance * create_static_resource_instance	(	const String &	resource_name,
		const String &	resource_type,
		M2MResourceInstance::ResourceType	type,
		const uint8_t *	value,
		const uint8_t	value_length,
		uint16_t	instance_id
	)

Creates a static resource instance for a given mbed Client Inteface object.

With this, the client can respond to server's GET methods with the provided value.

Parameters:

resource_name,Name	of the resource.
resource_type,Type	of the resource.
value,Pointer	to the value of the resource.
value_length,Length	of the value in pointer.
instance_id,Instance	Id of the resource.

Returns:: M2MResourceInstance, Resource Instance for managing other client operations.

Definition at line 121 of file m2mobjectinstance.cpp.

void get_observation_token	(	uint8_t *&	token,
		uint32_t &	token_length
	)		`[virtual, inherited]`

Provides the observation token of the object.

Parameters:

value[OUT],pointer	to the value of the token.
value_length[OUT],length	of the token pointer.

Definition at line 276 of file m2mbase.cpp.

sn_coap_hdr_s * handle_get_request	(	nsdl_s *	nsdl,
		sn_coap_hdr_s *	received_coap_header,
		M2MObservationHandler *	observation_handler = `NULL`
	)		`[virtual]`

Handles GET request for the registered objects.

Parameters:

nsdl,NSDL	handler for the CoAP library.
received_coap_header,CoAP	message received from the server.
observation_handler,Handler	object for sending observation callbacks.

Returns:: sn_coap_hdr_s, Message that needs to be sent to the server.

Reimplemented from M2MBase.

Definition at line 381 of file m2mobjectinstance.cpp.

bool handle_observation_attribute ( char *& query ) [virtual, inherited]

Parses the received query for the notification attribute.

Parameters:

query,Query that needs to be parsed.

Returns:: True if required attributes are present, else false.

Reimplemented in M2MResource.

Definition at line 301 of file m2mbase.cpp.

sn_coap_hdr_s * handle_post_request	(	nsdl_s *	nsdl,
		sn_coap_hdr_s *	received_coap_header,
		M2MObservationHandler *	observation_handler = `NULL`
	)		`[virtual]`

Handles GET request for the registered objects.

Parameters:

nsdl,NSDL	handler for the CoAP library.
received_coap_header,CoAP	message received from the server.
observation_handler,Handler	object for sending observation callbacks.

Returns:: sn_coap_hdr_s, Message that needs to be sent to the server.

Reimplemented from M2MBase.

Definition at line 620 of file m2mobjectinstance.cpp.

sn_coap_hdr_s * handle_put_request	(	nsdl_s *	nsdl,
		sn_coap_hdr_s *	received_coap_header,
		M2MObservationHandler *	observation_handler = `NULL`
	)		`[virtual]`

Handles PUT request for the registered objects.

Parameters:

nsdl,NSDL	handler for the CoAP library.
received_coap_header,CoAP	message received from the server.
observation_handler,Handler	object for sending observation callbacks.

Returns:: sn_coap_hdr_s, Message that needs to be sent to the server.

Reimplemented from M2MBase.

Definition at line 519 of file m2mobjectinstance.cpp.

uint16_t instance_id ( ) const [virtual, inherited]

Returns the object's Instance ID.

Returns:: Instance ID of the object.

Definition at line 246 of file m2mbase.cpp.

const String & interface_description ( ) const [virtual, inherited]

Returns the interface description of the object.

Returns:: Description of the object.

Definition at line 251 of file m2mbase.cpp.

bool is_observable ( ) const [virtual, inherited]

Returns the observation status of the object.

Returns:: True if observable, else false.

Definition at line 266 of file m2mbase.cpp.

void * memory_alloc ( uint16_t size ) [protected, virtual, inherited]

Memory Allocation required for libCoap.

Parameters:

size,Size of memory to be reserved.

Definition at line 369 of file m2mbase.cpp.

void memory_free ( void * ptr ) [protected, virtual, inherited]

Memory free functions required for libCoap.

Parameters:

ptr,Object whose memory needs to be freed.

Definition at line 377 of file m2mbase.cpp.

M2MBase::Mode mode ( ) const [virtual, inherited]

Returns the mode of the resource.

Returns:: Mode of the resource.

Definition at line 291 of file m2mbase.cpp.

const String & name ( ) const [virtual, inherited]

Returns the object name.

Returns:: Name for the object.

Definition at line 236 of file m2mbase.cpp.

int32_t name_id ( ) const [virtual, inherited]

Returns the object name in integer.

Returns:: Name for the object in integer.

Definition at line 241 of file m2mbase.cpp.

M2MObservationHandler * observation_handler ( ) [protected, inherited]

Returns Observation Handler object.

Returns:: M2MObservationHandler object.

Definition at line 388 of file m2mbase.cpp.

M2MBase::Observation observation_level ( ) const [virtual, inherited]

Returns the observation level of the object.

Returns:: Observation level of the object.

Definition at line 271 of file m2mbase.cpp.

uint16_t observation_number ( ) const [virtual, inherited]

Returns the observation number.

Returns:: Observation number for the object.

Definition at line 296 of file m2mbase.cpp.

void observation_to_be_sent ( ) [protected, virtual, inherited]

Observation callback to be sent to the server due to a change in the observed parameter.

Implements M2MReportObserver.

Definition at line 318 of file m2mbase.cpp.

M2MBase::Operation operation ( ) const [virtual, inherited]

Returns the operation type of the object.

Returns:: Operation, Supported operation on the object.

Definition at line 231 of file m2mbase.cpp.

void remove_object_from_coap ( ) [protected, virtual, inherited]

Removes object from NSDL list.

Definition at line 338 of file m2mbase.cpp.

void remove_observation_level ( M2MBase::Observation observation_level ) [virtual]

Removes the observation level from the object.

Parameters:

observation_level,Level of observation.

Reimplemented from M2MBase.

Definition at line 369 of file m2mobjectinstance.cpp.

bool remove_resource ( const String & name ) [virtual]

Removes the resource with the given name.

Parameters:

name,Name of the resource to be removed.

Returns:: True if removed, else false.

Definition at line 197 of file m2mobjectinstance.cpp.

void remove_resource_from_coap ( const String & resource_name ) [protected, virtual, inherited]

Removes resource from the CoAP structure.

Parameters:

resource_name,Name of the resource.

Definition at line 331 of file m2mbase.cpp.

bool remove_resource_instance	(	const String &	resource_name,
		uint16_t	instance_id
	)		`[virtual]`

Removes the resource instance with the given name.

Parameters:

resource_name,Name	of the resource instance to be removed.
instance_id,Instance	Id of the instance.

Returns:: True if removed, else false.

Definition at line 238 of file m2mobjectinstance.cpp.

M2MReportHandler * report_handler ( ) [protected, inherited]

Returns Report Handler object.

Returns:: M2MReportHandler object.

Definition at line 383 of file m2mbase.cpp.

M2MResource * resource ( const String & name ) const [virtual]

Returns resource with the given name.

Parameters:

name,Name of the requested resource.

Returns:: Resource reference if found, else NULL.

Definition at line 295 of file m2mobjectinstance.cpp.

uint16_t resource_count ( const String & resource ) const [virtual]

Returns the total number of single resource instances.

Parameters:

resource,Name of the resource.

Returns:: Total number of the resources.

Definition at line 333 of file m2mobjectinstance.cpp.

uint16_t resource_count ( ) const [virtual]

Returns the total number of resources with the object.

Returns:: Total number of the resources.

Definition at line 316 of file m2mobjectinstance.cpp.

const String & resource_type ( ) const [virtual, inherited]

Returns the resource type of the object.

Returns:: Resource type of the object.

Definition at line 256 of file m2mbase.cpp.

const M2MResourceList & resources ( ) const [virtual]

Returns a list of M2MResourceBase objects.

Returns:: List of Resource base with the object instance.

Definition at line 311 of file m2mobjectinstance.cpp.

void set_base_type ( M2MBase::BaseType type ) [protected, virtual, inherited]

Sets the Base type for object.

Parameters:

type,Type of the base object.

Definition at line 326 of file m2mbase.cpp.

void set_coap_content_type ( const uint8_t content_type ) [virtual, inherited]

Sets the CoAP content type of the object.

Parameters:

content_type,Content Type to be set based on CoAP specifications.

Definition at line 156 of file m2mbase.cpp.

void set_instance_id ( const uint16_t instance_id ) [virtual, inherited]

Sets the instance ID of the object.

Parameters:

instance_id,Instance ID of the object.

Definition at line 216 of file m2mbase.cpp.

void set_interface_description ( const String & description ) [virtual, inherited]

Sets the interface description of the object.

Parameters:

description,Description to be set.

Definition at line 146 of file m2mbase.cpp.

void set_observable ( bool observable ) [virtual, inherited]

Sets the observable mode for the object.

Parameters:

observable,Value for the observation.

Definition at line 161 of file m2mbase.cpp.

void set_observation_number ( const uint16_t observation_number ) [virtual, inherited]

Sets the observation number of the object.

Parameters:

observation_number,Observation number of the object.

Definition at line 221 of file m2mbase.cpp.

void set_observation_token	(	const uint8_t *	token,
		const uint8_t	length
	)		`[virtual, inherited]`

Sets the observation token value.

Parameters:

token,Pointer	to the token of the resource.
length,Length	of the token pointer.

Definition at line 198 of file m2mbase.cpp.

void set_operation ( M2MBase::Operation operation ) [virtual, inherited]

Sets the operation type for an object.

Parameters:

operation,Operation to be set.

Definition at line 135 of file m2mbase.cpp.

void set_resource_type ( const String & resource_type ) [virtual, inherited]

Sets the resource type of the object.

Parameters:

resource_type,Resource type to be set.

Definition at line 151 of file m2mbase.cpp.

void set_under_observation	(	bool	observed,
		M2MObservationHandler *	handler
	)		`[virtual, inherited]`

Sets the object under observation.

Parameters:

observed,Value	for the observation. When true, starts observing. When false, ongoing observation is cancelled.
handler,Handler	object for sending observation callbacks.

Definition at line 176 of file m2mbase.cpp.

Type:	Program
Mbed OS support:	Mbed 2 deprecated
Created:	16 Jun 2016
Imports:	15
Forks:	0
Commits:	12
Dependents:	0
Dependencies:	5
Followers:	2

M2MObjectInstance Class Reference

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

M2MObjectInstance Class Reference

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning