Class STATE_TRANSFER.StateHeader

java.lang.Object

org.jgroups.Header

org.jgroups.protocols.pbcast.STATE_TRANSFER.StateHeader

All Implemented Interfaces:

Externalizable, Serializable, Streamable

Enclosing class:

STATE_TRANSFER

public static class STATE_TRANSFER.StateHeader
extends Header
implements Streamable

Wraps data for a state request/response. Note that for a state response the actual state will notinvalid input: '<'/em be stored in the header itself, but in the message's buffer.

Version:

$Id: STATE_TRANSFER.java,v 1.76.2.1 2008/02/13 02:13:24 vlada Exp $

Author:

Bela Ban

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	STATE_REQ
static final byte	STATE_RSP

Fields inherited from class Header

HDR_OVERHEAD

Constructor Summary

Constructors

Constructor	Description
StateHeader()
StateHeader(byte type, Address sender, long id, Digest digest)
StateHeader(byte type, Address sender, long id, Digest digest, String state_id)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Digest	getDigest()
String	getStateId()
int	getType()
int	hashCode()
void	readExternal(ObjectInput in)
void	readFrom(DataInputStream in)	Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
int	size()	To be implemented by subclasses.
String	toString()
void	writeExternal(ObjectOutput out)
void	writeTo(DataOutputStream out)	Write the entire state of the current object (including superclasses) to outstream.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

STATE_REQ

public static final byte STATE_REQ

See Also:

• Constant Field Values

STATE_RSP

public static final byte STATE_RSP

See Also:

• Constant Field Values

Constructor Details

StateHeader

public StateHeader()

StateHeader

public StateHeader(byte type,
 Address sender,
 long id,
 Digest digest)

StateHeader

public StateHeader(byte type,
 Address sender,
 long id,
 Digest digest,
 String state_id)

Method Details

getType

public int getType()

getDigest

public Digest getDigest()

getStateId

public String getStateId()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Header

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeTo

public void writeTo(DataOutputStream out)
             throws IOException

Description copied from interface: Streamable

Write the entire state of the current object (including superclasses) to outstream. Note that the output stream must not be closed

Specified by:

writeTo in interface Streamable

Throws:

IOException

readFrom

public void readFrom(DataInputStream in)
              throws IOException,
IllegalAccessException,
InstantiationException

Description copied from interface: Streamable

Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed

Specified by:

readFrom in interface Streamable

Throws:

IOException

IllegalAccessException

InstantiationException

size

public int size()

Description copied from class: Header

To be implemented by subclasses. Return the size of this object for the serialized version of it. I.e. how many bytes this object takes when flattened into a buffer. This may be different for each instance, or can be the same. This may also just be an estimation. E.g. FRAG uses it on Message to determine whether or not to fragment the message. Fragmentation itself will be accurate, because the entire message will actually be serialized into a byte buffer, so we can determine the exact size.

Overrides:

size in class Header