com.ning.http.client

Interface ListenableFuture<V>

Type Parameters:

V - Type of the value that will be returned.

All Superinterfaces:

Future<V>

All Known Implementing Classes:

AbstractListenableFuture, ApacheResponseFuture, JDKDelegateFuture, JDKFuture, NettyResponseFuture

public interface ListenableFuture<V>
extends Future<V>

Extended Future

Method Summary

Methods

Modifier and Type	Method and Description
void	abort(Throwable t) Abort the current processing, and propagate the Throwable to the AsyncHandler or Future
ListenableFuture<V>	addListener(Runnable listener, Executor exec) Adds a listener and executor to the ListenableFuture.
void	content(V v) Set the content that will be returned by this instance
void	done(Callable callable) Execute a Callable and if there is no exception, mark this Future as done and release the internal lock.
boolean	getAndSetWriteBody(boolean writeBody) Write the Request body
boolean	getAndSetWriteHeaders(boolean writeHeader) Write the Request headers
void	touch() Touch the current instance to prevent external service to times out.

Methods inherited from interface java.util.concurrent.Future

cancel, get, get, isCancelled, isDone

Method Detail

done

void done(Callable callable)

Execute a Callable and if there is no exception, mark this Future as done and release the internal lock.

Parameters:

callable -

abort

void abort(Throwable t)

Abort the current processing, and propagate the Throwable to the AsyncHandler or Future

Parameters:

t -

content

void content(V v)

Set the content that will be returned by this instance

Parameters:

v - the content that will be returned by this instance

touch

void touch()

Touch the current instance to prevent external service to times out.

getAndSetWriteHeaders

boolean getAndSetWriteHeaders(boolean writeHeader)

Write the Request headers

getAndSetWriteBody

boolean getAndSetWriteBody(boolean writeBody)

Write the Request body

addListener

ListenableFuture<V> addListener(Runnable listener,
                              Executor exec)

Adds a listener and executor to the ListenableFuture. The listener will be passed to the executor for execution when the Future's computation is complete.

There is no guaranteed ordering of execution of listeners, they may get called in the order they were added and they may get called out of order, but any listener added through this method is guaranteed to be called once the computation is complete.

Parameters:

listener - the listener to run when the computation is complete.

exec - the executor to run the listener in.

Returns:

this Future

Throws:

NullPointerException - if the executor or listener was null.

RejectedExecutionException - if we tried to execute the listener immediately but the executor rejected it.