Package com.linecorp.armeria.common.websocket

Enum Class WebSocketFrameType

java.lang.Object

java.lang.Enum<WebSocketFrameType>

com.linecorp.armeria.common.websocket.WebSocketFrameType

All Implemented Interfaces:

Serializable, Comparable<WebSocketFrameType>, Constable

@UnstableApi
public enum WebSocketFrameType
extends Enum<WebSocketFrameType>

Represents the WebSocketFrame types.

See Also:

• Base Framing Protocol, RFC 6455

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BINARY	A binary frame.
CLOSE	A close frame.
CONTINUATION	A continuation frame.
PING	A ping frame.
PONG	A pong frame.
TEXT	A text frame.

Method Summary

Modifier and Type	Method	Description
boolean	isControlFrame()	Tells whether this frame is one of CLOSE, PING, and PONG.
byte	opcode()	Returns the opcode of the frame.
static WebSocketFrameType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WebSocketFrameType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CONTINUATION

public static final WebSocketFrameType CONTINUATION

A continuation frame.

TEXT

public static final WebSocketFrameType TEXT

A text frame.

BINARY

public static final WebSocketFrameType BINARY

A binary frame.

CLOSE

public static final WebSocketFrameType CLOSE

A close frame.

PING

public static final WebSocketFrameType PING

A ping frame.

PONG

public static final WebSocketFrameType PONG

A pong frame.

Method Details

values

public static WebSocketFrameType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static WebSocketFrameType valueOf(String name)

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

NullPointerException - if the argument is null

opcode

public byte opcode()

Returns the opcode of the frame.

isControlFrame

public boolean isControlFrame()

Tells whether this frame is one of CLOSE, PING, and PONG.