Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependencies: MAX44000 PWM_Tone_Library nexpaq_mdk
Fork of LED_Demo by
M2MResource Class Reference
#include <m2mresource.h>
Inherits M2MResourceInstance, and M2MResourceCallback.
Data Structures | |
class | M2MExecuteParameter |
M2MResource::M2MExecuteParameter. More... | |
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. | |
void | set_delayed_response (bool delayed_response) |
Sets whether the resource should send a delayed response for POST request. | |
bool | send_delayed_post_response () |
A trigger to send the delayed response for the POST request. | |
void | get_delayed_token (uint8_t *&token, uint8_t &token_length) |
Provides the value of the given token. | |
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 the 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. | |
bool | delayed_response () const |
Returns the value set for delayed response. | |
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 the 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, bool &execute_value_updated) |
Handles the 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, bool &execute_value_updated) |
Handles the POST request for the registered objects. | |
virtual M2MBase::BaseType | base_type () const |
Returns the object type. | |
virtual M2MResourceInstance::ResourceType | resource_instance_type () const |
Returns the 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 void | set_execute_function (execute_callback_2 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 bool | set_value (int64_t value) |
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. | |
int | get_value_int () |
Converts value to int and return it. | |
String | get_value_string () const |
Get the value as a String object. | |
uint8_t * | value () const |
Returns the value pointer of the object. | |
uint32_t | value_length () const |
Returns the length of the value pointer. | |
uint16_t | object_instance_id () const |
Returns the object instance id where resource exists. | |
const String & | object_name () const |
Returns the object name where resource exists. | |
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) 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::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 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 | |
void | set_resource_observer (M2MResourceCallback *resource) |
Set observer for sending the notification update. | |
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. | |
M2MReportHandler * | report_handler () |
Returns the Report Handler object. | |
M2MObservationHandler * | observation_handler () |
Returns the Observation Handler object. | |
Friends | |
class | M2MObjectInstance |
Detailed Description
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 Mode [inherited] |
enum Observation [inherited] |
enum Operation [inherited] |
enum ResourceType [inherited] |
Enum defining a resource type that can be supported by a given resource.
Definition at line 48 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 The öevel of observation.
Reimplemented from M2MBase.
Definition at line 231 of file m2mresource.cpp.
void add_resource_instance | ( | M2MResourceInstance * | resource_instance ) |
Adds resource instances to the M2MResource.
- Parameters:
-
resource_instance The resource instance to be added.
Definition at line 255 of file m2mresource.cpp.
uint8_t * alloc_copy | ( | const uint8_t * | source, |
uint32_t | size | ||
) | [protected, virtual, inherited] |
Allocate (size) amount of memory, copy size bytes into it.
- Parameters:
-
source Source buffer to copy, may not be NULL. size The 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, inherited] |
Allocate (size + 1) amount of memory, copy size bytes into it and add zero termination.
- Parameters:
-
source Source string to copy, may not be NULL. size The size of memory to be reserved.
Definition at line 388 of file m2mbase.cpp.
M2MBase::BaseType base_type | ( | ) | const [virtual, inherited] |
void clear_value | ( | ) | [virtual, inherited] |
Clears the value of the given resource.
Definition at line 157 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 260 of file m2mbase.cpp.
bool delayed_response | ( | ) | const |
Returns the value set for delayed response.
- Returns:
- The value for delayed response.
Definition at line 193 of file m2mresource.cpp.
void execute | ( | void * | arguments ) | [inherited] |
Executes the function that is set in "set_execute_function".
- Parameters:
-
arguments The arguments that will be passed to be executed.
Definition at line 269 of file m2mresourceinstance.cpp.
void execute_value_updated | ( | const String & | name ) | [virtual, inherited] |
Calls the function that is set in "set_value_updated_function".
- Parameters:
-
name Name of the object.
Definition at line 474 of file m2mbase.cpp.
void get_delayed_token | ( | uint8_t *& | token, |
uint8_t & | token_length | ||
) |
Provides the value of the given token.
- Parameters:
-
value[OUT] A pointer to the token value. value_length[OUT] The length of the token pointer.
Definition at line 136 of file m2mresource.cpp.
void get_observation_token | ( | uint8_t *& | token, |
uint32_t & | token_length | ||
) | [virtual, inherited] |
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.
void get_value | ( | uint8_t *& | value, |
uint32_t & | value_length | ||
) | [virtual, inherited] |
Provides the value of the given resource.
- Parameters:
-
value[OUT] A pointer to the resource value. value_length[OUT] The length of the value pointer.
Definition at line 277 of file m2mresourceinstance.cpp.
int get_value_int | ( | ) | [inherited] |
Converts value to int and return it.
Note: conversion errors are not detected.
Definition at line 292 of file m2mresourceinstance.cpp.
String get_value_string | ( | ) | const [inherited] |
Get the value as a String object.
No encoding/charset conversions done for the value, just a raw copy.
Definition at line 307 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 the GET request for the registered objects.
- Parameters:
-
nsdl The NSDL handler for the CoAP library. received_coap_header The CoAP message received from the server. observation_handler The handler object for sending observation callbacks.
- Returns:
- sn_coap_hdr_s The message that needs to be sent to the server.
Reimplemented from M2MBase.
Definition at line 263 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 198 of file m2mresource.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 the POST request for the registered objects.
- Parameters:
-
nsdl The NSDL handler for the CoAP library. received_coap_header The CoAP message received from the server. observation_handler The handler object for sending observation callbacks. execute_value_updated True will execute the "value_updated" callback.
- Returns:
- sn_coap_hdr_s The message that needs to be sent to the server.
Reimplemented from M2MBase.
Definition at line 512 of file m2mresource.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 the PUT request for the registered objects.
- Parameters:
-
nsdl The NSDL handler for the CoAP library. received_coap_header The CoAP message received from the server. observation_handler The handler object for sending observation callbacks. execute_value_updated True will execute the "value_updated" callback.
- Returns:
- sn_coap_hdr_s The message that needs to be sent to the server.
Reimplemented from M2MBase.
Definition at line 404 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 245 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 250 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 265 of file m2mbase.cpp.
bool is_under_observation | ( | ) | const [virtual, inherited] |
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, inherited] |
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, inherited] |
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, inherited] |
Memory allocation required for libCoap.
- Parameters:
-
size The size of memory to be reserved.
Definition at line 375 of file m2mbase.cpp.
void memory_free | ( | void * | ptr ) | [protected, virtual, inherited] |
Memory free functions required for libCoap.
- Parameters:
-
ptr The Object whose memory needs to be freed.
Definition at line 383 of file m2mbase.cpp.
M2MBase::Mode mode | ( | ) | const [virtual, inherited] |
Returns the mode of the resource.
- Returns:
- Mode of the resource.
Definition at line 286 of file m2mbase.cpp.
const String & name | ( | ) | const [virtual, inherited] |
int32_t name_id | ( | ) | const [virtual, inherited] |
Returns the object name in integer.
- Returns:
- Name of the object in integer.
Definition at line 240 of file m2mbase.cpp.
uint16_t object_instance_id | ( | ) | const [inherited] |
Returns the object instance id where resource exists.
- Returns:
- Object instance id.
Definition at line 504 of file m2mresourceinstance.cpp.
const String & object_name | ( | ) | const [inherited] |
Returns the object name where resource exists.
- Returns:
- Object name.
Definition at line 499 of file m2mresourceinstance.cpp.
M2MObservationHandler * observation_handler | ( | ) | [protected, inherited] |
Returns the Observation Handler object.
- Returns:
- M2MObservationHandler object.
Definition at line 416 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 270 of file m2mbase.cpp.
uint16_t observation_number | ( | ) | const [virtual, inherited] |
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, inherited] |
An observation callback to be sent to the server due to a change in the observed parameter.
- Parameters:
-
changed_instance_ids A list of changed object instance IDs. send_object Indicates whether the whole object will be sent or not.
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 230 of file m2mbase.cpp.
bool register_uri | ( | ) | [virtual, inherited] |
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, inherited] |
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 from the object.
- Parameters:
-
observation_level The level of observation.
Reimplemented from M2MBase.
Definition at line 243 of file m2mresource.cpp.
void remove_resource_from_coap | ( | const String & | resource_name ) | [protected, virtual, inherited] |
Removes the resource from the CoAP structure.
- Parameters:
-
resource_name The name of the resource.
Definition at line 335 of file m2mbase.cpp.
bool remove_resource_instance | ( | uint16_t | instance_id = 0 ) |
[virtual] |
Removes the resource with the given name.
- Parameters:
-
name The name of the resource to be removed. instance_id The instance ID of the resource to be removed, default is 0.
- Returns:
- True if removed, else false.
Definition at line 142 of file m2mresource.cpp.
M2MReportHandler * report_handler | ( | ) | [protected, inherited] |
Returns the Report Handler object.
- Returns:
- M2MReportHandler object.
Definition at line 411 of file m2mbase.cpp.
M2MResourceInstance * resource_instance | ( | uint16_t | instance_id = 0 ) |
const [virtual] |
Returns the resource instance with the given name.
- Parameters:
-
instance_id The instance ID of the requested resource, default is 0
- Returns:
- M2MResourceInstance object if found, else NULL.
Definition at line 165 of file m2mresource.cpp.
uint16_t resource_instance_count | ( | ) | const [virtual] |
Returns the total number of resources.
- Returns:
- The total number of resources.
Definition at line 188 of file m2mresource.cpp.
M2MResourceInstance::ResourceType resource_instance_type | ( | ) | const [virtual, inherited] |
Returns the resource data type.
- Returns:
- ResourceType.
Definition at line 120 of file m2mresourceinstance.cpp.
const M2MResourceInstanceList & resource_instances | ( | ) | const [virtual] |
Returns a list of resources.
- Returns:
- A list of resources.
Definition at line 183 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 255 of file m2mbase.cpp.
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.
- Returns:
- True if response is sent, else false.
Definition at line 126 of file m2mresource.cpp.
void set_base_type | ( | M2MBase::BaseType | type ) | [protected, virtual, inherited] |
Sets the Base type for object.
- Parameters:
-
type The type of the base object.
Definition at line 330 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 155 of file m2mbase.cpp.
void set_delayed_response | ( | bool | delayed_response ) |
Sets whether the resource should send a delayed response for POST request.
- Parameters:
-
delayed_response A boolean value to set the delayed response.
Definition at line 121 of file m2mresource.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 The function pointer that needs to be executed.
Definition at line 144 of file m2mresourceinstance.cpp.
void set_execute_function | ( | execute_callback_2 | callback ) | [virtual, inherited] |
Sets the function that should be executed when this resource receives a POST command.
- Parameters:
-
callback The function pointer that needs to be executed.
Definition at line 149 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 210 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 145 of file m2mbase.cpp.
void set_max_age | ( | const uint32_t | max_age ) | [virtual, inherited] |
Sets the max age for the resource value to be cached.
- Parameters:
-
max_age Max age in seconds.
Definition at line 220 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 160 of file m2mbase.cpp.
void set_observation_number | ( | const uint16_t | observation_number ) | [virtual, inherited] |
Function is deprecated.
Increment of observation number is done internally. Sets the observation number of the object.
- Parameters:
-
observation_number Observation 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, inherited] |
Sets the observation token value.
- Parameters:
-
token Pointer to the token of the resource. length Length of the token pointer.
Definition at line 196 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 134 of file m2mbase.cpp.
void set_register_uri | ( | bool | register_uri ) | [virtual, inherited] |
Sets whether this resource will be published to server or not.
- Parameters:
-
register_uri True sets the resource as part of registration message.
Definition at line 421 of file m2mbase.cpp.
void set_resource_observer | ( | M2MResourceCallback * | resource ) | [protected, inherited] |
Set observer for sending the notification update.
- Parameters:
-
resource The callback handle.
Definition at line 494 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 150 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 175 of file m2mbase.cpp.
void set_uri_path | ( | const String & | path ) | [virtual, inherited] |
bool set_value | ( | int64_t | value ) | [virtual, inherited] |
Sets the value of the given resource.
- Parameters:
-
value,new value which is to be formatted into a string and set on the resource.
- Returns:
- True if successfully set, else false.
Definition at line 168 of file m2mresourceinstance.cpp.
bool set_value | ( | const uint8_t * | value, |
const uint32_t | value_length | ||
) | [virtual, inherited] |
Sets the value of the given resource.
- Parameters:
-
value,A pointer to the value to be set on the resource. value_length The length of the value pointer.
- Returns:
- True if successfully set, else false.
Definition at line 180 of file m2mresourceinstance.cpp.
void set_value_updated_function | ( | value_updated_callback | callback ) | [virtual, inherited] |
Sets the function that is executed when this object receives a PUT or POST command.
- Parameters:
-
callback The function pointer that is called.
Definition at line 457 of file m2mbase.cpp.
void set_value_updated_function | ( | value_updated_callback2 | callback ) | [virtual, inherited] |
Sets the function that is executed when this object receives a PUT or POST command.
- Parameters:
-
callback The function pointer that is called.
Definition at line 462 of file m2mbase.cpp.
bool supports_multiple_instances | ( | ) | const |
Returns whether the resource has multiple resource instances or not.
- Returns:
- True if the resource base has multiple instances, else false.
Definition at line 116 of file m2mresource.cpp.
const String & uri_path | ( | ) | const [virtual, inherited] |
Returns the URI path of the object.
- Returns:
- URI path of the object.
Definition at line 447 of file m2mbase.cpp.
uint8_t * value | ( | ) | const [inherited] |
Returns the value pointer of the object.
- Returns:
- The value pointer of the object.
Definition at line 318 of file m2mresourceinstance.cpp.
uint32_t value_length | ( | ) | const [inherited] |
Returns the length of the value pointer.
- Returns:
- The length of the value pointer.
Definition at line 323 of file m2mresourceinstance.cpp.
Generated on Tue Jul 12 2022 12:29:08 by
