org.jgroups.protocols
Class FcHeader

java.lang.Object
  org.jgroups.Header
      org.jgroups.protocols.FcHeader

All Implemented Interfaces:

Streamable

public class FcHeader
extends Header

Header used by various flow control protocols

Author:

Bela Ban

Field Summary

static byte	CREDIT_REQUEST
static byte	REPLENISH

Constructor Summary

FcHeader()

FcHeader(byte type)

Method Summary

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

REPLENISH

public static final byte REPLENISH

See Also:

Constant Field Values

CREDIT_REQUEST

public static final byte CREDIT_REQUEST

See Also:

Constant Field Values

Constructor Detail

FcHeader

public FcHeader()

FcHeader

public FcHeader(byte type)

Method Detail

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

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

toString

public java.lang.String toString()

Overrides:

toString in class Header