-
- All Implemented Interfaces:
-
java.io.Serializable,java.lang.Comparable
public enum ChannelStateDescribes the possible states of a Channel object.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description suspendedThe channel, having previously been ATTACHED, has lost continuity,usually due to the client being disconnected from Ably for longer than two minutes.It will automatically attempt to reattach as soon as connectivity is restored.
failedAn indefinite failure condition.This state is entered if a channel error has been received from the Ably service,such as an attempt to attach without the necessary access rights.
detachedThe channel, having previously been ATTACHED, has been detached by the user.
detachingA detach has been initiated on an ATTACHED channel by sending a request to Ably.This is a transient state, followed either by a transition to DETACHED or FAILED.
attachedThe attach has succeeded.In the ATTACHED state a client may publish and subscribe to messages, or be present on the channel.
attachingAn attach has been initiated by sending a request to Ably.This is a transient state, followed either by a transition to ATTACHED, SUSPENDED, or FAILED.
initializedThe channel has been initialized but no attach has yet been attempted.
-
Method Summary
Modifier and Type Method Description ChannelEventgetChannelEvent()booleanisReattachable()static Array<ChannelState>values()static ChannelStatevalueOf(String name)-
-
Method Detail
-
getChannelEvent
ChannelEvent getChannelEvent()
-
isReattachable
boolean isReattachable()
-
values
static Array<ChannelState> values()
-
valueOf
static ChannelState valueOf(String name)
-
-
-
-