Package com.microsoft.azure.proton.transport.ws

Enum WebSocket.WebSocketState

java.lang.Object

java.lang.Enum<WebSocket.WebSocketState>

com.microsoft.azure.proton.transport.ws.WebSocket.WebSocketState

All Implemented Interfaces:

Serializable, Comparable<WebSocket.WebSocketState>

Enclosing interface:

WebSocket

public static enum WebSocket.WebSocketState
extends Enum<WebSocket.WebSocketState>

States that the web socket can be in.

Enum Constant Summary

Enum Constants

Enum Constant	Description
PN_WS_CLOSED	Connection closed.
PN_WS_CONNECTED_CLOSING	Connected and received a close.
PN_WS_CONNECTED_FLOW	Connected and messages flow.
PN_WS_CONNECTED_PONG	Connected and ping-pong.
PN_WS_CONNECTING	Pending connection.
PN_WS_FAILED	Connection failed.
PN_WS_NOT_STARTED	WebSocket.

Method Summary

Modifier and Type	Method	Description
static WebSocket.WebSocketState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static WebSocket.WebSocketState[]	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

PN_WS_NOT_STARTED

public static final WebSocket.WebSocketState PN_WS_NOT_STARTED

WebSocket.

PN_WS_CONNECTING

public static final WebSocket.WebSocketState PN_WS_CONNECTING

Pending connection.

PN_WS_CONNECTED_FLOW

public static final WebSocket.WebSocketState PN_WS_CONNECTED_FLOW

Connected and messages flow.

PN_WS_CONNECTED_PONG

public static final WebSocket.WebSocketState PN_WS_CONNECTED_PONG

Connected and ping-pong.

PN_WS_CONNECTED_CLOSING

public static final WebSocket.WebSocketState PN_WS_CONNECTED_CLOSING

Connected and received a close.

PN_WS_CLOSED

public static final WebSocket.WebSocketState PN_WS_CLOSED

Connection closed.

PN_WS_FAILED

public static final WebSocket.WebSocketState PN_WS_FAILED

Connection failed.

Method Detail

values

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

Returns:

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

valueOf

public static WebSocket.WebSocketState 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