org.jgroups.blocks

Class RequestCorrelator.Header

java.lang.Object

org.jgroups.Header

org.jgroups.blocks.RequestCorrelator.Header

All Implemented Interfaces:

Streamable

Direct Known Subclasses:

RequestCorrelator.MultiDestinationHeader

Enclosing class:

RequestCorrelator

public static class RequestCorrelator.Header
extends Header

The header for RequestCorrelator messages

Field Summary

Fields

Modifier and Type	Field and Description
short	corrId The unique ID of the associated RequestCorrelator
static byte	EXC_RSP
static byte	REQ
long	req_id The request id (unique for each blocking request), 0 means no response is expected
static byte	RSP
byte	type Type of header: request or reply

Fields inherited from class org.jgroups.Header

prot_id

Constructor Summary

Constructors

Constructor and Description
Header()
Header(byte type, long req_id, short corr_id)

Method Summary

Modifier and Type	Method and Description
short	corrId()
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
long	requestId()
RequestCorrelator.Header	requestId(long req_id)
boolean	rspExpected()
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 org.jgroups.Header

getProtId, setProtId

Methods inherited from class java.lang.Object

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

Field Detail

REQ

public static final byte REQ

See Also:

Constant Field Values

RSP

public static final byte RSP

See Also:

Constant Field Values

EXC_RSP

public static final byte EXC_RSP

See Also:

Constant Field Values

type

public byte type

Type of header: request or reply

req_id

public long req_id

The request id (unique for each blocking request), 0 means no response is expected

corrId

public short corrId

The unique ID of the associated RequestCorrelator

Constructor Detail

Header

public Header()

Header

public Header(byte type,
              long req_id,
              short corr_id)

Parameters:

type - type of header (REQ/RSP)

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

corr_id - The ID of the RequestCorrelator from which

Method Detail

requestId

public RequestCorrelator.Header requestId(long req_id)

requestId

public long requestId()

rspExpected

public boolean rspExpected()

corrId

public short corrId()

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