org.jwebsocket.kit

Enum CloseReason

java.lang.Object

java.lang.Enum<CloseReason>

org.jwebsocket.kit.CloseReason

All Implemented Interfaces:

Serializable, Comparable<CloseReason>

public enum CloseReason
extends Enum<CloseReason>

Enumeration to handle reasons for connection close.

Author:

aschulze

Enum Constant Summary

Enum Constants

Enum Constant and Description
BROKEN The connection was broken.
CLIENT The client closed the connection.
SERVER The server closed the connection.
SERVER_REDIRECT_CONNECTION The server redirect new connections
SERVER_REJECT_CONNECTION The server rejects the connection
SHUTDOWN The server was shut down.
TIMEOUT The session timeout exceeded.

Method Summary

Methods

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

BROKEN

public static final CloseReason BROKEN

The connection was broken.

TIMEOUT

public static final CloseReason TIMEOUT

The session timeout exceeded.

SERVER

public static final CloseReason SERVER

The server closed the connection.

CLIENT

public static final CloseReason CLIENT

The client closed the connection.

SHUTDOWN

public static final CloseReason SHUTDOWN

The server was shut down.

SERVER_REJECT_CONNECTION

public static final CloseReason SERVER_REJECT_CONNECTION

The server rejects the connection

SERVER_REDIRECT_CONNECTION

public static final CloseReason SERVER_REDIRECT_CONNECTION

The server redirect new connections

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public int getCode()