edu.umass.cs.reconfiguration.reconfigurationpackets

Class EchoRequest

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<java.net.InetSocketAddress>

edu.umass.cs.reconfiguration.reconfigurationpackets.EchoRequest

All Implemented Interfaces:

ClientRequest, Request, RequestIdentifier, Byteable, ProtocolEvent<ReconfigurationPacket.PacketType,java.lang.String>, ThresholdProtocolEvent<java.net.InetSocketAddress,ReconfigurationPacket.PacketType,java.lang.String>, Keyable<java.lang.String>, Summarizable

public class EchoRequest
extends BasicReconfigurationPacket<java.net.InetSocketAddress>
implements ClientRequest

Author:

arun

Nested Class Summary

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

ReconfigurationPacket.PacketType

Field Summary

Fields

Modifier and Type	Field and Description
java.net.InetSocketAddress	myReceiver
long	requestID
long	sentTime

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.gigapaxos.interfaces.Request

NO_OP

Constructor Summary

Constructors

Constructor and Description
EchoRequest(java.net.InetSocketAddress initiator)
EchoRequest(java.net.InetSocketAddress initiator, java.util.Map<java.net.InetAddress,java.lang.Long> closest)
EchoRequest(org.json.JSONObject json)
EchoRequest(org.json.JSONObject json, Stringifiable<?> unstringer)

Method Summary

Modifier and Type	Method and Description
java.net.InetSocketAddress	getClientAddress()
java.util.Map<java.net.InetAddress,java.lang.Long>	getClosest()
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.
ClientRequest	getResponse()
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.
boolean	hasClosest()
boolean	isRequest()
EchoRequest	makeResponse(java.net.InetSocketAddress address)
org.json.JSONObject	toJSONObjectImpl()

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

getEpochNumber, getRequestType, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getRequestType, getServiceName, toBytes, toString

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

getSummary

Field Detail

requestID

public final long requestID

sentTime

public final long sentTime

myReceiver

public final java.net.InetSocketAddress myReceiver

Constructor Detail

EchoRequest

public EchoRequest(java.net.InetSocketAddress initiator,
                   java.util.Map<java.net.InetAddress,java.lang.Long> closest)

Parameters:

initiator -

closest -

EchoRequest

public EchoRequest(java.net.InetSocketAddress initiator)

Parameters:

initiator -

EchoRequest

public EchoRequest(org.json.JSONObject json,
                   Stringifiable<?> unstringer)
            throws org.json.JSONException,
                   java.net.UnknownHostException

Parameters:

json -

unstringer -

Throws:

org.json.JSONException

java.net.UnknownHostException

EchoRequest

public EchoRequest(org.json.JSONObject json)
            throws org.json.JSONException,
                   java.net.UnknownHostException

Parameters:

json -

Throws:

org.json.JSONException

java.net.UnknownHostException

Method Detail

toJSONObjectImpl

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

Overrides:

toJSONObjectImpl in class BasicReconfigurationPacket<java.net.InetSocketAddress>

Throws:

org.json.JSONException

isRequest

public boolean isRequest()

Returns:

True if this is a request from an external client to an active replica.

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.

getClientAddress

public java.net.InetSocketAddress getClientAddress()

Specified by:

getClientAddress in interface ClientRequest

Returns:

The socket address of the client that sent this request. This method is now deprecated and exists only for backwards compatibility, so it is okay for applications to not explicitly override the default implementation of this method (that simply returns null); AbstractReplicaCoordinator already knows the sending client's address anyway.

getResponse

public ClientRequest getResponse()

Specified by:

getResponse in interface ClientRequest

Returns:

The response to be sent back to the client that issued this request. AbstractReplicaCoordinator, e.g., PaxosManager, will invoke this method immediately after Application.execute(Request) and, if the returned response is non-null, will send it back to the client that issued that request. Applications are expected to internally implement logic that sets the response at the end of Application.execute(Request) as follows:

public boolean Replicable.execute(Request request)} {
// execute request to obtain response
request.setResponse(response);
}

hasClosest

public boolean hasClosest()

Returns:

True if it has nonempty closest map.

makeResponse

public EchoRequest makeResponse(java.net.InetSocketAddress address)

Parameters:

address -

Returns:

this.

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 Summarizable

Overrides:

getSummary in class BasicReconfigurationPacket<java.net.InetSocketAddress>

Returns:

A pretty-print summary.

getClosest

public java.util.Map<java.net.InetAddress,java.lang.Long> getClosest()

Returns:

closest map.