Files
narya/src/main/java/com/threerings/presents/dobj/MessageEvent.java
T
Michael Bayne fc7706c79d Get the transport specification out of the construction path, since it's not a
streamed property of the event. It turns out to be cleaner to just set it in
the places where we know that we want a specific transport anyway.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@6581 542714f4-19e9-0310-aa3c-eee0fc999fb1
2011-04-02 00:01:46 +00:00

94 lines
2.9 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.dobj;
import com.samskivert.util.StringUtil;
/**
* A message event is used to dispatch a message to all subscribers of a distributed object without
* actually changing any of the fields of the object. A message has a name, by which different
* subscribers of the same object can distinguish their different messages, and an array of
* arguments by which any contents of the message can be delivered.
*
* @see DObjectManager#postEvent
*/
public class MessageEvent extends NamedEvent
{
/**
* Constructs a new message event on the specified target object with the supplied name and
* arguments.
*
* @param targetOid the object id of the object whose attribute has changed.
* @param name the name of the message event.
* @param args the arguments for this message. This array should contain only values of valid
* distributed object types.
*/
public MessageEvent (int targetOid, String name, Object[] args)
{
super(targetOid, name);
_args = args;
}
/**
* Returns the arguments to this message.
*/
public Object[] getArgs ()
{
return _args;
}
/**
* Replaces the arguments associated with this message event. <em>Note:</em> this should only
* be called on events that have not yet been dispatched into the distributed object system.
*/
public void setArgs (Object[] args)
{
_args = args;
}
@Override
public boolean applyToObject (DObject target)
throws ObjectAccessException
{
// nothing to do here
return true;
}
@Override
protected void notifyListener (Object listener)
{
if (listener instanceof MessageListener) {
((MessageListener)listener).messageReceived(this);
}
}
@Override
protected void toString (StringBuilder buf)
{
buf.append("MSG:");
super.toString(buf);
buf.append(", args=").append(StringUtil.toString(_args));
}
protected Object[] _args;
}