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.
FutureResponse(Message requestMessage, FutureSuccessEvaluator futureSuccessEvaluator, ProgressListener progressListener) Create the future and set the request message.
FutureResponse(Message requestMessage, ProgressListener progressListener) Create the future and set the request message.

Method Summary

Methods

Modifier and Type	Method and Description
Message	getRequest() The future response always keeps a reference to the request.
Message	getResponse() Returns the response message.
FutureResponse	progress() This will be called by the user, when the user provides more data.
void	progress(Message interMediateMessage) This will be called by the TomP2P library when a partial message is ready.
FutureResponse	progressFirst() Do not call this directly, as this is called from the TomP2P library.
protected boolean	setCompletedAndNotify() Make sure that the calling method has synchronized (lock).
boolean	setFailedLater(Throwable cause)
FutureResponse	setProgressHandler(ProgresHandler progressHandler) Set the user based progres handler, where the user can add more data and call progress() when data has been added.
FutureResponse	setResponse() 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.
FutureResponse	setResponse(Message responseMessage) Gets called if a peer responds.
boolean	setResponseLater(Message responseMessage)
FutureResponse	setResponseNow()
String	toString()

Methods inherited from class net.tomp2p.futures.BaseFutureImpl

addCancel, addListener, addListener, await, await, awaitListeners, awaitListenersUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, cancel, getFailedReason, getType, isCompleted, isFailed, isSuccess, notifyListeners, removeCancel, removeListener, self, setFailed, setFailed, setFailed, setFailed, setFailed

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.

Parameters:

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

futureSuccessEvaluator - Evaluates if the future was a success or failure

FutureResponse

public FutureResponse(Message requestMessage,
              ProgressListener progressListener)

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.

progressListener - The progress listener for streaming support

FutureResponse

public FutureResponse(Message requestMessage,
              FutureSuccessEvaluator futureSuccessEvaluator,
              ProgressListener progressListener)

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

setResponse

public FutureResponse setResponse()

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

setResponse

public FutureResponse setResponse(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

setResponseLater

public boolean setResponseLater(Message responseMessage)

setFailedLater

public boolean setFailedLater(Throwable cause)

setResponseNow

public FutureResponse setResponseNow()

setCompletedAndNotify

protected boolean setCompletedAndNotify()

Description copied from class: BaseFutureImpl

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

Overrides:

setCompletedAndNotify in class BaseFutureImpl<FutureResponse>

Returns:

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

getResponse

public Message getResponse()

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

getRequest

public Message getRequest()

The future response always keeps a reference to the request.

Returns:

The request message.

setProgressHandler

public FutureResponse setProgressHandler(ProgresHandler progressHandler)

Set the user based progres handler, where the user can add more data and call progress() when data has been added.

Parameters:

progressHandler - The progress handler that will be added by the TomP2P library.

Returns:

This class

progressFirst

public FutureResponse progressFirst()
                             throws InterruptedException

Do not call this directly, as this is called from the TomP2P library. This must be the first call to the progress handler, otherwise we might not be able to decode the header.

Returns:

This class

Throws:

InterruptedException - .

progress

public FutureResponse progress()
                        throws InterruptedException

This will be called by the user, when the user provides more data. This will block until a progress handler has been set by the TomP2P library.

Returns:

This class

Throws:

InterruptedException - If latch is interrupted

progress

public void progress(Message interMediateMessage)

This will be called by the TomP2P library when a partial message is ready.

Parameters:

interMediateMessage - The message that is either incomplete as indicated with Message.isDone() or completed. This will be called before the future completes.

toString

public String toString()

Overrides:

toString in class Object