atavism.msgsys

Class Message

java.lang.Object

atavism.msgsys.Message

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AdvertiseMessage, AgentHelloMessage, AgentStateMessage, AllocNameMessage, AwaitPluginDependentsMessage, ChatClient.SysChatMessage, EnginePlugin.PluginStateMessage, EnginePlugin.TransferObjectMessage, FilterUpdateMessage, GenericMessage, HelloResponseMessage, InstanceClient.CreateInstanceMessage, InstanceClient.GetInstanceInfoMessage, InstanceClient.GetMatchingEntityOidsMessage, InstanceClient.GetNavMeshPathMessage, InstanceClient.RegisterInstanceTemplateMessage, InstanceClient.SetInstanceGroupMessage, NamespaceMessage, NewAgentMessage, ObjectManagerClient.DeleteObjectMessage, ObjectManagerClient.FixWorldNodeMessage, ObjectManagerClient.GenerateObjectMessage, ObjectManagerClient.GetEnchantProfileMessage, ObjectManagerClient.GetItemSetProfileMessage, ObjectManagerClient.GetMatchingObjectsMessage, ObjectManagerClient.GetNamedObjectMessage, ObjectManagerClient.GetQualityInfoMessage, ObjectManagerClient.GetTemplateMessage, ObjectManagerClient.GetVipLevelMessage, ObjectManagerClient.LoadObjectMessage, ObjectManagerClient.ModifyNamespaceMessage, ObjectManagerClient.RegisterEnchantProfileMessage, ObjectManagerClient.RegisterItemSetProfileMessage, ObjectManagerClient.RegisterQualityInfoMessage, ObjectManagerClient.RegisterTemplateMessage, ObjectManagerClient.RegisterVipLevelMessage, ObjectManagerClient.SaveObjectMessage, ObjectManagerClient.UnloadObjectMessage, PerceptionMessage, PluginAvailableMessage, ResponseMessage, SearchMessage, SubjectMessage, SubscribeMessage, TargetMessage, UnsubscribeMessage, WorldManagerClient.HostInstanceMessage, WorldManagerClient.PlayerPathWMReqMessage

public class Message
extends java.lang.Object
implements java.io.Serializable

Atavism message base-class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected short	flags
protected long	msgId
protected OID	msgInstanceOid
protected MessageType	msgType
protected MessageAgent.RemoteAgent	remoteAgent

Constructor Summary

Constructors

Constructor and Description
Message()
Message(MessageType msgType) Create message of the given message type.

Method Summary

Modifier and Type	Method and Description
long	getEnqueueTime() Get the message enqueue time.
long	getMsgId() Get the message id.
OID	getMsgInstanceOid() Get the message type.
MessageType	getMsgType() Get the message type.
java.lang.String	getSenderName() Get the sending agent name.
boolean	isRPC() True if the message is an RPC request.
void	setEnqueueTime() Set the message enqueue time to the current nano-second time.
void	setEnqueueTime(long when) Set the message enqueue time.
void	setMsgInstanceOid(OID instanceOid) Set the message type.
void	setMsgType(MessageType msgType) Set the message type.
static AOByteBuffer	toBytes(Message message)
static void	toBytes(Message message, AOByteBuffer buffer) Internal use only.
static void	toBytes(Message message, java.util.Queue<AOByteBuffer> queue)
java.lang.String	ToString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

msgId

protected long msgId

msgType

protected MessageType msgType

msgInstanceOid

protected OID msgInstanceOid

flags

protected short flags

remoteAgent

protected transient MessageAgent.RemoteAgent remoteAgent

Constructor Detail

Message

public Message()

Message

public Message(MessageType msgType)

Create message of the given message type.

Method Detail

getMsgType

public MessageType getMsgType()

Get the message type.

setMsgType

public void setMsgType(MessageType msgType)

Set the message type.

getMsgId

public long getMsgId()

Get the message id. The message id is unique within the sending agent. The message ids will repeat if the agent restarts.

getSenderName

public java.lang.String getSenderName()

Get the sending agent name.

Returns:

Agent name or null if the message has not been sent.

getEnqueueTime

public long getEnqueueTime()

Get the message enqueue time.

setEnqueueTime

public void setEnqueueTime(long when)

Set the message enqueue time. Application callbacks can set the enqueue time prior to insertion to an application queue or thread pool.

setEnqueueTime

public void setEnqueueTime()

Set the message enqueue time to the current nano-second time. Application callbacks can set the enqueue time prior to insertion to an application queue or thread pool.

getMsgInstanceOid

public OID getMsgInstanceOid()

Get the message type.

setMsgInstanceOid

public void setMsgInstanceOid(OID instanceOid)

Set the message type.

toBytes

public static void toBytes(Message message,
                           java.util.Queue<AOByteBuffer> queue)

toBytes

public static AOByteBuffer toBytes(Message message)

toBytes

public static void toBytes(Message message,
                           AOByteBuffer buffer)

Internal use only.

ToString

public java.lang.String ToString()

isRPC

public boolean isRPC()

True if the message is an RPC request.