Package org.jgroups.protocols.tom

Class ToaHeader

java.lang.Object

org.jgroups.Header

org.jgroups.protocols.tom.ToaHeader

All Implemented Interfaces:

Constructable<Header>, SizeStreamable, Streamable

public class ToaHeader
extends Header

The header for the Total Order Anycast (TOA) protocol

Since:

3.1

Author:

Pedro Ruivo

Field Summary

Fields

Modifier and Type	Field	Description
static byte	DATA_MESSAGE
static byte	FINAL_MESSAGE
static byte	PROPOSE_MESSAGE
static byte	SINGLE_DESTINATION_MESSAGE

Fields inherited from class org.jgroups.Header

prot_id

Constructor Summary

Constructors

Constructor	Description
ToaHeader()

Method Summary

Modifier and Type	Method	Description
java.util.function.Supplier<? extends Header>	create()	Creates an instance of the class implementing this interface
static ToaHeader	createSingleDestinationHeader(MessageID messageID)
short	getMagicId()	Returns the magic-ID.
MessageID	getMessageID()
long	getSequencerNumber()
byte	getType()
long	getViewId()
static ToaHeader	newDataMessageHeader(MessageID messageID, long viewId)
static ToaHeader	newFinalMessageHeader(MessageID messageID, long sequenceNumber)
static ToaHeader	newProposeMessageHeader(MessageID messageID, long sequencerNumber)
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
int	serializedSize()	Returns the size (in bytes) of the marshalled object
ToaHeader	setSequencerNumber(long sequencerNumber)
java.lang.String	toString()
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, size

Methods inherited from class java.lang.Object

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

Field Detail

DATA_MESSAGE

public static final byte DATA_MESSAGE

See Also:

Constant Field Values

PROPOSE_MESSAGE

public static final byte PROPOSE_MESSAGE

See Also:

Constant Field Values

FINAL_MESSAGE

public static final byte FINAL_MESSAGE

See Also:

Constant Field Values

SINGLE_DESTINATION_MESSAGE

public static final byte SINGLE_DESTINATION_MESSAGE

See Also:

Constant Field Values

Constructor Detail

ToaHeader

public ToaHeader()

Method Detail

getMagicId

public short getMagicId()

Description copied from class: Header

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

Specified by:

getMagicId in class Header

create

public java.util.function.Supplier<? extends Header> create()

Description copied from interface: Constructable

Creates an instance of the class implementing this interface

getMessageID

public MessageID getMessageID()

getSequencerNumber

public long getSequencerNumber()

setSequencerNumber

public ToaHeader setSequencerNumber(long sequencerNumber)

getType

public byte getType()

serializedSize

public int serializedSize()

Description copied from interface: SizeStreamable

Returns the size (in bytes) of the marshalled object

writeTo

public void writeTo(java.io.DataOutput out)
             throws java.io.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

Throws:

java.io.IOException

readFrom

public void readFrom(java.io.DataInput in)
              throws java.io.IOException,
                     java.lang.ClassNotFoundException

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.io.IOException

java.lang.ClassNotFoundException

toString

public java.lang.String toString()

Overrides:

toString in class Header

newDataMessageHeader

public static ToaHeader newDataMessageHeader(MessageID messageID,
                                             long viewId)

newProposeMessageHeader

public static ToaHeader newProposeMessageHeader(MessageID messageID,
                                                long sequencerNumber)

newFinalMessageHeader

public static ToaHeader newFinalMessageHeader(MessageID messageID,
                                              long sequenceNumber)

createSingleDestinationHeader

public static ToaHeader createSingleDestinationHeader(MessageID messageID)

getViewId

public long getViewId()