multiverse.server.plugins
Class InstanceClient.InstanceEntryReqMessage

java.lang.Object
  multiverse.msgsys.Message
      multiverse.msgsys.TargetMessage
          multiverse.server.plugins.InstanceClient.InstanceEntryReqMessage

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

InstanceClient

public static class InstanceClient.InstanceEntryReqMessage
extends TargetMessage

Request object instance entry.

See Also:

Serialized Form

Field Summary

static int	FLAG_NONE No flags.
static int	FLAG_POP Instance to the top of instance restore stack.
static int	FLAG_PUSH Push current instance and location onto the instance restore stack.

Fields inherited from class multiverse.msgsys.TargetMessage

subject, target

Constructor Summary

InstanceClient.InstanceEntryReqMessage()

InstanceClient.InstanceEntryReqMessage(long oid)
Object instance entry.

InstanceClient.InstanceEntryReqMessage(long oid, BasicWorldNode instanceLoc)
Object instance entry to the given location.

InstanceClient.InstanceEntryReqMessage(long oid, BasicWorldNode instanceLoc, int flags)
Object instance entry to the given location.

InstanceClient.InstanceEntryReqMessage(long oid, BasicWorldNode instanceLoc, int flags, BasicWorldNode restoreLoc)
Object instance entry to the given location with a restore location.

InstanceClient.InstanceEntryReqMessage(long oid, int flags)
Object instance entry.

Method Summary

int	getFlags() Get the flags.
java.lang.Object	getProcessingState() Application defined processing state.
BasicWorldNode	getRestoreNode() Get the restore location override.
BasicWorldNode	getWorldNode() Get the destination instance and location.
void	setFlags(int flags) Set the flags.
void	setProcessingState(java.lang.Object state) Set the application defined processing state.
void	setRestoreNode(BasicWorldNode restoreLoc) Set the restore location override.
void	setWorldNode(BasicWorldNode instanceLoc) Set the destination instance and location.

Methods inherited from class multiverse.msgsys.TargetMessage

getSubject, getTarget, setSubject, setTarget, toString

Methods inherited from class multiverse.msgsys.Message

getEnqueueTime, getMsgId, getMsgType, getSenderName, isRPC, setEnqueueTime, setEnqueueTime, setMsgType, toBytes

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_NONE

public static final int FLAG_NONE

No flags.

See Also:

Constant Field Values

FLAG_PUSH

public static final int FLAG_PUSH

Push current instance and location onto the instance restore stack.

See Also:

InstanceClient.objectInstanceEntry(long,BasicWorldNode,int), Constant Field Values

FLAG_POP

public static final int FLAG_POP

Instance to the top of instance restore stack.

See Also:

InstanceClient.objectInstanceEntry(long,BasicWorldNode,int), Constant Field Values

Constructor Detail

InstanceClient.InstanceEntryReqMessage

public InstanceClient.InstanceEntryReqMessage()

InstanceClient.InstanceEntryReqMessage

public InstanceClient.InstanceEntryReqMessage(long oid)

Object instance entry.

InstanceClient.InstanceEntryReqMessage

public InstanceClient.InstanceEntryReqMessage(long oid,
                                              BasicWorldNode instanceLoc)

Object instance entry to the given location.

InstanceClient.InstanceEntryReqMessage

public InstanceClient.InstanceEntryReqMessage(long oid,
                                              BasicWorldNode instanceLoc,
                                              int flags)

Object instance entry to the given location.

InstanceClient.InstanceEntryReqMessage

public InstanceClient.InstanceEntryReqMessage(long oid,
                                              BasicWorldNode instanceLoc,
                                              int flags,
                                              BasicWorldNode restoreLoc)

Object instance entry to the given location with a restore location. Use with 'flags' set to FLAG_PUSH.

InstanceClient.InstanceEntryReqMessage

public InstanceClient.InstanceEntryReqMessage(long oid,
                                              int flags)

Object instance entry.

Method Detail

getWorldNode

public BasicWorldNode getWorldNode()

Get the destination instance and location.

setWorldNode

public void setWorldNode(BasicWorldNode instanceLoc)

Set the destination instance and location.

getFlags

public int getFlags()

Get the flags.

setFlags

public void setFlags(int flags)

Set the flags. One of FLAG_NONE, FLAG_PUSH, or FLAG_POP.

getRestoreNode

public BasicWorldNode getRestoreNode()

Get the restore location override.

setRestoreNode

public void setRestoreNode(BasicWorldNode restoreLoc)

Set the restore location override. When FLAG_PUSH is set, the object's current location is pushed. The pushed location can be overridden by setting the restore node.

getProcessingState

public java.lang.Object getProcessingState()

Application defined processing state. Used by the proxy when instance entry is broken into multiple steps. The value is not copied when message is sent between processes.

setProcessingState

public void setProcessingState(java.lang.Object state)

Set the application defined processing state. Used by the proxy when instance entry is broken into multiple steps. The value is not copied when message is sent between processes.