Package org.jgroups.protocols.pbcast

Class STATE_TRANSFER.StateHeader

java.lang.Object

org.jgroups.Header

org.jgroups.protocols.pbcast.STATE_TRANSFER.StateHeader

All Implemented Interfaces:

Constructable<Header>, SizeStreamable, 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 be stored in the header itself, but in the message's buffer.

Field Summary

Fields

Modifier and Type	Field	Description
protected Digest	my_digest
static final byte	STATE_EX
static final byte	STATE_REQ
static final byte	STATE_RSP
protected byte	type

Fields inherited from class org.jgroups.Header

prot_id

Constructor Summary

Constructors

Constructor	Description
StateHeader()
StateHeader(byte type)
StateHeader(byte type, Digest digest)

Method Summary

Modifier and Type	Method	Description
Supplier<? extends Header>	create()	Creates an instance of the class implementing this interface
Digest	getDigest()
short	getMagicId()	Returns the magic-ID.
int	getType()
void	readFrom(DataInput in)	Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
int	serializedSize()	Returns the size (in bytes) of the marshalled object
String	toString()
(package private) static String	type2Str(int t)
void	writeTo(DataOutput out)	Write the entire state of the current object (including superclasses) to outstream.

Methods inherited from class org.jgroups.Header

getProtId, setProtId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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

STATE_EX

public static final byte STATE_EX

See Also:

• Constant Field Values

type

protected byte type

my_digest

protected Digest my_digest

Constructor Details

StateHeader

public StateHeader()

StateHeader

public StateHeader(byte type)

StateHeader

public StateHeader(byte type,
 Digest digest)

Method Details

getMagicId

public short getMagicId()

Description copied from class: Header

Returns the magic-ID. If defined in jg-magic-map.xml, the IDs need to be the same

Specified by:

getMagicId in class Header

create

public Supplier<? extends Header> create()

Description copied from interface: Constructable

Creates an instance of the class implementing this interface

getType

public int getType()

getDigest

public Digest getDigest()

toString

public String toString()

Overrides:

toString in class Header

type2Str

static String type2Str(int t)

writeTo

public void writeTo(DataOutput 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

Throws:

IOException

readFrom

public void readFrom(DataInput in)
              throws IOException,
ClassNotFoundException

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:

IOException

ClassNotFoundException

serializedSize

public int serializedSize()

Description copied from interface: SizeStreamable

Returns the size (in bytes) of the marshalled object