org.jgroups.protocols.pbcast
Class STATE_TRANSFER.StateHeader

java.lang.Object
  org.jgroups.Header
      org.jgroups.protocols.pbcast.STATE_TRANSFER.StateHeader

All Implemented Interfaces:

Streamable

Enclosing class:

STATE_TRANSFER

public static class STATE_TRANSFER.StateHeader
extends Header

Wraps data for a state request/response. Note that for a state response the actual state will not

Field Summary

protected Digest	my_digest
static byte	STATE_EX
static byte	STATE_REQ
static byte	STATE_RSP
protected byte	type

Constructor Summary

STATE_TRANSFER.StateHeader()

STATE_TRANSFER.StateHeader(byte type)

STATE_TRANSFER.StateHeader(byte type, Digest digest)

Method Summary

Digest	getDigest()
int	getType()
void	readFrom(java.io.DataInput 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.
java.lang.String	toString()
void	writeTo(java.io.DataOutput out) Write the entire state of the current object (including superclasses) to outstream.

Methods inherited from class java.lang.Object

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

Field Detail

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

STATE_EX

public static final byte STATE_EX

See Also:

Constant Field Values

type

protected byte type

my_digest

protected Digest my_digest

Constructor Detail

STATE_TRANSFER.StateHeader

public STATE_TRANSFER.StateHeader()

STATE_TRANSFER.StateHeader

public STATE_TRANSFER.StateHeader(byte type)

STATE_TRANSFER.StateHeader

public STATE_TRANSFER.StateHeader(byte type,
                                  Digest digest)

Method Detail

getType

public int getType()

getDigest

public Digest getDigest()

toString

public java.lang.String toString()

Overrides:

toString in class Header

writeTo

public void writeTo(java.io.DataOutput out)
             throws java.lang.Exception

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

Throws:

java.lang.Exception

readFrom

public void readFrom(java.io.DataInput in)
              throws java.lang.Exception

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

Throws:

java.lang.Exception

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.

Specified by:

size in class Header