#include <m2mresource.h>

Inherits M2MResourceInstance, and M2MResourceCallback.

Public Types
enum	ResourceType
	Enum defining a resource type that can be supported by a given resource. More...
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
void	add_resource_instance (M2MResourceInstance *resource_instance)
	Adds resource instances to the M2MResource.
bool	supports_multiple_instances () const
	Returns whether the resource has multiple resource instances or not.
virtual bool	remove_resource_instance (uint16_t instance_id=0)
	Removes the resource with the given name.
virtual M2MResourceInstance *	resource_instance (uint16_t instance_id=0) const
	Returns resource instance with the given name.
virtual const M2MResourceInstanceList &	resource_instances () const
	Returns a list of resources.
virtual uint16_t	resource_instance_count () const
	Returns the total number of resources with the object.
virtual bool	handle_observation_attribute (char *&query)
	Parses the received query for a notification attribute.
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 POST request for the registered objects.
virtual M2MBase::BaseType	base_type () const
	Returns object type.
virtual M2MResourceInstance::ResourceType	resource_instance_type () const
	Returns resource data type.
virtual void	set_execute_function (execute_callback callback)
	Sets the function that should be executed when this resource receives a POST command.
virtual bool	set_value (const uint8_t *value, const uint32_t value_length)
	Sets the value of the given resource.
virtual void	clear_value ()
	Clears the value of the given resource.
void	execute (void *arguments)
	Executes the function that is set in "set_execute_function".
virtual void	get_value (uint8_t *&value, uint32_t &value_length)
	Provides the value of the given resource.
uint8_t *	value () const
	Returns value pointer of the object.
uint32_t	value_length () const
	Returns length of the value pointer.
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.
Protected Member Functions
void	set_resource_observer (M2MResourceCallback *resource)
	Set observer for sending notification update.
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	M2MObjectInstance

Detailed Description

M2MResource.

This class is the base class for mbed Client Resources. All defined LWM2M object models can be created using it. This class will also hold all resources instances associated with the given object.

Definition at line 38 of file m2mresource.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.

enum ResourceType [inherited]

Enum defining a resource type that can be supported by a given resource.

Definition at line 46 of file m2mresourceinstance.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 187 of file m2mresource.cpp.

void add_resource_instance ( M2MResourceInstance * resource_instance )

Adds resource instances to the M2MResource.

Parameters:

resource_instance,Resource Instance to be added.

Definition at line 211 of file m2mresource.cpp.

M2MBase::BaseType base_type ( ) const [virtual, inherited]

Returns object type.

Returns:: BaseType.

Definition at line 112 of file m2mresourceinstance.cpp.

void clear_value ( ) [virtual, inherited]

Clears the value of the given resource.

Definition at line 149 of file m2mresourceinstance.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.

void execute ( void * arguments ) [inherited]

Executes the function that is set in "set_execute_function".

Parameters:

arguments,Arguments that will be passed to be executed.

Definition at line 256 of file m2mresourceinstance.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.

void get_value	(	uint8_t *&	value,
		uint32_t &	value_length
	)		`[virtual, inherited]`

Provides the value of the given resource.

Parameters:

value[OUT],Pointer	to the resource value.
value_length[OUT],Length	of the value pointer.

Definition at line 264 of file m2mresourceinstance.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 219 of file m2mresource.cpp.

bool handle_observation_attribute ( char *& query ) [virtual]

Parses the received query for a notification attribute.

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

Reimplemented from M2MBase.

Definition at line 152 of file m2mresource.cpp.

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

Handles POST 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 487 of file m2mresource.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 368 of file m2mresource.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 199 of file m2mresource.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 ( uint16_t instance_id = 0 ) [virtual]

Removes the resource with the given name.

Parameters:

name,Name	of the resource to be removed.
instance_id,Instance	ID of resource to be removed, default is 0.

Returns:: True if removed, else false.

Definition at line 100 of file m2mresource.cpp.

M2MReportHandler * report_handler ( ) [protected, inherited]

Returns Report Handler object.

Returns:: M2MReportHandler object.

Definition at line 383 of file m2mbase.cpp.

M2MResourceInstance * resource_instance ( uint16_t instance_id = 0 ) const [virtual]

Returns resource instance with the given name.

Parameters:

instance_id,Instance ID of the requested resource, default is 0

Returns:: M2MResourceInstance object if found, else NULL.

Definition at line 124 of file m2mresource.cpp.

uint16_t resource_instance_count ( ) const [virtual]

Returns the total number of resources with the object.

Returns:: Total number of resources.

Definition at line 147 of file m2mresource.cpp.

M2MResourceInstance::ResourceType resource_instance_type ( ) const [virtual, inherited]

Returns resource data type.

Returns:: ResourceType.

Definition at line 117 of file m2mresourceinstance.cpp.

const M2MResourceInstanceList & resource_instances ( ) const [virtual]

Returns a list of resources.

Returns:: List of resources with the object.

Definition at line 142 of file m2mresource.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.

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_execute_function ( execute_callback callback ) [virtual, inherited]

Sets the function that should be executed when this resource receives a POST command.

Parameters:

callback,Function pointer that needs to be executed.

Definition at line 144 of file m2mresourceinstance.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_observer ( M2MResourceCallback * resource ) [protected, inherited]

Set observer for sending notification update.

Parameters:

resource,callback handle.

Definition at line 477 of file m2mresourceinstance.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.

bool set_value	(	const uint8_t *	value,
		const uint32_t	value_length
	)		`[virtual, inherited]`

Sets the value of the given resource.

Parameters:

value,Pointer	to the value to be set on the resource.
value_length,Length	of the value pointer.

Returns:: True if successfully set, else false.

Definition at line 160 of file m2mresourceinstance.cpp.

bool supports_multiple_instances ( ) const

Returns whether the resource has multiple resource instances or not.

Returns:: True if resource base has multiple instances, else false.

Definition at line 95 of file m2mresource.cpp.

uint8_t * value ( ) const [inherited]

Returns value pointer of the object.

Returns:: Value pointer of the object.

Definition at line 281 of file m2mresourceinstance.cpp.

uint32_t value_length ( ) const [inherited]

Returns length of the value pointer.

Returns:: Length of the value pointer.

Definition at line 286 of file m2mresourceinstance.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

M2MResource 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

M2MResource 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