Package org.jgroups

Class Header

java.lang.Object

org.jgroups.Header

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

AuthHeader, BSH.BshHeader, CAUSAL.CausalHeader, CAUSAL.CausalNewViewHeader, COMPRESS.CompressHeader, DISCARD.DiscardHeader, ENCRYPT.EncryptHeader, FC.FcHeader, FD_ALL.Header, FD_SIMPLE.FdHeader, FD_SOCK.FdHeader, FD.FdHeader, FLUSH.FlushHeader, FragHeader, GMS.GmsHeader, HTOTAL.HTotalHeader, MERGE3.CoordAnnouncement, MERGEFAST.MergefastHeader, MuxHeader, NakAckHeader, PingHeader, PullPushAdapter.PullHeader, RequestCorrelator.Header, SEQUENCER.SequencerHeader, SFC.Header, SMACK.SmackHeader, STABLE.StableHeader, STATE_TRANSFER.StateHeader, STREAMING_STATE_TRANSFER.StateHeader, TcpHeader, TpHeader, TunnelHeader, UdpHeader, UNICAST.UnicastHeader, VERIFY_SUSPECT.VerifyHeader, VIEW_SYNC.ViewSyncHeader

public abstract class Header
extends java.lang.Object
implements java.io.Externalizable

Abstract base class for all headers to be added to a Message.

Author:

Bela Ban

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static int	HDR_OVERHEAD

Constructor Summary

Constructors

Constructor	Description
Header()

Method Summary

Modifier and Type	Method	Description
int	size()	To be implemented by subclasses.
java.lang.String	toString()

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

HDR_OVERHEAD

public static final int HDR_OVERHEAD

See Also:

Constant Field Values

Constructor Detail

Header

public Header()

Method Detail

size

public int size()

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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object