org.apache.http.nio.client

Interface HttpPipeliningClient

All Superinterfaces:

HttpAsyncClient

All Known Implementing Classes:

CloseableHttpPipeliningClient

public interface HttpPipeliningClient
extends HttpAsyncClient

This interface represents only the most basic contract for HTTP request execution. It imposes no restrictions or particular details on the request execution process and leaves the specifics of state management, authentication and redirect handling up to individual implementations.

Since:

4.1

Method Summary

Methods

Modifier and Type	Method and Description
<T> Future<List<T>>	execute(HttpHost target, List<? extends org.apache.http.nio.protocol.HttpAsyncRequestProducer> requestProducers, List<? extends org.apache.http.nio.protocol.HttpAsyncResponseConsumer<T>> responseConsumers, FutureCallback<List<T>> callback) Initiates pipelined execution of a sequence of requests.
<T> Future<List<T>>	execute(HttpHost target, List<? extends org.apache.http.nio.protocol.HttpAsyncRequestProducer> requestProducers, List<? extends org.apache.http.nio.protocol.HttpAsyncResponseConsumer<T>> responseConsumers, HttpContext context, FutureCallback<List<T>> callback) Initiates pipelined execution of a sequence of requests.
Future<List<HttpResponse>>	execute(HttpHost target, List<HttpRequest> requests, FutureCallback<List<HttpResponse>> callback) Initiates pipelined execution of a sequence of requests against the given target.
Future<List<HttpResponse>>	execute(HttpHost target, List<HttpRequest> requests, HttpContext context, FutureCallback<List<HttpResponse>> callback) Initiates pipelined execution of a sequence of requests against the given target using the given context.

Methods inherited from interface org.apache.http.nio.client.HttpAsyncClient

execute, execute, execute, execute, execute, execute

Method Detail

execute

<T> Future<List<T>> execute(HttpHost target,
                          List<? extends org.apache.http.nio.protocol.HttpAsyncRequestProducer> requestProducers,
                          List<? extends org.apache.http.nio.protocol.HttpAsyncResponseConsumer<T>> responseConsumers,
                          HttpContext context,
                          FutureCallback<List<T>> callback)

Initiates pipelined execution of a sequence of requests.

The request producers passed to this method will be used to generate a request message and stream out its content without buffering it in memory. The response consumers passed to this method will be used to process a response message without buffering its content in memory.

Please note it may be unsafe to interact with the context instance while the request is still being executed.

Type Parameters:

T - the result type of request execution.

Parameters:

target - the target host for the request.

requestProducers - list of request producers.

responseConsumers - list of response consumers.

context - HTTP context

callback - future callback.

Returns:

future representing pending completion of the operation.

execute

<T> Future<List<T>> execute(HttpHost target,
                          List<? extends org.apache.http.nio.protocol.HttpAsyncRequestProducer> requestProducers,
                          List<? extends org.apache.http.nio.protocol.HttpAsyncResponseConsumer<T>> responseConsumers,
                          FutureCallback<List<T>> callback)

Initiates pipelined execution of a sequence of requests.

The request producers passed to this method will be used to generate a request message and stream out its content without buffering it in memory. The response consumers passed to this method will be used to process a response message without buffering its content in memory.

Type Parameters:

T - the result type of request execution.

Parameters:

target - the target host for the request.

requestProducers - list of request producers.

responseConsumers - list of response consumers.

callback - future callback.

Returns:

future representing pending completion of the operation.

execute

Future<List<HttpResponse>> execute(HttpHost target,
                                 List<HttpRequest> requests,
                                 HttpContext context,
                                 FutureCallback<List<HttpResponse>> callback)

Initiates pipelined execution of a sequence of requests against the given target using the given context.

Please note it may be unsafe to interact with the context instance while the request is still being executed.

Parameters:

target - the target host for the requests. Implementations may accept null if they can still determine a route, for example to a default target or by inspecting the request.

requests - the requests to execute

context - the context to use for the execution, or null to use the default context

callback - future callback.

Returns:

future representing pending completion of the operation.

execute

Future<List<HttpResponse>> execute(HttpHost target,
                                 List<HttpRequest> requests,
                                 FutureCallback<List<HttpResponse>> callback)

Initiates pipelined execution of a sequence of requests against the given target.

Parameters:

target - the target host for the requests. Implementations may accept null if they can still determine a route, for example to a default target or by inspecting the request.

requests - the requests to execute

callback - future callback.

Returns:

future representing pending completion of the operation.