Class GMS.GmsHeader

java.lang.Object

org.jgroups.Header

org.jgroups.protocols.pbcast.GMS.GmsHeader

All Implemented Interfaces:

Externalizable, Serializable, Streamable

Enclosing class:

GMS

public static class GMS.GmsHeader
extends Header
implements Streamable

Version:

$Id: GMS.java,v 1.126.2.20.2.3 2009/04/22 06:57:51 belaban Exp $

Author:

Bela Ban

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	CANCEL_MERGE
static final byte	GET_DIGEST_REQ
static final byte	GET_DIGEST_RSP
static final byte	INSTALL_MERGE_VIEW
static final byte	INSTALL_MERGE_VIEW_OK
static final byte	JOIN_REQ
static final byte	JOIN_REQ_WITH_STATE_TRANSFER
static final byte	JOIN_RSP
static final byte	LEAVE_REQ
static final byte	LEAVE_RSP
static final byte	MERGE_REQ
static final byte	MERGE_RSP
static final byte	VIEW
static final byte	VIEW_ACK

Fields inherited from class Header

HDR_OVERHEAD

Constructor Summary

Constructors

Constructor	Description
GmsHeader()
GmsHeader(byte type)
GmsHeader(byte type, Address mbr)	Used for JOIN_REQ or LEAVE_REQ header
GmsHeader(byte type, JoinRsp join_rsp)	Used for JOIN_RSP header
GmsHeader(byte type, View view)	Used for VIEW header

Method Summary

Modifier and Type	Method	Description
Address	getMember()
byte	getType()
void	readExternal(ObjectInput in)
void	readFrom(DataInputStream in)	Read the state of the current object (including superclasses) from instream Note that the input stream must not be closed
int	size()	To be implemented by subclasses.
String	toString()
static String	type2String(int type)
void	writeExternal(ObjectOutput out)
void	writeTo(DataOutputStream out)	Write the entire state of the current object (including superclasses) to outstream.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

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

Constructor Details

GmsHeader

public GmsHeader()

GmsHeader

public GmsHeader(byte type)

GmsHeader

public GmsHeader(byte type,
 View view)

Used for VIEW header

GmsHeader

public GmsHeader(byte type,
 Address mbr)

Used for JOIN_REQ or LEAVE_REQ header

GmsHeader

public GmsHeader(byte type,
 JoinRsp join_rsp)

Used for JOIN_RSP header

Method Details

getType

public byte getType()

getMember

public Address getMember()

toString

public String toString()

Overrides:

toString in class Header

type2String

public static String type2String(int type)

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeTo

public void writeTo(DataOutputStream out)
             throws IOException

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

Specified by:

writeTo in interface Streamable

Throws:

IOException

readFrom

public void readFrom(DataInputStream in)
              throws IOException,
IllegalAccessException,
InstantiationException

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

Specified by:

readFrom in interface Streamable

Throws:

IOException

IllegalAccessException

InstantiationException

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.

Overrides:

size in class Header