GMS.GmsHeader

java.lang.Object
- org.jgroups.Header
- - org.jgroups.protocols.pbcast.GMS.GmsHeader

All Implemented Interfaces:

Streamable

Enclosing class:

GMS
```
public static class GMS.GmsHeader
extends Header
```

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`CANCEL_MERGE`
`static byte`	`GET_CURRENT_VIEW`
`static byte`	`GET_DIGEST_REQ`
`static byte`	`GET_DIGEST_RSP`
`static byte`	`INSTALL_DIGEST`
`static byte`	`INSTALL_MERGE_VIEW`
`static byte`	`INSTALL_MERGE_VIEW_OK`
`static byte`	`JOIN_REQ`
`static byte`	`JOIN_REQ_WITH_STATE_TRANSFER`
`static byte`	`JOIN_RSP`
`static short`	`JOIN_RSP_PRESENT`
`static byte`	`LEAVE_REQ`
`static byte`	`LEAVE_RSP`
`protected Address`	`mbr`
`protected MergeId`	`merge_id`
`static short`	`MERGE_ID_PRESENT`
`protected boolean`	`merge_rejected`
`static short`	`MERGE_REJECTED`
`static byte`	`MERGE_REQ`
`static byte`	`MERGE_RSP`
`protected byte`	`type`
`static short`	`USE_FLUSH`
`protected boolean`	`useFlushIfPresent`
`static byte`	`VIEW`
`static byte`	`VIEW_ACK`

Fields inherited from class org.jgroups.Header
prot_id

Constructor Summary

Constructors
Constructor and Description
`GmsHeader()`
`GmsHeader(byte type)`
`GmsHeader(byte type, Address mbr)`
`GmsHeader(byte type, Address mbr, boolean useFlushIfPresent)` Used for JOIN_REQ or LEAVE_REQ header

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected short`	`determineFlags()`
`Address`	`getMember()`
`MergeId`	`getMergeId()`
`byte`	`getType()`
`boolean`	`isMergeRejected()`
`GMS.GmsHeader`	`mbr(Address mbr)`
`GMS.GmsHeader`	`mergeId(MergeId merge_id)`
`GMS.GmsHeader`	`mergeRejected(boolean flag)`
`void`	`readFrom(java.io.DataInput in)` Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
`void`	`setMergeId(MergeId merge_id)`
`void`	`setMergeRejected(boolean merge_rejected)`
`int`	`size()` To be implemented by subclasses.
`java.lang.String`	`toString()`
`static java.lang.String`	`type2String(int type)`
`void`	`writeTo(java.io.DataOutput out)` Write the entire state of the current object (including superclasses) to outstream.

Methods inherited from class org.jgroups.Header
getProtId, setProtId

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - JOIN_REQ
```
public static final byte JOIN_REQ
```
    See Also:
    
    Constant Field Values
  - JOIN_RSP
```
public static final byte JOIN_RSP
```
    See Also:
    
    Constant Field Values
  - LEAVE_REQ
```
public static final byte LEAVE_REQ
```
    See Also:
    
    Constant Field Values
  - LEAVE_RSP
```
public static final byte LEAVE_RSP
```
    See Also:
    
    Constant Field Values
  - VIEW
```
public static final byte VIEW
```
    See Also:
    
    Constant Field Values
  - MERGE_REQ
```
public static final byte MERGE_REQ
```
    See Also:
    
    Constant Field Values
  - MERGE_RSP
```
public static final byte MERGE_RSP
```
    See Also:
    
    Constant Field Values
  - INSTALL_MERGE_VIEW
```
public static final byte INSTALL_MERGE_VIEW
```
    See Also:
    
    Constant Field Values
  - CANCEL_MERGE
```
public static final byte CANCEL_MERGE
```
    See Also:
    
    Constant Field Values
  - VIEW_ACK
```
public static final byte VIEW_ACK
```
    See Also:
    
    Constant Field Values
  - JOIN_REQ_WITH_STATE_TRANSFER
```
public static final byte JOIN_REQ_WITH_STATE_TRANSFER
```
    See Also:
    
    Constant Field Values
  - INSTALL_MERGE_VIEW_OK
```
public static final byte INSTALL_MERGE_VIEW_OK
```
    See Also:
    
    Constant Field Values
  - GET_DIGEST_REQ
```
public static final byte GET_DIGEST_REQ
```
    See Also:
    
    Constant Field Values
  - GET_DIGEST_RSP
```
public static final byte GET_DIGEST_RSP
```
    See Also:
    
    Constant Field Values
  - INSTALL_DIGEST
```
public static final byte INSTALL_DIGEST
```
    See Also:
    
    Constant Field Values
  - GET_CURRENT_VIEW
```
public static final byte GET_CURRENT_VIEW
```
    See Also:
    
    Constant Field Values
  - JOIN_RSP_PRESENT
```
public static final short JOIN_RSP_PRESENT
```
    See Also:
    
    Constant Field Values
  - MERGE_ID_PRESENT
```
public static final short MERGE_ID_PRESENT
```
    See Also:
    
    Constant Field Values
  - USE_FLUSH
```
public static final short USE_FLUSH
```
    See Also:
    
    Constant Field Values
  - MERGE_REJECTED
```
public static final short MERGE_REJECTED
```
    See Also:
    
    Constant Field Values
  - type
```
protected byte type
```
  - mbr
```
protected Address mbr
```
  - merge_id
```
protected MergeId merge_id
```
  - useFlushIfPresent
```
protected boolean useFlushIfPresent
```
  - merge_rejected
```
protected boolean merge_rejected
```
- Constructor Detail
  - GmsHeader
```
public GmsHeader()
```
  - GmsHeader
```
public GmsHeader(byte type)
```
  - GmsHeader
```
public GmsHeader(byte type,
                 Address mbr,
                 boolean useFlushIfPresent)
```
    Used for JOIN_REQ or LEAVE_REQ header
  - GmsHeader
```
public GmsHeader(byte type,
                 Address mbr)
```
- Method Detail
  - getType
```
public byte getType()
```
  - mbr
```
public GMS.GmsHeader mbr(Address mbr)
```
  - mergeId
```
public GMS.GmsHeader mergeId(MergeId merge_id)
```
  - mergeRejected
```
public GMS.GmsHeader mergeRejected(boolean flag)
```
  - getMember
```
public Address getMember()
```
  - getMergeId
```
public MergeId getMergeId()
```
  - setMergeId
```
public void setMergeId(MergeId merge_id)
```
  - isMergeRejected
```
public boolean isMergeRejected()
```
  - setMergeRejected
```
public void setMergeRejected(boolean merge_rejected)
```
  - writeTo
```
public void writeTo(java.io.DataOutput out)
             throws java.lang.Exception
```
    Description copied from interface: Streamable
    
    Write the entire state of the current object (including superclasses) to outstream. Note that the output stream must not be closed
    
    Throws:
    
    java.lang.Exception
  - readFrom
```
public void readFrom(java.io.DataInput in)
              throws java.lang.Exception
```
    Description copied from interface: Streamable
    
    Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
    
    Throws:
    
    java.lang.Exception
  - size
```
public int size()
```
    Description copied from class: Header
    
    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.
    
    Specified by:
    
    size in class Header
  - determineFlags
```
protected short determineFlags()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class Header
  - type2String
```
public static java.lang.String type2String(int type)
```

Class GMS.GmsHeader

Field Summary

Fields inherited from class org.jgroups.Header

Constructor Summary

Method Summary

Methods inherited from class org.jgroups.Header

Methods inherited from class java.lang.Object

Field Detail

JOIN_REQ

JOIN_RSP

LEAVE_REQ

LEAVE_RSP

VIEW

MERGE_REQ

MERGE_RSP

INSTALL_MERGE_VIEW

CANCEL_MERGE

VIEW_ACK

JOIN_REQ_WITH_STATE_TRANSFER

INSTALL_MERGE_VIEW_OK

GET_DIGEST_REQ

GET_DIGEST_RSP

INSTALL_DIGEST

GET_CURRENT_VIEW

JOIN_RSP_PRESENT

MERGE_ID_PRESENT

USE_FLUSH

MERGE_REJECTED

type

mbr

merge_id

useFlushIfPresent

merge_rejected

Constructor Detail

GmsHeader

GmsHeader

GmsHeader

GmsHeader

Method Detail

getType

mbr

mergeId

mergeRejected

getMember

getMergeId

setMergeId

isMergeRejected

setMergeRejected

writeTo

readFrom

size

determineFlags

toString

type2String