com.martiansoftware.nailgun

Enum NGClientDisconnectReason

java.lang.Object

java.lang.Enum<NGClientDisconnectReason>

com.martiansoftware.nailgun.NGClientDisconnectReason

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NGClientDisconnectReason>

public enum NGClientDisconnectReason
extends java.lang.Enum<NGClientDisconnectReason>

Used in NGClientListener callback to provide a reason why Nailgun server thinks that client is disconnected

Enum Constant Summary

Enum Constants

Enum Constant and Description
HEARTBEAT Thread reading from socket stream is blocked waiting for data for configured time.
INTERNAL_ERROR Some unexpected error happened
SESSION_SHUTDOWN Server is no longer reading from client because server itself signals shutdown
SOCKET_ERROR Some error encountered reading data from the socket
SOCKET_TIMEOUT Communication transport socket did not receive anything from the client within configured time.

Method Summary

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

SOCKET_TIMEOUT

public static final NGClientDisconnectReason SOCKET_TIMEOUT

Communication transport socket did not receive anything from the client within configured time. The time usually equals to heartbeat timeout.

HEARTBEAT

public static final NGClientDisconnectReason HEARTBEAT

Thread reading from socket stream is blocked waiting for data for configured time. The time usually equals to heartbeat timeout + 10% to allow socket to timeout first, if socket supports timeout natively.

SOCKET_ERROR

public static final NGClientDisconnectReason SOCKET_ERROR

Some error encountered reading data from the socket

SESSION_SHUTDOWN

public static final NGClientDisconnectReason SESSION_SHUTDOWN

Server is no longer reading from client because server itself signals shutdown

INTERNAL_ERROR

public static final NGClientDisconnectReason INTERNAL_ERROR

Some unexpected error happened

Method Detail

values

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

Returns:

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

valueOf

public static NGClientDisconnectReason valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null