AfflictionNetworks/narya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

The great Interval revamp.

Browse Source 
There is no more SafeInterval, instead Intervals can be constructed with a RunQueue to use for expiring.
PresentsDObjectMgr implements RunQueue.
Client has a getRunQueue() method to get the client side RunQueue.


git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@3283 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Ray Greenwell
2004-12-22 19:23:00 +00:00
parent 8ee6cb6fae
commit bd80c348eb
22 changed files with 199 additions and 391 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/java/com/threerings/presents/client/Client.java
+26 -42
View File
@@ -22,9 +22,9 @@
package com.threerings.presents.client;
import com.samskivert.util.Interval;
import com.samskivert.util.IntervalManager;
import com.samskivert.util.ObserverList;
import com.samskivert.util.RunAnywhere;
import com.samskivert.util.RunQueue;
import com.threerings.presents.Log;
import com.threerings.presents.data.ClientObject;
@@ -46,42 +46,28 @@ public class Client
* connections. */
public static final int DEFAULT_SERVER_PORT = 4007;
/**
* This is used by the client to allow dobj event dispatching to take
* place along side the activities of the rest of the application
* (usually this means running dobj events on the AWT thread).
*/
public static interface Invoker
{
/**
* Requests that the supplied runnable be queued up for invocation
* on the main event dispatching thread of the application.
*/
public void invokeLater (Runnable run);
}
/**
* Constructs a client object with the supplied credentials and
* invoker. The creds will be used to authenticate with any server to
* which this client attempts to connect. The invoker is used to
* RunQueue. The creds will be used to authenticate with any server to
* which this client attempts to connect. The RunQueue is used to
* operate the distributed object event dispatch mechanism. To allow
* the dobj event dispatch to coexist with threads like the AWT
* thread, the client will request that the invoker queue up a
* thread, the client will request that the RunQueue queue up a
* runnable whenever there are distributed object events that need to
* be processed. The invoker can then queue that runnable up on the
* be processed. The RunQueue can then queue that runnable up on the
* AWT thread if it is so inclined to make life simpler for the rest
* of the application.
*
* @param creds the credentials to use when logging on to the server.
* These can be null, but <code>setCredentials</code> must then be
* called before any call to <code>logon</code>.
* @param invoker an invoker that can be used to process incoming
* @param runQueue a RunQueue that can be used to process incoming
* events.
*/
public Client (Credentials creds, Invoker invoker)
public Client (Credentials creds, RunQueue runQueue)
{
_creds = creds;
_invoker = invoker;
_runQueue = runQueue;
}
/**
@@ -125,12 +111,12 @@ public class Client
}
/**
* Returns the invoker in use by this client. This can be used to
* Returns the RunQueue in use by this client. This can be used to
* queue up event dispatching stints.
*/
public Invoker getInvoker ()
public RunQueue getRunQueue ()
{
return _invoker;
return _runQueue;
}
/**
@@ -369,15 +355,12 @@ public class Client
// register an interval that we'll use to keep the clock synced
// and to send pings when appropriate
_piid = IntervalManager.register(new Interval() {
public void intervalExpired (int id, Object arg) {
if (id != _piid) {
IntervalManager.remove(id);
} else {
tick();
}
_tickInterval = new Interval() {
public void expired () {
tick();
}
}, 5000L, null, true);
};
_tickInterval.schedule(5000L, true);
}
/**
@@ -408,7 +391,8 @@ public class Client
}
// kill our tick interval
_piid = -1;
_tickInterval.cancel();
_tickInterval = null;
// ask the communicator to send a logoff message and disconnect
// from the server
@@ -517,17 +501,17 @@ public class Client
};
// we need to run immediately if this is WILL_LOGOFF or if we have
// no invoker (which currently only happens in some really obscure
// no RunQueue (which currently only happens in some really obscure
// circumstances where we're using a Client instance on the server
// so that we can sort of pretend to be a real client)
if (code == CLIENT_WILL_LOGOFF || _invoker == null) {
if (code == CLIENT_WILL_LOGOFF || _runQueue == null) {
unit.run();
return noty.getRejected();
} else {
// otherwise we can queue this notification up with our
// invoker and ensure that it's run on the proper thread
_invoker.invokeLater(unit);
// RunQueue and ensure that it's run on the proper thread
_runQueue.postRunnable(unit);
return false;
}
}
@@ -537,10 +521,10 @@ public class Client
// we know that prior to the call to this method, the observers
// were notified with CLIENT_DID_LOGOFF; that may not have been
// invoked yet, so we don't want to clear out our communicator
// reference immediately; instead we queue up an invoker unit to
// reference immediately; instead we queue up a runnable unit to
// do so to ensure that it won't happen until CLIENT_DID_LOGOFF
// was dispatched
_invoker.invokeLater(new Runnable() {
_runQueue.postRunnable(new Runnable() {
public void run () {
// clear out our references
_comm = null;
@@ -677,7 +661,7 @@ public class Client
/** An entity that gives us the ability to process events on the main
* client thread (which is also the AWT thread). */
protected Invoker _invoker;
protected RunQueue _runQueue;
/** The data associated with our authentication response. */
protected AuthResponseData _authData;
@@ -723,7 +707,7 @@ public class Client
protected long _lastSync;
/** Our tick interval id. */
protected int _piid = -1;
protected Interval _tickInterval;
/** How often we recompute our time offset from the server. */
protected static final long CLOCK_SYNC_INTERVAL = 600 * 1000L;
src/java/com/threerings/presents/client/ClientDObjectMgr.java
+7 -8
View File
@@ -1,5 +1,5 @@
//
// $Id: ClientDObjectMgr.java,v 1.26 2004/08/27 02:20:17 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -32,10 +32,9 @@ import com.samskivert.util.DebugChords;
import com.samskivert.util.HashIntMap;
import com.samskivert.util.Queue;
import com.samskivert.util.StringUtil;
import com.samskivert.util.IntervalManager;
import com.samskivert.util.Interval;
import com.threerings.presents.Log;
import com.threerings.presents.client.util.SafeInterval;
import com.threerings.presents.dobj.*;
import com.threerings.presents.net.*;
@@ -68,11 +67,11 @@ public class ClientDObjectMgr
DUMP_OTABLE_MODMASK, DUMP_OTABLE_KEYCODE, DUMP_OTABLE_HOOK);
// register a flush interval
IntervalManager.register(new SafeInterval(client) {
public void run () {
new Interval(client.getRunQueue()) {
public void expired () {
flushObjects();
}
}, FLUSH_INTERVAL, null, true);
}.schedule(FLUSH_INTERVAL, true);
}
// documentation inherited from interface
@@ -111,7 +110,7 @@ public class ClientDObjectMgr
// queue up an action
_actions.append(new ObjectAction(oid, target, subscribe));
// and queue up the omgr to get invoked on the invoker thread
_client.getInvoker().invokeLater(this);
_client.getRunQueue().postRunnable(this);
}
// inherit documentation from the interface
@@ -170,7 +169,7 @@ public class ClientDObjectMgr
// append it to our queue
_actions.append(msg);
// and queue ourselves up to be run
_client.getInvoker().invokeLater(this);
_client.getRunQueue().postRunnable(this);
}
/**
src/java/com/threerings/presents/client/util/SafeInterval.java
-76
View File
@@ -1,76 +0,0 @@
//
// $Id: SafeInterval.java,v 1.4 2004/08/27 02:20:18 mdb Exp $
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
// http://www.threerings.net/code/narya/
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package com.threerings.presents.client.util;
import com.samskivert.util.Interval;
import com.threerings.presents.client.Client;
/**
* Used in conjunction with the {@link Client}, this class provides a
* means by which code can be run on the client main thread at some point
* in the future, either as a recurring interval or as a one shot deal.
* The code is built on top of the {@link IntervalManager} services.
*
* <p> A {@link SafeInterval} instance should be created and then
* scheduled to run using the {@link IntervalManager}. For example:
*
* <pre>
* IntervalManager.register(new SafeInterval(_ctx.getClient()) {
* public void run () {
* System.out.println("Foo!");
* }
* }, 25L * 1000L, null, false);
* </pre>
*/
public abstract class SafeInterval
implements Runnable, Interval
{
/**
* Creates a safe interval instance that will queue itself up for
* execution using the supplied client when it expires.
*/
public SafeInterval (Client client)
{
_client = client;
}
/**
* Called (on the client main thread) when the interval period has
* expired. If this is a recurring interval, this method will be
* called each time the interval expires.
*/
public abstract void run ();
/** Handles the proper scheduling and queueing. */
public void intervalExpired (int id, Object arg)
{
_iid = id;
_client.getInvoker().invokeLater(this);
}
/** The client via which we queue ourselves when we expire. */
protected Client _client;
/** Configured with our current interval id when we are triggered. */
protected int _iid;
}
src/java/com/threerings/presents/server/ClientManager.java
+4 -5
View File
@@ -27,7 +27,7 @@ import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import com.samskivert.util.IntervalManager;
import com.samskivert.util.Interval;
import com.samskivert.util.StringUtil;
import com.threerings.util.Name;
@@ -38,7 +38,6 @@ import com.threerings.presents.net.AuthRequest;
import com.threerings.presents.net.AuthResponse;
import com.threerings.presents.net.Credentials;
import com.threerings.presents.server.net.*;
import com.threerings.presents.server.util.SafeInterval;
/**
* The client manager is responsible for managing the clients (surprise,
@@ -82,11 +81,11 @@ public class ClientManager
// start up an interval that will check for expired clients and
// flush them from the bowels of the server
IntervalManager.register(new SafeInterval(PresentsServer.omgr) {
public void run () {
new Interval(PresentsServer.omgr) {
public void expired () {
flushClients();
}
}, CLIENT_FLUSH_INTERVAL, null, true);
}.schedule(CLIENT_FLUSH_INTERVAL, true);
// register as a "state of server" reporter and a shutdowner
PresentsServer.registerReporter(this);
src/java/com/threerings/presents/server/PresentsClient.java
+2 -2
View File
@@ -438,7 +438,7 @@ public class PresentsClient
*/
protected void safeEndSession ()
{
PresentsServer.omgr.postUnit(new Runnable() {
PresentsServer.omgr.postRunnable(new Runnable() {
public void run () {
if (getClientObject() == null) {
// refuse to end the session unless the client is
@@ -624,7 +624,7 @@ public class PresentsClient
// our connection reference. once the connection ref is null, no
// more subscriptions will be processed (even those that were
// queued up before the connection went away)
PresentsServer.omgr.postUnit(new Runnable() {
PresentsServer.omgr.postRunnable(new Runnable() {
public void run () {
sessionConnectionClosed();
}
src/java/com/threerings/presents/server/PresentsDObjectMgr.java
+10 -7
View File
@@ -1,5 +1,5 @@
//
// $Id: PresentsDObjectMgr.java,v 1.48 2004/10/28 21:59:00 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -30,8 +30,8 @@ import sun.misc.Perf;
import com.samskivert.util.HashIntMap;
import com.samskivert.util.Histogram;
import com.samskivert.util.Invoker;
import com.samskivert.util.Queue;
import com.samskivert.util.RunQueue;
import com.samskivert.util.StringUtil;
import com.samskivert.util.Throttle;
@@ -52,8 +52,7 @@ import com.threerings.presents.dobj.*;
* requested to shut down.
*/
public class PresentsDObjectMgr
implements RootDObjectManager, Invoker.ResultReceiver,
PresentsServer.Reporter
implements RootDObjectManager, RunQueue, PresentsServer.Reporter
{
/**
* Creates the dobjmgr and prepares it for operation.
@@ -146,8 +145,10 @@ public class PresentsDObjectMgr
* opportunity. The code will be queued up with the rest of the events
* and invoked in turn. Like event processing code, the code should
* not take long to complete and should <em>definitely</em> not block.
*
* From interface RunQueue
*/
public void postUnit (Runnable unit)
public void postRunnable (Runnable unit)
{
// just append it to the queue
_evqueue.append(unit);
@@ -172,8 +173,10 @@ public class PresentsDObjectMgr
* that is doing distributed object event dispatch. Code that wishes
* to enforce that it is either always or never called on the event
* dispatch thread will want to make use of this method.
*
* From interface RunQueue
*/
public synchronized boolean isEventDispatchThread ()
public synchronized boolean isDispatchThread ()
{
return Thread.currentThread() == _dobjThread;
}
@@ -378,7 +381,7 @@ public class PresentsDObjectMgr
*/
public void harshShutdown ()
{
postUnit(new Runnable() {
postRunnable(new Runnable() {
public void run () {
_running = false;
}
src/java/com/threerings/presents/server/PresentsInvoker.java
+2 -2
View File
@@ -1,5 +1,5 @@
//
// $Id: PresentsInvoker.java,v 1.2 2004/08/27 02:20:23 mdb Exp $
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
@@ -110,7 +110,7 @@ public class PresentsInvoker extends Invoker
// if the queue isn't empty, re-post
} else if (!_omgr.queueIsEmpty()) {
_loopCount++;
_omgr.postUnit(this);
_omgr.postRunnable(this);
// if the invoker still has stuff and we're still under the pass
// limit, go ahead and pass it back to the invoker
src/java/com/threerings/presents/server/PresentsServer.java
+12 -10
View File
@@ -23,7 +23,7 @@ package com.threerings.presents.server;
import java.util.ArrayList;
import com.samskivert.util.IntervalManager;
import com.samskivert.util.Interval;
import com.samskivert.util.ObserverList;
import com.samskivert.util.StringUtil;
import com.samskivert.util.SystemInfo;
@@ -33,7 +33,6 @@ import com.threerings.util.signal.SignalManager;
import com.threerings.presents.Log;
import com.threerings.presents.client.Client;
import com.threerings.presents.server.net.ConnectionManager;
import com.threerings.presents.server.util.SafeInterval;
/**
* The presents server provides a central point of access to the various
@@ -130,11 +129,11 @@ public class PresentsServer
TimeBaseProvider.init(invmgr, omgr);
// queue up an interval which will generate reports
IntervalManager.register(new SafeInterval(omgr) {
public void run () {
new Interval(omgr) {
public void expired () {
generateReport(System.currentTimeMillis());
}
}, REPORT_INTERVAL, null, true);
}.schedule(REPORT_INTERVAL, true);
}
/**
@@ -154,7 +153,7 @@ public class PresentsServer
{
// post a unit that will start up the connection manager when
// everything else in the dobjmgr queue is processed
omgr.postUnit(new Runnable() {
omgr.postRunnable(new Runnable() {
public void run () {
// start up the connection manager
conmgr.start();
@@ -215,12 +214,15 @@ public class PresentsServer
}
}
report.append("* samskivert.IntervalManager:\n");
/* The following Interval debug methods are no longer supported,
* but they could be added back easily if needed.
report.append("* samskivert.Interval:\n");
report.append("- Registered intervals: ");
report.append(IntervalManager.registeredIntervalCount());
report.append(Interval.registeredIntervalCount());
report.append("\n- Fired since last report: ");
report.append(IntervalManager.getAndClearFiredIntervals());
report.append(Interval.getAndClearFiredIntervals());
report.append("\n");
*/
// strip off the final newline
int blen = report.length();
@@ -277,7 +279,7 @@ public class PresentsServer
*/
public void queueShutdown ()
{
omgr.postUnit(new Runnable() {
omgr.postRunnable(new Runnable() {
public void run () {
shutdown();
}
src/java/com/threerings/presents/server/util/SafeInterval.java
-76
View File
@@ -1,76 +0,0 @@
//
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
// http://www.threerings.net/code/narya/
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package com.threerings.presents.server.util;
import com.samskivert.util.Interval;
import com.threerings.presents.server.PresentsDObjectMgr;
/**
* Used in conjunction with the {@link PresentsDObjectMgr}, this class
* provides a means by which code can be run on the dobjmgr thread at some
* point in the future, either as a recurring interval or as a one shot
* deal. The code is built on top of the {@link IntervalManager} services.
*
* <p> A {@link SafeInterval} instance should be created and then
* scheduled to run using the {@link IntervalManager}. For example:
*
* <pre>
* IntervalManager.register(new SafeInterval(_omgr) {
* public void run () {
* System.out.println("Foo!");
* }
* }, 25L * 1000L, null, false);
* </pre>
*/
public abstract class SafeInterval
implements Runnable, Interval
{
/**
* Creates a safe interval instance that will queue itself up for
* execution on the supplied dobjmgr when it expires.
*/
public SafeInterval (PresentsDObjectMgr omgr)
{
_omgr = omgr;
}
/**
* Called (on the dobjmgr thread) when the interval period has
* expired. If this is a recurring interval, this method will be
* called each time the interval expires.
*/
public abstract void run ();
/** Handles the proper scheduling and queueing. */
public void intervalExpired (int id, Object arg)
{
_iid = id;
_omgr.postUnit(this);
}
/** The dobjmgr on which we queue ourselves when we expire. */
protected PresentsDObjectMgr _omgr;
/** Configured with our current interval id when we are triggered. */
protected int _iid;
}