## Uses of Class
org.jgroups.Header

Packages that use Header
Package | Description
--- | ---
org.jgroups | Provides top-level public JGroups classes such as Channel, Message, etc.
org.jgroups.blocks | Provides building blocks that are layered on top of channels.
org.jgroups.blocks.mux |
org.jgroups.protocols | Provides implementations of transport protocols which are responsible for sending and receiving messages to/from the network.
org.jgroups.protocols.pbcast | Supports probabilistic broadcasts.
org.jgroups.util | Provides useful functionality which cannot be assigned to any particular other package.

### Uses of Header in org.jgroups

Methods in org.jgroups that return Header
Modifier and Type | Method and Description
--- | ---
`Header` | Message.`getHeader(short id)`
`Header` | Message.`putHeaderIfAbsent(short id, Header hdr)` Puts a header given a key into the map, only if the key doesn't exist yet
`Header` | Message.`removeHeader(short id)` Deprecated. Use getHeader() instead. The issue with removing a header is described in http://jira.jboss.com/jira/browse/JGRP-393

Methods in org.jgroups that return types with arguments of type Header
Modifier and Type | Method and Description
--- | ---
`java.util.Map<java.lang.Short,Header>` | Message.`getHeaders()` Returns a reference to the headers hashmap, which is immutable.

Methods in org.jgroups with parameters of type Header
Modifier and Type | Method and Description
--- | ---
`void` | Message.`putHeader(short id, Header hdr)` Puts a header given an ID into the hashmap.
`Header` | Message.`putHeaderIfAbsent(short id, Header hdr)` Puts a header given a key into the map, only if the key doesn't exist yet

### Uses of Header in org.jgroups.blocks

Subclasses of Header in org.jgroups.blocks
Modifier and Type | Class and Description
--- | ---
`static class` | `PullPushAdapter.PullHeader` Deprecated.
`static class` | `RequestCorrelator.Header` The header for `RequestCorrelator` messages
`static class` | `RequestCorrelator.MultiDestinationHeader`

### Uses of Header in org.jgroups.blocks.mux

Subclasses of Header in org.jgroups.blocks.mux
Modifier and Type | Class and Description
--- | ---
`class` | `MuxHeader` Header that identifies the target handler for multiplexed dispatches.

### Uses of Header in org.jgroups.protocols

Subclasses of Header in org.jgroups.protocols
Modifier and Type | Class and Description
--- | ---
`class` | `AuthHeader` AuthHeader is a holder object for the token that is passed from the joiner to the coordinator
`static class` | `COMPRESS.CompressHeader`
`static class` | `DAISYCHAIN.DaisyHeader`
`static class` | `DISCARD.DiscardHeader`
`static class` | `ENCRYPT.EncryptHeader`
`static class` | `Executing.ExecutorHeader`
`class` | `FcHeader` Header used by various flow control protocols
`static class` | `FD_ALL.HeartbeatHeader`
`static class` | `FD_SIMPLE.FdHeader`
`static class` | `FD_SOCK.FdHeader`
`static class` | `FD.FdHeader`
`class` | `FragHeader`
`static class` | `HTOTAL.HTotalHeader`
`static class` | `Locking.LockingHeader`
`static class` | `MERGE3.CoordAnnouncement`
`static class` | `MERGEFAST.MergefastHeader`
`class` | `PingHeader`

`class`

`PrioHeader`
This Header class is used in conjunction with the PRIO protocol to prioritize message sending/receiving Priority values are from 0 to 255 where 0 is the highest priority Example of setting a message priority: `// Create a message to send to everyone Message message = new Message( null, null, messagePayload ); // Add the priority protocol header PrioHeader header = new PrioHeader( 1 ); short protocolId = ClassConfigurator.getProtocolId(PRIO.class); message.putHeader( protocolId, header);`

`static class` | `RELAY.RelayHeader`
`static class` | `SCOPE.ScopeHeader`
`static class` | `SEQUENCER.SequencerHeader`
`static class` | `SFC.Header` Deprecated.
`static class` | `SMACK.SmackHeader`
`static class` | `STOMP.StompHeader`
`class` | `TpHeader` Generic transport header, used by TP.
`static class` | `UNICAST.UnicastHeader` The following types and fields are serialized:
`static class` | `UNICAST2.Unicast2Header` The following types and fields are serialized:
`static class` | `VERIFY_SUSPECT.VerifyHeader`
`static class` | `VIEW_SYNC.ViewSyncHeader`

### Uses of Header in org.jgroups.protocols.pbcast

Subclasses of Header in org.jgroups.protocols.pbcast
Modifier and Type | Class and Description
--- | ---
`static class` | `FLUSH.FlushHeader`
`static class` | `GMS.GmsHeader`
`class` | `NakAckHeader`
`static class` | `STABLE.StableHeader`
`static class` | `STATE_TRANSFER.StateHeader` Wraps data for a state request/response.
`static class` | `STREAMING_STATE_TRANSFER.StateHeader`

### Uses of Header in org.jgroups.util

Methods in org.jgroups.util that return Header
Modifier and Type | Method and Description
--- | ---
`Header` | Headers.`getHeader(short id)` Returns the header associated with an ID
`Header[]` | Headers.`getRawHeaders()`
`Header` | Headers.`putHeaderIfAbsent(short id, Header hdr)` Puts a header given a key into the map, only if the key doesn't exist yet
`Header` | Headers.`removeHeader(short id)` Deprecated. Use getHeader() instead. The issue with removing a header is described in http://jira.jboss.com/jira/browse/JGRP-393

Methods in org.jgroups.util that return types with arguments of type Header
Modifier and Type | Method and Description
--- | ---
`java.util.Map<java.lang.Short,Header>` | Headers.`getHeaders()`

Methods in org.jgroups.util with parameters of type Header
Modifier and Type | Method and Description
--- | ---
`void` | Headers.`putHeader(short id, Header hdr)` Puts a header given a key into the hashmap.
`Header` | Headers.`putHeaderIfAbsent(short id, Header hdr)` Puts a header given a key into the map, only if the key doesn't exist yet