io.ably.lib.realtime

Class AblyRealtime.Channels

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.String,Channel>

io.ably.lib.realtime.AblyRealtime.Channels

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,Channel>

Enclosing class:

AblyRealtime

public class AblyRealtime.Channels
extends java.util.HashMap<java.lang.String,Channel>

A collection of the Channels associated with this Realtime instance.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Channels()

Method Summary

Modifier and Type	Method and Description
Channel	get(java.lang.String channelName) Get the named channel; if it does not already exist, create it with default options.
Channel	get(java.lang.String channelName, ChannelOptions channelOptions) Get the named channel and set the given options, creating it if it does not already exist.
void	onChannelMessage(ITransport transport, ProtocolMessage msg)
void	release(java.lang.String channelName) Remove this channel from this AblyRealtime instance.
void	suspendAll(ErrorInfo error)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

Channels

public Channels()

Method Detail

get

public Channel get(java.lang.String channelName)

Get the named channel; if it does not already exist, create it with default options.

Parameters:

channelName - the name of the channel

Returns:

the channel

get

public Channel get(java.lang.String channelName,
                   ChannelOptions channelOptions)
            throws AblyException

Get the named channel and set the given options, creating it if it does not already exist.

Parameters:

channelName - the name of the channel

channelOptions - the options to set (null to clear options on an existing channel)

Returns:

the channel

Throws:

AblyException

release

public void release(java.lang.String channelName)

Remove this channel from this AblyRealtime instance. This detaches from the channel and releases all other resources associated with the channel in this client. This silently does nothing if the channel does not already exist.

Parameters:

channelName -

onChannelMessage

public void onChannelMessage(ITransport transport,
                             ProtocolMessage msg)

suspendAll

public void suspendAll(ErrorInfo error)