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

This is the interface used by the transport layer to signal events comming in from the network. More...

#include <transport.h>

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

Public Member Functions

Events
virtual void connected (Link *link)=0
 Callback to report that a new transport link was been created to a remote device. More...
 
virtual void disconnected (Link *link)=0
 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...
 
virtual void receive (Protocol::Packet &packet, Common::ByteArray &payload, uint16_t offset)=0
 Callback to deliver a packet received from the transport layer. More...
 

Detailed Description

This is the interface used by the transport layer to signal events comming in from the network.

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

Member Function Documentation

◆ connected()

virtual void HF::Transport::Endpoint::connected ( Link link)
pure virtual

Callback to report that a new transport link was been created to a remote device.

This link can then be used by the local end-point to send messages to the remote end-point.

Parameters
[in]linkpointer to the created link.

Implemented in HF::Devices::Concentrator::AbstractBase, HF::Devices::Node::Abstract< CoreServices >, HF::Devices::Node::Abstract< NodeUnit0 >, and HF::Devices::Node::Abstract< HF::Devices::Node::DefaultUnit0 >.

Referenced by HF::Devices::Node::Transport::add(), and HF::Devices::Concentrator::Transport::add().

+ Here is the caller graph for this function:

◆ disconnected()

virtual void HF::Transport::Endpoint::disconnected ( Link link)
pure virtual

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.

At the time of this method call the link MUST not be used to send any further messages to the remote end-point.

Parameters
[in]linkpointer to the link disconnected.

Implemented in HF::Devices::Concentrator::AbstractBase, HF::Devices::Node::Abstract< CoreServices >, HF::Devices::Node::Abstract< NodeUnit0 >, and HF::Devices::Node::Abstract< HF::Devices::Node::DefaultUnit0 >.

◆ receive()

virtual void HF::Transport::Endpoint::receive ( Protocol::Packet packet,
Common::ByteArray payload,
uint16_t  offset 
)
pure virtual

Callback to deliver a packet received from the transport layer.

Parameters
[in]packetreference to the received packet.
[in]payloadreference a ByteArray containing the received data.
[in]offsetoffset from where the received data starts on the payload byte array buffer.

Implemented in HF::Devices::Concentrator::AbstractBase, HF::Devices::Node::Abstract< CoreServices >, HF::Devices::Node::Abstract< NodeUnit0 >, HF::Devices::Node::Abstract< HF::Devices::Node::DefaultUnit0 >, Base, HF::Devices::AbstractDevice, and Node.


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