HAN-FUN API  1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
HF::Core::DeviceInformation::Server Struct Reference

Device Information interface : Server side. More...

#include <device_information.h>

+ Inheritance diagram for HF::Core::DeviceInformation::Server:
+ Collaboration diagram for HF::Core::DeviceInformation::Server:

Public Member Functions

 Server (HF::Core::Unit0 &unit)
 Device UID. More...
 
void paging (bool value)
 Set extra capabilities attribute paging bit to given value. More...
 
bool has_paging () const
 Get extra capabilities attribute paging bit. More...
 
void broadcast (bool value)
 Set extra capabilities attribute broadcast bit to given value. More...
 
bool has_broadcast () const
 Get extra capabilities attribute broadcast bit. More...
 
void capabilities (uint8_t value)
 Setter for the extra capabilities attribute. More...
 
uint8_t capabilities ()
 Getter for the extra capabilities attribute bitmask. More...
 
- Public Member Functions inherited from HF::Core::ServiceRole< Base, HF::Interface::SERVER_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 IUnitsunits () 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::IUnitunit (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::SERVER_ROLE >
 ServiceRole (Unit0 &unit)
 Constructor. More...
 
- Protected Member Functions inherited from HF::Devices::Concentrator::AbstractBase
HF::Transport::Linklink (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...
 
- 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.
 

Detailed Description

Device Information interface : Server side.

Definition at line 227 of file device_information.h.

Constructor & Destructor Documentation

◆ Server()

HF::Core::DeviceInformation::Server::Server ( HF::Core::Unit0 unit)
inline

Device UID.

Constructor.

Parameters
[in]unitreference to the unit containing this service.

Definition at line 236 of file device_information.h.

236  :
237  ServiceRole<Base, HF::Interface::SERVER_ROLE>(unit), _capabilities(0)
238  {}
Units::IUnit * unit(uint8_t id) const
Return pointer to the unit with the given id.

Member Function Documentation

◆ broadcast()

void HF::Core::DeviceInformation::Server::broadcast ( bool  value)

Set extra capabilities attribute broadcast bit to given value.

Parameters
[in]valuebroadcast bit value to place in extra capabilities attribute.

◆ capabilities() [1/2]

void HF::Core::DeviceInformation::Server::capabilities ( uint8_t  value)

Setter for the extra capabilities attribute.

Parameters
[in]valuebitmask value for the extra capabilities attribute.

◆ capabilities() [2/2]

uint8_t HF::Core::DeviceInformation::Server::capabilities ( )

Getter for the extra capabilities attribute bitmask.

Returns
the bitmask value of the extra capabilities attribute.

◆ has_broadcast()

bool HF::Core::DeviceInformation::Server::has_broadcast ( ) const

Get extra capabilities attribute broadcast bit.

Return values
truethe broadcast bit is 1.
falsethe broadcast bit is 0.

◆ has_paging()

bool HF::Core::DeviceInformation::Server::has_paging ( ) const

Get extra capabilities attribute paging bit.

Return values
truethe broadcast bit is 1.
falsethe broadcast bit is 0.

◆ paging()

void HF::Core::DeviceInformation::Server::paging ( bool  value)

Set extra capabilities attribute paging bit to given value.

Parameters
[in]valuepaging bit value to place in extra capabilities attribute.

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