The base class for Client Resources. More...
#include <m2mresource.h>
Data Structures | |
class | M2MExecuteParameter |
M2MResource::M2MExecuteParameter. This class handles the "Execute" operation arguments. More... | |
Public Member Functions | |
void | add_resource_instance (M2MResourceInstance *resource_instance) |
Adds resource instances to a M2MResource. More... | |
bool | supports_multiple_instances () const |
Returns whether the resource has multiple resource instances or not. More... | |
void | set_delayed_response (bool delayed_response) |
Sets whether the resource should send a delayed response for a POST request. This only works for resources which don't support multiple instances. Please use M2MBase::set_async_coap_request_cb method, if you are using ENABLE_ASYNC_REST_RESPONSE flag, because this method will be deprecated. More... | |
bool | send_delayed_post_response () |
A trigger to send the delayed response for the POST request. The delayed_response flag must be set before receiving the POST request and the value of the resource must be updated before calling this function. This sends the post response with code 'COAP_MSG_CODE_RESPONSE_CHANGED'. Please use M2MBase::send_async_response_with_code method, if you are using ENABLE_ASYNC_REST_RESPONSE flag, because this method will be deprecated. More... | |
void | get_delayed_token (uint8_t *&token, uint8_t &token_length) |
Provides the value of the token of the delayed post response. More... | |
bool | delayed_response () const |
Returns the value set for delayed response for POST requests. More... | |
bool | remove_resource_instance (uint16_t instance_id=0) |
Removes a resource with a given name. More... | |
M2MResourceInstance * | resource_instance (uint16_t instance_id=0) const |
Returns a resource instance with a given name. More... | |
const M2MResourceInstanceList & | resource_instances () const |
Returns a list of resources. More... | |
uint16_t | resource_instance_count () const |
Returns the total number of resources. More... | |
virtual M2MObservationHandler * | observation_handler () const |
Returns the Observation Handler object. More... | |
virtual void | set_observation_handler (M2MObservationHandler *handler) |
Sets the observation handler. More... | |
virtual void | add_observation_level (M2MBase::Observation observation_level) |
Adds the observation level for the object. More... | |
virtual void | remove_observation_level (M2MBase::Observation observation_level) |
Removes the observation level from an object. More... | |
virtual sn_coap_hdr_s * | handle_get_request (nsdl_s *nsdl, sn_coap_hdr_s *received_coap_header, M2MObservationHandler *observation_handler=NULL) |
Handles the GET request for registered objects. More... | |
virtual sn_coap_hdr_s * | handle_put_request (nsdl_s *nsdl, sn_coap_hdr_s *received_coap_header, M2MObservationHandler *observation_handler, bool &execute_value_updated) |
Handles the PUT request for registered objects. More... | |
virtual sn_coap_hdr_s * | handle_post_request (nsdl_s *nsdl, sn_coap_hdr_s *received_coap_header, M2MObservationHandler *observation_handler, bool &execute_value_updated, sn_nsdl_addr_s *address=NULL) |
Handles the POST request for registered objects. More... | |
M2MObjectInstance & | get_parent_object_instance () const |
virtual uint16_t | object_instance_id () const |
Returns the instance ID of the object where the resource exists. More... | |
virtual const char * | object_name () const |
Returns the name of the object where the resource exists. More... | |
virtual M2MResource & | get_parent_resource () const |
Public Member Functions inherited from M2MResourceBase | |
M2MResourceBase::ResourceType | resource_instance_type () const |
Returns the resource data type. More... | |
bool | set_execute_function (execute_callback callback) |
Sets the function that should be executed when this resource receives a POST command. More... | |
bool | set_execute_function (execute_callback_2 callback) |
Sets the function that should be executed when this resource receives a POST command. More... | |
bool | set_resource_read_callback (read_resource_value_callback callback, void *client_args) |
Sets the callback function that is executed when reading the resource value. More... | |
bool | set_resource_read_size_callback (read_resource_value_size_callback callback, void *client_args) |
Sets the callback function that is executed when reading the resource value size. More... | |
bool | set_resource_write_callback (write_resource_value_callback callback, void *client_args) |
Sets the callback function that is executed when writing the resource value. More... | |
int | read_resource_value (const M2MResourceBase &resource, void *buffer, size_t *buffer_len) |
Executes the function that is set in "set_resource_read_callback". More... | |
int | read_resource_value_size (const M2MResourceBase &resource, size_t *buffer_len) |
Executes the function that is set in "set_resource_read_size_callback". More... | |
bool | write_resource_value (const M2MResourceBase &resource, const uint8_t *buffer, const size_t buffer_size) |
Executes the function that is set in "set_resource_write_callback". More... | |
bool | set_value (const uint8_t *value, const uint32_t value_length) |
Sets a value of a given resource. More... | |
bool | set_value_raw (uint8_t *value, const uint32_t value_length) |
Sets a value of a given resource. More... | |
bool | set_value (int64_t value) |
Sets a value of a given resource. More... | |
bool | set_value_float (float value) |
Sets a value of a given resource. More... | |
void | clear_value () |
Clears the value of a given resource. | |
void | execute (void *arguments) |
Executes the function that is set in "set_execute_function". More... | |
void | get_value (uint8_t *&value, uint32_t &value_length) |
Provides the value of the given resource. More... | |
int64_t | get_value_int () const |
Converts a value to integer and returns it. Note: Conversion errors are not detected. | |
String | get_value_string () const |
float | get_value_float () const |
Converts a value to float and returns it. Note: Conversion errors are not detected. | |
uint8_t * | value () const |
Returns the value pointer of the object. More... | |
uint32_t | value_length () const |
Returns the length of the value pointer. More... | |
void | set_value_set_callback (value_set_callback callback) |
Set the value set callback. The set callback will be called instead of setting the value in set_value methods. When this function is set actual value change is done using the update_value function. More... | |
void | update_value (uint8_t *value, const uint32_t value_length) |
Default value update function. This function frees old value, stores the new value and informs report handler in case it changed. More... | |
bool | set_incoming_block_message_callback (incoming_block_message_callback callback) |
Sets the function that is executed when this object receives a block-wise message. More... | |
bool | set_outgoing_block_message_callback (outgoing_block_message_callback callback) |
Sets the function that is executed when this object receives a GET request. This is called if resource values are stored on the application side. More... | |
M2MBlockMessage * | block_message () const |
Returns the block message object. More... | |
bool | set_notification_sent_callback (notification_sent_callback callback) m2m_deprecated |
Sets the function that is executed when this object receives response(Empty ACK) for notification message. More... | |
bool | set_notification_sent_callback (notification_sent_callback_2 callback) m2m_deprecated |
Sets the function that is executed when this object receives response(Empty ACK) for notification message. More... | |
bool | set_notification_status_callback (notification_status_callback callback) m2m_deprecated |
Sets the function that is executed when this object receives response(Empty ACK) for notification message. More... | |
bool | set_notification_status_callback (notification_status_callback_2 callback) |
Sets the function that is executed when this object receives response(Empty ACK) for notification message. More... | |
void | notification_sent () |
Executes the function that is set in "set_notification_sent_callback". | |
void | notification_status (const uint16_t msg_id, NotificationStatus status) |
Executes the function that is set in "set_notification_status_callback". | |
M2MResourceBase::NotificationStatus | notification_status () const |
Returns notification send status. More... | |
void | clear_notification_status () |
Clears the notification send status to initial state. | |
void | publish_value_in_registration_msg (bool publish_value) |
Set the status whether resource value will be part of registration message. * This only allowed for following resource types: STRING, INTEGER, FLOAT, BOOLEAN OPAQUE. More... | |
Public Member Functions inherited from M2MBase | |
virtual | ~M2MBase () |
Destructor. | |
void | set_operation (M2MBase::Operation operation) |
Sets the operation type for an object. More... | |
void | set_interface_description (const String &description) |
Sets the interface description of the object. More... | |
void | set_interface_description (const char *description) |
Sets the interface description of the object. More... | |
const char * | interface_description () const |
Returns the interface description of the object. More... | |
virtual void | set_resource_type (const String &resource_type) |
Sets the resource type of the object. More... | |
virtual void | set_resource_type (const char *resource_type) |
Sets the resource type of the object. More... | |
const char * | resource_type () const |
Returns the resource type of the object. More... | |
void | set_coap_content_type (const uint16_t content_type) |
Sets the CoAP content type of the object. More... | |
void | set_observable (bool observable) |
Sets the observable mode for the object. More... | |
void | set_auto_observable (bool auto_observable) |
Sets the object to be auto-observable. More... | |
void | set_under_observation (bool observed, M2MObservationHandler *handler) |
Sets the object under observation. More... | |
void | set_instance_id (const uint16_t instance_id) |
Sets the instance ID of the object. More... | |
void | set_max_age (const uint32_t max_age) |
Sets the max age for the resource value to be cached. More... | |
M2MBase::BaseType | base_type () const |
Returns the object type. More... | |
M2MBase::Operation | operation () const |
Returns the operation type of the object. More... | |
const char * | name () const |
Returns the object name. More... | |
int32_t | name_id () const |
Returns the object name in integer. More... | |
uint16_t | instance_id () const |
Returns the object's instance ID. More... | |
const char * | uri_path () const |
Returns the path of the object. More... | |
uint16_t | coap_content_type () const |
Returns the CoAP content type of the object. More... | |
bool | is_observable () const |
Returns the observation status of the object. More... | |
bool | is_auto_observable () const |
Returns the auto observation status of the object. More... | |
M2MBase::Observation | observation_level () const |
Returns the observation level of the object. More... | |
Mode | mode () const |
Returns the mode of the resource. More... | |
uint16_t | observation_number () const |
Returns the observation number. More... | |
uint32_t | max_age () const |
Returns the max age for the resource value to be cached. More... | |
void | send_notification_delivery_status (const M2MBase &object, const NotificationDeliveryStatus status) |
Executes the function that is set in "set_notification_delivery_status_cb". Note: the setter for this callback is marked as m2m_deprecated, but there is no point having it here, as then the code will always give warnings. This simply must be there until the set_notification_delivery_status_cb() is removed. | |
void | send_message_delivery_status (const M2MBase &object, const MessageDeliveryStatus status, const MessageType type) |
Executes the function that is set in "set_message_delivery_status_cb". | |
void | set_register_uri (bool register_uri) |
Sets whether this resource is published to server or not. More... | |
bool | register_uri () |
Returns whether this resource is published to server or not. More... | |
bool | is_under_observation () const |
Returns whether this resource is under observation or not. More... | |
bool | set_value_updated_function (value_updated_callback callback) |
Sets the function that is executed when this object receives a PUT or POST command. More... | |
bool | set_value_updated_function (value_updated_callback2 callback) |
Sets the function that is executed when this object receives a PUT or POST command. More... | |
bool | is_value_updated_function_set () const |
Returns whether a callback function is set or not. More... | |
void | execute_value_updated (const String &name) |
Calls the function that is set in the "set_value_updated_function". More... | |
size_t | resource_name_length () const |
Returns length of the object name. More... | |
sn_nsdl_dynamic_resource_parameters_s * | get_nsdl_resource () const |
Returns the resource information. More... | |
M2MBase::lwm2m_parameters_s * | get_lwm2m_parameters () const |
Returns the resource structure. More... | |
uint16_t | get_notification_msgid () const m2m_deprecated |
Returns the notification message id. More... | |
void | set_notification_msgid (uint16_t msgid) m2m_deprecated |
Sets the notification message id. This is used to map RESET and EMPTY ACK messages. More... | |
bool | set_notification_delivery_status_cb (notification_delivery_status_cb callback, void *client_args) m2m_deprecated |
Sets the function that is executed when notification message state changes. More... | |
bool | set_message_delivery_status_cb (message_delivery_status_cb callback, void *client_args) |
Sets the function that is executed when message state changes. Currently this is used to track notifications and delayed response delivery statuses. More... | |
Additional Inherited Members | |
Public Types inherited from M2MResourceBase | |
enum | NotificationStatus { INIT = 0, SENT, DELIVERED } |
enum | ResourceType { STRING, INTEGER, FLOAT, BOOLEAN, OPAQUE, TIME, OBJLINK } |
typedef FP2< void, const uint16_t, const M2MResourceBase::NotificationStatus > | notification_status_callback |
typedef void(* | notification_status_callback_2) (const uint16_t msg_id, const M2MResourceBase::NotificationStatus status) |
typedef void(* | value_set_callback) (const M2MResourceBase *resource, uint8_t *value, const uint32_t value_length) |
typedef int(* | read_resource_value_callback) (const M2MResourceBase &resource, void *buffer, size_t *buffer_size, void *client_args) |
typedef int(* | read_resource_value_size_callback) (const M2MResourceBase &resource, size_t *buffer_size, void *client_args) |
typedef bool(* | write_resource_value_callback) (const M2MResourceBase &resource, const uint8_t *buffer, const size_t buffer_size, void *client_args) |
Public Types inherited from M2MBase | |
enum | BaseType { Object = 0x0, Resource = 0x1, ObjectInstance = 0x2, ResourceInstance = 0x3 } |
Enum to define the type of object. | |
enum | Observation { None = 0x0, R_Attribute = 0x01, OI_Attribute = 0x02, OIR_Attribute = 0x03, O_Attribute = 0x04, OR_Attribute = 0x05, OOI_Attribute = 0x06, OOIR_Attribute = 0x07 } |
Enum to define observation level. | |
enum | Mode { Static, Dynamic, Directory } |
Enum defining a resource type. | |
enum | DataType { STRING, INTEGER, FLOAT, BOOLEAN, OPAQUE, TIME, OBJLINK } |
Enum defining a resource data type. | |
enum | Operation { NOT_ALLOWED = 0x00, GET_ALLOWED = 0x01, PUT_ALLOWED = 0x02, GET_PUT_ALLOWED = 0x03, POST_ALLOWED = 0x04, GET_POST_ALLOWED = 0x05, PUT_POST_ALLOWED = 0x06, GET_PUT_POST_ALLOWED = 0x07, DELETE_ALLOWED = 0x08, GET_DELETE_ALLOWED = 0x09, PUT_DELETE_ALLOWED = 0x0A, GET_PUT_DELETE_ALLOWED = 0x0B, POST_DELETE_ALLOWED = 0x0C, GET_POST_DELETE_ALLOWED = 0x0D, PUT_POST_DELETE_ALLOWED = 0x0E, GET_PUT_POST_DELETE_ALLOWED = 0x0F } |
Enum defining an operation that can be supported by a given resource. | |
enum | MessageDeliveryStatus { MESSAGE_STATUS_INIT = 0, MESSAGE_STATUS_BUILD_ERROR, MESSAGE_STATUS_RESEND_QUEUE_FULL, MESSAGE_STATUS_SENT, MESSAGE_STATUS_DELIVERED, MESSAGE_STATUS_SEND_FAILED, MESSAGE_STATUS_SUBSCRIBED, MESSAGE_STATUS_UNSUBSCRIBED, MESSAGE_STATUS_REJECTED } |
Enum defining an status codes that can happen when sending confirmable message. | |
enum | MessageType { NOTIFICATION = 0, DELAYED_POST_RESPONSE, BLOCK_SUBSCRIBE, PING } |
enum | MaxPathSize { MAX_NAME_SIZE = 64, MAX_INSTANCE_SIZE = 5, MAX_PATH_SIZE = ((MAX_NAME_SIZE * 2) + (MAX_INSTANCE_SIZE * 2) + 3 + 1), MAX_PATH_SIZE_2 = ((MAX_NAME_SIZE * 2) + MAX_INSTANCE_SIZE + 2 + 1), MAX_PATH_SIZE_3 = (MAX_NAME_SIZE + (MAX_INSTANCE_SIZE * 2) + 2 + 1), MAX_PATH_SIZE_4 = (MAX_NAME_SIZE + MAX_INSTANCE_SIZE + 1 + 1) } |
typedef void(* | notification_delivery_status_cb) (const M2MBase &base, const NotificationDeliveryStatus status, void *client_args) |
typedef void(* | message_delivery_status_cb) (const M2MBase &base, const MessageDeliveryStatus status, const MessageType type, void *client_args) |
typedef struct M2MBase::lwm2m_parameters | lwm2m_parameters_s |
LwM2M parameters. | |
Static Public Member Functions inherited from M2MBase | |
static char * | create_path (const M2MObject &parent, const char *name) |
static char * | create_path (const M2MObject &parent, uint16_t object_instance) |
static char * | create_path (const M2MResource &parent, uint16_t resource_instance) |
static char * | create_path (const M2MResource &parent, const char *name) |
static char * | create_path (const M2MObjectInstance &parent, const char *name) |
Protected Member Functions inherited from M2MResourceBase | |
M2MResourceBase (const lwm2m_parameters_s *s, M2MBase::DataType type) | |
M2MResourceBase (const String &resource_name, M2MBase::Mode mode, const String &resource_type, M2MBase::DataType type, char *path, bool external_blockwise_store, bool multiple_instance) | |
A constructor for creating a resource. More... | |
M2MResourceBase (const String &resource_name, M2MBase::Mode mode, const String &resource_type, M2MBase::DataType type, const uint8_t *value, const uint8_t value_length, char *path, bool external_blockwise_store, bool multiple_instance) | |
A Constructor for creating a resource. More... | |
M2MResourceBase & | operator= (const M2MResourceBase &) |
M2MResourceBase (const M2MResourceBase &) | |
virtual | ~M2MResourceBase () |
Protected Member Functions inherited from M2MBase | |
M2MBase & | operator= (const M2MBase &) |
M2MBase (const M2MBase &) | |
M2MBase (const String &name, M2MBase::Mode mode, const String &resource_type, char *path, bool external_blockwise_store, bool multiple_instance, M2MBase::DataType type=M2MBase::OBJLINK) | |
Constructor. More... | |
M2MBase (const lwm2m_parameters_s *s) | |
virtual bool | observation_to_be_sent (const m2m::Vector< uint16_t > &changed_instance_ids, uint16_t obs_number, bool send_object=false) |
An observation callback to be sent to the server due to a change in the observed parameter. More... | |
void | set_base_type (M2MBase::BaseType type) |
Sets the base type for an object. More... | |
M2MReportHandler * | create_report_handler () |
Create Report Handler object. More... | |
M2MReportHandler * | report_handler () const |
Returns the Report Handler object. More... | |
void | free_resources () |
Delete the resource structures owned by this object. Note: this needs to be called separately from each subclass' destructor as this method uses a virtual method and the call needs to be done at same class which has the implementation of the pure virtual method. | |
NotificationDeliveryStatus | get_notification_delivery_status () const m2m_deprecated |
Returns notification send status. More... | |
void | clear_notification_delivery_status () m2m_deprecated |
Clears the notification send status to initial state. | |
void | get_observation_token (uint8_t *token, uint8_t &token_length) const |
Provides the observation token of the object. More... | |
void | set_observation_token (const uint8_t *token, const uint8_t length) |
Sets the observation token value. More... | |
virtual void | set_changed () |
The data has changed and it needs to be updated into Device Management. Current implementation maintains the changed state only in M2MEndpoint. If any of the changes in an object changes the M2M registration structure, the information is propagated to M2MEndpoint using this interface. | |
void | handle_observation (nsdl_s *nsdl, const sn_coap_hdr_s &received_coap_header, sn_coap_hdr_s &coap_response, M2MObservationHandler *observation_handler, sn_coap_msg_code_e &response_code) |
Handles subscription request. More... | |
void | start_observation (const sn_coap_hdr_s &received_coap_header, M2MObservationHandler *observation_handler) |
Start the observation. More... | |
Static Protected Member Functions inherited from M2MBase | |
static void * | memory_alloc (uint32_t size) |
Memory allocation required for libCoap. More... | |
static void | memory_free (void *ptr) |
Memory free functions required for libCoap. More... | |
static char * | alloc_string_copy (const char *source) |
Allocate and make a copy of given zero terminated string. This is functionally equivalent with strdup(). More... | |
static 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. More... | |
static uint8_t * | alloc_copy (const uint8_t *source, uint32_t size) |
Allocate (size) amount of memory, copy size bytes into it. More... | |
static bool | validate_string_length (const String &string, size_t min_length, size_t max_length) |
static bool | validate_string_length (const char *string, size_t min_length, size_t max_length) |
static bool | build_path (StringBuffer< MAX_PATH_SIZE > &buffer, const char *s1, uint16_t i1, const char *s2, uint16_t i2) |
static bool | build_path (StringBuffer< MAX_PATH_SIZE_2 > &buffer, const char *s1, uint16_t i1, const char *s2) |
static bool | build_path (StringBuffer< MAX_PATH_SIZE_3 > &buffer, const char *s1, uint16_t i1, uint16_t i2) |
static bool | build_path (StringBuffer< MAX_PATH_SIZE_4 > &buffer, const char *s1, uint16_t i1) |
static char * | stringdup (const char *s) |
static bool | is_blockwise_needed (const nsdl_s *nsdl, uint32_t payload_len) |
Checks whether blockwise is needed to send resource value to server. More... | |
The base class for Client Resources.
|
virtual |
Adds the observation level for the object.
observation_level | The level of observation. |
Reimplemented from M2MBase.
void M2MResource::add_resource_instance | ( | M2MResourceInstance * | resource_instance | ) |
Adds resource instances to a M2MResource.
resource_instance | The resource instance to be added. |
bool M2MResource::delayed_response | ( | ) | const |
Returns the value set for delayed response for POST requests.
void M2MResource::get_delayed_token | ( | uint8_t *& | token, |
uint8_t & | token_length | ||
) |
Provides the value of the token of the delayed post response.
[out] | token | A pointer to the token value. |
[out] | token_length | The length of the token pointer. |
|
virtual |
Handles the GET request for registered objects.
nsdl | An NSDL handler for the CoAP library. |
received_coap_header | The CoAP message received from the server. |
observation_handler | A handler object for sending observation callbacks. |
Reimplemented from M2MResourceBase.
|
virtual |
Handles the POST request for registered objects.
nsdl | An NSDL handler for the CoAP library. |
received_coap_header | The CoAP message received from the server. |
observation_handler | A handler object for sending observation callbacks. |
execute_value_updated | True executes the "value_updated" callback. |
Reimplemented from M2MBase.
|
virtual |
Handles the PUT request for registered objects.
nsdl | An NSDL handler for the CoAP library. |
received_coap_header | The CoAP message received from the server. |
observation_handler | A handler object for sending observation callbacks. |
execute_value_updated | True executes the "value_updated" callback. |
Reimplemented from M2MResourceBase.
|
virtual |
Returns the instance ID of the object where the resource exists.
Implements M2MResourceBase.
|
virtual |
Returns the name of the object where the resource exists.
Implements M2MResourceBase.
|
virtual |
|
virtual |
Removes the observation level from an object.
observation_level | The level of observation. |
Reimplemented from M2MBase.
bool M2MResource::remove_resource_instance | ( | uint16_t | instance_id = 0 | ) |
Removes a resource with a given name.
instance_id | The instance ID of the resource to be removed, default is 0. |
M2MResourceInstance* M2MResource::resource_instance | ( | uint16_t | instance_id = 0 | ) | const |
Returns a resource instance with a given name.
instance_id | The instance ID of the requested resource, default is 0 |
uint16_t M2MResource::resource_instance_count | ( | ) | const |
Returns the total number of resources.
const M2MResourceInstanceList& M2MResource::resource_instances | ( | ) | const |
Returns a list of resources.
bool M2MResource::send_delayed_post_response | ( | ) |
A trigger to send the delayed response for the POST request. The delayed_response flag must be set before receiving the POST request and the value of the resource must be updated before calling this function. This sends the post response with code 'COAP_MSG_CODE_RESPONSE_CHANGED'. Please use M2MBase::send_async_response_with_code method, if you are using ENABLE_ASYNC_REST_RESPONSE flag, because this method will be deprecated.
void M2MResource::set_delayed_response | ( | bool | delayed_response | ) |
Sets whether the resource should send a delayed response for a POST request. This only works for resources which don't support multiple instances. Please use M2MBase::set_async_coap_request_cb method, if you are using ENABLE_ASYNC_REST_RESPONSE flag, because this method will be deprecated.
delayed_response | A boolean value to set the delayed response. |
|
virtual |
bool M2MResource::supports_multiple_instances | ( | ) | const |
Returns whether the resource has multiple resource instances or not.