net.tomp2p.futures

Class FutureResponse

java.lang.Object

net.tomp2p.futures.BaseFutureImpl<FutureResponse>

net.tomp2p.futures.FutureResponse

All Implemented Interfaces:

BaseFuture, Cancel

public class FutureResponse
extends BaseFutureImpl<FutureResponse>

Each response has one request messages. The corresponding response message is set only if the request has been successful. This is indicated with isFailed.

Author:

Thomas Bocek

Nested Class Summary

Nested classes/interfaces inherited from interface net.tomp2p.futures.BaseFuture

BaseFuture.FutureType

Field Summary

Fields inherited from class net.tomp2p.futures.BaseFutureImpl

completed, lock, reason, type

Constructor Summary

Constructors

Constructor and Description
FutureResponse(Message requestMessage) Create the future and set the request message.
FutureResponse(Message requestMessage, FutureSuccessEvaluator futureSuccessEvaluator) Create the future and set the request message.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	completedAndNotify() Make sure that the calling method has synchronized (lock).
FutureResponse	emptyResponse() If we don't get a reply message, which is the case for fire-and-forget messages, then set the reply to null and set this future to complete with the type Success.
boolean	failedLater(Throwable cause)
RTT	getRoundTripTime()
Message	request() The future response always keeps a reference to the request.
FutureResponse	response(Message responseMessage) Gets called if a peer responds.
boolean	responseLater(Message responseMessage)
Message	responseMessage() Returns the response message.
FutureResponse	responseNow()
boolean	startRTTMeasurement(boolean isUDP) Start measuring time until reply is recieved
boolean	stopRTTMeasurement() Stops time measurement for the round trip time
String	toString()

Methods inherited from class net.tomp2p.futures.BaseFutureImpl

addCancel, addListener, await, await, awaitListeners, awaitListenersUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, cancel, failed, failed, failed, failed, failed, failedReason, isCompleted, isFailed, isSuccess, notifyListeners, removeCancel, removeListener, self, self, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FutureResponse

public FutureResponse(Message requestMessage)

Create the future and set the request message.

Parameters:

requestMessage - The request message that will be send over the wire.

FutureResponse

public FutureResponse(Message requestMessage,
              FutureSuccessEvaluator futureSuccessEvaluator)

Create the future and set the request message. This will set the progress listener for streaming support.

Parameters:

requestMessage - The request message that will be send over the wire.

futureSuccessEvaluator - Evaluates if the future was a success or failure

progressListener - The progress listener for streaming support

Method Detail

emptyResponse

public FutureResponse emptyResponse()

If we don't get a reply message, which is the case for fire-and-forget messages, then set the reply to null and set this future to complete with the type Success.

Returns:

This class

response

public FutureResponse response(Message responseMessage)

Gets called if a peer responds. Note that either this method or responseFailed() is always called. This does not notify any listeners. The listeners gets notified if channel is closed

Parameters:

responseMessage - The received message

Returns:

This class

responseLater

public boolean responseLater(Message responseMessage)

failedLater

public boolean failedLater(Throwable cause)

responseNow

public FutureResponse responseNow()

completedAndNotify

protected boolean completedAndNotify()

Description copied from class: BaseFutureImpl

Make sure that the calling method has synchronized (lock).

Overrides:

completedAndNotify in class BaseFutureImpl<FutureResponse>

Returns:

True if notified. It will notify if completed is not set yet.

responseMessage

public Message responseMessage()

Returns the response message. This is the same message as in response(Message message). If no response where send, then this will return null.

Returns:

The successful response message or null if failed

request

public Message request()

The future response always keeps a reference to the request.

Returns:

The request message.

startRTTMeasurement

public boolean startRTTMeasurement(boolean isUDP)

Start measuring time until reply is recieved

Returns:

True if time has successfully been started False if measurement already has been stopped

stopRTTMeasurement

public boolean stopRTTMeasurement()

Stops time measurement for the round trip time

Returns:

True if some valid time was recorded, False if time has not yet been started or already been stopped

toString

public String toString()

Overrides:

toString in class Object

getRoundTripTime

public RTT getRoundTripTime()