Annotate some of these methods since PresentsClient is one place where we have

to do our little dance on different threads.


git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@5401 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Michael Bayne
2008-09-29 18:00:15 +00:00
parent 657aafaedb
commit 053c179f69
@@ -281,7 +281,7 @@ public class PresentsClient
} }
/** /**
* Returns the client object that is associated with this client. * returns the client object that is associated with this client.
*/ */
public ClientObject getClientObject () public ClientObject getClientObject ()
{ {
@@ -291,6 +291,7 @@ public class PresentsClient
/** /**
* Forcibly terminates a client's session. This must be called from the dobjmgr thread. * Forcibly terminates a client's session. This must be called from the dobjmgr thread.
*/ */
@EventThread
public void endSession () public void endSession ()
{ {
// queue up a request for our connection to be closed (if we have a connection, that is) // queue up a request for our connection to be closed (if we have a connection, that is)
@@ -493,6 +494,7 @@ public class PresentsClient
* This is called from the dobjmgr thread to complete the session resumption. We call some call * This is called from the dobjmgr thread to complete the session resumption. We call some call
* backs and send the bootstrap info to the client. * backs and send the bootstrap info to the client.
*/ */
@EventThread
protected void finishResumeSession () protected void finishResumeSession ()
{ {
// if we have no client object for whatever reason; we're hosed, shut ourselves down // if we have no client object for whatever reason; we're hosed, shut ourselves down
@@ -514,6 +516,7 @@ public class PresentsClient
/** /**
* Queues up a runnable on the object manager thread where we can safely end the session. * Queues up a runnable on the object manager thread where we can safely end the session.
*/ */
@AnyThread
protected void safeEndSession () protected void safeEndSession ()
{ {
_omgr.postRunnable(new Runnable() { _omgr.postRunnable(new Runnable() {
@@ -583,6 +586,7 @@ public class PresentsClient
* <p><em>Note:</em> This function will be called on the dobjmgr thread which means that object * <p><em>Note:</em> This function will be called on the dobjmgr thread which means that object
* manipulations are OK, but client instance manipulations must done carefully. * manipulations are OK, but client instance manipulations must done carefully.
*/ */
@EventThread
protected void sessionWillStart () protected void sessionWillStart ()
{ {
// configure a specific access controller for the client object // configure a specific access controller for the client object
@@ -598,6 +602,7 @@ public class PresentsClient
* <p><em>Note:</em> This function will be called on the dobjmgr thread which means that object * <p><em>Note:</em> This function will be called on the dobjmgr thread which means that object
* manipulations are OK, but client instance manipulations must done carefully. * manipulations are OK, but client instance manipulations must done carefully.
*/ */
@EventThread
protected void sessionWillResume () protected void sessionWillResume ()
{ {
} }
@@ -610,6 +615,7 @@ public class PresentsClient
* <p><em>Note:</em> This function will be called on the dobjmgr thread which means that object * <p><em>Note:</em> This function will be called on the dobjmgr thread which means that object
* manipulations are OK, but client instance manipulations must done carefully. * manipulations are OK, but client instance manipulations must done carefully.
*/ */
@EventThread
protected void sessionDidEnd () protected void sessionDidEnd ()
{ {
// clear out our subscriptions so that we don't get a complaint about inability to forward // clear out our subscriptions so that we don't get a complaint about inability to forward
@@ -620,6 +626,7 @@ public class PresentsClient
/** /**
* Called to inform derived classes when the client has subscribed to a distributed object. * Called to inform derived classes when the client has subscribed to a distributed object.
*/ */
@EventThread
protected void subscribedToObject (DObject object) protected void subscribedToObject (DObject object)
{ {
} }
@@ -627,6 +634,7 @@ public class PresentsClient
/** /**
* Called to inform derived classes when the client has unsubscribed from a distributed object. * Called to inform derived classes when the client has unsubscribed from a distributed object.
*/ */
@EventThread
protected void unsubscribedFromObject (DObject object) protected void unsubscribedFromObject (DObject object)
{ {
} }
@@ -710,6 +718,7 @@ public class PresentsClient
* closed and unmapped. If the user logged off before closing their connection, this will be * closed and unmapped. If the user logged off before closing their connection, this will be
* preceded by a call to {@link #sessionDidEnd}. * preceded by a call to {@link #sessionDidEnd}.
*/ */
@EventThread
protected void sessionConnectionClosed () protected void sessionConnectionClosed ()
{ {
// clear out our dobj subscriptions in case they weren't cleared by a call to sessionDidEnd // clear out our dobj subscriptions in case they weren't cleared by a call to sessionDidEnd