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

Enum WebSocketHandler.WebSocketMessageType

java.lang.Object

java.lang.Enum<WebSocketHandler.WebSocketMessageType>

com.microsoft.azure.proton.transport.ws.WebSocketHandler.WebSocketMessageType

All Implemented Interfaces:

Serializable, Comparable<WebSocketHandler.WebSocketMessageType>

Enclosing interface:

WebSocketHandler

public static enum WebSocketHandler.WebSocketMessageType
extends Enum<WebSocketHandler.WebSocketMessageType>

States when parsing a frame.

Enum Constant Summary

Enum Constants

Enum Constant	Description
WEB_SOCKET_MESSAGE_TYPE_AMQP	Frame received is AMQP data.
WEB_SOCKET_MESSAGE_TYPE_CHUNK	Frame received is part of a multi-framed message.
WEB_SOCKET_MESSAGE_TYPE_CLOSE	Receiving has completed because a close message was received.
WEB_SOCKET_MESSAGE_TYPE_HEADER_CHUNK	Header frame received is part of a multi-framed message.
WEB_SOCKET_MESSAGE_TYPE_PING	Received a PING from the endpoint.
WEB_SOCKET_MESSAGE_TYPE_UNKNOWN	Unknown frame.

Method Summary

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

WEB_SOCKET_MESSAGE_TYPE_UNKNOWN

public static final WebSocketHandler.WebSocketMessageType WEB_SOCKET_MESSAGE_TYPE_UNKNOWN

Unknown frame.

WEB_SOCKET_MESSAGE_TYPE_CHUNK

public static final WebSocketHandler.WebSocketMessageType WEB_SOCKET_MESSAGE_TYPE_CHUNK

Frame received is part of a multi-framed message.

WEB_SOCKET_MESSAGE_TYPE_HEADER_CHUNK

public static final WebSocketHandler.WebSocketMessageType WEB_SOCKET_MESSAGE_TYPE_HEADER_CHUNK

Header frame received is part of a multi-framed message.

WEB_SOCKET_MESSAGE_TYPE_AMQP

public static final WebSocketHandler.WebSocketMessageType WEB_SOCKET_MESSAGE_TYPE_AMQP

Frame received is AMQP data.

WEB_SOCKET_MESSAGE_TYPE_PING

public static final WebSocketHandler.WebSocketMessageType WEB_SOCKET_MESSAGE_TYPE_PING

Received a PING from the endpoint.

WEB_SOCKET_MESSAGE_TYPE_CLOSE

public static final WebSocketHandler.WebSocketMessageType WEB_SOCKET_MESSAGE_TYPE_CLOSE

Receiving has completed because a close message was received.

Method Detail

values

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

Returns:

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

valueOf

public static WebSocketHandler.WebSocketMessageType 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