com.cloudhopper.smpp

Interface PduAsyncResponse

All Known Implementing Classes:

DefaultPduAsyncResponse

public interface PduAsyncResponse

A container to hold an asynchronous response and include information tracked internally by an SmppSession. For example, an instance of this class will contain the original request, the response, and a few timestamps.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Method Summary

Methods

Modifier and Type	Method and Description
long	getEstimatedProcessingTime() Gets an estimate of the processing time required by the remote endpoint to process this request.
PduRequest	getRequest() Gets the original request associated with the response.
PduResponse	getResponse() Gets the response from the remote endpoint.
long	getResponseTime() Gets the amount of time required for the remote endpoint to acknowledge the request with a response.
int	getWindowSize() Gets the size of the window after this request was added.
long	getWindowWaitTime() Gets the amount of time required to accept the request into the session send window (for a free slot to open up).

Method Detail

getRequest

PduRequest getRequest()

Gets the original request associated with the response.

Returns:

The original request

getResponse

PduResponse getResponse()

Gets the response from the remote endpoint.

Returns:

The response

getWindowSize

int getWindowSize()

Gets the size of the window after this request was added.

Returns:

The size of the window after this request was added.

getWindowWaitTime

long getWindowWaitTime()

Gets the amount of time required to accept the request into the session send window (for a free slot to open up).

Returns:

The amount of time (in ms) to accept the request into the send window

getResponseTime

long getResponseTime()

Gets the amount of time required for the remote endpoint to acknowledge the request with a response. This value is based on the time the request went out on the wire till a response was received on the wire. Does not include any time required waiting for a slot in the window to become available.

NOTE: If the window size is > 1, this value can be somewhat misleading. The remote endpoint would process X number of requests ahead of this one that went out ahead of it in the window. This does represent the total response time, but doesn't mean the remote endpoint is this slow at processing one request. In cases of high load where the window is always full, the windowWaitTime actually represents how fast the remote endpoint is processing requests.

Returns:

The amount of time (in ms) to receive a response from remote endpoint

getEstimatedProcessingTime

long getEstimatedProcessingTime()

Gets an estimate of the processing time required by the remote endpoint to process this request. The value is calculated with the following formula: "response time" divided by the "window size" at the time of the request.

Returns:

The amount of estimated time (in ms) to receive a response from the remote endpoint just for this request (as opposed to potentially this request and all requests ahead of it in the window).