Package org.jgroups

Class Header

java.lang.Object

org.jgroups.Header

All Implemented Interfaces:

Constructable<Header>, SizeStreamable, Streamable

Direct Known Subclasses:

AuthHeader, BATCH.BatchHeader, BATCH2.Batch2Header, COMPRESS.CompressHeader, COUNTER.CounterHeader, DAISYCHAIN.DaisyHeader, DH_KEY_EXCHANGE.DhHeader, EncryptHeader, EXAMPLE.ExampleHeader, FailureDetection.HeartbeatHeader, FcHeader, FD_SOCK.FdHeader, FD_SOCK2.FdHeader, FLUSH.FlushHeader, FORK.ForkHeader, Frag3Header, FragHeader, GMS.GmsHeader, Locking.LockingHeader, MERGE3.MergeHeader, MessageSendTest.MyHeader, MPerf.MPerfHeader, NakAckHeader2, PERF.PerfHeader, PingHeader, ProtPerfHeader, RelayHeader, RequestCorrelator.Header, RSVP.RsvpHeader, RTTHeader, SEQUENCER.SequencerHeader, SEQUENCER2.SequencerHeader, STABLE.StableHeader, STATE_TRANSFER.StateHeader, STOMP.StompHeader, StreamingStateTransfer.StateHeader, TpHeader, UnicastHeader3, VERIFY_SUSPECT.VerifyHeader, VERIFY_SUSPECT2.VerifyHeader

public abstract class Header
extends Object
implements SizeStreamable, Constructable<Header>

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
Header()

Method Summary

Modifier and Type	Method	Description
abstract short	getMagicId()	Returns the magic-ID.
short	getProtId()
Header	setProtId(short id)
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.Constructable

create

Methods inherited from interface org.jgroups.util.SizeStreamable

serializedSize

Methods inherited from interface org.jgroups.util.Streamable

readFrom, writeTo

Field Details

prot_id

protected short prot_id

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

Constructor Details

Header

public Header()

Method Details

getProtId

public short getProtId()

setProtId

public Header setProtId(short id)

getMagicId

public abstract short getMagicId()

Returns the magic-ID. If defined in jg-magic-map.xml, the IDs need to be the same

toString

public String toString()

Overrides:

toString in class Object