org.jgroups.protocols.tom
Class ToaHeader

java.lang.Object
  org.jgroups.Header
      org.jgroups.protocols.tom.ToaHeader

All Implemented Interfaces:

Streamable

public class ToaHeader
extends Header

The header for the Total Order Anycast (TOA) protocol

Since:

3.1

Author:

Pedro Ruivo

Field Summary

static byte	DATA_MESSAGE
static byte	FINAL_MESSAGE
static byte	PROPOSE_MESSAGE
static byte	SINGLE_DESTINATION_MESSAGE

Constructor Summary

ToaHeader()

Method Summary

void	addDestinations(java.util.Collection<Address> addresses)
static ToaHeader	createNewHeader(byte type, MessageID messageID)
static ToaHeader	createSingleDestinationHeader()
java.util.Collection<Address>	getDestinations()
MessageID	getMessageID()
Address	getOrigin()
long	getSequencerNumber()
byte	getType()
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	setSequencerNumber(long sequencerNumber)
int	size() To be implemented by subclasses.
java.lang.String	toString()
static java.lang.String	type2String(byte type)
void	writeTo(java.io.DataOutput out) Write the entire state of the current object (including superclasses) to outstream.

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

getMessageID

public MessageID getMessageID()

getOrigin

public Address getOrigin()

addDestinations

public void addDestinations(java.util.Collection<Address> addresses)

getDestinations

public java.util.Collection<Address> getDestinations()

getSequencerNumber

public long getSequencerNumber()

setSequencerNumber

public void setSequencerNumber(long sequencerNumber)

getType

public byte getType()

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

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

toString

public java.lang.String toString()

Overrides:

toString in class Header

type2String

public static java.lang.String type2String(byte type)

createNewHeader

public static ToaHeader createNewHeader(byte type,
                                        MessageID messageID)

createSingleDestinationHeader

public static ToaHeader createSingleDestinationHeader()