Michael Koster
observe updates
Fork of
mbedConnectorInterface
by 
Doug Anson
DynamicResource Class Reference
DynamicResource class. More...
#include <DynamicResource.h>
Inherits Resource< string >.
Public Member Functions | |
| DynamicResource (const Logger *logger, const char *name, const char *res_type, uint8_t res_mask, const bool observable=false) | |
| Default constructor (char strings) | |
| DynamicResource (const Logger *logger, const char *name, const char *res_type, const string value, uint8_t res_mask, const bool observable=false) | |
| Default constructor (char strings) | |
| DynamicResource (const Logger *logger, const string name, const string res_type, const string value, uint8_t res_mask, const bool observable=false) | |
| constructor with string buffer for name | |
| DynamicResource (const DynamicResource &resource) | |
| Copy constructor. | |
| virtual | ~DynamicResource () |
| Destructor. | |
| virtual void | bind (void *p) |
| Bind resource to endpoint. | |
| uint8_t | process (sn_coap_hdr_s *received_coap_ptr, sn_nsdl_addr_s *address, sn_proto_info_s *proto) |
| Process the CoAP message. | |
| virtual string | get ()=0 |
| Resource value getter (REQUIRED: must be implemented in derived class as all Binders MUST support and implement GET) | |
| virtual void | put (const string value) |
| Resource value setter (PUT) (OPTIONAL: defaulted noop if not derived. | |
| virtual void | post (const string value) |
| Resource value setter (POST) (OPTIONAL: defaulted noop if not derived. | |
| virtual void | del (const string value) |
| Resource value deleter (OPTIONAL: defaulted noop if not derived. | |
| int | notify (const string data) |
| Send notification of new data. | |
| bool | isObservable () |
| Determine whether this dynamic resource is observable or not. | |
| void | setObserver (void *observer) |
| Set the observer pointer. | |
| void | setDataWrapper (DataWrapper *data_wrapper) |
| Set the data wrapper. | |
| virtual void | observe () |
| observe the resource | |
| string | getName () |
| Get the resource name. | |
| string | getValue () |
| Get the resource value. | |
| void | setName (const string name) |
| Set the resource name. | |
| void | setValue (const stringvalue) |
| Set the resource value. | |
Detailed Description
DynamicResource class.
Definition at line 37 of file DynamicResource.h.
Constructor & Destructor Documentation
| DynamicResource | ( | const Logger * | logger, |
| const char * | name, | ||
| const char * | res_type, | ||
| uint8_t | res_mask, | ||
| const bool | observable = false |
||
| ) |
Default constructor (char strings)
- Parameters:
-
logger input logger instance for this resource name input the Resource URI/Name res_type input type for the Resource res_mask input the resource enablement mask (GET, PUT, etc...) observable input the resource is Observable (default: FALSE)
Definition at line 40 of file DynamicResource.cpp.
| DynamicResource | ( | const Logger * | logger, |
| const char * | name, | ||
| const char * | res_type, | ||
| const string | value, | ||
| uint8_t | res_mask, | ||
| const bool | observable = false |
||
| ) |
Default constructor (char strings)
- Parameters:
-
logger input logger instance for this resource name input the Resource URI/Name res_type input type for the Resource value input initial value for the Resource res_mask input the resource enablement mask (GET, PUT, etc...) observable input the resource is Observable (default: FALSE)
Definition at line 53 of file DynamicResource.cpp.
| DynamicResource | ( | const Logger * | logger, |
| const string | name, | ||
| const string | res_type, | ||
| const string | value, | ||
| uint8_t | res_mask, | ||
| const bool | observable = false |
||
| ) |
constructor with string buffer for name
- Parameters:
-
logger input logger instance for this resource name input the Resource URI/Name res_type input type for the Resource value input initial value for the Resource res_mask input the resource enablement mask (GET, PUT, etc...) observable input the resource is Observable (default: FALSE)
Definition at line 66 of file DynamicResource.cpp.
| DynamicResource | ( | const DynamicResource & | resource ) |
Copy constructor.
- Parameters:
-
resource input the DynamicResource that is to be deep copied
Definition at line 79 of file DynamicResource.cpp.
| ~DynamicResource | ( | ) | [virtual] |
Destructor.
Definition at line 92 of file DynamicResource.cpp.
Member Function Documentation
| void bind | ( | void * | p ) | [virtual] |
Bind resource to endpoint.
- Parameters:
-
p input pointer to the endpoint resources necessary for binding
Implements Resource< string >.
Definition at line 98 of file DynamicResource.cpp.
| void del | ( | const string | value ) | [virtual] |
Resource value deleter (OPTIONAL: defaulted noop if not derived.
Binders MAY implement DELETE if needed)
- Parameters:
-
string value of the resource
Definition at line 346 of file DynamicResource.cpp.
| virtual string get | ( | ) | [pure virtual] |
Resource value getter (REQUIRED: must be implemented in derived class as all Binders MUST support and implement GET)
- Returns:
- string value of the resource
| string getName | ( | ) | [inherited] |
| string getValue | ( | ) | [inherited] |
| bool isObservable | ( | ) |
Determine whether this dynamic resource is observable or not.
- Returns:
- true - is observable, false - otherwise
Definition at line 133 of file DynamicResource.h.
| int notify | ( | const string | data ) |
Send notification of new data.
- Parameters:
-
data input the new data to update
- Returns:
- 1 - success, 0 - failure
Definition at line 288 of file DynamicResource.cpp.
| void observe | ( | ) | [virtual] |
observe the resource
Definition at line 353 of file DynamicResource.cpp.
| void post | ( | const string | value ) | [virtual] |
Resource value setter (POST) (OPTIONAL: defaulted noop if not derived.
Binders MAY implement POST if needed)
- Parameters:
-
string value of the resource
Definition at line 339 of file DynamicResource.cpp.
| uint8_t process | ( | sn_coap_hdr_s * | received_coap_ptr, |
| sn_nsdl_addr_s * | address, | ||
| sn_proto_info_s * | proto | ||
| ) |
Process the CoAP message.
- Parameters:
-
received_coap_ptr input the received coap pointer address input the NSDL address pointer proto input the NSDL protocol pointer
- Returns:
- 0 - success, 1 - failure
Definition at line 118 of file DynamicResource.cpp.
| void put | ( | const string | value ) | [virtual] |
Resource value setter (PUT) (OPTIONAL: defaulted noop if not derived.
Binders MAY implement PUT if needed)
- Parameters:
-
string value of the resource
Definition at line 332 of file DynamicResource.cpp.
| void setDataWrapper | ( | DataWrapper * | data_wrapper ) |
Set the data wrapper.
- Parameters:
-
data_wrapper input the data wrapper instance
Definition at line 145 of file DynamicResource.h.
| void setName | ( | const string | name ) | [inherited] |
Set the resource name.
- Parameters:
-
name input the resource name
Definition at line 88 of file Resource.h.
| void setObserver | ( | void * | observer ) |
Set the observer pointer.
- Parameters:
-
observer input the pointer to the ResourceObserver observing this resource
Definition at line 360 of file DynamicResource.cpp.
| void setValue | ( | const string | value ) | [inherited] |
Set the resource value.
- Parameters:
-
value input the resource value
Definition at line 96 of file Resource.h.
Generated on Wed Jul 13 2022 02:11:49 by
1.7.2