org.kaaproject.kaa.client.channel

Interface KaaDataChannel

All Known Implementing Classes:

AbstractHttpChannel, DefaultBootstrapChannel, DefaultOperationHttpChannel, DefaultOperationsChannel, DefaultOperationTcpChannel

public interface KaaDataChannel

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

Author:

Yaroslav Zeygerman

Method Summary

Modifier and Type	Method and Description
String	getId() Retrieves the channel's id.
TransportConnectionInfo	getServer() Retrieves info about current used server
ServerType	getServerType() Retrieves the channel's server type (i.e.
Map<TransportType,ChannelDirection>	getSupportedTransportTypes() Retrieves the map of transport types and their directions supported by this channel.
TransportProtocolId	getTransportProtocolId() Retrieves the TransportProtocolId.
void	pause() Pauses the channel's workflow.
void	resume() Resumes the channel's workflow.
void	setConnectivityChecker(ConnectivityChecker checker) Sets connectivity checker to the current channel.
void	setDemultiplexer(KaaDataDemultiplexer demultiplexer) Sets the response demultiplexer for this channel.
void	setMultiplexer(KaaDataMultiplexer multiplexer) Sets the request multiplexer for this channel.
void	setServer(TransportConnectionInfo server) Sets the server's parameters for the current channel.
void	shutdown() Shuts down the channel instance.
void	sync(Set<TransportType> types) Updates the channel's state of the specific service.
void	sync(TransportType type) Updates the channel's state of the specific service.
void	syncAck(Set<TransportType> type) Notifies channel about successful acknowledgment of the sync only in case of smth change.
void	syncAck(TransportType type) Notifies channel about successful acknowledgment of the sync only in case of smth change.
void	syncAll() Updates the channel's state of all supported services.

Method Detail

sync

void sync(TransportType type)

Updates the channel's state of the specific service.

Parameters:

type - transport type of the service.

See Also:

TransportType

sync

void sync(Set<TransportType> types)

Updates the channel's state of the specific service.

Parameters:

types - transport types to sync.

See Also:

TransportType

syncAll

void syncAll()

Updates the channel's state of all supported services.

syncAck

void syncAck(TransportType type)

Notifies channel about successful acknowledgment of the sync only in case of smth change.

Parameters:

type - transport type of the service.

See Also:

TransportType

syncAck

void syncAck(Set<TransportType> type)

Notifies channel about successful acknowledgment of the sync only in case of smth change.

Parameters:

type - transport type to ack.

See Also:

TransportType

getId

String getId()

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

Returns:

the channel's id.

getTransportProtocolId

TransportProtocolId getTransportProtocolId()

Retrieves the TransportProtocolId.

Returns:

the transport protocol id.

See Also:

TransportProtocolId

getServerType

ServerType getServerType()

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

Returns:

the channel's server type.

See Also:

ServerType

setDemultiplexer

void setDemultiplexer(KaaDataDemultiplexer demultiplexer)

Sets the response demultiplexer for this channel.

Parameters:

demultiplexer - demultiplexer instance to be set.

See Also:

KaaDataDemultiplexer

setMultiplexer

void setMultiplexer(KaaDataMultiplexer multiplexer)

Sets the request multiplexer for this channel.

Parameters:

multiplexer - multiplexer instance to be set.

See Also:

KaaDataMultiplexer

setServer

void setServer(TransportConnectionInfo server)

Sets the server's parameters for the current channel.

Parameters:

server - server's parameters.

See Also:

TransportConnectionInfo

getServer

TransportConnectionInfo getServer()

Retrieves info about current used server

Returns:

Server info

setConnectivityChecker

void setConnectivityChecker(ConnectivityChecker checker)

Sets connectivity checker to the current channel.

Parameters:

checker - platform-dependent connectivity checker.

See Also:

ConnectivityChecker

getSupportedTransportTypes

Map<TransportType,ChannelDirection> getSupportedTransportTypes()

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

Returns:

the map of transport types.

See Also:

TransportType, ChannelDirection

shutdown

void shutdown()

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

pause

void pause()

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

resume

void resume()

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