HAN-FUN API  1.5.3
This project provides the common implementation of ULE Alliance's HAN-FUN application protocol.
HF::Transport::Link Struct Referenceabstract

This interface represents a link on the transport layer, used to send data to the remote end-point. More...

#include <transport.h>

+ Inheritance diagram for HF::Transport::Link:
+ Collaboration diagram for HF::Transport::Link:

Public Member Functions

virtual uint16_t address () const =0
 Get the address of the device this link corresponds to. More...
 
virtual void address (uint16_t addr)=0
 Set the address of this link corresponds to. More...
 
virtual void send (Common::ByteArray &array)=0
 Send the data in the given ByteArray using the link to the remote end-point. More...
 
virtual const HF::UID::UID uid () const =0
 Return the end-point UID associated with this link. More...
 

Detailed Description

This interface represents a link on the transport layer, used to send data to the remote end-point.

Definition at line 49 of file inc/hanfun/transport.h.

Member Function Documentation

◆ address() [1/2]

virtual uint16_t HF::Transport::Link::address ( ) const
pure virtual

Get the address of the device this link corresponds to.

Returns
the address of the device for this link.

Implemented in HF::Transport::AbstractLink.

◆ address() [2/2]

virtual void HF::Transport::Link::address ( uint16_t  addr)
pure virtual

Set the address of this link corresponds to.

Parameters
[in]addrthe address value to set.

Implemented in HF::Transport::AbstractLink.

◆ send()

virtual void HF::Transport::Link::send ( Common::ByteArray array)
pure virtual

Send the data in the given ByteArray using the link to the remote end-point.

Parameters
[in]arrayreference to the ByteArray containing the data to send.

Implemented in HF::Application::Link.

◆ uid()

virtual const HF::UID::UID HF::Transport::Link::uid ( ) const
pure virtual

Return the end-point UID associated with this link.

For example, for a ULE transport layer this would return the RFPI/IPUI of the remote device.

Returns
the UID of the remote device of this link.

Implemented in HF::Transport::AbstractLink.


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