HAN-FUN API  1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
HF::Transport::Group Namespace Reference

This namespace contains the API used for managing groups of devices at the transport layer level. More...

Functions

Common::Result create (Endpoint &ep, uint16_t group)
 Create a new group of devices at the transport layer with the given address. More...
 
Common::Result add (Endpoint &ep, uint16_t group, uint16_t device)
 Add the given device to the given group for the given end-point ep. More...
 
void remove (Endpoint &ep, uint16_t group, uint16_t device)
 Remove the given device from the given group for the given end-point ep. More...
 
void remove (Endpoint &ep, uint16_t group)
 Remove the given group of devices at the transport layer. More...
 

Detailed Description

This namespace contains the API used for managing groups of devices at the transport layer level.

Function Documentation

◆ add()

Common::Result HF::Transport::Group::add ( Endpoint ep,
uint16_t  group,
uint16_t  device 
)

Add the given device to the given group for the given end-point ep.

Parameters
[in]epreference to the end-point.
[in]groupHF address for the group to add the device for.
[in]deviceHF address of the device to add to the group.
Returns
Common::Result::OK if the device was added to the group.

◆ create()

Common::Result HF::Transport::Group::create ( Endpoint ep,
uint16_t  group 
)

Create a new group of devices at the transport layer with the given address.

The new link associated with the group MUST be sent to the given end-point via the Endpoint::connected API.

Parameters
[in]epreference to the end-point to create the new group for.
[in]groupHF address for the new group, i.e. the address for the new link.
Returns
Common::Result::OK if the group was created.

◆ remove() [1/2]

void HF::Transport::Group::remove ( Endpoint ep,
uint16_t  group,
uint16_t  device 
)

Remove the given device from the given group for the given end-point ep.

Parameters
[in]epreference to the end-point.
[in]groupHF address for the group to remove the device from.
[in]deviceHF address of the device to remove from the group.

◆ remove() [2/2]

void HF::Transport::Group::remove ( Endpoint ep,
uint16_t  group 
)

Remove the given group of devices at the transport layer.

The link associated with the group MUST be disconnected from the given end-point via the Endpoint::disconnected API.

Parameters
[in]epreference to the end-point to remove the group from.
[in]groupHF address of the group to remove.