bftsmart.consensus.messages

Class PaxosMessage

java.lang.Object

bftsmart.communication.SystemMessage

bftsmart.consensus.messages.PaxosMessage

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class PaxosMessage
extends SystemMessage

This class represents a message used in the paxos protocol.

See Also:

Serialized Form

Field Summary

Fields inherited from class bftsmart.communication.SystemMessage

authenticated, sender

Constructor Summary

Constructors

Constructor and Description
PaxosMessage() Creates a paxos message.
PaxosMessage(int paxosType, int id, int round, int from) Creates a paxos message.
PaxosMessage(int paxosType, int id, int round, int from, byte[] value) Creates a paxos message.

Method Summary

Methods

Modifier and Type	Method and Description
int	getNumber() Returns the consensus execution ID of this message
int	getPaxosType() Returns this message type
java.lang.String	getPaxosVerboseType() Returns this message type as a verbose string
java.lang.Object	getProof() Returns the proof associated with a PROPOSE or COLLECT message
int	getRound() Retrieves the round number to which this message belongs
byte[]	getValue() Retrieves the value contained in the message.
void	readExternal(java.io.ObjectInput in)
void	setProof(java.lang.Object proof)
java.lang.String	toString()
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class bftsmart.communication.SystemMessage

getSender

Methods inherited from class java.lang.Object

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

Constructor Detail

PaxosMessage

public PaxosMessage()

Creates a paxos message. Not used. TODO: How about making it private?

PaxosMessage

public PaxosMessage(int paxosType,
            int id,
            int round,
            int from,
            byte[] value)

Creates a paxos message. Used by the message factory to create a COLLECT or PROPOSE message TODO: How about removing the modifier, to make it visible just within the package?

Parameters:

paxosType - This should be MessageFactory.COLLECT or MessageFactory.PROPOSE

id - Consensus's execution ID

round - Round number

from - This should be this process ID

value - This should be null if its a COLLECT message, or the proposed value if it is a PROPOSE message

PaxosMessage

public PaxosMessage(int paxosType,
            int id,
            int round,
            int from)

Creates a paxos message. Used by the message factory to create a FREEZE message TODO: How about removing the modifier, to make it visible just within the package?

Parameters:

paxosType - This should be MessageFactory.FREEZE

id - Consensus's execution ID

round - Round number

from - This should be this process ID

Method Detail

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class SystemMessage

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Overrides:

readExternal in class SystemMessage

Throws:

java.io.IOException

java.lang.ClassNotFoundException

getRound

public int getRound()

Retrieves the round number to which this message belongs

Returns:

Round number to which this message belongs

getValue

public byte[] getValue()

Retrieves the value contained in the message.

Returns:

The value

setProof

public void setProof(java.lang.Object proof)

getProof

public java.lang.Object getProof()

Returns the proof associated with a PROPOSE or COLLECT message

Returns:

The proof

getNumber

public int getNumber()

Returns the consensus execution ID of this message

Returns:

Consensus execution ID of this message

getPaxosType

public int getPaxosType()

Returns this message type

Returns:

This message type

getPaxosVerboseType

public java.lang.String getPaxosVerboseType()

Returns this message type as a verbose string

Returns:

Message type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object