KaaChannelManager Protocol Reference
Declared in | KaaChannelManager.h |
---|
Overview
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.
– setChannel:withType:
required method
Updates the manager by setting the channel to the specified transport type.
- (void)setChannel:(id<KaaDataChannel>)channel withType:(TransportType)type
Discussion
Updates the manager by setting the channel to the specified transport type.
Declared In
KaaChannelManager.h
– addChannel:
required method
Updates the manager by adding the channel.
- (void)addChannel:(id<KaaDataChannel>)channel
Discussion
Updates the manager by adding the channel.
Declared In
KaaChannelManager.h
– removeChannel:
required method
Updates the manager by removing the channel from the manager.
- (void)removeChannel:(id<KaaDataChannel>)channel
Discussion
Updates the manager by removing the channel from the manager.
Declared In
KaaChannelManager.h
– removeChannelById:
required method
Removes channel by the unique channel id.
- (void)removeChannelById:(NSString *)channelId
Discussion
Removes channel by the unique channel id.
Declared In
KaaChannelManager.h
– getChannels
required method
Retrieves the list of current channels.
- (NSArray *)getChannels
Discussion
Retrieves the list of current channels.
Declared In
KaaChannelManager.h
– getChannelById:
required method
Retrieves channel by the unique channel id.
- (id<KaaDataChannel>)getChannelById:(NSString *)channelId
Discussion
Retrieves channel by the unique channel id.
Declared In
KaaChannelManager.h
– onServerFailedWithConnectionInfo:failoverStatus:
required method
Reports to Channel Manager in case link with server was not established.
- (void)onServerFailedWithConnectionInfo:(id<TransportConnectionInfo>)server failoverStatus:(FailoverStatus)status
Parameters
server |
the parameters of server that was not connected. |
---|---|
status |
failover status that reports connection issue. |
Discussion
Reports to Channel Manager in case link with server was not established.
See Also
Declared In
KaaChannelManager.h
– clearChannelList
required method
Clears the list of channels.
- (void)clearChannelList
Discussion
Clears the list of channels.
Declared In
KaaChannelManager.h
– syncForTransportType:
required method
Invoke sync on active channel by specified transport type.
- (void)syncForTransportType:(TransportType)type
Discussion
Invoke sync on active channel by specified transport type.
Declared In
KaaChannelManager.h
– syncAckForTransportType:
required method
Invoke sync acknowledgement on active channel by specified transport type;
- (void)syncAckForTransportType:(TransportType)type
Discussion
Invoke sync acknowledgement on active channel by specified transport type;
Declared In
KaaChannelManager.h
– syncAll:
required method
Invoke sync acknowledgement on active channel;
- (void)syncAll:(TransportType)type
Parameters
type |
transport type that is used to identify active channel. |
---|
Discussion
Invoke sync acknowledgement on active channel;
Declared In
KaaChannelManager.h
– getActiveServerForType:
required method
Returns information about server that is used for data transfer for specified TransportType.
- (id<TransportConnectionInfo>)getActiveServerForType:(TransportType)type
Discussion
Returns information about server that is used for data transfer for specified TransportType.
Declared In
KaaChannelManager.h
– setFailoverManager:
required method
Sets a new failover manager
- (void)setFailoverManager:(id<FailoverManager>)failoverManager
Discussion
Sets a new failover manager
Declared In
KaaChannelManager.h