In the normal course of affairs, clientDidLogon will
- * be called after the client successfully logs on to the server and
- * clientDidLogoff will be called after the client logs off
- * of the server. If logon fails for any reson,
- * clientFailedToLogon will be called to explain the failure.
+ *
In the normal course of affairs, {@link #clientDidLogon} will be called after the client + * successfully logs on to the server and {@link #clientDidLogoff} will be called after the client + * logs off of the server. If logon fails for any reson, {@link #clientFailedToLogon} will be + * called to explain the failure. * - *
clientWillLogoff will only be called when an abortable
- * logoff is requested (like when the user clicks on a logoff button of
- * some sort). It will not be called during non-abortable logoff requests
- * (like when the browser calls stop on the applet and is about to yank
- * the rug out from under us). If an observer aborts the logoff request,
- * it should notify the user in some way why the request was aborted
- * (but it shouldn't do so on the thread that calls
- * clientWillLogoff).
+ *
{@link #clientWillLogoff} will only be called when an abortable logoff is requested (like + * when the user clicks on a logoff button of some sort). It will not be called during + * non-abortable logoff requests (like when the browser calls stop on the applet and is about to + * yank the rug out from under us). If an observer aborts the logoff request, it should notify the + * user in some way why the request was aborted (but it shouldn't do so on the thread that + * calls {@link #clientWillLogoff}). * - *
If the client connection fails unexpectedly,
- * clientConnectionFailed will be called to let the
- * observers know that we lost our connection to the
- * server. clientDidLogoff will be called immediately
- * afterwards as a normal logoff procedure is effected.
+ *
If the client connection fails unexpectedly, {@link #clientConnectionFailed} will be called
+ * to let the observers know that we lost our connection to the server. {@link #clientDidLogoff}
+ * will be called immediately afterwards as a normal logoff procedure is effected.
*/
public interface ClientObserver extends SessionObserver
{
/**
- * 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.
+ * 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.
*
- * @param cause an exception indicating the cause of the logon failure.
- * Note: this may be a {@link LogonException} and if so, the
- * caller must check {@link 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).
+ * @param cause an exception indicating the cause of the logon failure. Note: this
+ * may be a {@link LogonException} and if so, the caller must check {@link
+ * 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).
*/
public void clientFailedToLogon (Client client, Exception cause);
/**
- * Called when the connection to the server went away for some
- * unexpected reason. This will be followed by a call to
- * clientDidLogoff.
+ * Called when the connection to the server went away for some unexpected reason. This will be
+ * followed by a call to {@link #clientDidLogoff}.
*/
public void clientConnectionFailed (Client client, Exception cause);
/**
- * Called when an abortable logoff request is made. If the observer
- * returns false from this method, the client will abort the logoff
- * request.
+ * Called when an abortable logoff request is made. If the observer returns false from this
+ * method, the client will abort the logoff request.
*/
public boolean clientWillLogoff (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. This will
- * only be called after an active session was terminated, not after a logon
- * attempt failed as that failure will be reported by {@link
+ * 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 {@link
* #clientFailedToLogon}.
*/
public void clientDidClear (Client client);
diff --git a/src/java/com/threerings/presents/client/SessionObserver.java b/src/java/com/threerings/presents/client/SessionObserver.java
index 7b30aef7d..f96b57e96 100644
--- a/src/java/com/threerings/presents/client/SessionObserver.java
+++ b/src/java/com/threerings/presents/client/SessionObserver.java
@@ -22,9 +22,8 @@
package com.threerings.presents.client;
/**
- * A session observer is registered with the client instance to be
- * notified when the client establishes and ends their session with the
- * server.
+ * A session observer is registered with the client instance to be notified when the client
+ * establishes and ends their session with the server.
*
* @see ClientObserver
*/
@@ -36,23 +35,20 @@ public interface SessionObserver
public void clientWillLogon (Client client);
/**
- * 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.
+ * 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.
*/
public void clientDidLogon (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.
+ * 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.
*/
public void clientObjectDidChange (Client client);
/**
- * Called after the client has been logged off of the server and has
- * disconnected.
+ * Called after the client has been logged off of the server and has disconnected.
*/
public void clientDidLogoff (Client client);
}