client-cpp  0.10.0
kaa::DefaultOperationLongPollChannel Class Reference

#include <DefaultOperationLongPollChannel.hpp>

+ Inheritance diagram for kaa::DefaultOperationLongPollChannel:
+ Collaboration diagram for kaa::DefaultOperationLongPollChannel:

Public Member Functions

 DefaultOperationLongPollChannel (IKaaChannelManager &channelManager, const KeyPair &clientKeys, IKaaClientContext &context)
 
virtual ~DefaultOperationLongPollChannel ()
 
virtual void sync (TransportType type)
 
virtual void syncAll ()
 
virtual void syncAck (TransportType type)
 
virtual const std::string & getId () const
 
virtual TransportProtocolId getTransportProtocolId () const
 
virtual ServerType getServerType () const
 
virtual void setMultiplexer (IKaaDataMultiplexer *multiplexer)
 
virtual void setDemultiplexer (IKaaDataDemultiplexer *demultiplexer)
 
virtual void setServer (ITransportConnectionInfoPtr server)
 
virtual const std::map
< TransportType,
ChannelDirection > & 
getSupportedTransportTypes () const
 
virtual void shutdown ()
 
virtual void pause ()
 
virtual void resume ()
 
virtual void setFailoverStrategy (IFailoverStrategyPtr strategy)
 
virtual void setConnectivityChecker (ConnectivityCheckerPtr checker)
 
virtual ITransportConnectionInfoPtr getServer ()
 
- Public Member Functions inherited from kaa::IDataChannel
virtual ~IDataChannel ()
 

Protected Member Functions

std::string getURLSuffix ()
 

Protected Attributes

IKaaClientContextcontext_
 

Detailed Description

Definition at line 41 of file DefaultOperationLongPollChannel.hpp.

Constructor & Destructor Documentation

kaa::DefaultOperationLongPollChannel::DefaultOperationLongPollChannel ( IKaaChannelManager channelManager,
const KeyPair clientKeys,
IKaaClientContext context 
)
virtual kaa::DefaultOperationLongPollChannel::~DefaultOperationLongPollChannel ( )
virtual

Member Function Documentation

virtual const std::string& kaa::DefaultOperationLongPollChannel::getId ( ) const
inlinevirtual

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

Returns
the channel's id.

Implements kaa::IDataChannel.

Definition at line 49 of file DefaultOperationLongPollChannel.hpp.

virtual ITransportConnectionInfoPtr kaa::DefaultOperationLongPollChannel::getServer ( )
inlinevirtual

Retrieves current used server.

Returns
Server info.
See Also
IServerInfo

Implements kaa::IDataChannel.

Definition at line 74 of file DefaultOperationLongPollChannel.hpp.

virtual ServerType kaa::DefaultOperationLongPollChannel::getServerType ( ) const
inlinevirtual

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

Returns
the channel's type.
See Also
ServerType

Implements kaa::IDataChannel.

Definition at line 55 of file DefaultOperationLongPollChannel.hpp.

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

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

Returns
the map of transport types.
See Also
TransportType
ChannelDirection

Implements kaa::IDataChannel.

Definition at line 63 of file DefaultOperationLongPollChannel.hpp.

virtual TransportProtocolId kaa::DefaultOperationLongPollChannel::getTransportProtocolId ( ) const
inlinevirtual

Retrieves the TransportProtocolId.

Returns
the transport protocol id.
See Also
TransportProtocolId

Implements kaa::IDataChannel.

Definition at line 51 of file DefaultOperationLongPollChannel.hpp.

std::string kaa::DefaultOperationLongPollChannel::getURLSuffix ( )
inlineprotected

Definition at line 79 of file DefaultOperationLongPollChannel.hpp.

virtual void kaa::DefaultOperationLongPollChannel::pause ( )
virtual

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

Implements kaa::IDataChannel.

virtual void kaa::DefaultOperationLongPollChannel::resume ( )
virtual

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

Implements kaa::IDataChannel.

virtual void kaa::DefaultOperationLongPollChannel::setConnectivityChecker ( ConnectivityCheckerPtr  checker)
inlinevirtual

Sets connectivity checker to the current channel.

Parameters
checkerplatform-dependent connectivity checker.
See Also
IConnectivityChecker

Implements kaa::IDataChannel.

Definition at line 72 of file DefaultOperationLongPollChannel.hpp.

virtual void kaa::DefaultOperationLongPollChannel::setDemultiplexer ( IKaaDataDemultiplexer demultiplexer)
virtual

Sets the request multiplexer for this channel.

Parameters
multiplexermultiplexer instance to be set.
See Also
IKaaDataMultiplexer

Implements kaa::IDataChannel.

virtual void kaa::DefaultOperationLongPollChannel::setFailoverStrategy ( IFailoverStrategyPtr  strategy)
inlinevirtual

Implements kaa::IDataChannel.

Definition at line 71 of file DefaultOperationLongPollChannel.hpp.

virtual void kaa::DefaultOperationLongPollChannel::setMultiplexer ( IKaaDataMultiplexer multiplexer)
virtual

Sets the response demultiplexer for this channel.

Parameters
demultiplexerdemultiplexer instance to be set.
See Also
IKaaDataDemultiplexer

Implements kaa::IDataChannel.

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

Sets the connection data for the current channel.

Parameters
connectionInfoThe server's connection data.
See Also
ITransportConnectionInfo

Implements kaa::IDataChannel.

virtual void kaa::DefaultOperationLongPollChannel::shutdown ( )
virtual

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

Implements kaa::IDataChannel.

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

Updates the channel's state of the specific service.

Parameters
typetransport type of the service.
See Also
TransportType

Implements kaa::IDataChannel.

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

Updates the channel's state of all supported services.

Implements kaa::IDataChannel.

virtual void kaa::DefaultOperationLongPollChannel::syncAll ( )
virtual

Updates the channel's state of all supported services.

Implements kaa::IDataChannel.

Member Data Documentation

IKaaClientContext& kaa::DefaultOperationLongPollChannel::context_
protected

Definition at line 116 of file DefaultOperationLongPollChannel.hpp.


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