org.jgroups
Class Header

java.lang.Object
  org.jgroups.Header

All Implemented Interfaces:

java.lang.Cloneable, java.io.Externalizable, java.io.Serializable

Direct Known Subclasses:

BSH.BshHeader, CAUSAL.CausalHeader, COMPRESS.CompressHeader, DenyResponseHeader, ENCRYPT1_4.EncryptHeader, FC.FcHeader, FD_PID.FdHeader, FD_PROB.FdHeader, FD_SIMPLE.FdHeader, FD_SOCK.FdHeader, FD.FdHeader, FRAG.FragHeader, FRAG2.FragHeader, GMS.GmsHeader, LeaseInfoReplicationHeader, LeaseRequestHeader, LeaseResponseHeader, MERGE.MergeHeader, MERGEFAST.MergefastHeader, NakAckHeader, NakAckHeader, PARTITIONER.PartitionerHeader, PbcastHeader, PerfHeader, PIGGYBACK.PiggybackHeader, PingHeader, PullPushAdapter.PullHeader, RequestCorrelator.Header, SMACK.SmackHeader, STABLE.StableHeader, STATE_TRANSFER.StateHeader, TcpHeader, TOTAL_OLD.TotalHeader, TOTAL_TOKEN.RingTokenHeader, TOTAL_TOKEN.TotalTokenHeader, TOTAL.Header, TunnelHeader, UdpHeader, UNICAST.UnicastHeader, VERIFY_SUSPECT.VerifyHeader, WANPIPE.WanPipeHeader

public abstract class Header

extends java.lang.Object

implements java.io.Externalizable, java.lang.Cloneable

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

Author:

Bela Ban, bela@nms.fnc.fujitsu.com

See Also:

Serialized Form

Field Summary

static long

HDR_OVERHEAD

Constructor Summary

Header()

Method Summary

long	size() To be implemented by subclasses.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Field Detail

HDR_OVERHEAD

public static final long HDR_OVERHEAD

See Also:

Constant Field Values

Constructor Detail

Header

public Header()

Method Detail

size

public long 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()