kaa::IDataChannel Class Reference

#include <IDataChannel.hpp>

Inheritance diagram for kaa::IDataChannel:

Public Member Functions
virtual void	sync (TransportType type)=0
virtual void	syncAll ()=0
virtual void	syncAck (TransportType type)=0
virtual const std::string &	getId () const =0
virtual TransportProtocolId	getTransportProtocolId () const =0
virtual ServerType	getServerType () const =0
virtual void	setMultiplexer (IKaaDataMultiplexer *multiplexer)=0
virtual void	setDemultiplexer (IKaaDataDemultiplexer *demultiplexer)=0
virtual void	setServer (ITransportConnectionInfoPtr connectionInfo)=0
virtual const std::map < TransportType, ChannelDirection > &	getSupportedTransportTypes () const =0
virtual void	setConnectivityChecker (ConnectivityCheckerPtr checker)=0
virtual void	shutdown ()=0
virtual void	pause ()=0
virtual void	resume ()=0
virtual	~IDataChannel ()

Detailed Description

Channel is responsible for sending/receiving data to/from the endpoint server.

Definition at line 38 of file IDataChannel.hpp.

Constructor & Destructor Documentation

virtual kaa::IDataChannel::~IDataChannel ( )

inlinevirtual

Definition at line 151 of file IDataChannel.hpp.

Member Function Documentation

virtual const std::string& kaa::IDataChannel::getId ( ) const

pure virtual

Retrieves the channel's id. It should be unique in existing channels scope.

Returns

the channel's id.

virtual ServerType kaa::IDataChannel::getServerType ( ) const

pure virtual

Retrieves the channel's server type (i.e. BOOTSTRAP or OPERATIONS).

Returns

the channel's type.

See also

ServerType

virtual const std::map<TransportType, ChannelDirection>& kaa::IDataChannel::getSupportedTransportTypes ( ) const

pure virtual

Retrieves the map of transport types and their directions supported by this channel.

Returns

the map of transport types.

See also

TransportType

ChannelDirection

virtual TransportProtocolId kaa::IDataChannel::getTransportProtocolId ( ) const

pure virtual

Retrieves the TransportProtocolId.

Returns

the transport protocol id.

See also

TransportProtocolId

virtual void kaa::IDataChannel::pause ( )

pure virtual

Pauses the channel's workflow. The channel should stop all network activity.

Implemented in kaa::ImpermanentDataChannel.

virtual void kaa::IDataChannel::resume ( )

pure virtual

Resumes the channel's workflow. The channel should restore the previous connection.

Implemented in kaa::ImpermanentDataChannel.

virtual void kaa::IDataChannel::setConnectivityChecker ( ConnectivityCheckerPtr  checker )

pure virtual

Sets connectivity checker to the current channel.

Parameters

checker

platform-dependent connectivity checker.

See also

IConnectivityChecker

virtual void kaa::IDataChannel::setDemultiplexer ( IKaaDataDemultiplexer *  demultiplexer )

pure virtual

Sets the request multiplexer for this channel.

Parameters

multiplexer

multiplexer instance to be set.

See also

IKaaDataMultiplexer

virtual void kaa::IDataChannel::setMultiplexer ( IKaaDataMultiplexer *  multiplexer )

pure virtual

Sets the response demultiplexer for this channel.

Parameters

demultiplexer

demultiplexer instance to be set.

See also

IKaaDataDemultiplexer

virtual void kaa::IDataChannel::setServer ( ITransportConnectionInfoPtr  connectionInfo )

pure virtual

Sets the connection data for the current channel.

Parameters

connectionInfo

The server's connection data.

See also

ITransportConnectionInfo

virtual void kaa::IDataChannel::shutdown ( )

pure virtual

Shuts down the channel instance. All connections and threads should be terminated. The instance can no longer be used.

Implemented in kaa::ImpermanentDataChannel.

virtual void kaa::IDataChannel::sync ( TransportType  type )

pure virtual

Updates the channel's state of the specific service.

Parameters

type	transport type of the service.

See also

TransportType

virtual void kaa::IDataChannel::syncAck ( TransportType  type )

pure virtual

Updates the channel's state of all supported services.

virtual void kaa::IDataChannel::syncAll ( )

pure virtual

Updates the channel's state of all supported services.

---

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

• /var/lib/jenkins/workspace/kaa_stable/client/client-multi/client-cpp/kaa/channel/IDataChannel.hpp