Common

This module contains the common definitions for the Attribute Reporting service implementation. More...

Collaboration diagram for Common:

Data Structures
struct	HF::Core::AttributeReporting::Reference
	Report Identifier. More...
struct	HF::Core::AttributeReporting::Entry
	Parent class for all report rule entries. More...
struct	HF::Core::AttributeReporting::Rule
	Parent class for all report rules. More...

Enumerations
enum	HF::Core::AttributeReporting::CMD {   HF::Core::AttributeReporting::PERIODIC_REPORT_CMD = 0x01, HF::Core::AttributeReporting::EVENT_REPORT_CMD = 0x02, HF::Core::AttributeReporting::CREATE_PERIODIC_CMD = 0x01, HF::Core::AttributeReporting::CREATE_EVENT_CMD = 0x02,   HF::Core::AttributeReporting::ADD_PERIODIC_ENTRY_CMD = 0x03, HF::Core::AttributeReporting::ADD_EVENT_ENTRY_CMD = 0x04, HF::Core::AttributeReporting::DELETE_REPORT_CMD = 0x05, HF::Core::AttributeReporting::GET_PERIODIC_ENTRIES = 0x06,   HF::Core::AttributeReporting::GET_EVENT_ENTRIES = 0x07, HF::Core::AttributeReporting::UPDATE_INTERVAL_CMD = 0x08 }
	Commands. More...
enum	HF::Core::AttributeReporting::Attributes { HF::Core::AttributeReporting::REPORT_COUNT_ATTR = 0x01, HF::Core::AttributeReporting::PERIODIC_REPORT_COUNT_ATTR = 0x02, HF::Core::AttributeReporting::EVENT_REPORT_COUNT_ATTR = 0x03 }
	Attributes. More...
enum	HF::Core::AttributeReporting::Type { HF::Core::AttributeReporting::PERIODIC = 0x00, HF::Core::AttributeReporting::EVENT = 0x01 }
	Types of reports send from the server to the client. More...

Functions
Protocol::Message *	HF::Core::AttributeReporting::create (Protocol::Address &destination)
	Create a new attribute reporting event rule for the device with the given address. More...
Protocol::Message *	HF::Core::AttributeReporting::create (Protocol::Address &destination, uint32_t interval)
	Create a new attribute reporting periodic rule for the device with the given address and the given interval. More...
Protocol::Message *	HF::Core::AttributeReporting::destroy (Type type, uint8_t report_id)
	Remove the rule with the given type and the given report_id. More...
Protocol::Message *	HF::Core::AttributeReporting::destroy (Reference report)
	Remove the rule for the given report reference. More...
Protocol::Message *	HF::Core::AttributeReporting::add (Reference report, periodic_iterator begin, periodic_iterator end)
	Add the periodic entries from start to end into the rule with the given report reference. More...
Protocol::Message *	HF::Core::AttributeReporting::update (Reference report, uint32_t new_interval)
	Change the Update Interval for the specified report. More...
HF::Attributes::IAttribute *	HF::Core::AttributeReporting::create_attribute (uint8_t uid)
	Create an attribute object that can hold the attribute with the given uid. (HF::Core::AttributeReporting::Server *,uint8_t) More...

Detailed Description

This module contains the common definitions for the Attribute Reporting service implementation.

Enumeration Type Documentation

Attributes

enum HF::Core::AttributeReporting::Attributes

Attributes.

Enumerator
REPORT_COUNT_ATTR	Number of report entries attribute.
PERIODIC_REPORT_COUNT_ATTR	Number of periodic report entries attribute.
EVENT_REPORT_COUNT_ATTR	Number of event report entries attribute.

Definition at line 90 of file attribute_reporting.h.

         {
            REPORT_COUNT_ATTR          = 0x01, 
            PERIODIC_REPORT_COUNT_ATTR = 0x02, 
            EVENT_REPORT_COUNT_ATTR    = 0x03, 
            __LAST_ATTR__              = EVENT_REPORT_COUNT_ATTR
         } Attributes;

CMD

enum HF::Core::AttributeReporting::CMD

Commands.

Enumerator
PERIODIC_REPORT_CMD	Periodic Report.
EVENT_REPORT_CMD	Event Report.
CREATE_PERIODIC_CMD	Create Periodic Report.
CREATE_EVENT_CMD	Create Event Report.
ADD_PERIODIC_ENTRY_CMD	Add periodic report entry.
ADD_EVENT_ENTRY_CMD	Add event report entry.
DELETE_REPORT_CMD	Delete report.
GET_PERIODIC_ENTRIES	Get periodic entries.
GET_EVENT_ENTRIES	Get event entries.
UPDATE_INTERVAL_CMD	Update the interval of an existent report.

Definition at line 74 of file attribute_reporting.h.

         {
            PERIODIC_REPORT_CMD    = 0x01, 
            EVENT_REPORT_CMD       = 0x02, 
            CREATE_PERIODIC_CMD    = 0x01, 
            CREATE_EVENT_CMD       = 0x02, 
            ADD_PERIODIC_ENTRY_CMD = 0x03, 
            ADD_EVENT_ENTRY_CMD    = 0x04, 
            DELETE_REPORT_CMD      = 0x05, 
            GET_PERIODIC_ENTRIES   = 0x06, 
            GET_EVENT_ENTRIES      = 0x07, 
            UPDATE_INTERVAL_CMD    = 0x08, 
            __LAST_CMD__           = UPDATE_INTERVAL_CMD
         } CMD;

Type

enum HF::Core::AttributeReporting::Type

Types of reports send from the server to the client.

Enumerator
PERIODIC	Periodic Report.
EVENT	Event Report.

Definition at line 99 of file attribute_reporting.h.

         {
            PERIODIC = 0x00, 
            EVENT    = 0x01, 
         } Type;

Function Documentation

add()

Protocol::Message * HF::Core::AttributeReporting::add	(	Reference	report,
		periodic_iterator	begin,
		periodic_iterator	end
	)

Add the periodic entries from start to end into the rule with the given report reference.

Add the event entries from start to end into the rule with the given report reference.

Parameters

[in]	report	report reference
[in]	begin	iterator to the start of the periodic entries to add.
[in]	end	iterator to the end of the periodic entries to add.

Returns

pointer to a message indicating the result of the operation to be sent to the requesting device.

Parameters

[in]	report	report reference
[in]	begin	iterator to the start of the event entries to add.
[in]	end	iterator to the end of the event entries to add.

Returns

pointer to a message indicating the result of the operation to be sent to the requesting device.

create() [1/2]

Protocol::Message* HF::Core::AttributeReporting::create

(

Protocol::Address &

destination

)

Create a new attribute reporting event rule for the device with the given address.

Parameters

[in]

destination

device address the rule should be created for.

Returns

pointer to a message indicating the result of the operation to be sent to the requesting device.

create() [2/2]

Protocol::Message* HF::Core::AttributeReporting::create	(	Protocol::Address &	destination,
		uint32_t	interval
	)

Create a new attribute reporting periodic rule for the device with the given address and the given interval.

Parameters

[in]	destination	device address the rule should be created for.
[in]	interval	time interval in seconds for the periodic rule.

Returns

pointer to a message indicating the result of the operation to be sent to the requesting device.

create_attribute()

HF::Attributes::IAttribute* HF::Core::AttributeReporting::create_attribute ( uint8_t  uid )

inline

Create an attribute object that can hold the attribute with the given uid. (HF::Core::AttributeReporting::Server *,uint8_t)

See also

HF::Core::create_attribute (HF::Core::AttributeReporting::Server *,uint8_t)

Parameters

[in]

uid

attribute UID to create the attribute object for.

Return values

pointer	to an attribute object
<tt>nullptr</tt>	if the attribute UID does not exist.

Create an attribute object that can hold the attribute with the given uid. (HF::Core::AttributeReporting::Server *,uint8_t)

See also

HF::Interfaces::create_attribute (HF::Interfaces::SimpleHumidity::Server *,uint8_t)

Parameters

[in]

uid

attribute UID to create the attribute object for.

Returns

pointer to an attribute object or nullptr if the attribute UID does not exist.

Create an attribute object that can hold the attribute with the given uid. (HF::Core::AttributeReporting::Server *,uint8_t)

See also

HF::Interfaces::create_attribute (HF::Interfaces::SimpleTemperature::Server *,uint8_t)

Parameters

[in]

uid

attribute UID to create the attribute object for.

Return values

pointer	to an attribute object
<tt>nullptr</tt>	if the attribute UID does not exist.

Definition at line 108 of file simple_humidity.h.

         {
            return Interfaces::create_attribute(static_cast<SimpleHumidity::Server *>(nullptr),
                                                uid);
         }

destroy() [1/2]

Protocol::Message* HF::Core::AttributeReporting::destroy	(	Type	type,
		uint8_t	report_id
	)

Remove the rule with the given type and the given report_id.

Parameters

[in]	type	report type (HF::Core::AttributeReporting::Type)
[in]	report_id	report ID.

Returns

pointer to a message indicating the result of the operation to be sent to the requesting device.

Referenced by HF::Core::SessionManagement::EntriesWrapper< _Entries >::destroy().

Here is the caller graph for this function:

destroy() [2/2]

Protocol::Message* HF::Core::AttributeReporting::destroy

(

Reference

report

)

Remove the rule for the given report reference.

Parameters

[in]

report

report reference to remove the rule for.

Returns

pointer to a message indicating the result of the operation to be sent to the requesting device.

update()

Protocol::Message* HF::Core::AttributeReporting::update	(	Reference	report,
		uint32_t	new_interval
	)

Change the Update Interval for the specified report.

Parameters

[in]	report	Report reference
[in]	new_interval	New updata interval.

Returns

pointer to a message indicating the result of the operation to be sent to the requesting device.