client-cpp  0.10.0
kaa::IKaaChannelManager Class Referenceabstract

#include <IKaaChannelManager.hpp>

+ Inheritance diagram for kaa::IKaaChannelManager:

Public Member Functions

virtual void setFailoverStrategy (IFailoverStrategyPtr strategy)=0
 
virtual void setChannel (TransportType type, IDataChannelPtr channel)=0
 
virtual void addChannel (IDataChannelPtr channel)=0
 
virtual void removeChannel (const std::string &id)=0
 
virtual void removeChannel (IDataChannelPtr channel)=0
 
virtual std::list
< IDataChannelPtr
getChannels ()=0
 
virtual IDataChannelPtr getChannelByTransportType (TransportType type)=0
 
virtual IDataChannelPtr getChannel (const std::string &channelId)=0
 
virtual void onServerFailed (ITransportConnectionInfoPtr connectionInfo, KaaFailoverReason reason)=0
 
virtual void onConnected (const EndpointConnectionInfo &connection)=0
 
virtual void onTransportConnectionInfoUpdated (ITransportConnectionInfoPtr connectionInfo)=0
 
virtual void clearChannelList ()=0
 
virtual void setConnectivityChecker (ConnectivityCheckerPtr checker)=0
 
virtual void shutdown ()=0
 
virtual void pause ()=0
 
virtual void resume ()=0
 
virtual ~IKaaChannelManager ()
 

Detailed Description

Channel manager establishes/removes channels' links between client and server.

Definition at line 35 of file IKaaChannelManager.hpp.

Constructor & Destructor Documentation

virtual kaa::IKaaChannelManager::~IKaaChannelManager ( )
inlinevirtual

Definition at line 170 of file IKaaChannelManager.hpp.

Member Function Documentation

virtual void kaa::IKaaChannelManager::addChannel ( IDataChannelPtr  channel)
pure virtual

Updates the manager by adding the channel.

Parameters
channelthe channel to be added.
See Also
IDataChannel

Implemented in kaa::KaaChannelManager.

virtual void kaa::IKaaChannelManager::clearChannelList ( )
pure virtual

Clears the list of channels.

Implemented in kaa::KaaChannelManager.

virtual IDataChannelPtr kaa::IKaaChannelManager::getChannel ( const std::string &  channelId)
pure virtual

Retrieves channel by the unique channel id.

Parameters
idthe channel's id.
Returns
channel object.
See Also
IDataChannel

Implemented in kaa::KaaChannelManager.

virtual IDataChannelPtr kaa::IKaaChannelManager::getChannelByTransportType ( TransportType  type)
pure virtual

Retrieves the list of channels by the specific transport type.

Parameters
typethe transport's type.
Returns
the channels' list.
See Also
TransportType
IDataChannel

Implemented in kaa::KaaChannelManager.

virtual std::list<IDataChannelPtr> kaa::IKaaChannelManager::getChannels ( )
pure virtual

Retrieves a list of current channels.

Returns
a list of channels.
See Also
IDataChannel

Implemented in kaa::KaaChannelManager.

virtual void kaa::IKaaChannelManager::onConnected ( const EndpointConnectionInfo connection)
pure virtual

Reports to Channel Manager about successful connection.

Parameters
connectionconnection metadata.

Implemented in kaa::KaaChannelManager.

virtual void kaa::IKaaChannelManager::onServerFailed ( ITransportConnectionInfoPtr  connectionInfo,
KaaFailoverReason  reason 
)
pure virtual

Reports to Channel Manager in case link with server was not established.

Parameters
serverthe parameters of server that was not connected.
See Also
ITransportConnectionInfo
Parameters
reasonThe reason which caused failure.
See Also
KaaFailoverReason

Implemented in kaa::KaaChannelManager.

virtual void kaa::IKaaChannelManager::onTransportConnectionInfoUpdated ( ITransportConnectionInfoPtr  connectionInfo)
pure virtual

Reports to Channel Manager about the new server.

Parameters
newServerthe parameters of the new server.
See Also
ITransportConnectionInfo

Implemented in kaa::KaaChannelManager.

virtual void kaa::IKaaChannelManager::pause ( )
pure virtual

Pauses all active channels.

Implemented in kaa::KaaChannelManager.

virtual void kaa::IKaaChannelManager::removeChannel ( const std::string &  id)
pure virtual

Updates the manager by removing the channel from the manager.

Parameters
idthe channel's id.
See Also
KaaDataChannel

Implemented in kaa::KaaChannelManager.

virtual void kaa::IKaaChannelManager::removeChannel ( IDataChannelPtr  channel)
pure virtual

Updates the manager by removing the channel from the manager.

Parameters
channelthe channel to be removed.
See Also
IDataChannel

Implemented in kaa::KaaChannelManager.

virtual void kaa::IKaaChannelManager::resume ( )
pure virtual

Restores channels' activity.

Implemented in kaa::KaaChannelManager.

virtual void kaa::IKaaChannelManager::setChannel ( TransportType  type,
IDataChannelPtr  channel 
)
pure virtual

Updates the manager by setting the channel to the specified transport type.

Parameters
typethe type of the transport which is going to receive updates using the specified channel.
channelthe channel to be added.
See Also
IDataChannel

Implemented in kaa::KaaChannelManager.

virtual void kaa::IKaaChannelManager::setConnectivityChecker ( ConnectivityCheckerPtr  checker)
pure virtual

Sets connectivity checker to the current channel.

Parameters
checkerplatform-dependent connectivity checker.
See Also
IConnectivityChecker

Implemented in kaa::KaaChannelManager.

virtual void kaa::IKaaChannelManager::setFailoverStrategy ( IFailoverStrategyPtr  strategy)
pure virtual

Implemented in kaa::KaaChannelManager.

virtual void kaa::IKaaChannelManager::shutdown ( )
pure virtual

Shuts down the manager and all registered channels. The instance can no longer be used.

Implemented in kaa::KaaChannelManager.


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