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

Enum WebSocket.WebSocketFrameReadState

java.lang.Object

java.lang.Enum<WebSocket.WebSocketFrameReadState>

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

All Implemented Interfaces:

Serializable, Comparable<WebSocket.WebSocketFrameReadState>

Enclosing interface:

WebSocket

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

States for the web socket when reading from the underlying buffer.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHUNK_READ	Reading chunks of bytes until a full header is read.
CONTINUED_FRAME_READ	Continue reading bytes until correct number of bytes are read.
HEADER_READ	Full header has been read.
INIT_READ	The initial read.
READ_ERROR	An error reading.

Method Summary

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

INIT_READ

public static final WebSocket.WebSocketFrameReadState INIT_READ

The initial read.

CHUNK_READ

public static final WebSocket.WebSocketFrameReadState CHUNK_READ

Reading chunks of bytes until a full header is read.

CONTINUED_FRAME_READ

public static final WebSocket.WebSocketFrameReadState CONTINUED_FRAME_READ

Continue reading bytes until correct number of bytes are read.

HEADER_READ

public static final WebSocket.WebSocketFrameReadState HEADER_READ

Full header has been read.

READ_ERROR

public static final WebSocket.WebSocketFrameReadState READ_ERROR

An error reading.

Method Detail

values

public static WebSocket.WebSocketFrameReadState[] 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.WebSocketFrameReadState c : WebSocket.WebSocketFrameReadState.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.WebSocketFrameReadState 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