Package com.github.twitch4j.client.websocket.domain

Enum Class WebsocketConnectionState

java.lang.Object

java.lang.Enum<WebsocketConnectionState>

com.github.twitch4j.client.websocket.domain.WebsocketConnectionState

All Implemented Interfaces:

Serializable, Comparable<WebsocketConnectionState>, Constable

public enum WebsocketConnectionState
extends Enum<WebsocketConnectionState>

The state of a WebsocketConnection.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONNECTED	The websocket has established a connection after completing the connection handshake procedure.
CONNECTING	The websocket has started its connection procedure after a call to WebsocketConnection.connect().
DISCONNECTED	The websocket is (deliberately) fully disconnected.
DISCONNECTING	The websocket is in the process of disconnecting after a call to WebsocketConnection.disconnect().
LOST	The websocket inadvertently lost connection.
RECONNECTING	The websocket has started its reconnection procedure after a call to WebsocketConnection.reconnect().

Method Summary

Modifier and Type	Method	Description
static WebsocketConnectionState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WebsocketConnectionState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DISCONNECTING

public static final WebsocketConnectionState DISCONNECTING

The websocket is in the process of disconnecting after a call to WebsocketConnection.disconnect().

RECONNECTING

public static final WebsocketConnectionState RECONNECTING

The websocket has started its reconnection procedure after a call to WebsocketConnection.reconnect().

DISCONNECTED

public static final WebsocketConnectionState DISCONNECTED

The websocket is (deliberately) fully disconnected.

This state will eventually be set after a call to WebsocketConnection.disconnect(). This is also the initial state upon creation of WebsocketConnection.

CONNECTING

public static final WebsocketConnectionState CONNECTING

The websocket has started its connection procedure after a call to WebsocketConnection.connect().

CONNECTED

public static final WebsocketConnectionState CONNECTED

The websocket has established a connection after completing the connection handshake procedure.

LOST

public static final WebsocketConnectionState LOST

The websocket inadvertently lost connection.

This could occur for a variety of reasons including: network issues, firewall changes, or even a server-side crash.

Method Details

values

public static WebsocketConnectionState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static WebsocketConnectionState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null