 |
HAN-FUN API
1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
|
|
HAN-FUN API
1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
|
Bind Management interface : Client side. More...
#include <bind_management.h>
Inheritance diagram for HF::Core::BindManagement::Client: Collaboration diagram for HF::Core::BindManagement::Client:Public Member Functions | |
| Client (HF::Core::Unit0 &unit) | |
| Constructor. More... | |
| SessionMgr & | session () |
| Reference to the session management API. More... | |
| void | send (const Protocol::Address &addr, Protocol::Message &message) |
Send message msg to the network address given by addr. More... | |
Commands | |
| void | add (const Protocol::Address &source, const Protocol::Address &destination, const Common::Interface &itf) |
| Send a ADD_BIND command. More... | |
| void | remove (const Protocol::Address &source, const Protocol::Address &destination, const Common::Interface &itf) |
| Send a REMOVE_BIND command. More... | |
| void | start_session () const |
| Start read entries session. | |
| void | get_entries (uint16_t offset, uint8_t count=0) const |
| Read entries. More... | |
| void | end_session () const |
| End read entries session. | |
Events | |
| virtual void | response (const CMD cmd, const Protocol::Response &response) |
| This method is called when the response to a command is received. More... | |
| Public Member Functions inherited from HF::Core::ServiceRole< Base, HF::Interface::CLIENT_ROLE > | |
| Interface::Role | role () const |
| Return the Interface::Role this interface implements. More... | |
| Public Member Functions inherited from Base | |
| void | receive (HF::Protocol::Packet &packet, HF::Common::ByteArray &payload, uint16_t offset) |
| Callback to deliver a packet received from the transport layer. More... | |
| bool | has_bind (uint16_t dev_addr_1, uint16_t dev_addr_2) |
| Check if bind exists. More... | |
| uint8_t | bind (uint16_t dev_addr_1, uint16_t dev_addr_2) |
| Create a new bind entry. More... | |
| bool | unbind (uint16_t dev_addr_1, uint16_t dev_addr_2) |
| Remove the binding entry for the given devices. More... | |
| Public Member Functions inherited from HF::Devices::Concentrator::Abstract< CoreServices > | |
| CoreServices * | unit0 () const |
| Get the unit 0 used by this concentrator device. More... | |
| Public Member Functions inherited from HF::Devices::Concentrator::AbstractBase | |
| uint16_t | address () const |
Return the device address on the HAN-FUN network, when the device is registered, or HF_BROADCAST_ADDR otherwise. More... | |
| void | connected (HF::Transport::Link *link) |
Callback to report that a new transport link was been created to a remote device. More... | |
| void | disconnected (HF::Transport::Link *link) |
Callback to the report that the given transport link no longer is valid and MUST not be used to send messages to the corresponding end-point. More... | |
| Public Member Functions inherited from HF::Devices::AbstractDevice | |
| const IUnits & | units () const |
| Return the list of units registered in this device. More... | |
| void | add (Units::IUnit *unit) |
| Add unit to devices unit lists. More... | |
| void | remove (Units::IUnit *unit) |
| Remove unit from device's unit list. More... | |
| Units::IUnit * | unit (uint8_t id) const |
| Return pointer to the unit with the given id. More... | |
| void | send (Protocol::Packet &packet) |
Send given packet into the HAN-FUN network. More... | |
| void | periodic (uint32_t time) |
| Handle periodic processing. More... | |
Events | |
Additional Inherited Members | |
| Protected Member Functions inherited from HF::Core::ServiceRole< Base, HF::Interface::CLIENT_ROLE > | |
| ServiceRole (Unit0 &unit) | |
| Constructor. More... | |
| Protected Member Functions inherited from HF::Devices::Concentrator::AbstractBase | |
| HF::Transport::Link * | link (uint16_t addr) const |
| Return the link that can be used to send a packet to the device with the given address. More... | |
| virtual void | route_packet (Protocol::Packet &packet, Common::ByteArray &payload, uint16_t offset) |
| Route the given packet to the corresponding device. More... | |
| Protected Member Functions inherited from HF::Devices::AbstractDevice | |
| virtual bool | to_local (const Protocol::Packet &packet) const |
| Check if the given packet is for this device. More... | |
| bool | from_local (const Protocol::Packet &packet) const |
| Check if the given packet is from the local device. More... | |
| bool | from_remote (const Protocol::Packet &packet) |
| Check if the given packet is from the a remote device. More... | |
| bool | is_registered () |
| Check if the device has a valid, i.e. More... | |
| virtual void | entries (const GetEntriesResponse< Entry > &response) |
| This event is called when a response to a get entries is received. More... | |
| Protected Member Functions inherited from HF::Core::SessionManagement::AbstractClient | |
| Common::Result | handle_command (CMD cmd, Protocol::Packet &packet, Common::ByteArray &payload, uint16_t offset=0) |
| Handle command request/response messages. More... | |
| uint16_t | payload_size (CMD cmd) const |
| Get the minimum number of bytes necessary to pack/unpack a message of the given command. More... | |
| template<uint8_t _role, uint16_t _uid, uint8_t _member> | |
| void | get_entries (uint16_t offset, uint8_t count=0) const |
Helper method to send a message to read, count entries starting at offset from the server. More... | |
| template<uint8_t _role, uint16_t _uid, uint8_t _member> | |
| void | request () const |
| Helper method to create a session management request. More... | |
| Protected Attributes inherited from HF::Devices::Concentrator::AbstractBase | |
| Common::SimpleList< Transport::Link * > | _links |
| List of links present in this concentrator. | |
| Protected Attributes inherited from HF::Devices::AbstractDevice | |
| uint8_t | next_reference |
| Last reference number used to send a packet. | |
| IUnits | _units |
| List containing pointers to the units present in the device. | |
| Protocol::Filters::ResponseRequired | response_filter |
| Support for generating missing responses for messages. | |
Bind Management interface : Client side.
Definition at line 284 of file bind_management.h.
1.8.15 
