Package com.yahoo.jdisc.handler

Class FutureResponse

java.lang.Object

java.util.concurrent.CompletableFuture<Response>

com.yahoo.jdisc.handler.FutureResponse

All Implemented Interfaces:

ResponseHandler, CompletionStage<Response>, Future<Response>

public final class FutureResponse
extends CompletableFuture<Response>
implements ResponseHandler

This class provides an implementation of ResponseHandler that allows you to wait for a Response to be returned.

Author:

Simon Thoresen Hult

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.CompletableFuture

CompletableFuture.AsynchronousCompletionTask

Constructor Summary

Constructors

Constructor	Description
FutureResponse()	Constructs a new FutureResponse that returns a NullContent when handleResponse(Response) is invoked.
FutureResponse(ContentChannel content)	Constructs a new FutureResponse that returns the given ContentChannel when handleResponse(Response) is invoked.
FutureResponse(ResponseHandler handler)	Constructs a new FutureResponse that calls the given ResponseHandler when handleResponse(Response) is invoked.

Method Summary

Modifier and Type	Method	Description
void	addListener(Runnable r, Executor e)
final boolean	cancel(boolean mayInterruptIfRunning)
ContentChannel	handleResponse(Response response)	This method will process the given Response and return a ContentChannel into which the caller can write the Response's content.
final boolean	isCancelled()

Methods inherited from class java.util.concurrent.CompletableFuture

acceptEither, acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEither, applyToEitherAsync, applyToEitherAsync, complete, completeAsync, completeAsync, completedFuture, completedStage, completeExceptionally, completeOnTimeout, copy, defaultExecutor, delayedExecutor, delayedExecutor, exceptionally, exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync, failedFuture, failedStage, get, get, getNow, getNumberOfDependents, handle, handleAsync, handleAsync, isCompletedExceptionally, isDone, join, minimalCompletionStage, newIncompleteFuture, obtrudeException, obtrudeValue, orTimeout, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, runAsync, runAsync, supplyAsync, supplyAsync, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, toString, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from class java.lang.Object

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

Constructor Details

FutureResponse

public FutureResponse()

Constructs a new FutureResponse that returns a NullContent when handleResponse(Response) is invoked.

FutureResponse

public FutureResponse(ContentChannel content)

Constructs a new FutureResponse that returns the given ContentChannel when handleResponse(Response) is invoked.

Parameters:

content - The content channel for the Response.

FutureResponse

public FutureResponse(ResponseHandler handler)

Constructs a new FutureResponse that calls the given ResponseHandler when handleResponse(Response) is invoked.

Parameters:

handler - The ResponseHandler to invoke.

Method Details

addListener

public void addListener(Runnable r,
 Executor e)

handleResponse

public ContentChannel handleResponse(Response response)

Description copied from interface: ResponseHandler

This method will process the given Response and return a ContentChannel into which the caller can write the Response's content.

Specified by:

handleResponse in interface ResponseHandler

Parameters:

response - the Response to handle

Returns:

the ContentChannel to write the Response content to. Notice that the ContentChannel holds a Container reference, so failure to close this will prevent the Container from ever shutting down.

cancel

public final boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<Response>

Overrides:

cancel in class CompletableFuture<Response>

isCancelled

public final boolean isCancelled()

Specified by:

isCancelled in interface Future<Response>

Overrides:

isCancelled in class CompletableFuture<Response>