org.granite.client.messaging.channel

Interface ResponseMessageFuture

All Known Implementing Classes:

AsyncToken, ImmediateFailureResponseMessageFuture

public interface ResponseMessageFuture

Future-like interface to synchronously wait for a response

Author:

Franck WOLFF

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel() Cancel the current request
ResponseMessage	get() Wait synchronously for the response
ResponseMessage	get(long timeout) Wait synchronously for the response.
boolean	isCancelled() Is the request cancelled ?
boolean	isDone() Is the request finished ?

Method Detail

cancel

boolean cancel()

Cancel the current request

Returns:

true if cancelled

get

ResponseMessage get()
                    throws java.lang.InterruptedException,
                           java.util.concurrent.ExecutionException,
                           java.util.concurrent.TimeoutException

Wait synchronously for the response

Returns:

response

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

get

ResponseMessage get(long timeout)
                    throws java.lang.InterruptedException,
                           java.util.concurrent.ExecutionException,
                           java.util.concurrent.TimeoutException

Wait synchronously for the response. This method throws a TimeoutException if the specified amount of time (timeout) has elapsed before the response is received. If timeout is zero, however, then the method simply waits until the response is received or the default transport timeout has elapsed.

Parameters:

timeout - the maximum time to wait in milliseconds.

Returns:

response

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

isCancelled

boolean isCancelled()

Is the request cancelled ?

Returns:

true if cancelled

isDone

boolean isDone()

Is the request finished ?

Returns:

true if finished