edu.umass.cs.reconfiguration.reconfigurationpackets

Class RCRecordRequest<NodeIDType>

java.lang.Object

edu.umass.cs.protocoltask.json.ProtocolPacket<NodeIDType,ReconfigurationPacket.PacketType>

edu.umass.cs.reconfiguration.reconfigurationpackets.ReconfigurationPacket<NodeIDType>

edu.umass.cs.reconfiguration.reconfigurationpackets.BasicReconfigurationPacket<NodeIDType>

edu.umass.cs.reconfiguration.reconfigurationpackets.RCRecordRequest<NodeIDType>

All Implemented Interfaces:

Request, RequestIdentifier, SummarizableRequest, Byteable, ProtocolEvent<ReconfigurationPacket.PacketType,java.lang.String>, ThresholdProtocolEvent<NodeIDType,ReconfigurationPacket.PacketType,java.lang.String>, ReconfigurableRequest, ReplicableRequest, Keyable<java.lang.String>, Summarizable

public class RCRecordRequest<NodeIDType>
extends BasicReconfigurationPacket<NodeIDType>
implements ReplicableRequest, ReconfigurableRequest, SummarizableRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RCRecordRequest.RequestTypes RCRecordRequest sub-types.

Nested classes/interfaces inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.ReconfigurationPacket

ReconfigurationPacket.PacketType

Field Summary

Fields

Modifier and Type	Field and Description
StartEpoch<NodeIDType>	startEpoch The start epoch request that started this reconfiguration.

Fields inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.BasicReconfigurationPacket

epochNumber, serviceName

Fields inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.ReconfigurationPacket

clientPacketTypes, HANDLER_METHOD_PREFIX, PACKET_TYPE, serverPacketTypes

Fields inherited from class edu.umass.cs.protocoltask.json.ProtocolPacket

type

Fields inherited from interface edu.umass.cs.reconfiguration.interfaces.ReconfigurableRequest

STOP

Fields inherited from interface edu.umass.cs.gigapaxos.interfaces.Request

NO_OP

Constructor Summary

Constructors

Constructor and Description
RCRecordRequest(org.json.JSONObject json, Stringifiable<NodeIDType> unstringer)
RCRecordRequest(NodeIDType initiator, StartEpoch<NodeIDType> startEpoch, RCRecordRequest.RequestTypes reqType)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
RCRecordRequest.RequestTypes	getRCRequestType()
static java.lang.String	getRCRequestTypeCompact(RCRecordRequest.RequestTypes rType)
long	getRequestID() The uniqueness of this identifier across all requests to a replica group is important for safety when PaxosConfig.PC.PREVENT_DOUBLE_EXECUTION is enabled as gigapaxos may otherwise assume that the duplicate request identifier corresponds to a retransmission and will send back the response if any corresponding to the first execution.
IntegerPacketType	getRequestType()
java.lang.String	getSummary() Implementations are encouraged to return an inline created new Object() whose toString() method will return the actual String instead of just returning the String directly.
java.lang.String	getSummary(java.util.logging.Level level)
int	hashCode()
boolean	isActiveNodeConfigChange()
boolean	isDeleteIntent()
boolean	isDeleteIntentOrPrevDropComplete()
boolean	isNodeConfigChange()
boolean	isReconfigurationComplete()
boolean	isReconfigurationIntent()
boolean	isReconfigurationMerge()
boolean	isReconfigurationPrevDropComplete()
boolean	isSplitIntent()
boolean	isStop()
boolean	lessThan(RCRecordRequest<NodeIDType> req2)
boolean	needsCoordination()
void	setNeedsCoordination(boolean b) After this method returns, ReplicableRequest.needsCoordination() should subsequently return b.
org.json.JSONObject	toJSONObjectImpl()

Methods inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.BasicReconfigurationPacket

getEpochNumber, getServiceName

Methods inherited from class edu.umass.cs.reconfiguration.reconfigurationpackets.ReconfigurationPacket

assertPacketTypeChecks, assertPacketTypeChecks, assertPacketTypeChecks, assertPacketTypeChecks, concatenate, getMessage, getPacketType, getPacketTypeCanonicalClassName, getPacketTypeClass, getPacketTypeClassName, getReconfigurationPacket, getReconfigurationPacket, getReconfigurationPacketSuppressExceptions, getReconfigurationPacketSuppressExceptions, getReconfigurationPacketType, getReconfigurationPacketType, isReconfigurationPacket, putPacketType, toBytes, toString

Methods inherited from class edu.umass.cs.protocoltask.json.ProtocolPacket

flip, getInitiator, getKey, getSender, getType, setKey, setSender, setType, toJSONObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface edu.umass.cs.reconfiguration.interfaces.ReconfigurableRequest

getEpochNumber

Methods inherited from interface edu.umass.cs.gigapaxos.interfaces.Request

getServiceName, toBytes, toString

Methods inherited from interface edu.umass.cs.utils.Summarizable

getSummary

Field Detail

startEpoch

public final StartEpoch<NodeIDType> startEpoch

The start epoch request that started this reconfiguration.

Constructor Detail

RCRecordRequest

public RCRecordRequest(NodeIDType initiator,
                       StartEpoch<NodeIDType> startEpoch,
                       RCRecordRequest.RequestTypes reqType)

Parameters:

initiator -

startEpoch -

reqType -

RCRecordRequest

public RCRecordRequest(org.json.JSONObject json,
                       Stringifiable<NodeIDType> unstringer)
                throws org.json.JSONException

Parameters:

json -

unstringer -

Throws:

org.json.JSONException

Method Detail

toJSONObjectImpl

public org.json.JSONObject toJSONObjectImpl()
                                     throws org.json.JSONException

Overrides:

toJSONObjectImpl in class BasicReconfigurationPacket<NodeIDType>

Throws:

org.json.JSONException

isReconfigurationIntent

public boolean isReconfigurationIntent()

isReconfigurationMerge

public boolean isReconfigurationMerge()

isReconfigurationComplete

public boolean isReconfigurationComplete()

isReconfigurationPrevDropComplete

public boolean isReconfigurationPrevDropComplete()

isDeleteIntent

public boolean isDeleteIntent()

isDeleteIntentOrPrevDropComplete

public boolean isDeleteIntentOrPrevDropComplete()

isSplitIntent

public boolean isSplitIntent()

getRequestType

public IntegerPacketType getRequestType()

Specified by:

getRequestType in interface Request

Overrides:

getRequestType in class BasicReconfigurationPacket<NodeIDType>

Returns:

The IntegerPacketType type corresponding to this request.

needsCoordination

public boolean needsCoordination()

Specified by:

needsCoordination in interface ReplicableRequest

Returns:

True if this request needs to be coordinated, false otherwise.

setNeedsCoordination

public void setNeedsCoordination(boolean b)

Description copied from interface: ReplicableRequest

After this method returns, ReplicableRequest.needsCoordination() should subsequently return b. This method is invoked by AbstractReplicaCoordinator with a false argument just before coordinating the request so that coordinated packets are not coordinated again infinitely. For example, if a replica coordinator's coordination strategy is to simply flood the request to all replicas, there needs to be a way for a recipient of a copy of this already once coordinated request to know that it should not coordinate it again. This method provides AbstractReplicaCoordinator a placeholder in the application request to prevent such infinite coordination loops.

This method is now deprecated and does not need to be overridden by implementing classes. It's original purpose was really only to be able to easily do lazy propagation replica coordination without introducing an additional type (just to distinguish between the original request at the entry replica and the replicated request so as to avoid an infinite propagation loop), but introducing an additional type is the clean way to do this. Paxos for example already has its own types, so it doesn't need this method.

Specified by:

setNeedsCoordination in interface ReplicableRequest

Parameters:

b - True if subsequent invocations of ReplicableRequest.needsCoordination() must return true, false otherwise.

isNodeConfigChange

public boolean isNodeConfigChange()

getRCRequestType

public RCRecordRequest.RequestTypes getRCRequestType()

isStop

public boolean isStop()

Specified by:

isStop in interface ReconfigurableRequest

Returns:

True if this request is a stop request.

getRCRequestTypeCompact

public static java.lang.String getRCRequestTypeCompact(RCRecordRequest.RequestTypes rType)

getSummary

public java.lang.String getSummary()

Description copied from interface: Summarizable

Implementations are encouraged to return an inline created new Object() whose toString() method will return the actual String instead of just returning the String directly. This helps loggers be more efficient as the String won't be generated until the log level demands it.

Specified by:

getSummary in interface Request

Specified by:

getSummary in interface SummarizableRequest

Specified by:

getSummary in interface ReconfigurableRequest

Specified by:

getSummary in interface Summarizable

Overrides:

getSummary in class BasicReconfigurationPacket<NodeIDType>

Returns:

A pretty-print summary.

getSummary

public java.lang.String getSummary(java.util.logging.Level level)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

lessThan

public boolean lessThan(RCRecordRequest<NodeIDType> req2)

getRequestID

public long getRequestID()

Description copied from interface: RequestIdentifier

The uniqueness of this identifier across all requests to a replica group is important for safety when PaxosConfig.PC.PREVENT_DOUBLE_EXECUTION is enabled as gigapaxos may otherwise assume that the duplicate request identifier corresponds to a retransmission and will send back the response if any corresponding to the first execution. With PaxosConfig.PC.PREVENT_DOUBLE_EXECUTION disabled, the uniqueness is important for liveness as duplicate request identifiers may result in the client not receiving a response for the latter request; this is because gigapaxos stores request execution callbacks indexed by the request identifier, so there must be at most one outstanding request with a given identifier for a given replica group.

Specified by:

getRequestID in interface RequestIdentifier

Returns:

A unique request identifier for this request.

isActiveNodeConfigChange

public boolean isActiveNodeConfigChange()