Top Description Constructors Methods
org.apache.hc.client5.http.impl.async

public abstract Class CloseableHttpAsyncClient

extends Object
implements HttpAsyncClient, ModalCloseable
Class Inheritance
All Implemented Interfaces
org.apache.hc.core5.io.ModalCloseable, java.io.Closeable, java.lang.AutoCloseable, org.apache.hc.client5.http.async.HttpAsyncClient
Known Direct Subclasses
org.apache.hc.client5.http.impl.async.AbstractHttpAsyncClientBase
Annotations
@Contract
threading:STATELESS
Imports
java.util.concurrent.Future, org.apache.hc.client5.http.async.HttpAsyncClient, org.apache.hc.client5.http.async.methods.SimpleHttpRequest, .SimpleHttpResponse, .SimpleRequestProducer, .SimpleResponseConsumer, org.apache.hc.client5.http.protocol.HttpClientContext, org.apache.hc.core5.annotation.Contract, .ThreadingBehavior, org.apache.hc.core5.concurrent.FutureCallback, org.apache.hc.core5.function.Supplier, org.apache.hc.core5.http.HttpHost, org.apache.hc.core5.http.nio.AsyncPushConsumer, .AsyncRequestProducer, .AsyncResponseConsumer, .HandlerFactory, org.apache.hc.core5.http.protocol.HttpContext, org.apache.hc.core5.io.ModalCloseable, org.apache.hc.core5.reactor.IOReactorStatus, org.apache.hc.core5.util.Args, .TimeValue

Base implementation of HttpAsyncClient that also implements ModalCloseable.
Since
5.0

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public abstract void
protected abstract <T> Future<T>
doExecute(final HttpHost target, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer<T> responseConsumer, final HandlerFactory<AsyncPushConsumer> pushHandlerFactory, final HttpContext context, final FutureCallback<T> callback)

public final <T> Future<T>
execute(final HttpHost target, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer<T> responseConsumer, final HandlerFactory<AsyncPushConsumer> pushHandlerFactory, final HttpContext context, final FutureCallback<T> callback)

public final <T> Future<T>
execute(final AsyncRequestProducer
request producer callback.
requestProducer
,
final AsyncResponseConsumer<T>
response consumer callback.
responseConsumer
,
final HandlerFactory<AsyncPushConsumer>
the push handler factory. Optional and may be null.
pushHandlerFactory
,
final HttpContext
HTTP context. Optional and may be null.
context
,
final FutureCallback<T>
future callback. Optional and may be null.
callback
)

Implements org.apache.hc.client5.http.async.HttpAsyncClient.execute.

Initiates asynchronous HTTP request execution using the given context.
public final <T> Future<T>
execute(final AsyncRequestProducer requestProducer, final AsyncResponseConsumer<T> responseConsumer, final HttpContext context, final FutureCallback<T> callback)

public final <T> Future<T>
execute(final AsyncRequestProducer requestProducer, final AsyncResponseConsumer<T> responseConsumer, final FutureCallback<T> callback)

public final Future<SimpleHttpResponse>
execute(final SimpleHttpRequest request, final HttpContext context, final FutureCallback<SimpleHttpResponse> callback)

public final Future<SimpleHttpResponse>
public abstract IOReactorStatus
public abstract void
public abstract void
register(String hostname, String uriPattern, Supplier<AsyncPushConsumer> supplier)

public final void
register(final String uriPattern, final Supplier<AsyncPushConsumer> supplier)

public abstract void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

CloseableHttpAsyncClientback to summary
public CloseableHttpAsyncClient()

Method Detail

awaitShutdownback to summary
public abstract void awaitShutdown(TimeValue waitTime) throws InterruptedException
doExecuteback to summary
protected abstract <T> Future<T> doExecute(final HttpHost target, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer<T> responseConsumer, final HandlerFactory<AsyncPushConsumer> pushHandlerFactory, final HttpContext context, final FutureCallback<T> callback)
executeback to summary
public final <T> Future<T> execute(final HttpHost target, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer<T> responseConsumer, final HandlerFactory<AsyncPushConsumer> pushHandlerFactory, final HttpContext context, final FutureCallback<T> callback)
executeback to summary
public final <T> Future<T> execute(final AsyncRequestProducer requestProducer, final AsyncResponseConsumer<T> responseConsumer, final HandlerFactory<AsyncPushConsumer> pushHandlerFactory, final HttpContext context, final FutureCallback<T> callback)

Implements org.apache.hc.client5.http.async.HttpAsyncClient.execute.

Doc from org.apache.hc.client5.http.async.HttpAsyncClient.execute.

Initiates asynchronous HTTP request execution using the given context.

The request producer passed to this method will be used to generate a request message and stream out its content without buffering it in memory. The response consumer 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.

Parameters
<T>
the result type of request execution.
requestProducer:AsyncRequestProducer

request producer callback.

responseConsumer:AsyncResponseConsumer<T>

response consumer callback.

pushHandlerFactory:HandlerFactory<AsyncPushConsumer>

the push handler factory. Optional and may be null.

context:HttpContext

HTTP context. Optional and may be null.

callback:FutureCallback<T>

future callback. Optional and may be null.

Returns:Future<T>

future representing pending completion of the operation.

Annotations
@Override
executeback to summary
public final <T> Future<T> execute(final AsyncRequestProducer requestProducer, final AsyncResponseConsumer<T> responseConsumer, final HttpContext context, final FutureCallback<T> callback)
executeback to summary
public final <T> Future<T> execute(final AsyncRequestProducer requestProducer, final AsyncResponseConsumer<T> responseConsumer, final FutureCallback<T> callback)
executeback to summary
public final Future<SimpleHttpResponse> execute(final SimpleHttpRequest request, final HttpContext context, final FutureCallback<SimpleHttpResponse> callback)
executeback to summary
public final Future<SimpleHttpResponse> execute(final SimpleHttpRequest request, final FutureCallback<SimpleHttpResponse> callback)
getStatusback to summary
public abstract IOReactorStatus getStatus()
initiateShutdownback to summary
public abstract void initiateShutdown()
registerback to summary
public abstract void register(String hostname, String uriPattern, Supplier<AsyncPushConsumer> supplier)
registerback to summary
public final void register(final String uriPattern, final Supplier<AsyncPushConsumer> supplier)
startback to summary
public abstract void start()