org.wso2.transport.http.netty.contract.websocket

Enum WebSocketControlSignal

java.lang.Object

java.lang.Enum<WebSocketControlSignal>

org.wso2.transport.http.netty.contract.websocket.WebSocketControlSignal

All Implemented Interfaces:

Serializable, Comparable<WebSocketControlSignal>

public enum WebSocketControlSignal
extends Enum<WebSocketControlSignal>

Control signals for WebSocket connection. These signals are the heartbeat signals of a WebSocket connection.

Enum Constant Summary

Enum Constants

Enum Constant and Description
IDLE_TIMEOUT Idle timeout indicator.
PING Heartbeat request signal.
PONG Heartbeat response signal.

Method Summary

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

PING

public static final WebSocketControlSignal PING

Heartbeat request signal.

PONG

public static final WebSocketControlSignal PONG

Heartbeat response signal.

IDLE_TIMEOUT

public static final WebSocketControlSignal IDLE_TIMEOUT

Idle timeout indicator.

Method Detail

values

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

Returns:

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

valueOf

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