io.ably.lib.realtime

Interface AblyRealtime.Channels

All Superinterfaces:

ReadOnlyMap<java.lang.String,Channel>

Enclosing class:

AblyRealtime

public static interface AblyRealtime.Channels
extends ReadOnlyMap<java.lang.String,Channel>

A collection of Channels associated with this Ably Realtime instance.

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	release(java.lang.String channelName) Remove this channel from this AblyRealtime instance.

Methods inherited from interface io.ably.lib.types.ReadOnlyMap

containsKey, containsValue, entrySet, get, isEmpty, keySet, size, values

Method Detail

get

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

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

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 - the name of the channel