atavism.server.plugins

Class WorldManagerClient.TargetedExtensionMessage

java.lang.Object

atavism.msgsys.Message

atavism.msgsys.TargetMessage

atavism.server.plugins.WorldManagerClient.TargetedPropertyMessage

atavism.server.plugins.WorldManagerClient.TargetedExtensionMessage

All Implemented Interfaces:

IPropertyMessage, java.io.Serializable

Direct Known Subclasses:

ClientParameter.ClientParameterMessage

Enclosing class:

WorldManagerClient

public static class WorldManagerClient.TargetedExtensionMessage
extends WorldManagerClient.TargetedPropertyMessage

TargetedExtensionMessage is an extension message sent to a specific object (the target). If the target is a player, then the message can be sent to the player's client. The default message type is MSG_TYPE_EXTENSION.

See Also:

Serialized Form

Field Summary

Fields inherited from class atavism.server.plugins.WorldManagerClient.TargetedPropertyMessage

lock, removedProperties

Fields inherited from class atavism.msgsys.TargetMessage

subject, target

Fields inherited from class atavism.msgsys.Message

flags, msgId, msgInstanceOid, msgType, remoteAgent

Constructor Summary

Constructors

Constructor and Description
TargetedExtensionMessage()
TargetedExtensionMessage(MessageType msgType, OID target, OID subject, java.lang.Boolean clientTargeted, java.util.Map<java.lang.String,java.io.Serializable> propertyMap) Create TargetedExtensionMessage.
TargetedExtensionMessage(MessageType msgType, java.lang.String subType, OID target, OID subject) Create TargetedExtensionMessage.
TargetedExtensionMessage(OID target) Create TargetedExtensionMessage.
TargetedExtensionMessage(OID target, OID subject) Create TargetedExtensionMessage.
TargetedExtensionMessage(java.lang.String subType, OID target) Create TargetedExtensionMessage.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getExtensionType() Get the extension message sub-type.
java.util.Set<java.lang.String>	getKeys()
void	setExtensionType(java.lang.String type) Set the extension message sub-type.
AOByteBuffer	toBuffer(java.lang.String version)

Methods inherited from class atavism.server.plugins.WorldManagerClient.TargetedPropertyMessage

get, getProperty, getPropertyMapRef, keySet, put, removeProperty, setProperty, setProperty, toBuffer, toBufferInternal

Methods inherited from class atavism.msgsys.TargetMessage

getSubject, getTarget, setSubject, setTarget, toString

Methods inherited from class atavism.msgsys.Message

getEnqueueTime, getMsgId, getMsgInstanceOid, getMsgType, getSenderName, isRPC, setEnqueueTime, setEnqueueTime, setMsgInstanceOid, setMsgType, toBytes, toBytes, toBytes, ToString

Methods inherited from class java.lang.Object

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

Constructor Detail

TargetedExtensionMessage

public TargetedExtensionMessage()

TargetedExtensionMessage

public TargetedExtensionMessage(OID target)

Create TargetedExtensionMessage.

Parameters:

target - Message target.

TargetedExtensionMessage

public TargetedExtensionMessage(OID target,
                                OID subject)

Create TargetedExtensionMessage.

Parameters:

target - Message target.

subject - Message subject.

TargetedExtensionMessage

public TargetedExtensionMessage(java.lang.String subType,
                                OID target)

Create TargetedExtensionMessage.

Parameters:

subType - Extension message sub-type.

target - Message target.

TargetedExtensionMessage

public TargetedExtensionMessage(MessageType msgType,
                                java.lang.String subType,
                                OID target,
                                OID subject)

Create TargetedExtensionMessage.

Parameters:

msgType - Message type.

subType - Extension message sub-type.

target - Message target.

subject - Message subject.

TargetedExtensionMessage

public TargetedExtensionMessage(MessageType msgType,
                                OID target,
                                OID subject,
                                java.lang.Boolean clientTargeted,
                                java.util.Map<java.lang.String,java.io.Serializable> propertyMap)

Create TargetedExtensionMessage.

Parameters:

msgType - Message type.

target - Message target.

subject - Message subject.

clientTargeted - True if the message is sent from one client to another client (a P2P message).

propertyMap - Message properties.

Method Detail

setExtensionType

public void setExtensionType(java.lang.String type)

Set the extension message sub-type. The sub-type is used when an extension message is sent to the client.

getExtensionType

public java.lang.String getExtensionType()

Get the extension message sub-type.

getKeys

public java.util.Set<java.lang.String> getKeys()

toBuffer

public AOByteBuffer toBuffer(java.lang.String version)

Overrides:

toBuffer in class WorldManagerClient.TargetedPropertyMessage