Header

java.lang.Object
- org.jgroups.Header

All Implemented Interfaces:

Constructable<Header>, SizeStreamable, Streamable

Direct Known Subclasses:

ABP.ABPHeader, AuthHeader, COMPRESS.CompressHeader, COUNTER.CounterHeader, DAISYCHAIN.DaisyHeader, DH_KEY_EXCHANGE.DhHeader, EncryptHeader, EXAMPLE.ExampleHeader, Executing.ExecutorHeader, FailureDetection.HeartbeatHeader, FcHeader, FD_SOCK.FdHeader, FD.FdHeader, FLUSH.FlushHeader, FORK.ForkHeader, FORWARD_TO_COORD.ForwardHeader, Frag3Header, FragHeader, GMS.GmsHeader, Locking.LockingHeader, MERGE3.MergeHeader, NakAckHeader2, NAMING.Header, PERF.PerfHeader, PingHeader, RELAY.RelayHeader, RELAY2.Relay2Header, RequestCorrelator.Header, RSVP.RsvpHeader, SaslHeader, SEQUENCER.SequencerHeader, SEQUENCER2.SequencerHeader, STABLE.StableHeader, STATE_TRANSFER.StateHeader, STOMP.StompHeader, StreamingStateTransfer.StateHeader, ToaHeader, TpHeader, UnicastHeader3, VERIFY_SUSPECT.VerifyHeader
```
public abstract class Header
extends java.lang.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

Author:

Bela Ban

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

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`abstract short`	`getMagicId()`	Returns the magic-ID.
`short`	`getProtId()`
`Header`	`setProtId(short id)`
`int`	`size()`	Deprecated. Headers should implement `SizeStreamable.serializedSize()` instead
`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.Constructable
create

Methods inherited from interface org.jgroups.util.SizeStreamable
serializedSize

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)
```
  - getMagicId
```
public abstract short getMagicId()
```
    Returns the magic-ID. If defined in jg-magic-map.xml, the IDs need to be the same
  - size
```
@Deprecated
public int size()
```
    Deprecated.
    Headers should implement SizeStreamable.serializedSize() instead
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object