com.threerings.presents.client

Class LogonException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.threerings.presents.client.LogonException

All Implemented Interfaces:

Serializable

public class LogonException
extends Exception

A logon exception is used to indicate a failure to log on to the server. The reason for failure is encoded as a string and stored in the message field of the exception.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LogonException(String code) Constructs a logon exception with the supplied logon failure code.
LogonException(String code, boolean stillInProgress) Constructs a logon exception with the supplied logon failure code.

Method Summary

Modifier and Type	Method and Description
boolean	isStillInProgress() Returns true if this exception is reporting an intermediate status rather than total logon failure.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LogonException

public LogonException(String code)

Constructs a logon exception with the supplied logon failure code.

LogonException

public LogonException(String code,
                      boolean stillInProgress)

Constructs a logon exception with the supplied logon failure code.

Parameters:

stillInProgress - indicates that the logon attempt has not totally failed, rather we are still trying but want to report that our initial attempt did not work and that we're falling back to alternative methods.

Method Detail

isStillInProgress

public boolean isStillInProgress()

Returns true if this exception is reporting an intermediate status rather than total logon failure. The client may be falling back to an alternative port or delaying an auto-retry attempt due to server overload. If this method returns true, the client should not allow additional calls to Client.logon() as the current attempt is still in progress.