Class RequestCorrelator.Header

java.lang.Object

org.jgroups.Header

org.jgroups.blocks.RequestCorrelator.Header

All Implemented Interfaces:

Externalizable, Serializable, Streamable

Enclosing class:

RequestCorrelator

public static final class RequestCorrelator.Header
extends Header
implements Streamable

The header for RequestCorrelator messages

Author:

Bela Ban

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
Stack<Address>	callStack	Stack<Address>.
String	corrName	The unique name of the associated RequestCorrelator
List<Address>	dest_mbrs	Contains a list of members who should receive the request (others will drop).
long	id	The id of this request to distinguish among other requests from the same RequestCorrelator
static final byte	REQ
static final byte	RSP
boolean	rsp_expected	msg is synchronous if true
byte	type	Type of header: request or reply

Fields inherited from class Header

HDR_OVERHEAD

Constructor Summary

Constructors

Constructor	Description
Header()	Used for externalization
Header(byte type, long id, boolean rsp_expected, String name)

Method Summary

Modifier and Type	Method	Description
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

REQ

public static final byte REQ

See Also:

• Constant Field Values

RSP

public static final byte RSP

See Also:

• Constant Field Values

type

public byte type

Type of header: request or reply

id

public long id

The id of this request to distinguish among other requests from the same RequestCorrelator

rsp_expected

public boolean rsp_expected

msg is synchronous if true

corrName

public String corrName

The unique name of the associated RequestCorrelator

callStack

public Stack<Address> callStack

Stack<Address>. Contains senders (e.g. P --> Q --> R)

dest_mbrs

public List<Address> dest_mbrs

Contains a list of members who should receive the request (others will drop). Ignored if null

Constructor Details

Header

public Header()

Used for externalization

Header

public Header(byte type,
 long id,
 boolean rsp_expected,
 String name)

Parameters:

type - type of header (REQ/RSP)

id - id of this header relative to ids of other requests originating from the same correlator

rsp_expected - whether it's a sync or async request

name - the name of the RequestCorrelator from which

Method Details

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