RequestPacket

java.lang.Object
- edu.umass.cs.nio.JSONPacket
- - edu.umass.cs.gigapaxos.paxospackets.PaxosPacket
  - - edu.umass.cs.gigapaxos.paxospackets.RequestPacket

All Implemented Interfaces:

ClientRequest, Request, RequestIdentifier, Byteable, Summarizable

Direct Known Subclasses:

MetaRequestPacket, ProposalPacket
```
public class RequestPacket
extends PaxosPacket
implements Request, ClientRequest, Byteable
```
Author:

arun

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RequestPacket.Keys` These JSON keys are rather specific to RequestPacket or for debugging, so they are here as opposed to PaxosPacket.
`static class`	`RequestPacket.ResponseCodes`

Nested classes/interfaces inherited from class edu.umass.cs.gigapaxos.paxospackets.PaxosPacket
PaxosPacket.NodeIDKeys, PaxosPacket.PaxosPacketType

Field Summary

Fields
Modifier and Type	Field and Description
`protected byte[]`	`digest`
`static java.lang.String`	`NO_OP`
`protected static java.net.InetSocketAddress`	`NULL_SOCKADDR` We use this address instead of a null client socket address or listen address so that a null address doesn't get overwritten by a bad legitimate address when a request is forwarded across servers.
`long`	`requestID` A unique requestID for each request.
`java.lang.String`	`requestValue` The actual request body.
`static int`	`SIZE_ESTIMATE` We need this estimate to use it in `RequestBatcher.dequeueImpl()`.
`protected static int`	`SIZEOF_REQUEST_FIXED`
`boolean`	`stop` Whether this request is a stop request.

Fields inherited from class edu.umass.cs.gigapaxos.paxospackets.PaxosPacket
BYTEIFICATION, CHARSET, packetType, paxosID, SIZEOF_PAXOSPACKET_FIXED, version

Fields inherited from class edu.umass.cs.nio.JSONPacket
PACKET_TYPE, type

Constructor Summary

Constructors
Constructor and Description
`RequestPacket(byte[] bytes)`
`RequestPacket(java.nio.ByteBuffer bbuf)`
`RequestPacket(org.json.JSONObject json)`
`RequestPacket(net.minidev.json.JSONObject json)`
`RequestPacket(long reqID, java.lang.String value, boolean stop)`
`RequestPacket(long reqID, java.lang.String value, boolean stop, java.net.InetSocketAddress csa)`
`RequestPacket(long reqID, java.lang.String value, boolean stop, RequestPacket req)`
`RequestPacket(RequestPacket req)`
`RequestPacket(java.lang.String value, boolean stop)`
`RequestPacket(java.lang.String value, boolean stop, java.net.InetSocketAddress csa)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`addDebugInfo(org.json.JSONObject msg, java.lang.String str, int nodeID)`
`RequestPacket`	`addDebugInfo(java.lang.String str)`
`RequestPacket`	`addDebugInfo(java.lang.String str, int nodeID)`
`RequestPacket`	`addDebugInfoDeep(java.lang.String str)`
`RequestPacket`	`addDebugInfoDeep(java.lang.String str, int nodeID)`
`int`	`batchSize()`
`boolean`	`digestEquals(RequestPacket req, java.security.MessageDigest md)`
`static void`	`doubleCheckFields()`
`boolean`	`equals(java.lang.Object obj)`
`RequestPacket`	`getACK()`
`RequestPacket[]`	`getBatched()`
`protected byte[]`	`getByteifiedSelf()`
`java.net.InetSocketAddress`	`getClientAddress()`
`int`	`getClientID()`
`java.lang.String`	`getDebugInfo(boolean get)`
`byte[]`	`getDigest(java.security.MessageDigest md)`
`int`	`getEntryReplica()`
`RequestPacket[]`	`getEntryReplicaRequestsAsBatch(int id)`
`long`	`getEntryTime()`
`protected RequestPacket`	`getFirstOnly()`
`int`	`getForwardCount()`
`int`	`getForwarderID()`
`java.net.InetSocketAddress`	`getListenAddress()`
`static java.security.MessageDigest`	`getMessageDigest()`
`RequestPacket`	`getNACK()`
`static PValuePacket`	`getRandomPValue(java.lang.String paxosID, int version, int slot, Ballot ballot)`
`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.
`RequestPacket[]`	`getRequestPackets()`
`IntegerPacketType`	`getRequestType()`
`java.lang.String`	`getRequestValue()`
`java.lang.String[]`	`getRequestValues()`
`ClientRequest`	`getResponse()`
`static PValuePacket`	`getSamplePValue()`
`java.lang.String`	`getServiceName()`
`java.lang.String`	`getStringifiedSelf()`
`java.lang.Object`	`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.
`protected java.lang.String`	`getSummaryString()`
`boolean`	`hasRequestValue()`
`boolean`	`isBroadcasted()`
`boolean`	`isMetaValue()`
`boolean`	`isNoop()`
`boolean`	`isPingPonging()`
`static boolean`	`isPingPonging(org.json.JSONObject msg)`
`boolean`	`isStopRequest()`
`RequestPacket`	`latchToBatch(RequestPacket[] reqs)`
`int`	`lengthEstimate()`
`static void`	`main(java.lang.String[] args)`
`RequestPacket`	`makeNewRequest()`
`RequestPacket`	`makeNoop()`
`java.lang.String`	`printBatched()`
`RequestPacket`	`setBroadcasted()`
`protected void`	`setByteifiedSelf(byte[] bytes)`
`RequestPacket`	`setDigest(byte[] d)`
`RequestPacket`	`setEntryReplica(int id)`
`int`	`setEntryReplicaAndReturnCount(int id)`
`void`	`setEntryTime()`
`RequestPacket`	`setForwarderID(int id)`
`void`	`setResponse(java.lang.String response)`
`RequestPacket`	`setReturnRequestValue()`
`RequestPacket`	`setStringifiedSelf(java.lang.String s)`
`boolean`	`shouldBroadcast()`
`boolean`	`shouldDigest()`
`boolean`	`shouldReturnRequestValue()`
`byte[]`	`toBytes()` The implementation of this method is tied to and must be the inverse of `AppRequestParser.getRequest(byte[], edu.umass.cs.nio.nioutils.NIOHeader)` , i.e., invoking getRequest(request.toBytes(), header).equals(request).
`protected byte[]`	`toBytes(boolean instrument)` The weird constant above is to try to avoid mistakes in the painful (but totally worth it) byte'ification method below.
`byte[]`	`toBytesInstrument()`
`org.json.JSONObject`	`toJSONObjectImpl()`
`net.minidev.json.JSONObject`	`toJSONSmartImpl()`
`java.lang.String`	`toString()` Learned the hard way that using org.json to stringify is an order of magnitude slower with large request values compared to manually inserting the string like below.

Methods inherited from class edu.umass.cs.gigapaxos.paxospackets.PaxosPacket
getPaxosID, getPaxosIDVersion, getPaxosPacket, getPaxosPacket, getPaxosPacketType, getPaxosPacketType, getSummary, getType, getType, getVersion, isParseable, isRecovery, isRecovery, isStatic, markRecovered, putPaxosID, toBytes, toJSONObject, toJSONSmart, toSingletonArray

Methods inherited from class edu.umass.cs.nio.JSONPacket
couldBeJSON, couldBeJSON, couldBeJSON, couldBeJSONArray, couldBeJSONObject, getPacketType, putPacketType, putPacketType

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

- Field Detail
  - NO_OP
```
public static final java.lang.String NO_OP
```
    See Also:
    
    Constant Field Values
  - requestID
```
public final long requestID
```
    A unique requestID for each request. Paxos doesn't actually check or care whether two requests with the same ID are identical. This field is useful for asynchronous clients to associate responses with requests. FIXME: change to long.
  - stop
```
public final boolean stop
```
    Whether this request is a stop request.
  - digest
```
protected byte[] digest
```
  - requestValue
```
public final java.lang.String requestValue
```
    The actual request body. The client will get back this string if that is what it sent to paxos. If it issued a RequestPacket, then it will get back the whole RequestPacket back.
  - SIZEOF_REQUEST_FIXED
```
protected static final int SIZEOF_REQUEST_FIXED
```
    See Also:
    
    Constant Field Values
  - SIZE_ESTIMATE
```
public static final int SIZE_ESTIMATE
```
    We need this estimate to use it in RequestBatcher.dequeueImpl(). The value needs to be an upper bound on the sum total of all of the gunk in PValuePacket other than the requestValue itself, i.e., the size of a no-op decision.
  - NULL_SOCKADDR
```
protected static final java.net.InetSocketAddress NULL_SOCKADDR
```
    We use this address instead of a null client socket address or listen address so that a null address doesn't get overwritten by a bad legitimate address when a request is forwarded across servers. Port 9 is a privileged port and is used for the Discard protocol. We don't use this anymore.
- Constructor Detail
  - RequestPacket
```
public RequestPacket(java.lang.String value,
                     boolean stop)
```
  - RequestPacket
```
public RequestPacket(long reqID,
                     java.lang.String value,
                     boolean stop)
```
  - RequestPacket
```
public RequestPacket(long reqID,
                     java.lang.String value,
                     boolean stop,
                     java.net.InetSocketAddress csa)
```
  - RequestPacket
```
public RequestPacket(java.lang.String value,
                     boolean stop,
                     java.net.InetSocketAddress csa)
```
  - RequestPacket
```
public RequestPacket(RequestPacket req)
```
  - RequestPacket
```
public RequestPacket(long reqID,
                     java.lang.String value,
                     boolean stop,
                     RequestPacket req)
```
  - RequestPacket
```
public RequestPacket(org.json.JSONObject json)
              throws org.json.JSONException
```
    Throws:
    
    org.json.JSONException
  - RequestPacket
```
public RequestPacket(net.minidev.json.JSONObject json)
              throws org.json.JSONException
```
    Throws:
    
    org.json.JSONException
  - RequestPacket
```
public RequestPacket(byte[] bytes)
              throws java.io.UnsupportedEncodingException,
                     java.net.UnknownHostException
```
    Throws:
    
    java.io.UnsupportedEncodingException
    
    java.net.UnknownHostException
  - RequestPacket
```
public RequestPacket(java.nio.ByteBuffer bbuf)
              throws java.io.UnsupportedEncodingException,
                     java.net.UnknownHostException
```
    Throws:
    
    java.io.UnsupportedEncodingException
    
    java.net.UnknownHostException
- Method Detail
  - getMessageDigest
```
public static java.security.MessageDigest getMessageDigest()
```
    Returns:
    
    MessageDigest.
  - makeNoop
```
public RequestPacket makeNoop()
```
  - makeNewRequest
```
public RequestPacket makeNewRequest()
```
  - setReturnRequestValue
```
public RequestPacket setReturnRequestValue()
```
  - getClientID
```
public int getClientID()
```
  - isNoop
```
public boolean isNoop()
```
  - getForwardCount
```
public int getForwardCount()
```
  - setEntryReplica
```
public RequestPacket setEntryReplica(int id)
```
  - setEntryTime
```
public void setEntryTime()
```
  - setEntryReplicaAndReturnCount
```
public int setEntryReplicaAndReturnCount(int id)
```
  - shouldDigest
```
public boolean shouldDigest()
```
  - getEntryReplica
```
public int getEntryReplica()
```
  - setForwarderID
```
public RequestPacket setForwarderID(int id)
```
  - getForwarderID
```
public int getForwarderID()
```
  - addDebugInfo
```
public RequestPacket addDebugInfo(java.lang.String str)
```
  - addDebugInfoDeep
```
public RequestPacket addDebugInfoDeep(java.lang.String str)
```
  - addDebugInfo
```
public RequestPacket addDebugInfo(java.lang.String str,
                                  int nodeID)
```
  - addDebugInfoDeep
```
public RequestPacket addDebugInfoDeep(java.lang.String str,
                                      int nodeID)
```
  - addDebugInfo
```
public static boolean addDebugInfo(org.json.JSONObject msg,
                                   java.lang.String str,
                                   int nodeID)
                            throws org.json.JSONException
```
    Throws:
    
    org.json.JSONException
  - getDebugInfo
```
public java.lang.String getDebugInfo(boolean get)
```
  - isPingPonging
```
public static boolean isPingPonging(org.json.JSONObject msg)
```
  - isPingPonging
```
public boolean isPingPonging()
```
  - getStringifiedSelf
```
public java.lang.String getStringifiedSelf()
```
  - setStringifiedSelf
```
public RequestPacket setStringifiedSelf(java.lang.String s)
```
  - toJSONObjectImpl
```
public org.json.JSONObject toJSONObjectImpl()
                                     throws org.json.JSONException
```
    Specified by:
    
    toJSONObjectImpl in class PaxosPacket
    
    Returns:
    
    JSONObject corresponding to fields in classes extending this class.
    
    Throws:
    
    org.json.JSONException
  - toJSONSmartImpl
```
public net.minidev.json.JSONObject toJSONSmartImpl()
                                            throws org.json.JSONException
```
    Overrides:
    
    toJSONSmartImpl in class PaxosPacket
    
    Throws:
    
    org.json.JSONException
  - toBytesInstrument
```
public byte[] toBytesInstrument()
```
  - toBytes
```
public byte[] toBytes()
```
    Description copied from interface: Request
    
    The implementation of this method is tied to and must be the inverse of AppRequestParser.getRequest(byte[], edu.umass.cs.nio.nioutils.NIOHeader) , i.e., invoking getRequest(request.toBytes(), header).equals(request).
    
    Specified by:
    
    toBytes in interface Request
    
    Specified by:
    
    toBytes in interface Byteable
    
    Returns:
    
    byte[] serialized form of this request
  - toBytes
```
protected byte[] toBytes(boolean instrument)
```
    The weird constant above is to try to avoid mistakes in the painful (but totally worth it) byte'ification method below. Using bytes as opposed to json strings makes a non-trivial difference (~2x over json-smart and >4x over org.json. So we just chuck json libraries and use our own byte[] serializer for select packets. The serialization overhead really matters most for RequestPacket and AcceptPacket. Every request, even with batching, must be deserialized by the coordinator and must be serialized back while sending out the AcceptPacket. The critical path is the following at a coordinator and is incurred at least in part even with batching for every request: (1) receive request, (2) send accept, (3) receive accept_replies, (4) send commit Accordingly, we use byteification for RequestPacket, AcceptPacket, BatchedAcceptReply and BatchedCommit.
  - toString
```
public java.lang.String toString()
```
    Learned the hard way that using org.json to stringify is an order of magnitude slower with large request values compared to manually inserting the string like below. json-smart is fast enough for our purposes but still doesn't beat direct string construction like below. Note: we need to account for batching carefully here. So, we use a json array of strings as opposed to json objects for batched requests above. Otherwise, this method will only use string construction for the first request in a batch.
    
    Specified by:
    
    toString in interface Request
    
    Overrides:
    
    toString in class PaxosPacket
    
    Returns:
    
    Returns this request serialized as a String.
  - 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.
  - getListenAddress
```
public java.net.InetSocketAddress getListenAddress()
```
  - isStopRequest
```
public boolean isStopRequest()
```
  - getEntryTime
```
public long getEntryTime()
```
  - latchToBatch
```
public RequestPacket latchToBatch(RequestPacket[] reqs)
```
  - isMetaValue
```
public boolean isMetaValue()
```
  - getBatched
```
public RequestPacket[] getBatched()
```
  - getFirstOnly
```
protected RequestPacket getFirstOnly()
```
  - getACK
```
public RequestPacket getACK()
```
  - getNACK
```
public RequestPacket getNACK()
```
  - getRequestValue
```
public java.lang.String getRequestValue()
```
  - getRequestValues
```
public java.lang.String[] getRequestValues()
```
  - getRequestPackets
```
public RequestPacket[] getRequestPackets()
```
  - batchSize
```
public int batchSize()
```
  - getEntryReplicaRequestsAsBatch
```
public RequestPacket[] getEntryReplicaRequestsAsBatch(int id)
```
  - getRequestType
```
public IntegerPacketType getRequestType()
```
    Specified by:
    
    getRequestType in interface Request
    
    Returns:
    
    The IntegerPacketType type corresponding to this request.
  - getServiceName
```
public java.lang.String getServiceName()
```
    Specified by:
    
    getServiceName in interface Request
    
    Returns:
    
    Returns the unique app-level replica-group ID.
  - getSummaryString
```
protected java.lang.String getSummaryString()
```
    Specified by:
    
    getSummaryString in class PaxosPacket
  - getRandomPValue
```
public static PValuePacket getRandomPValue(java.lang.String paxosID,
                                           int version,
                                           int slot,
                                           Ballot ballot)
```
  - getSamplePValue
```
public static PValuePacket getSamplePValue()
```
  - hasRequestValue
```
public boolean hasRequestValue()
```
  - lengthEstimate
```
public int lengthEstimate()
```
  - printBatched
```
public java.lang.String printBatched()
```
  - 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);
    }
  - setResponse
```
public void setResponse(java.lang.String response)
```
  - shouldReturnRequestValue
```
public boolean shouldReturnRequestValue()
```
  - 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.
  - getDigest
```
public byte[] getDigest(java.security.MessageDigest md)
```
  - digestEquals
```
public boolean digestEquals(RequestPacket req,
                            java.security.MessageDigest md)
```
  - setDigest
```
public RequestPacket setDigest(byte[] d)
```
  - setBroadcasted
```
public RequestPacket setBroadcasted()
```
  - shouldBroadcast
```
public boolean shouldBroadcast()
```
  - isBroadcasted
```
public boolean isBroadcasted()
```
  - getSummary
```
public java.lang.Object 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 PaxosPacket
    
    Returns:
    
    Object for pretty printing.
  - getByteifiedSelf
```
protected byte[] getByteifiedSelf()
```
  - setByteifiedSelf
```
protected void setByteifiedSelf(byte[] bytes)
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - doubleCheckFields
```
public static void doubleCheckFields()
```
  - main
```
public static void main(java.lang.String[] args)
                 throws java.io.UnsupportedEncodingException,
                        java.net.UnknownHostException
```
    Throws:
    
    java.io.UnsupportedEncodingException
    
    java.net.UnknownHostException

Class RequestPacket

Nested Class Summary

Nested classes/interfaces inherited from class edu.umass.cs.gigapaxos.paxospackets.PaxosPacket

Field Summary

Fields inherited from class edu.umass.cs.gigapaxos.paxospackets.PaxosPacket

Fields inherited from class edu.umass.cs.nio.JSONPacket

Constructor Summary

Method Summary

Methods inherited from class edu.umass.cs.gigapaxos.paxospackets.PaxosPacket

Methods inherited from class edu.umass.cs.nio.JSONPacket

Methods inherited from class java.lang.Object

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

Field Detail

NO_OP

requestID

stop

digest

requestValue

SIZEOF_REQUEST_FIXED

SIZE_ESTIMATE

NULL_SOCKADDR

Constructor Detail

RequestPacket

RequestPacket

RequestPacket

RequestPacket

RequestPacket

RequestPacket

RequestPacket

RequestPacket

RequestPacket

RequestPacket

Method Detail

getMessageDigest

makeNoop

makeNewRequest

setReturnRequestValue

getClientID

isNoop

getForwardCount

setEntryReplica

setEntryTime

setEntryReplicaAndReturnCount

shouldDigest

getEntryReplica

setForwarderID

getForwarderID

addDebugInfo

addDebugInfoDeep

addDebugInfo

addDebugInfoDeep

addDebugInfo

getDebugInfo

isPingPonging

isPingPonging

getStringifiedSelf

setStringifiedSelf

toJSONObjectImpl

toJSONSmartImpl

toBytesInstrument

toBytes

toBytes

toString

getClientAddress

getListenAddress

isStopRequest

getEntryTime

latchToBatch

isMetaValue

getBatched

getFirstOnly

getACK

getNACK

getRequestValue

getRequestValues

getRequestPackets

batchSize

getEntryReplicaRequestsAsBatch

getRequestType

getServiceName