com.goldencode.p2j.net

Class SyncMessage

java.lang.Object

com.goldencode.p2j.net.Message

com.goldencode.p2j.net.SyncMessage

All Implemented Interfaces:

MessageTypes, java.io.Externalizable, java.io.Serializable

public class SyncMessage
extends Message

This class provides state synchronization extensions to a standard message. In particular, there is an additional "payload" that is provided to allow any state changes that need to be synchronized to be "piggybacked" into any existing message.

Author:

GES

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.Externalizable	state State to be synchronized.

Fields inherited from interface com.goldencode.p2j.net.MessageTypes

ADDRESS_REPLY, ADDRESS_REQUEST, BEGIN_REPLY, ECHO, ECHO_REPLY, END_REPLY, INIT_CONVERSATION, INIT_REPLY, INIT_ROUTER, INIT_STANDARD, REPLY_ASYNC, REPLY_EXCEPTION_ASYNC, REPLY_EXCEPTION_SYNC, REPLY_SYNC, REQUEST_ASYNCH, REQUEST_SYNCH, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
SyncMessage() Default constructor, used during de-serialization.
SyncMessage(Message msg, java.io.Externalizable state) Constructs an instance using an already existing message.

Method Summary

Modifier and Type	Method and Description
java.io.Externalizable	getState() Get the state from the message.
void	readExternal(java.io.ObjectInput in) Replacement for the default object reading method.
void	setState(java.io.Externalizable state) Set the state in the message.
void	writeExternal(java.io.ObjectOutput out) Replacement for the default object writing method.

Methods inherited from class com.goldencode.p2j.net.Message

getKey, getPayload, getRequestID, getType, isAsyncReply, isAsyncRequest, isDispatcherRequest, isEchoRequest, isReply, isRouterRequest, onRead, onWrite, setKey, setPayload, setRequestID, setType

Methods inherited from class java.lang.Object

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

Field Detail

state

private java.io.Externalizable state

State to be synchronized.

Constructor Detail

SyncMessage

public SyncMessage()

Default constructor, used during de-serialization.

SyncMessage

public SyncMessage(Message msg,
                   java.io.Externalizable state)

Constructs an instance using an already existing message.

Parameters:

msg - A valid message. Must not be null.

state - The state to be piggybacked into the given message.

Method Detail

getState

public java.io.Externalizable getState()

Get the state from the message.

Returns:

The state carried in this message.

setState

public void setState(java.io.Externalizable state)

Set the state in the message.

Parameters:

state - The state to be carried in this message.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Replacement for the default object reading method. The piggybacked state is read from the input source. Note that the parent's version of this method is called first because as an Externalizable it won't be called by the serialization infrastructure.

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class Message

Parameters:

in - Input source from which fields will be restored.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If payload can't be instantiated.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Replacement for the default object writing method. The piggybacked state is written to the output source. Note that the parent's version of this method is called first because as an Externalizable it won't be called by the serialization infrastructure.

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class Message

Parameters:

out - The output destination to which fields will be saved.

Throws:

java.io.IOException - In case of I/O errors.