KaaChannelManager (Kaa Client (Java Core) 0.7.4 API)

All Known Subinterfaces:

KaaInternalChannelManager

All Known Implementing Classes:

DefaultChannelManager
```
public interface KaaChannelManager
```
Channel manager establishes/removes channels' links between client and server.

Use this manager to add or remove specific network channel implementation for client-server communication.
```
 class SpecificDataChannel implements KaaDataChannel {...}
 ...
 SpecificDataChannel dataChannel1 = new SpecificDataChannel();
 kaaClient.getChannelManager().addChannel(dataChannel1);
 
 
```
The code above registers new data channel in the KaaChannelManager instance. This channel will be used by each transport abstraction which is supported by this channel (See KaaDataChannel.getSupportedTransportTypes()).

Channel manager will use the latest added channel for each TransportType for data transferring. For example, if there are two KaaDataChannel implementations ChannelA and ChannelB such as:
ChannelA is data transceiver (ChannelDirection.BIDIRECTIONAL) for transport types [TransportType.EVENT, TransportType.LOGGING];
ChannelB is data transmitter (ChannelDirection.UP) for [ TransportType.EVENT].

and they are added to addChannel(KaaDataChannel) in the following order:

 {
     @code
     ChannelA channelA = new ChannelA();
     ChannelB channelB = new ChannelB();
     kaaClient.getChannelManager().addChannel(channelA);
     kaaClient.getChannelManager().addChannel(channelB);
 }

then ChannelA instance will be used to receive TransportType.EVENT and TransportType.LOGGING data, but to transmit only TransportType.LOGGING data. For TransportType.EVENT data transmission will be used ChannelB instance.
NOTE: If mentioned above channels will be added in reverse order, ChannelB instance will not be used until channelA will not be removed using removeChannel(KaaDataChannel)

On Kaa initialization KaaChannelManager instance is populated with DefaultBootstrapChannel, DefaultOperationsChannel and DefaultOperationHttpChannel (in given order).

Calling removeChannel(KaaDataChannel) forces KaaChannelManager to remove given channel and reset TransportType-to-Channel internal mapping with applicable channel if such exists.

Call to clearChannelList() removes all existing channels.

If physical connection to remote server failed, call onServerFailed(TransportConnectionInfo) to switch to another available server.

Author:: Yaroslav Zeygerman
See Also:: KaaDataChannel

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addChannel(KaaDataChannel channel)` Updates the manager by adding the channel.
`void`	`clearChannelList()` Clears the list of channels.
`TransportConnectionInfo`	`getActiveServer(org.kaaproject.kaa.common.TransportType type)` Returns information about server that is used for data transfer for specified `TransportType`
`KaaDataChannel`	`getChannel(String id)` Retrieves channel by the unique channel id.
`List<KaaDataChannel>`	`getChannels()` Retrieves the list of current channels.
`void`	`onServerFailed(TransportConnectionInfo server)` Reports to Channel Manager in case link with server was not established.
`void`	`removeChannel(KaaDataChannel channel)` Updates the manager by removing the channel from the manager.
`void`	`removeChannel(String id)` Updates the manager by removing the channel from the manager.
`void`	`setChannel(org.kaaproject.kaa.common.TransportType transport, KaaDataChannel channel)` Updates the manager by setting the channel to the specified `TransportType`.
`void`	`setFailoverManager(FailoverManager failoverManager)` Sets a new failover manager
`void`	`sync(org.kaaproject.kaa.common.TransportType type)` Invoke sync on active channel by specified transport type
`void`	`syncAck(org.kaaproject.kaa.common.TransportType type)` Invoke sync acknowledgement on active channel by specified transport type
`void`	`syncAll(org.kaaproject.kaa.common.TransportType type)` Invoke sync acknowledgement on active channel

- Method Detail
  - setChannel
```
void setChannel(org.kaaproject.kaa.common.TransportType transport,
              KaaDataChannel channel)
                throws KaaInvalidChannelException
```
    Updates the manager by setting the channel to the specified TransportType.
    
    Parameters:
    transport - the type of the transport which is going to receive updates using the specified channel.
    channel - the channel to be added.
    
    Throws:
    
    KaaInvalidChannelException
    See Also:
    KaaDataChannel
  - addChannel
```
void addChannel(KaaDataChannel channel)
```
    Updates the manager by adding the channel.
    
    Parameters:
    channel - the channel to be added.
    See Also:
    KaaDataChannel
  - removeChannel
```
void removeChannel(KaaDataChannel channel)
```
    Updates the manager by removing the channel from the manager.
    
    Parameters:
    channel - the channel to be removed.
    See Also:
    KaaDataChannel
  - removeChannel
```
void removeChannel(String id)
```
    Updates the manager by removing the channel from the manager.
    
    Parameters:
    id - the channel's id.
    See Also:
    KaaDataChannel
  - getChannels
```
List<KaaDataChannel> getChannels()
```
    Retrieves the list of current channels.
    
    Returns:
    the channels' list.
    See Also:
    KaaDataChannel
  - getChannel
```
KaaDataChannel getChannel(String id)
```
    Retrieves channel by the unique channel id.
    
    Parameters:
    id - the channel's id.
    
    Returns:
    channel object.
    See Also:
    KaaDataChannel
  - onServerFailed
```
void onServerFailed(TransportConnectionInfo server)
```
    Reports to Channel Manager in case link with server was not established.
    
    Parameters:
    server - the parameters of server that was not connected.
    See Also:
    TransportConnectionInfo
  - clearChannelList
```
void clearChannelList()
```
    Clears the list of channels.
  - sync
```
void sync(org.kaaproject.kaa.common.TransportType type)
```
    Invoke sync on active channel by specified transport type
    
    Parameters:
    type -
  - syncAck
```
void syncAck(org.kaaproject.kaa.common.TransportType type)
```
    Invoke sync acknowledgement on active channel by specified transport type
    
    Parameters:
    type -
  - syncAll
```
void syncAll(org.kaaproject.kaa.common.TransportType type)
```
    Invoke sync acknowledgement on active channel
    
    Parameters:
    type - - type that is used to identify active channel
  - getActiveServer
```
TransportConnectionInfo getActiveServer(org.kaaproject.kaa.common.TransportType type)
```
    Returns information about server that is used for data transfer for specified TransportType
    
    Parameters:
    type - - type that is used to identify active channel
    
    Returns:
  - setFailoverManager
```
void setFailoverManager(FailoverManager failoverManager)
```
    Sets a new failover manager
    
    Parameters:
    failoverManager - the failover manager

Interface KaaChannelManager

Method Summary

Method Detail

setChannel

addChannel

removeChannel

removeChannel

getChannels

getChannel

onServerFailed

clearChannelList

sync

syncAck

syncAll

getActiveServer

setFailoverManager