Package com.smartfoxserver.util

Enum Class ClientDisconnectionReason

java.lang.Object

java.lang.Enum<ClientDisconnectionReason>

com.smartfoxserver.util.ClientDisconnectionReason

All Implemented Interfaces:

IDisconnectionReason, Serializable, Comparable<ClientDisconnectionReason>, Constable

public enum ClientDisconnectionReason
extends Enum<ClientDisconnectionReason>
implements IDisconnectionReason

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
BAN	The client was banned (by a mod or admin User)
IDLE	The connection was closed after the Client has been idle for too long.
KICK	The client was kicked (by a mod or admin User)
UNKNOWN	It wasn't possible to detect the cause of disconnection.

Method Summary

Modifier and Type	Method	Description
byte	getByteValue()
int	getValue()
static ClientDisconnectionReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ClientDisconnectionReason[]	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

IDLE

public static final ClientDisconnectionReason IDLE

The connection was closed after the Client has been idle for too long. This depends on the maxUserIdleTime value configured in the Zone.

KICK

public static final ClientDisconnectionReason KICK

The client was kicked (by a mod or admin User)

BAN

public static final ClientDisconnectionReason BAN

The client was banned (by a mod or admin User)

UNKNOWN

public static final ClientDisconnectionReason UNKNOWN

It wasn't possible to detect the cause of disconnection. This is likely due to a network error

Method Details

values

public static ClientDisconnectionReason[] 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 ClientDisconnectionReason 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

getValue

public int getValue()

Specified by:

getValue in interface IDisconnectionReason

getByteValue

public byte getByteValue()

Specified by:

getByteValue in interface IDisconnectionReason