Default implementation of the IGroupTable interface. More...

#include <group_management.h>

Inheritance diagram for HF::Core::GroupManagement::GroupTableClient:

Collaboration diagram for HF::Core::GroupManagement::GroupTableClient:

Public Member Functions
void	add (const Protocol::Address &source, const AddMessage &request, uint8_t reference)
	Send a GroupTable::ADD_CMD to the device given by the `AddMessage` request. More...

Public Member Functions inherited from HF::Core::GroupManagement::IGroupTable
	IGroupTable (IServer &_server)
	Constructor. More...

Protected Member Functions
void	added (const Protocol::Address &addr, const GroupTable::Response &response)
	Callback for processing the response of a `GroupTable::ADD_CMD`. More...

Protected Member Functions inherited from HF::Core::GroupTable::Client
Common::Result	handle_command (Protocol::Packet &packet, Common::ByteArray &payload, uint16_t offset)
	Handle incoming messages from the network. More...

uint16_t	payload_size (Protocol::Message::Interface &itf) const
	Return the minimal payload size that a message should hold when addressed at the given interface. More...

void	add (const Protocol::Address &addr, const Entry &entry)
	Send a HAN-FUN message containing a `GroupTable::ADD_CMD`, to the given network address. More...

void	add (const uint16_t device, const Entry &entry)
	Send a HAN-FUN message containing a `GroupTable::ADD_CMD`, to the given `device` and the given `entry`. More...

void	add (const Protocol::Address &addr, uint16_t group, uint8_t unit)
	Send a HAN-FUN message containing a `GroupTable::ADD_CMD`, to the given network address, for the given `group` and `unit`. More...

void	add (const uint16_t device, uint16_t group, uint8_t unit)
	Send a HAN-FUN message containing a `GroupTable::ADD_CMD`, to the given `device`, for the given `group` and `unit`. More...

void	remove (const Protocol::Address &addr, const Entry &entry)
	Send a HAN-FUN message containing a `GroupTable::REMOVE_CMD`, to the given network address. More...

void	remove (const uint16_t device, const Entry &entry)
	Send a HAN-FUN message containing a `GroupTable::REMOVE_CMD`, to the given `device` and the given `entry`. More...

void	remove (const Protocol::Address &addr, uint16_t group, uint8_t unit)
	Send a HAN-FUN message containing a `GroupTable::REMOVE_CMD`, to the given network address, for the given `group` and `unit`. More...

void	remove (const uint16_t device, uint16_t group, uint8_t unit)
	Send a HAN-FUN message containing a `GroupTable::REMOVE_CMD`, to the given `device`, for the given `group` and `unit`. More...

void	remove_all (const Protocol::Address &addr)
	Send a HAN-FUN message containing a `GroupTable::REMOVE_ALL_CMD`, to the given network address. More...

void	remove_all (uint16_t device)
	Send a HAN-FUN message containing a `GroupTable::REMOVE_ALL_CMD`, to the device with the given address. More...

void	read_entries (const Protocol::Address &addr, const ReadEntries &params)
	Send a HAN-FUN message containing a `GroupTable::READ_ENTRIES_CMD`, to the given network address. More...

void	read_entries (const Protocol::Address &addr, const uint8_t offset, const uint8_t count)
	Send a HAN-FUN message containing a `GroupTable::READ_ENTRIES_CMD`, to the given network address. More...

void	read_entries (const uint16_t device, const ReadEntries &params)
	Send a HAN-FUN message containing a `GroupTable::REMOVE_ALL_CMD`, to the device with the given address. More...

void	read_entries (const uint16_t device, const uint8_t offset, const uint8_t count)
	Send a HAN-FUN message containing a `GroupTable::REMOVE_ALL_CMD`, to the device with the given address. More...

virtual void	removed (const Protocol::Address &addr, const GroupTable::Response &response)
	Callback for processing the response of a `GroupTable::REMOVE_CMD`. More...

virtual void	removed_all (const Protocol::Address &addr, const Protocol::Response &response)
	Callback for processing the response of a `GroupTable::REMOVE_ALL_CMD`. More...

virtual void	read_entries (const Protocol::Address &addr, const ReadEntriesResponse &response)
	Callback for processing the response of a `GroupTable::READ_ENTRIES_CMD`. More...

Protected Member Functions inherited from HF::Core::ServiceRole< GroupTable::Base, HF::Interface::CLIENT_ROLE >
	ServiceRole (Unit0 &unit)
	Constructor. More...

Interface::Role	role () const
	Return the Interface::Role this interface implements. More...

Protected Member Functions inherited from HF::Core::GroupTable::Base
	Base (Unit0 &unit)
	Constructor.

Protected Member Functions inherited from HF::Core::Service< HF::Interface::GROUP_TABLE >
	Service (Unit0 &unit)
	Constructor. More...

bool	check_uid (uint16_t uid) const
	Check if the given `uid` value matches the service's `UID` value. More...

uint16_t	uid () const
	This method returns the interface UID. More...

Protected Member Functions inherited from HF::Core::AbstractService
	AbstractService (Unit0 &unit)
	Constructor. More...

void	send (const Protocol::Address &addr, Protocol::Message &message)
	Send message `msg` to the network address given by `addr`. More...

void	send (const Protocol::Address &addr, Protocol::Message &message, Transport::Link *link)
	Create and send a new packet with the given message to the given address. More...

Unit0 &	unit () const
	The device this unit is associated with.

HF::Attributes::IAttribute *	attribute (uint8_t uid)
	Return a pointer to the interface attribute with the given `uid`. More...

HF::Attributes::UIDS	attributes (uint8_t pack_id=HF::Attributes::Pack::MANDATORY) const
	Return a vector containing the attribute UIDs, for the given pack ID. More...

Protected Member Functions inherited from HF::Interfaces::AbstractInterface
virtual void	notify (const HF::Attributes::IAttribute &old_value, const HF::Attributes::IAttribute &new_value) const
	Notify that an attribute value as changed. More...

Common::Result	check (Protocol::Message &message, Common::ByteArray &payload, uint16_t offset)
	Check if message has correct attributes to be processed by the interface. More...

Common::Result	check_payload_size (Protocol::Message &message, Common::ByteArray &payload, uint16_t offset)
	Check if `payload` data size if sufficient for processing the `message`. More...

virtual uint16_t	payload_size (Protocol::Message &message) const
	Return the minimal payload size that should be present for the given message. More...

template<typename _Message >
uint16_t	payload_size_helper () const
	Helper function template to retrieve minimum size required for serializing/deserializing the class given. More...

virtual Common::Result	handle_attribute (Protocol::Packet &packet, Common::ByteArray &payload, uint16_t offset)
	Handle incoming messages from the network. More...

Common::Result	handle (Protocol::Packet &packet, Common::ByteArray &payload, uint16_t offset)
	Handle incoming messages from the network. More...

void	periodic (uint32_t time)
	Handle periodic processing. More...

HF::Attributes::IAttribute *	attribute (uint8_t uid)
	Return a pointer to the interface attribute with the given `uid`. More...

Additional Inherited Members
Protected Types inherited from HF::Interface
enum	Role { CLIENT_ROLE = 0, SERVER_ROLE = 1 }
	Interface roles. More...

enum	UID { DEVICE_MANAGEMENT = 0x0001, BIND_MANAGEMENT = 0x0002, GROUP_MANAGEMENT = 0x0003, IDENTIFY = 0x0004, DEVICE_INFORMATION = 0x0005, ATTRIBUTE_REPORTING = 0x0006, BATCH_PROGRAM_MANAGEMENT = 0x0007, EVENT_SCHEDULING = 0x0008, WEEKLY_SCHEDULING = 0x0009, GROUP_TABLE = 0x000A, TAMPER_ALERT = 0x0101, TIME = 0x0102, POWER = 0x0110, KEEP_ALIVE = 0x0115, RSSI = 0x0111, SUOTA = 0x0400, ALERT = 0x0100, ON_OFF = 0x0200, LEVEL_CONTROL = 0x0201, COLOUR_CONTROL = 0x0202, SIMPLE_KEYPAD = 0x0203, SIMPLE_POWER_METER = 0x0300, SIMPLE_TEMPERATURE = 0x0301, SIMPLE_HUMIDITY = 0x0302, SIMPLE_THERMOSTAT = 0x0303, SIMPLE_BUTTON = 0x0304, SIMPLE_VISUAL_EFFECTS = 0x0305, SIMPLE_AIR_PRESSURE = 0x0306, SIMPLE_LIGHT_SENSOR = 0x0307, RESERVED = 0x7F00, MAX_UID = 0x7FFE, ANY_UID = 0x7FFF }
	Interfaces Unique Identifiers (UID). More...

Protected Attributes inherited from HF::Core::AbstractService
Unit0 &	_unit
	Reference to the unit the service belongs to.

Static Protected Attributes inherited from HF::Interface
static constexpr uint8_t	MAX_CMD_ID = 0xFF
	Maximum value for command IDs in interfaces.

Detailed Description

Default implementation of the IGroupTable interface.

Definition at line 1071 of file group_management.h.

Member Function Documentation

◆ add()

void HF::Core::GroupManagement::GroupTableClient::add	(	const Protocol::Address &	source,
		const AddMessage &	request,
		uint8_t	reference
	)

virtual

Send a GroupTable::ADD_CMD to the device given by the AddMessage request.

Parameters

source	HF address of the device that requested the `HF::GroupManagement::ADD_CMD`.
request	the payload for the `HF::GroupManagement::ADD_CMD` command.
reference	application reference of the message.

Reimplemented from HF::Core::GroupManagement::IGroupTable.

◆ added()

void HF::Core::GroupManagement::GroupTableClient::added	(	const Protocol::Address &	addr,
		const GroupTable::Response &	response
	)

protectedvirtual

Callback for processing the response of a GroupTable::ADD_CMD.

Parameters

[in]	addr	address for device that sent the response.
[in]	response	the response received.

Reimplemented from HF::Core::GroupTable::Client.

The documentation for this struct was generated from the following file:

group_management.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add()

◆ added()