HF::Transport::Layer Struct Reference

This class defines the API for the transport layer. More...

#include <transport.h>

Inheritance diagram for HF::Transport::Layer:

Collaboration diagram for HF::Transport::Layer:

Public Member Functions
Commands
virtual void	initialize ()=0
	Initialize the associated transport layer. More...
virtual void	add (Endpoint *ep)=0
	Register the given Endpoint to receive events. More...
virtual void	remove (Endpoint *ep=nullptr)=0
	Free the system resources associated with the given Endpoint, and remove it from receiving any further events. More...
virtual void	destroy ()=0
	Free the system resources associated with this transport layer.
virtual const HF::UID::UID	uid () const =0
	Return the UID of the local device on this transport layer. More...

Detailed Description

This class defines the API for the transport layer.

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

Member Function Documentation

add()

virtual void HF::Transport::Layer::add ( Endpoint *  ep )

pure virtual

Register the given Endpoint to receive events.

This should be possible to register multiple end-points, to the transport layer.

Parameters

[in]

ep

pointer to the end-point to register in the transport layer.

Implemented in HF::Devices::Concentrator::Transport, HF::Devices::Node::Transport, and HF::Transport::AbstractLayer.

initialize()

virtual void HF::Transport::Layer::initialize ( )

pure virtual

Initialize the associated transport layer.

This method should initialize the transport layer using it's default values.

Implemented in HF::Transport::AbstractLayer, and HF::Application::Transport.

remove()

virtual void HF::Transport::Layer::remove ( Endpoint *  ep = nullptr )

pure virtual

Free the system resources associated with the given Endpoint, and remove it from receiving any further events.

If ep is nullptr then all end-points should be removed.

When all end-points are removed all remaining system resources, associated with this transport layer should be freed.

Parameters

ep	pointer to the endpoint to remove from the transport layer.

Implemented in HF::Transport::AbstractLayer.

uid()

virtual const HF::UID::UID HF::Transport::Layer::uid ( ) const

pure virtual

Return the UID of the local device on this transport layer.

For example on an ULE device this would return the IPUI of the device.

Returns

the UID of the local device on this transport layer.

Implemented in HF::Transport::AbstractLayer.

---

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

• inc/hanfun/transport.h