org.jgroups

Class Header

java.lang.Object

org.jgroups.Header

All Implemented Interfaces:

Streamable

Direct Known Subclasses:

AuthHeader, COMPRESS.CompressHeader, COUNTER.CounterHeader, DAISYCHAIN.DaisyHeader, DISCARD.DiscardHeader, ENCRYPT.EncryptHeader, Executing.ExecutorHeader, FcHeader, FD_ALL.HeartbeatHeader, FD_SIMPLE.FdHeader, FD_SOCK.FdHeader, FD.FdHeader, FLUSH.FlushHeader, FragHeader, GMS.GmsHeader, HTOTAL.HTotalHeader, Locking.LockingHeader, MuxHeader, NakAckHeader, PingHeader, PrioHeader, RELAY.RelayHeader, RequestCorrelator.Header, RSVP.RsvpHeader, SCOPE.ScopeHeader, SEQUENCER.SequencerHeader, STABLE.StableHeader, STATE_TRANSFER.StateHeader, STOMP.StompHeader, StreamingStateTransfer.StateHeader, TpHeader, UNICAST.UnicastHeader, UNICAST2.Unicast2Header, VERIFY_SUSPECT.VerifyHeader

public abstract class Header
extends Object
implements Streamable

Header is a JGroups internal base class for all JGroups headers. Client normally do not need to interact with headers unless they are developing their custom protocols.

Since:

2.0

Author:

Bela Ban

Constructor Summary

Constructors

Constructor and Description
Header()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jgroups.util.Streamable

readFrom, writeTo

Constructor Detail

Header

public Header()

Method Detail

size

public abstract 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 String toString()

Overrides:

toString in class Object