Package 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	Description
Channel	get(java.lang.String channelName)	Creates a new Channel object, or returns the existing channel object.
Channel	get(java.lang.String channelName, ChannelOptions channelOptions)	Creates a new Channel object, with the specified ChannelOptions, or returns the existing channel object.
void	release(java.lang.String channelName)	Releases a Channel object, deleting it, and enabling it to be garbage collected.

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)

Creates a new Channel object, or returns the existing channel object.

Spec: RSN3a, RTS3a

Parameters:

channelName - The channel name.

Returns:

A Channel object.

get

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

Creates a new Channel object, with the specified ChannelOptions, or returns the existing channel object.

Spec: RSN3c, RTS3c

Parameters:

channelName - The channel name.

channelOptions - A ChannelOptions object.

Returns:

A Channel object.

Throws:

AblyException

release

void release(java.lang.String channelName)

Releases a Channel object, deleting it, and enabling it to be garbage collected. It also removes any listeners associated with the channel. To release a channel, the ChannelState must be INITIALIZED, DETACHED, or FAILED.

Spec: RSN4, RTS4

Parameters:

channelName - The channel name.