org.eclipse.jetty.websocket.common

Enum ConnectionState

java.lang.Object

java.lang.Enum<ConnectionState>

org.eclipse.jetty.websocket.common.ConnectionState

All Implemented Interfaces:

Serializable, Comparable<ConnectionState>

public enum ConnectionState
extends Enum<ConnectionState>

Connection states as outlined in RFC6455.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED [RFC] The websocket connection is closed.
CLOSING [RFC] The websocket closing handshake is started.
CONNECTED [Impl] Intermediate state between CONNECTING and OPEN, used to indicate that a upgrade request/response is successful, but the end-user provided socket's onOpen code has yet to run.
CONNECTING [RFC] Initial state of a connection, the upgrade request / response is in progress
OPEN [RFC] The websocket connection is established and open.

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONNECTING

public static final ConnectionState CONNECTING

[RFC] Initial state of a connection, the upgrade request / response is in progress

CONNECTED

public static final ConnectionState CONNECTED

[Impl] Intermediate state between CONNECTING and OPEN, used to indicate that a upgrade request/response is successful, but the end-user provided socket's onOpen code has yet to run.

This state is to allow the local socket to initiate messages and frames, but to NOT start reading yet.

OPEN

public static final ConnectionState OPEN

[RFC] The websocket connection is established and open.

This indicates that the Upgrade has succeed, and the end-user provided socket's onOpen code has completed.

It is now time to start reading from the remote endpoint.

CLOSING

public static final ConnectionState CLOSING

[RFC] The websocket closing handshake is started.

This can be considered a half-closed state.

When receiving this as an event on ConnectionStateListener#onConnectionStateChange(ConnectionState) a close frame should be sent using the CloseInfo available from IOState#getCloseInfo()

CLOSED

public static final ConnectionState CLOSED

[RFC] The websocket connection is closed.

Connection should be disconnected and no further reads or writes should occur.

Method Detail

values

public static ConnectionState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConnectionState c : ConnectionState.values())
    System.out.println(c);

Returns:

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

valueOf

public static ConnectionState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null