kaa::IDataChannel Class Reference

#include <IDataChannel.hpp>

Inheritance diagram for kaa::IDataChannel:

Public Member Functions
virtual void	setFailoverStrategy (IFailoverStrategyPtr strategy)=0
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 ITransportConnectionInfoPtr	getServer ()=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 39 of file IDataChannel.hpp.

Constructor & Destructor Documentation

virtual kaa::IDataChannel::~IDataChannel ( )

inlinevirtual

Definition at line 164 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.

Implemented in kaa::DefaultOperationTcpChannel, kaa::DefaultOperationLongPollChannel, kaa::DefaultOperationHttpChannel, and kaa::DefaultBootstrapChannel.

virtual ITransportConnectionInfoPtr kaa::IDataChannel::getServer ( )

pure virtual

Retrieves current used server.

Returns

Server info.

See Also

IServerInfo

Implemented in kaa::DefaultOperationLongPollChannel, kaa::DefaultOperationTcpChannel, and kaa::AbstractHttpChannel.

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

Implemented in kaa::DefaultOperationTcpChannel, and kaa::DefaultOperationLongPollChannel.

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

Implemented in kaa::DefaultOperationTcpChannel, kaa::DefaultOperationLongPollChannel, kaa::DefaultOperationHttpChannel, and kaa::DefaultBootstrapChannel.

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

pure virtual

Retrieves the TransportProtocolId.

Returns

the transport protocol id.

See Also

TransportProtocolId

Implemented in kaa::AbstractHttpChannel, kaa::DefaultOperationTcpChannel, and kaa::DefaultOperationLongPollChannel.

virtual void kaa::IDataChannel::pause ( )

pure virtual

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

Implemented in kaa::DefaultOperationTcpChannel, kaa::DefaultOperationLongPollChannel, and kaa::ImpermanentDataChannel.

virtual void kaa::IDataChannel::resume ( )

pure virtual

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

Implemented in kaa::DefaultOperationTcpChannel, kaa::DefaultOperationLongPollChannel, and 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

Implemented in kaa::DefaultOperationTcpChannel, kaa::DefaultOperationLongPollChannel, and kaa::AbstractHttpChannel.

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

Implemented in kaa::DefaultOperationTcpChannel, kaa::DefaultOperationLongPollChannel, and kaa::AbstractHttpChannel.

virtual void kaa::IDataChannel::setFailoverStrategy ( IFailoverStrategyPtr  strategy )

pure virtual

Implemented in kaa::DefaultOperationTcpChannel, kaa::DefaultOperationLongPollChannel, and kaa::AbstractHttpChannel.

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

Implemented in kaa::DefaultOperationTcpChannel, kaa::DefaultOperationLongPollChannel, and kaa::AbstractHttpChannel.

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

Implemented in kaa::DefaultOperationTcpChannel, kaa::DefaultOperationLongPollChannel, and kaa::AbstractHttpChannel.

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::DefaultOperationTcpChannel, kaa::DefaultOperationLongPollChannel, and 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

Implemented in kaa::DefaultOperationTcpChannel, kaa::AbstractHttpChannel, and kaa::DefaultOperationLongPollChannel.

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

pure virtual

Updates the channel's state of all supported services.

Implemented in kaa::DefaultOperationTcpChannel, kaa::AbstractHttpChannel, and kaa::DefaultOperationLongPollChannel.

virtual void kaa::IDataChannel::syncAll ( )

pure virtual

Updates the channel's state of all supported services.

Implemented in kaa::DefaultOperationTcpChannel, kaa::AbstractHttpChannel, and kaa::DefaultOperationLongPollChannel.

---

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

• /home/architec/Documents/kaa/client/client-multi/client-cpp/kaa/channel/IDataChannel.hpp