com.threerings.presents.client

Class ClientAdapter

java.lang.Object

com.threerings.presents.client.ClientAdapter

All Implemented Interfaces:

ClientObserver, SessionObserver

public class ClientAdapter
extends Object
implements ClientObserver

The client adapter makes life easier for client observer classes that only care about one or two of the client observer callbacks. They can either extend client adapter or create an anonymous class that extends it and overrides just the callbacks they care about.

Note that the client adapter defaults to always ratifying a call to clientWillLogoff(com.threerings.presents.client.Client) by returning true.

Constructor Summary

Constructors

Constructor and Description
ClientAdapter()

Method Summary

Modifier and Type	Method and Description
void	clientConnectionFailed(Client client, Exception cause) Called when the connection to the server went away for some unexpected reason.
void	clientDidClear(Client client) Called after the client is completely logged off from a successful session and is ready to reconnect to a new server if desired.
void	clientDidLogoff(Client client) Called after the client has been logged off of the server and has disconnected.
void	clientDidLogon(Client client) Called after the client successfully connected to and authenticated with the server.
void	clientFailedToLogon(Client client, Exception cause) Called if anything fails during the logon attempt.
void	clientObjectDidChange(Client client) For systems that allow switching screen names after logon, this method is called whenever a screen name change takes place to report that the client object has been replaced to potential client-side subscribers.
boolean	clientWillLogoff(Client client) Called when an abortable logoff request is made.
void	clientWillLogon(Client client) Called immediately before a logon is attempted.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientAdapter

public ClientAdapter()

Method Detail

clientWillLogon

public void clientWillLogon(Client client)

Description copied from interface: SessionObserver

Called immediately before a logon is attempted.

Specified by:

clientWillLogon in interface SessionObserver

clientDidLogon

public void clientDidLogon(Client client)

Description copied from interface: SessionObserver

Called after the client successfully connected to and authenticated with the server. The entire object system is up and running by the time this method is called.

Specified by:

clientDidLogon in interface SessionObserver

clientFailedToLogon

public void clientFailedToLogon(Client client,
                                Exception cause)

Description copied from interface: ClientObserver

Called if anything fails during the logon attempt. This could be a network failure, authentication failure or otherwise. The exception provided will indicate the cause of the failure.

Specified by:

clientFailedToLogon in interface ClientObserver

cause - an exception indicating the cause of the logon failure. Note: this may be a LogonException and if so, the caller must check LogonException.isStillInProgress() to find out if the logon process has totally failed or if we are simply reporting intermediate status (we might be falling back to an alternative port or delaying our auto-retry attempt due to server overload).

clientObjectDidChange

public void clientObjectDidChange(Client client)

Description copied from interface: SessionObserver

For systems that allow switching screen names after logon, this method is called whenever a screen name change takes place to report that the client object has been replaced to potential client-side subscribers.

Specified by:

clientObjectDidChange in interface SessionObserver

clientConnectionFailed

public void clientConnectionFailed(Client client,
                                   Exception cause)

Description copied from interface: ClientObserver

Called when the connection to the server went away for some unexpected reason. This will be followed by a call to SessionObserver.clientDidLogoff(com.threerings.presents.client.Client).

Specified by:

clientConnectionFailed in interface ClientObserver

clientWillLogoff

public boolean clientWillLogoff(Client client)

Description copied from interface: ClientObserver

Called when an abortable logoff request is made. If the observer returns false from this method, the client will abort the logoff request.

Specified by:

clientWillLogoff in interface ClientObserver

clientDidLogoff

public void clientDidLogoff(Client client)

Description copied from interface: SessionObserver

Called after the client has been logged off of the server and has disconnected.

Specified by:

clientDidLogoff in interface SessionObserver

clientDidClear

public void clientDidClear(Client client)

Description copied from interface: ClientObserver

Called after the client is completely logged off from a successful session and is ready to reconnect to a new server if desired. This will only be called after an active session was terminated, not after a logon attempt failed as that failure will be reported by ClientObserver.clientFailedToLogon(com.threerings.presents.client.Client, java.lang.Exception).

Specified by:

clientDidClear in interface ClientObserver