first pass at converting the bureau client to actionscript. now to find a way to run it...

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@5054 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Jamie Doornbos
2008-05-08 23:01:46 +00:00
parent 18d4136e3a
commit bc35598a2e
16 changed files with 970 additions and 2 deletions
@@ -0,0 +1,61 @@
//
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2008 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.bureau.client {
import com.threerings.bureau.data.AgentObject;
/**
* Represents an agent running within a bureau client.
*/
public class Agent
{
/**
* Initializes the Agent with the distributed agent object.
*/
public function init (agentObj :AgentObject) :void
{
_agentObj = agentObj;
}
/**
* Starts the code running in the agent.
*/
public function start () :void
{
throw new Error("Abstract method");
}
/**
* Stops the code running in the agent.
*/
public function stop () :void
{
throw new Error("Abstract method");
}
/**
* The shared agent object.
*/
protected var _agentObj :AgentObject;
}
}
@@ -0,0 +1,115 @@
//
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2007 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.bureau.client {
import com.threerings.presents.client.Client;
import com.threerings.bureau.data.BureauCredentials;
import com.threerings.bureau.util.BureauContext;
import com.threerings.presents.dobj.DObjectManager;
/**
* Represents a client embedded in a bureau.
*/
public class BureauClient extends Client
{
/**
* Creates a new client.
* @param creds the credentials supplied during connection
* @param runQueue the place to post tasks required by clients
*/
public function BureauClient (token :String, bureauId :String)
{
super(null);
_bureauId = bureauId;
var creds :BureauCredentials = new BureauCredentials(_bureauId);
creds.sessionToken = token;
_creds = creds;
_ctx = createContext();
_director = createDirector();
}
public function getBureauDirector () :BureauDirector
{
return _director;
}
public function getBureauId () :String
{
return _bureauId;
}
protected function createDirector () :BureauDirector
{
throw new Error("Abstract method");
}
protected function createContext () :BureauContext
{
return new Context(this);
}
protected var _ctx :BureauContext;
protected var _bureauId :String;
protected var _director :BureauDirector;
}
}
import com.threerings.bureau.client.BureauClient;
import com.threerings.bureau.client.BureauDirector;
import com.threerings.presents.dobj.DObjectManager;
import com.threerings.presents.client.Client;
import com.threerings.bureau.util.BureauContext;
class Context
implements BureauContext
{
function Context (client :BureauClient)
{
_client = client;
}
public function getBureauDirector () :BureauDirector
{
return _client.getBureauDirector();
}
public function getDObjectManager () :DObjectManager
{
return _client.getDObjectManager();
}
public function getClient () :Client
{
return _client;
}
public function getBureauId () :String
{
return _client.getBureauId();
}
protected var _client :BureauClient;
}
@@ -0,0 +1,80 @@
//
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2008 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.bureau.client {
import com.threerings.bureau.client.BureauReceiver;
import com.threerings.presents.client.InvocationDecoder;
/**
* Dispatches calls to a {@link BureauReceiver} instance.
*/
public class BureauDecoder extends InvocationDecoder
{
/** The generated hash code used to identify this receiver class. */
public static const RECEIVER_CODE :String = "3e98f7a30deb5a8e25e05c71c6081bf4";
/** The method id used to dispatch {@link BureauReceiver#createAgent}
* notifications. */
public static const CREATE_AGENT :int = 1;
/** The method id used to dispatch {@link BureauReceiver#destroyAgent}
* notifications. */
public static const DESTROY_AGENT :int = 2;
/**
* Creates a decoder that may be registered to dispatch invocation
* service notifications to the specified receiver.
*/
public function BureauDecoder (receiver :BureauReceiver)
{
this.receiver = receiver;
}
// documentation inherited
public override function getReceiverCode () :String
{
return RECEIVER_CODE;
}
// documentation inherited
public override function dispatchNotification (methodId :int, args :Array) :void
{
switch (methodId) {
case CREATE_AGENT:
BureauReceiver(receiver).createAgent(
args[0] as int
);
return;
case DESTROY_AGENT:
BureauReceiver(receiver).destroyAgent(
args[0] as int
);
return;
default:
super.dispatchNotification(methodId, args);
return;
}
}
}
}
@@ -0,0 +1,186 @@
package com.threerings.bureau.client {
import com.threerings.presents.client.BasicDirector;
import com.threerings.presents.data.ClientObject;
import com.threerings.bureau.data.BureauCodes;
import com.threerings.bureau.data.AgentObject;
import com.threerings.bureau.Log;
import com.threerings.bureau.util.BureauContext;
import com.threerings.presents.client.Client;
import com.threerings.presents.dobj.Subscriber;
import com.threerings.presents.dobj.SubscriberAdapter;
import com.threerings.presents.util.SafeSubscriber;
import com.threerings.presents.dobj.ObjectAccessError;
import com.threerings.util.HashMap;
import com.threerings.presents.client.ClientEvent;
/**
* Allows the server to create and destroy agents on a client.
* @see BureauRegistry
*/
public class BureauDirector extends BasicDirector
{
/**
* Creates a new BureauDirector.
*/
public function BureauDirector (ctx :BureauContext)
{
super(ctx);
}
// from BasicDirector
public override function clientDidLogon (event :ClientEvent) :void
{
super.clientDidLogon(event);
var id :String = BureauContext(_ctx).getBureauId();
_bureauService.bureauInitialized(_ctx.getClient(), id);
}
/**
* Creates a new agent when the server requests it.
*/
protected function createAgentFromId (agentId :int) :void
{
var delegator :Subscriber =
new SubscriberAdapter(objectAvailable, requestFailed);
Log.info("Subscribing to object " + agentId);
var subscriber :SafeSubscriber =
new SafeSubscriber(agentId, delegator);
_subscribers.put(agentId, subscriber);
subscriber.subscribe(_ctx.getDObjectManager());
}
/**
* Destroys an agent at the server's request.
*/
protected function destroyAgent (agentId :int) :void
{
var agent :Agent = null;
agent = _agents.remove(agentId);
if (agent == null) {
Log.warning("Lost an agent, id " + agentId);
}
else {
try {
agent.stop();
}
catch (e :Error) {
Log.warning("Stopping an agent caused an exception");
Log.logStackTrace(e);
}
var subscriber :SafeSubscriber = _subscribers.remove(agentId);
if (subscriber == null) {
Log.warning("Lost a subscriber for agent " + agent);
}
else {
subscriber.unsubscribe(_ctx.getDObjectManager());
}
_bureauService.agentDestroyed(_ctx.getClient(), agentId);
}
}
/**
* Callback for when the a request to subscribe to an object finishes and the object is available.
*/
protected function objectAvailable (agentObject :AgentObject) :void
{
var oid :int = agentObject.getOid();
Log.info("Object " + oid + " now available");
var agent :Agent;
try {
agent = createAgent(agentObject);
agent.init(agentObject);
agent.start();
}
catch (e :Error) {
Log.warning("Could not create agent [obj=" + agentObject + "]");
Log.logStackTrace(e);
_bureauService.agentCreationFailed(_ctx.getClient(), oid);
return;
}
_agents.put(oid, agent);
_bureauService.agentCreated(_ctx.getClient(), oid);
}
/**
* Callback for when the a request to subscribe to an object fails.
*/
protected function requestFailed (oid :int, cause :ObjectAccessError) :void
{
Log.warning("Could not subscribe to agent [oid=" + oid + "]");
Log.logStackTrace(cause);
}
// from BasicDirector
protected override function registerServices (client :Client) :void
{
super.registerServices(client);
// Require the bureau services
client.addServiceGroup(BureauCodes.BUREAU_GROUP);
// Set up our decoder so we can receive method calls
// from the server
var receiver :BureauReceiver =
new ReceiverDelegator(createAgentFromId, destroyAgent);
client.getInvocationDirector().
registerReceiver(new BureauDecoder(receiver));
}
// from BasicDirector
protected override function fetchServices (client :Client) :void
{
super.fetchServices(client);
_bureauService = client.getService(BureauService) as BureauService;
}
/**
* Called when it is time to create an Agent. Subclasses should read the
* <code>agentObject</code>'s type and/or properties to determine what kind of Agent to
* create.
* @param agentObj the distributed and object
* @return a new Agent that will govern the distributed object
*/
protected function createAgent (agentObj :AgentObject) :Agent
{
throw new Error("Abstract function");
}
protected var _bureauService :BureauService;
protected var _agents :HashMap = new HashMap();
protected var _subscribers :HashMap = new HashMap();
}
}
import com.threerings.bureau.client.BureauReceiver;
class ReceiverDelegator implements BureauReceiver
{
public function ReceiverDelegator (createFn :Function, destroyFn :Function)
{
_createFn = createFn;
_destroyFn = destroyFn;
}
public function createAgent (agentId :int) :void
{
_createFn(agentId);
}
public function destroyAgent (agentId :int) :void
{
_destroyFn(agentId);
}
protected var _createFn :Function;
protected var _destroyFn :Function;
}
@@ -0,0 +1,50 @@
//
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2008 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.bureau.client {
import com.threerings.presents.client.InvocationReceiver;
/**
* Hooks for controlling a previously launched bureau client.
*/
public interface BureauReceiver extends InvocationReceiver
{
/**
* Creates a new agent. Implementors should create a new {@link Agent} and give it access to
* the {@link AgentObject} referred to by the <code>agentId</code> parameter and must notify
* the service that the agent has been created using {@link BureauService#agentCreated}.
* @param client the client receiving the request
* @param agentId the id of the <code>AgentObject</code> that needs an <code>Agent</code>
*/
function createAgent (agentId :int) :void;
/**
* Destroys a previously created agent. Implementors should destroy the agent that was created
* by the call to <code>createAgent</code> with the same agent id and must notify
* the service that the agent has been created using {@link BureauService#agentDestroyed}.
* @param client the client receiving the request
* @param agentId the id of the <code>AgentObject</code> whose <code>Agent</code>
* should be destroyed
*/
function destroyAgent (agentId :int) :void;
}
}
@@ -0,0 +1,44 @@
//
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2008 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.bureau.client {
import com.threerings.presents.client.Client;
import com.threerings.presents.client.InvocationService;
/**
* An ActionScript version of the Java BureauService interface.
*/
public interface BureauService extends InvocationService
{
// from Java interface BureauService
function agentCreated (arg1 :Client, arg2 :int) :void;
// from Java interface BureauService
function agentCreationFailed (arg1 :Client, arg2 :int) :void;
// from Java interface BureauService
function agentDestroyed (arg1 :Client, arg2 :int) :void;
// from Java interface BureauService
function bureauInitialized (arg1 :Client, arg2 :String) :void;
}
}