org.jgroups

Class Header

java.lang.Object

org.jgroups.Header

All Implemented Interfaces:

Streamable

Direct Known Subclasses:

ABP.ABPHeader, AuthHeader, COMPRESS.CompressHeader, COUNTER.CounterHeader, DAISYCHAIN.DaisyHeader, DemoToken.DemoHeader, ENCRYPT.EncryptHeader, EncryptHeader, EXAMPLE.ExampleHeader, Executing.ExecutorHeader, FcHeader, FD_ALL.HeartbeatHeader, FD_ALL2.HeartbeatHeader, FD_SOCK.FdHeader, FD.FdHeader, FLUSH.FlushHeader, FORK.ForkHeader, FORWARD_TO_COORD.ForwardHeader, FragHeader, GMS.GmsHeader, Locking.LockingHeader, MERGE2.MergeHeader, MERGE3.MergeHeader, MuxHeader, NakAckHeader, NakAckHeader2, PERF.PerfHeader, PingHeader, PrioHeader, RELAY.RelayHeader, RELAY2.Relay2Header, RequestCorrelator.Header, RSVP.RsvpHeader, SaslHeader, SCOPE.ScopeHeader, SEQUENCER.SequencerHeader, SEQUENCER2.SequencerHeader, STABLE.StableHeader, STATE_TRANSFER.StateHeader, STOMP.StompHeader, StreamingStateTransfer.StateHeader, ToaHeader, TpHeader, UNICAST.UnicastHeader, UNICAST2.Unicast2Header, UNICAST3.Header, VERIFY_SUSPECT.VerifyHeader

public abstract class Header
extends java.lang.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

Field Summary

Fields

Modifier and Type	Field and Description
protected short	prot_id The ID of the protocol which added a header to a message.

Constructor Summary

Constructors

Constructor and Description
Header()

Method Summary

Modifier and Type	Method and Description
short	getProtId()
Header	setProtId(short id)
abstract int	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 org.jgroups.util.Streamable

readFrom, writeTo

Field Detail

prot_id

protected short prot_id

The ID of the protocol which added a header to a message. Set externally, e.g. by Message.putHeader(short,Header)

Constructor Detail

Header

public Header()

Method Detail

getProtId

public short getProtId()

setProtId

public Header setProtId(short id)

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 java.lang.String toString()

Overrides:

toString in class java.lang.Object