Andrzej Kapolka
0c28d31357
well in standalone mode. We need a way to install a director on registration. git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@6413 542714f4-19e9-0310-aa3c-eee0fc999fb1
311 lines
10 KiB
Java
311 lines
10 KiB
Java
//
|
|
// $Id$
|
|
//
|
|
// Narya library - tools for developing networked games
|
|
// Copyright (C) 2002-2011 Three Rings Design, Inc., All Rights Reserved
|
|
// http://code.google.com/p/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.data;
|
|
|
|
import java.io.IOException;
|
|
|
|
import com.threerings.io.ObjectInputStream;
|
|
import com.threerings.io.Streamable;
|
|
|
|
import com.threerings.presents.client.Client;
|
|
import com.threerings.presents.client.ClientObjectInputStream;
|
|
import com.threerings.presents.client.InvocationDirector;
|
|
import com.threerings.presents.client.InvocationService;
|
|
import com.threerings.presents.dobj.DObjectManager;
|
|
import com.threerings.presents.dobj.InvocationResponseEvent;
|
|
import com.threerings.presents.net.Transport;
|
|
|
|
import static com.threerings.presents.Log.log;
|
|
|
|
/**
|
|
* Provides a base from which all invocation service marshallers extend. Handles functionality
|
|
* common to all marshallers.
|
|
*/
|
|
public class InvocationMarshaller
|
|
implements Streamable, InvocationService
|
|
{
|
|
/**
|
|
* Provides a base from which invocation listener marshallers extend.
|
|
*/
|
|
public static class ListenerMarshaller
|
|
implements Streamable, InvocationListener
|
|
{
|
|
/** The method id used to dispatch a {@link #requestFailed} response. */
|
|
public static final int REQUEST_FAILED_RSPID = 0;
|
|
|
|
/** The request id associated with this listener. */
|
|
public short requestId;
|
|
|
|
/** The oid of the invocation service requester. Only used on the server. */
|
|
public transient int callerOid;
|
|
|
|
/** The actual invocation listener associated with this marshalling listener. This is only
|
|
* valid on the client. */
|
|
public transient InvocationListener listener;
|
|
|
|
/** The time at which this listener marshaller was registered. This is only valid on the
|
|
* client. */
|
|
public transient long mapStamp;
|
|
|
|
/** The distributed object manager to use when dispatching proxied responses. This is only
|
|
* valid on the server. */
|
|
public transient DObjectManager omgr;
|
|
|
|
/** The transport mode through which the request was received. This is only valid on the
|
|
* server. */
|
|
public transient Transport transport;
|
|
|
|
/**
|
|
* Set an identifier for the invocation that this listener is used for, so we can report it
|
|
* if we are never responded-to.
|
|
*/
|
|
public void setInvocationId (String name)
|
|
{
|
|
_invId = name;
|
|
}
|
|
|
|
/**
|
|
* Indicates that this listener will not be responded-to, and that this is normal behavior.
|
|
*/
|
|
public void setNoResponse ()
|
|
{
|
|
// we enact this by merely doing the same thing that we normally do during a response.
|
|
_invId = null;
|
|
}
|
|
|
|
// documentation inherited from interface
|
|
public void requestFailed (String cause)
|
|
{
|
|
_invId = null;
|
|
omgr.postEvent(new InvocationResponseEvent(
|
|
callerOid, requestId, REQUEST_FAILED_RSPID, new Object[] { cause }, transport));
|
|
}
|
|
|
|
/**
|
|
* Called to dispatch an invocation response to our target listener.
|
|
*/
|
|
public void dispatchResponse (int methodId, Object[] args)
|
|
{
|
|
if (methodId == REQUEST_FAILED_RSPID) {
|
|
listener.requestFailed((String)args[0]);
|
|
|
|
} else {
|
|
log.warning("Requested to dispatch unknown invocation response",
|
|
"listener", listener, "methodId", methodId, "args", args);
|
|
}
|
|
}
|
|
|
|
@Override
|
|
public String toString ()
|
|
{
|
|
return "[callerOid=" + callerOid + ", reqId=" + requestId +
|
|
", type=" + getClass().getName() + "]";
|
|
}
|
|
|
|
@Override
|
|
protected void finalize ()
|
|
throws Throwable
|
|
{
|
|
try {
|
|
if (_invId != null && getClass() != ListenerMarshaller.class) {
|
|
log.warning("Invocation listener never responded to: " + _invId);
|
|
}
|
|
} finally {
|
|
super.finalize();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Performs type casts in a way that works for parameterized types as well as simple types.
|
|
*/
|
|
@SuppressWarnings("unchecked")
|
|
protected <K> K cast (Object value)
|
|
{
|
|
return (K)value;
|
|
}
|
|
|
|
/** On the server, the id of the invocation method. */
|
|
protected transient String _invId;
|
|
}
|
|
|
|
/**
|
|
* Defines a marshaller for the standard {@link InvocationService.ConfirmListener}.
|
|
*/
|
|
public static class ConfirmMarshaller extends ListenerMarshaller
|
|
implements ConfirmListener
|
|
{
|
|
/** The method id used to dispatch {@link #requestProcessed} responses. */
|
|
public static final int REQUEST_PROCESSED = 1;
|
|
|
|
// documentation inherited from interface
|
|
public void requestProcessed ()
|
|
{
|
|
_invId = null;
|
|
omgr.postEvent(new InvocationResponseEvent(
|
|
callerOid, requestId, REQUEST_PROCESSED, null, transport));
|
|
}
|
|
|
|
@Override
|
|
public void dispatchResponse (int methodId, Object[] args)
|
|
{
|
|
switch (methodId) {
|
|
case REQUEST_PROCESSED:
|
|
((ConfirmListener)listener).requestProcessed();
|
|
return;
|
|
|
|
default:
|
|
super.dispatchResponse(methodId, args);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Defines a marshaller for the standard {@link InvocationService.ResultListener}.
|
|
*/
|
|
public static class ResultMarshaller extends ListenerMarshaller
|
|
implements ResultListener
|
|
{
|
|
/** The method id used to dispatch {@link #requestProcessed} responses. */
|
|
public static final int REQUEST_PROCESSED = 1;
|
|
|
|
// documentation inherited from interface
|
|
public void requestProcessed (Object result)
|
|
{
|
|
_invId = null;
|
|
omgr.postEvent(new InvocationResponseEvent(
|
|
callerOid, requestId, REQUEST_PROCESSED, new Object[] { result }, transport));
|
|
}
|
|
|
|
@Override
|
|
public void dispatchResponse (int methodId, Object[] args)
|
|
{
|
|
switch (methodId) {
|
|
case REQUEST_PROCESSED:
|
|
((ResultListener)listener).requestProcessed(args[0]);
|
|
return;
|
|
|
|
default:
|
|
super.dispatchResponse(methodId, args);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Initializes this invocation marshaller instance with the requisite information to allow it
|
|
* to operate in the wide world. This is called by the invocation manager when an invocation
|
|
* provider is registered and should not be called otherwise.
|
|
*/
|
|
public void init (int invOid, int invCode, InvocationDirector invDir)
|
|
{
|
|
_invOid = invOid;
|
|
_invCode = invCode;
|
|
_invdir = invDir;
|
|
}
|
|
|
|
/**
|
|
* Sets the invocation oid to which this marshaller should send its invocation service
|
|
* requests. This is called by the invocation manager in certain initialization circumstances.
|
|
*/
|
|
public void setInvocationOid (int invOid)
|
|
{
|
|
_invOid = invOid;
|
|
}
|
|
|
|
/**
|
|
* Returns the code assigned to this marshaller.
|
|
*/
|
|
public int getInvocationCode ()
|
|
{
|
|
return _invCode;
|
|
}
|
|
|
|
/**
|
|
* A convenience method to indicate that the listener is not going to be responded-to, and that
|
|
* this is ok.
|
|
*/
|
|
public static void setNoResponse (InvocationListener listener)
|
|
{
|
|
if (listener instanceof ListenerMarshaller) {
|
|
((ListenerMarshaller) listener).setNoResponse();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* A custom reader method for {@link Streamable}.
|
|
*/
|
|
public void readObject (ObjectInputStream in)
|
|
throws IOException, ClassNotFoundException
|
|
{
|
|
in.defaultReadObject();
|
|
_invdir = ((ClientObjectInputStream)in).client.getInvocationDirector();
|
|
}
|
|
|
|
@Override
|
|
public String toString ()
|
|
{
|
|
return "[invOid=" + _invOid + ", code=" + _invCode + ", type=" + getClass().getName() + "]";
|
|
}
|
|
|
|
/**
|
|
* Called by generated invocation marshaller code; packages up and sends the specified
|
|
* invocation service request.
|
|
*/
|
|
protected void sendRequest (int methodId, Object[] args)
|
|
{
|
|
sendRequest(methodId, args, Transport.DEFAULT);
|
|
}
|
|
|
|
/**
|
|
* Called by generated invocation marshaller code; packages up and sends the specified
|
|
* invocation service request.
|
|
*/
|
|
protected void sendRequest (int methodId, Object[] args, Transport transport)
|
|
{
|
|
_invdir.sendRequest(_invOid, _invCode, methodId, args, transport);
|
|
}
|
|
|
|
/** @deprecated use client-argument-free version. */
|
|
@Deprecated
|
|
protected void sendRequest (Client client, int methodId, Object[] args)
|
|
{
|
|
sendRequest(client, methodId, args, Transport.DEFAULT);
|
|
}
|
|
|
|
/** @deprecated use client-argument-free version. */
|
|
@Deprecated
|
|
protected void sendRequest (Client client, int methodId, Object[] args, Transport transport)
|
|
{
|
|
client.getInvocationDirector().sendRequest(_invOid, _invCode, methodId, args, transport);
|
|
}
|
|
|
|
/** The oid of the invocation object, where invocation service requests are sent. */
|
|
protected int _invOid;
|
|
|
|
/** The invocation service code assigned to this service when it was registered on the
|
|
* server. */
|
|
protected int _invCode;
|
|
|
|
/** A reference to the invocation director with whom we interoperate. This is initialized in
|
|
* {@link #readObject} when we're read in from the network. */
|
|
protected transient InvocationDirector _invdir;
|
|
}
|