bftsmart.tom.server.defaultservices

Class DefaultApplicationState

java.lang.Object

bftsmart.tom.server.defaultservices.DefaultApplicationState

All Implemented Interfaces:

ApplicationState, java.io.Serializable

public class DefaultApplicationState
extends java.lang.Object
implements ApplicationState

This classe represents a state tranfered from a replica to another. The state associated with the last checkpoint together with all the batches of messages received do far, comprises the sender's current state

Author:

Jo�o Sousa

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultApplicationState() Constructs a TansferableState This constructor should be used when there isn't a valid state to construct the object with
DefaultApplicationState(CommandsInfo[] messageBatches, byte[] logHash, int lastCheckpointEid, int lastCheckpointRound, int lastCheckpointLeader, int lastEid, byte[] state, byte[] stateHash)
DefaultApplicationState(CommandsInfo[] messageBatches, int lastCheckpointEid, int lastCheckpointRound, int lastCheckpointLeader, int lastEid, byte[] state, byte[] stateHash) Constructs a TansferableState This constructor should be used when there is a valid state to construct the object with

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) This method MUST be implemented.
int	getLastCheckpointEid() Retrieves the execution ID for the last checkpoint
int	getLastCheckpointLeader() Retrieves the leader for the last checkpoint
int	getLastCheckpointRound() Retrieves the decision round for the last checkpoint
int	getLastEid() Retrieves the execution ID for the last messages batch delivered to the application
CommandsInfo	getMessageBatch(int eid) Retrieves the specified batch of messages
CommandsInfo[]	getMessageBatches() Retrieves all batches of messages
byte[]	getSerializedState() Byte array that must be a representation of the application state
byte[]	getState() Retrieves the state associated with the last checkpoint
byte[]	getStateHash() Retrieves the hash of the state associated with the last checkpoint
int	hashCode() This method MUST be implemented.
boolean	hasState() Indicates if the TransferableState object has a valid state
void	setMessageBatches(CommandsInfo[] messageBatches)
void	setSerializedState(byte[] state) Sets a byte array that must be a representation of the application state
void	setState(byte[] state) Sets the state associated with the last checkpoint

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultApplicationState

public DefaultApplicationState(CommandsInfo[] messageBatches,
                       int lastCheckpointEid,
                       int lastCheckpointRound,
                       int lastCheckpointLeader,
                       int lastEid,
                       byte[] state,
                       byte[] stateHash)

Constructs a TansferableState This constructor should be used when there is a valid state to construct the object with

Parameters:

messageBatches - Batches received since the last checkpoint.

state - State associated with the last checkpoint

stateHash - Hash of the state associated with the last checkpoint

DefaultApplicationState

public DefaultApplicationState(CommandsInfo[] messageBatches,
                       byte[] logHash,
                       int lastCheckpointEid,
                       int lastCheckpointRound,
                       int lastCheckpointLeader,
                       int lastEid,
                       byte[] state,
                       byte[] stateHash)

DefaultApplicationState

public DefaultApplicationState()

Constructs a TansferableState This constructor should be used when there isn't a valid state to construct the object with

Method Detail

setSerializedState

public void setSerializedState(byte[] state)

Description copied from interface: ApplicationState

Sets a byte array that must be a representation of the application state

Specified by:

setSerializedState in interface ApplicationState

Parameters:

state - a byte array that must be a representation of the application state

getSerializedState

public byte[] getSerializedState()

Description copied from interface: ApplicationState

Byte array that must be a representation of the application state

Specified by:

getSerializedState in interface ApplicationState

hasState

public boolean hasState()

Indicates if the TransferableState object has a valid state

Specified by:

hasState in interface ApplicationState

Returns:

true if it has a valid state, false otherwise

getLastEid

public int getLastEid()

Retrieves the execution ID for the last messages batch delivered to the application

Specified by:

getLastEid in interface ApplicationState

Returns:

Execution ID for the last messages batch delivered to the application

getState

public byte[] getState()

Retrieves the state associated with the last checkpoint

Returns:

State associated with the last checkpoint

getStateHash

public byte[] getStateHash()

Retrieves the hash of the state associated with the last checkpoint

Specified by:

getStateHash in interface ApplicationState

Returns:

Hash of the state associated with the last checkpoint

setState

public void setState(byte[] state)

Sets the state associated with the last checkpoint

Parameters:

state - State associated with the last checkpoint

getMessageBatches

public CommandsInfo[] getMessageBatches()

Retrieves all batches of messages

Returns:

Batch of messages

setMessageBatches

public void setMessageBatches(CommandsInfo[] messageBatches)

getMessageBatch

public CommandsInfo getMessageBatch(int eid)

Retrieves the specified batch of messages

Parameters:

eid - Execution ID associated with the batch to be fetched

Returns:

The batch of messages associated with the batch correspondent execution ID

getLastCheckpointEid

public int getLastCheckpointEid()

Retrieves the execution ID for the last checkpoint

Returns:

Execution ID for the last checkpoint, or -1 if no checkpoint was yet executed

getLastCheckpointRound

public int getLastCheckpointRound()

Retrieves the decision round for the last checkpoint

Returns:

Decision round for the last checkpoint, or -1 if no checkpoint was yet executed

getLastCheckpointLeader

public int getLastCheckpointLeader()

Retrieves the leader for the last checkpoint

Returns:

Leader for the last checkpoint, or -1 if no checkpoint was yet executed

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: ApplicationState

This method MUST be implemented. However, the attribute returned by getSerializedState() should be ignored, and getStateHash() should be used instead

Specified by:

equals in interface ApplicationState

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Description copied from interface: ApplicationState

This method MUST be implemented. However, the attribute returned by getSerializedState() should be ignored, and getStateHash() should be used instead

Specified by:

hashCode in interface ApplicationState

Overrides:

hashCode in class java.lang.Object