joey shelton / LED_Demo

Dependencies:   MAX44000 PWM_Tone_Library nexpaq_mdk

Fork of LED_Demo by Maxim nexpaq

Embed: (wiki syntax)

« Back to documentation index

M2MBase Class Reference

M2MBase. More...

#include <m2mbase.h>

Inherits M2MReportObserver.

Inherited by M2MBaseTest, M2MObject, M2MObjectInstance, M2MResourceInstance, and Test_M2MBase [private].

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

virtual ~M2MBase ()
 Destructor.
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 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 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) m2m_deprecated
 Function is deprecated.
virtual void set_max_age (const uint32_t max_age)
 Sets the max age for the resource value to be cached.
virtual M2MBase::BaseType base_type () const
 Returns object type.
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 uint32_t max_age () const
 Returns max age for the resource value to be cached.
virtual bool handle_observation_attribute (char *&query)
 Parses the received query for the notification attribute.
virtual sn_coap_hdr_shandle_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_shandle_put_request (nsdl_s *nsdl, sn_coap_hdr_s *received_coap_header, M2MObservationHandler *observation_handler, bool &execute_value_updated)
 Handles PUT request for the registered objects.
virtual sn_coap_hdr_shandle_post_request (nsdl_s *nsdl, sn_coap_hdr_s *received_coap_header, M2MObservationHandler *observation_handler, bool &execute_value_updated)
 Handles GET request for the registered objects.
virtual void set_register_uri (bool register_uri)
 Sets whether this resource will be published to server or not.
virtual bool register_uri ()
 Returns whether this resource will be published to server or not.
virtual void set_uri_path (const String &path)
 Sets object URI path.
virtual const String & uri_path () const
 Returns the URI path of the object.
virtual bool is_under_observation () const
 Returns whether this resource is under observation or not.
virtual void set_value_updated_function (value_updated_callback callback)
 Sets the function that is executed when this object receives a PUT or POST command.
virtual void set_value_updated_function (value_updated_callback2 callback)
 Sets the function that is executed when this object receives a PUT or POST command.
virtual bool is_value_updated_function_set ()
 Returns whether callback function is set or not.
virtual void execute_value_updated (const String &name)
 Calls the function that is set in "set_value_updated_function".

Protected Member Functions

 M2MBase (const String &name, M2MBase::Mode mode)
 Constructor.
virtual void observation_to_be_sent (m2m::Vector< uint16_t > changed_instance_ids, bool send_object=false)
 An 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 the resource from the CoAP structure.
virtual void remove_object_from_coap ()
 Removes an object from the NSDL list.
virtual void * memory_alloc (uint32_t size)
 Memory allocation required for libCoap.
virtual void memory_free (void *ptr)
 Memory free functions required for libCoap.
virtual uint8_t * alloc_string_copy (const uint8_t *source, uint32_t size)
 Allocate (size + 1) amount of memory, copy size bytes into it and add zero termination.
virtual uint8_t * alloc_copy (const uint8_t *source, uint32_t size)
 Allocate (size) amount of memory, copy size bytes into it.
M2MReportHandlerreport_handler ()
 Returns the Report Handler object.
M2MObservationHandlerobservation_handler ()
 Returns the Observation Handler object.

Detailed Description

M2MBase.

This class is the base class based on which all LWM2M object models can be created. This serves base class for Object, ObjectInstances and Resources.

Definition at line 43 of file m2mbase.h.


Member Enumeration Documentation

enum BaseType

Enum to define the type of object.

Definition at line 50 of file m2mbase.h.

enum Mode

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

Definition at line 76 of file m2mbase.h.

Enum to define observation level.

Definition at line 60 of file m2mbase.h.

enum Operation

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

Definition at line 86 of file m2mbase.h.


Constructor & Destructor Documentation

M2MBase ( const String &  name,
M2MBase::Mode  mode 
) [protected]

Constructor.

Parameters:
baseTypeType of the object created
nameName of the object
idID of the object

Definition at line 97 of file m2mbase.cpp.

~M2MBase (  ) [virtual]

Destructor.

Definition at line 127 of file m2mbase.cpp.


Member Function Documentation

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

Adds the observation level for the object.

Parameters:
observation_levelLevel of the observation.

Reimplemented in M2MObject, M2MObjectInstance, and M2MResource.

Definition at line 165 of file m2mbase.cpp.

uint8_t * alloc_copy ( const uint8_t *  source,
uint32_t  size 
) [protected, virtual]

Allocate (size) amount of memory, copy size bytes into it.

Parameters:
sourceSource buffer to copy, may not be NULL.
sizeThe size of memory to be reserved.

Definition at line 400 of file m2mbase.cpp.

uint8_t * alloc_string_copy ( const uint8_t *  source,
uint32_t  size 
) [protected, virtual]

Allocate (size + 1) amount of memory, copy size bytes into it and add zero termination.

Parameters:
sourceSource string to copy, may not be NULL.
sizeThe size of memory to be reserved.

Definition at line 388 of file m2mbase.cpp.

M2MBase::BaseType base_type (  ) const [virtual]

Returns object type.

Returns:
BaseType of the object.

Reimplemented in M2MObject, and M2MObjectInstance.

Definition at line 225 of file m2mbase.cpp.

uint8_t coap_content_type (  ) const [virtual]

Returns the CoAP content type of the object.

Returns:
Content type of the object.

Definition at line 260 of file m2mbase.cpp.

void execute_value_updated ( const String &  name ) [virtual]

Calls the function that is set in "set_value_updated_function".

Parameters:
nameName of the object.

Definition at line 474 of file m2mbase.cpp.

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

Provides the observation token of the object.

Parameters:
value[OUT]A pointer to the value of the token.
value_length[OUT]Length of the token pointer.

Definition at line 275 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:
nsdlNSDL handler for the CoAP library.
received_coap_headerReceived CoAP message from the server.
observation_handlerHandler object for sending observation callbacks.
Returns:
sn_coap_hdr_s The message that needs to be sent to server.

Reimplemented in M2MObject, M2MObjectInstance, and M2MResource.

Definition at line 349 of file m2mbase.cpp.

bool handle_observation_attribute ( char *&  query ) [virtual]

Parses the received query for the notification attribute.

Parameters:
queryThe 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,
bool &  execute_value_updated 
) [virtual]

Handles GET request for the registered objects.

Parameters:
nsdlNSDL handler for the CoAP library.
received_coap_headerThe received CoAP message from the server.
observation_handlerThe handler object for sending observation callbacks.
execute_value_updatedTrue will execute "value_updated" callback.
Returns:
sn_coap_hdr_s The message that needs to be sent to server.

Reimplemented in M2MObject, M2MObjectInstance, and M2MResource.

Definition at line 366 of file m2mbase.cpp.

sn_coap_hdr_s * handle_put_request ( nsdl_s *  nsdl,
sn_coap_hdr_s received_coap_header,
M2MObservationHandler observation_handler,
bool &  execute_value_updated 
) [virtual]

Handles PUT request for the registered objects.

Parameters:
nsdlNSDL handler for the CoAP library.
received_coap_headerThe received CoAP message from the server.
observation_handlerThe handler object for sending observation callbacks.
execute_value_updatedTrue will execute "value_updated" callback.
Returns:
sn_coap_hdr_s The message that needs to be sent to server.

Reimplemented in M2MObject, M2MObjectInstance, and M2MResource.

Definition at line 357 of file m2mbase.cpp.

uint16_t instance_id (  ) const [virtual]

Returns the object's Instance ID.

Returns:
Instance ID of the object.

Definition at line 245 of file m2mbase.cpp.

const String & interface_description (  ) const [virtual]

Returns the interface description of the object.

Returns:
Description of the object.

Definition at line 250 of file m2mbase.cpp.

bool is_observable (  ) const [virtual]

Returns the observation status of the object.

Returns:
True if observable, else false.

Definition at line 265 of file m2mbase.cpp.

bool is_under_observation (  ) const [virtual]

Returns whether this resource is under observation or not.

Returns:
True if the resource is under observation, else false,

Definition at line 452 of file m2mbase.cpp.

bool is_value_updated_function_set (  ) [virtual]

Returns whether callback function is set or not.

Returns:
True if the callback function is set, else false.

Definition at line 469 of file m2mbase.cpp.

uint32_t max_age (  ) const [virtual]

Returns max age for the resource value to be cached.

Returns:
Max age in seconds.

Definition at line 296 of file m2mbase.cpp.

void * memory_alloc ( uint32_t  size ) [protected, virtual]

Memory allocation required for libCoap.

Parameters:
sizeThe size of memory to be reserved.

Definition at line 375 of file m2mbase.cpp.

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

Memory free functions required for libCoap.

Parameters:
ptrThe Object whose memory needs to be freed.

Definition at line 383 of file m2mbase.cpp.

M2MBase::Mode mode (  ) const [virtual]

Returns the mode of the resource.

Returns:
Mode of the resource.

Definition at line 286 of file m2mbase.cpp.

const String & name (  ) const [virtual]

Returns the object name.

Returns:
Name of the object.

Definition at line 235 of file m2mbase.cpp.

int32_t name_id (  ) const [virtual]

Returns the object name in integer.

Returns:
Name of the object in integer.

Definition at line 240 of file m2mbase.cpp.

M2MObservationHandler * observation_handler (  ) [protected]

Returns the Observation Handler object.

Returns:
M2MObservationHandler object.

Definition at line 416 of file m2mbase.cpp.

M2MBase::Observation observation_level (  ) const [virtual]

Returns the observation level of the object.

Returns:
Observation level of the object.

Definition at line 270 of file m2mbase.cpp.

uint16_t observation_number (  ) const [virtual]

Returns the observation number.

Returns:
Observation number of the object.

Definition at line 291 of file m2mbase.cpp.

void observation_to_be_sent ( m2m::Vector< uint16_t >  changed_instance_ids,
bool  send_object = false 
) [protected, virtual]

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

Parameters:
changed_instance_idsA list of changed object instance IDs.
send_objectIndicates whether the whole object will be sent or not.

Implements M2MReportObserver.

Definition at line 318 of file m2mbase.cpp.

M2MBase::Operation operation (  ) const [virtual]

Returns the operation type of the object.

Returns:
Operation Supported operation on the object.

Definition at line 230 of file m2mbase.cpp.

bool register_uri (  ) [virtual]

Returns whether this resource will be published to server or not.

Returns:
True if the resource is part of the registration message, else false.

Definition at line 426 of file m2mbase.cpp.

void remove_object_from_coap (  ) [protected, virtual]

Removes an object from the NSDL list.

Definition at line 342 of file m2mbase.cpp.

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

Removes the observation level for the object.

Parameters:
observation_levelLevel of the observation.

Reimplemented in M2MObject, M2MObjectInstance, and M2MResource.

Definition at line 170 of file m2mbase.cpp.

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

Removes the resource from the CoAP structure.

Parameters:
resource_nameThe name of the resource.

Definition at line 335 of file m2mbase.cpp.

M2MReportHandler * report_handler (  ) [protected]

Returns the Report Handler object.

Returns:
M2MReportHandler object.

Definition at line 411 of file m2mbase.cpp.

const String & resource_type (  ) const [virtual]

Returns the resource type of the object.

Returns:
Resource type of the object.

Definition at line 255 of file m2mbase.cpp.

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

Sets the Base type for object.

Parameters:
typeThe type of the base object.

Definition at line 330 of file m2mbase.cpp.

void set_coap_content_type ( const uint8_t  content_type ) [virtual]

Sets the CoAP content type of the object.

Parameters:
content_typeContent Type to be set based on CoAP specifications.

Definition at line 155 of file m2mbase.cpp.

void set_instance_id ( const uint16_t  instance_id ) [virtual]

Sets the instance ID of the object.

Parameters:
instance_idInstance ID of the object.

Definition at line 210 of file m2mbase.cpp.

void set_interface_description ( const String &  description ) [virtual]

Sets the interface description of the object.

Parameters:
descriptionDescription to be set.

Definition at line 145 of file m2mbase.cpp.

void set_max_age ( const uint32_t  max_age ) [virtual]

Sets the max age for the resource value to be cached.

Parameters:
max_ageMax age in seconds.

Definition at line 220 of file m2mbase.cpp.

void set_observable ( bool  observable ) [virtual]

Sets the observable mode for the object.

Parameters:
observableValue for the observation.

Definition at line 160 of file m2mbase.cpp.

void set_observation_number ( const uint16_t  observation_number ) [virtual]

Function is deprecated.

Increment of observation number is done internally. Sets the observation number of the object.

Parameters:
observation_numberObservation number of the object.

Definition at line 216 of file m2mbase.cpp.

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

Sets the observation token value.

Parameters:
tokenPointer to the token of the resource.
lengthLength of the token pointer.

Definition at line 196 of file m2mbase.cpp.

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

Sets the operation type for an object.

Parameters:
operationOperation to be set.

Definition at line 134 of file m2mbase.cpp.

void set_register_uri ( bool  register_uri ) [virtual]

Sets whether this resource will be published to server or not.

Parameters:
register_uriTrue sets the resource as part of registration message.

Definition at line 421 of file m2mbase.cpp.

void set_resource_type ( const String &  resource_type ) [virtual]

Sets the resource type of the object.

Parameters:
resource_typeResource type to be set.

Definition at line 150 of file m2mbase.cpp.

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

Sets the object under observation.

Parameters:
observedValue for the observation. When true, starts observing. When false, ongoing observation is cancelled.
handlerHandler object for sending observation callbacks.

Definition at line 175 of file m2mbase.cpp.

void set_uri_path ( const String &  path ) [virtual]

Sets object URI path.

Parameters:
pathObject path

Definition at line 442 of file m2mbase.cpp.

void set_value_updated_function ( value_updated_callback  callback ) [virtual]

Sets the function that is executed when this object receives a PUT or POST command.

Parameters:
callbackThe function pointer that is called.

Definition at line 457 of file m2mbase.cpp.

void set_value_updated_function ( value_updated_callback2  callback ) [virtual]

Sets the function that is executed when this object receives a PUT or POST command.

Parameters:
callbackThe function pointer that is called.

Definition at line 462 of file m2mbase.cpp.

const String & uri_path (  ) const [virtual]

Returns the URI path of the object.

Returns:
URI path of the object.

Definition at line 447 of file m2mbase.cpp.