sfs2x.client.util
Class ClientDisconnectionReason

java.lang.Object
  extended by sfs2x.client.util.ClientDisconnectionReason

public class ClientDisconnectionReason
extends java.lang.Object

The ClientDisconnectionReason class contains the constants describing the possible reasons why a disconnection from the server occurred.


Field Summary
static java.lang.String BAN
          Client was banned from the server.
static java.lang.String IDLE
          Client was disconnected because it was idle for too long.
static java.lang.String KICK
          Client was kicked out of the server.
static java.lang.String MANUAL
          The client manually disconnected from the server.
static java.lang.String UNKNOWN
          A generic network error occurred, and the client is unable to determine the cause of the disconnection.
 
Constructor Summary
ClientDisconnectionReason()
           
 
Method Summary
static java.lang.String getReason(int reasonId)
          * API internal usage only *
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

IDLE

public static final java.lang.String IDLE
Client was disconnected because it was idle for too long. The connection timeout depends on the server settings.

See Also:
Constant Field Values

KICK

public static final java.lang.String KICK
Client was kicked out of the server. Kicking can occur automatically (i.e. for swearing, if the words filter is active) or due to the intervention of a user with enough privileges (i.e. an administrator or a moderator).

See Also:
Constant Field Values

BAN

public static final java.lang.String BAN
Client was banned from the server. Banning can occur automatically (i.e. for flooding, if the flood filter is active) or due to the intervention of a user with enough privileges (i.e. an administrator or a moderator).

See Also:
Constant Field Values

MANUAL

public static final java.lang.String MANUAL
The client manually disconnected from the server. The disconnect method on the SmartFox class was called.

See Also:
Constant Field Values

UNKNOWN

public static final java.lang.String UNKNOWN
A generic network error occurred, and the client is unable to determine the cause of the disconnection. The server-side log should be checked for possible error messages or warnings.

See Also:
Constant Field Values
Constructor Detail

ClientDisconnectionReason

public ClientDisconnectionReason()
Method Detail

getReason

public static java.lang.String getReason(int reasonId)
* API internal usage only *