org.jwebsocket.api

Enum WebSocketStatus

java.lang.Object

java.lang.Enum<WebSocketStatus>

org.jwebsocket.api.WebSocketStatus

All Implemented Interfaces:

Serializable, Comparable<WebSocketStatus>

public enum WebSocketStatus
extends Enum<WebSocketStatus>

WebSocket connection status. These status values are based on HTML5 WebSocket API specification http://dev.w3.org/html5/websockets/#websocket

Author:

puran, aschulze

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHENTICATED The connection is established and authenticated.
CLOSED The connection has been closed or could not be opened.
CLOSING The connection is going through the closing handshake.
CONNECTING The connection has not yet been established.
OPEN The WebSocket connection is established and communication is possible
RECONNECTING The connection manager is trying to re-connect, but not yet connected.

Method Summary

Methods

Modifier and Type	Method and Description
int	getStatus()
boolean	isAuthenticated()
boolean	isClosable()
boolean	isClosed()
boolean	isConnected()
boolean	isWritable()
static WebSocketStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static WebSocketStatus[]	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 WebSocketStatus CONNECTING

The connection has not yet been established.

OPEN

public static final WebSocketStatus OPEN

The WebSocket connection is established and communication is possible

CLOSING

public static final WebSocketStatus CLOSING

The connection is going through the closing handshake.

CLOSED

public static final WebSocketStatus CLOSED

The connection has been closed or could not be opened.

RECONNECTING

public static final WebSocketStatus RECONNECTING

The connection manager is trying to re-connect, but not yet connected. This is jWebSocket specific and not part of the W3C API.

AUTHENTICATED

public static final WebSocketStatus AUTHENTICATED

The connection is established and authenticated. This is jWebSocket specific and not part of the W3C API.

Method Detail

values

public static WebSocketStatus[] 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 (WebSocketStatus c : WebSocketStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static WebSocketStatus 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

getStatus

public int getStatus()

Returns:

the status int value

isWritable

public boolean isWritable()

Returns:

isConnected

public boolean isConnected()

Returns:

isAuthenticated

public boolean isAuthenticated()

Returns:

isClosable

public boolean isClosable()

Returns:

isClosed

public boolean isClosed()

Returns: