org.apache.hc.client5.http.impl.async

Class MinimalH2AsyncClient

java.lang.Object

org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient

org.apache.hc.client5.http.impl.async.MinimalH2AsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable, HttpAsyncClient, ModalCloseable

@Contract(threading=SAFE_CONDITIONAL)
public final class MinimalH2AsyncClient
extends CloseableHttpAsyncClient

Minimal implementation of HTTP/2 only CloseableHttpAsyncClient. This client is optimized for HTTP/2 multiplexing message transport and does not support advanced HTTP protocol functionality such as request execution via a proxy, state management, authentication and request redirects.

Concurrent message exchanges with the same connection route executed by this client will get automatically multiplexed over a single physical HTTP/2 connection.

Since:

5.0

Method Summary

Modifier and Type	Method and Description
void	awaitShutdown(TimeValue waitTime)
void	close() Closes this resource, relinquishing any underlying resources.
void	close(CloseMode closeMode) Closes this process or endpoint and releases any system resources associated with it.
protected <T> Future<T>	doExecute(HttpHost httpHost, AsyncRequestProducer requestProducer, AsyncResponseConsumer<T> responseConsumer, HandlerFactory<AsyncPushConsumer> pushHandlerFactory, HttpContext context, FutureCallback<T> callback)
Cancellable	execute(AsyncClientExchangeHandler exchangeHandler)
Cancellable	execute(AsyncClientExchangeHandler exchangeHandler, HandlerFactory<AsyncPushConsumer> pushHandlerFactory, HttpContext context)
IOReactorStatus	getStatus()
void	initiateShutdown()
void	register(String hostname, String uriPattern, Supplier<AsyncPushConsumer> supplier)
void	start()

Methods inherited from class org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient

execute, execute, execute, execute, execute, execute, register

Methods inherited from class java.lang.Object

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

Method Detail

execute

public Cancellable execute(AsyncClientExchangeHandler exchangeHandler,
                           HandlerFactory<AsyncPushConsumer> pushHandlerFactory,
                           HttpContext context)

doExecute

protected <T> Future<T> doExecute(HttpHost httpHost,
                                  AsyncRequestProducer requestProducer,
                                  AsyncResponseConsumer<T> responseConsumer,
                                  HandlerFactory<AsyncPushConsumer> pushHandlerFactory,
                                  HttpContext context,
                                  FutureCallback<T> callback)

Specified by:

doExecute in class CloseableHttpAsyncClient

execute

public final Cancellable execute(AsyncClientExchangeHandler exchangeHandler)

awaitShutdown

public final void awaitShutdown(TimeValue waitTime)
                         throws InterruptedException

Specified by:

awaitShutdown in class CloseableHttpAsyncClient

Throws:

InterruptedException

close

public void close()

Description copied from interface: AutoCloseable

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

While this interface method is declared to throw Exception, implementers are strongly encouraged to declare concrete implementations of the close method to throw more specific exceptions, or to throw no exception at all if the close operation cannot fail.

Implementers of this interface are also strongly advised to not have the close method throw InterruptedException. This exception interacts with a thread's interrupted status.

Note that unlike the close method of Closeable, this close method is not required to be idempotent. In other words, calling this close method more than once may have some visible side effect, unlike Closeable.close which is required to have no effect if called more than once. However, implementers of this interface are strongly encouraged to make their close methods idempotent.

close

public final void close(CloseMode closeMode)

Description copied from interface: ModalCloseable

Closes this process or endpoint and releases any system resources associated with it. If the endpoint or the process is already closed then invoking this method has no effect.

Parameters:

closeMode - How to close the receiver.

getStatus

public final IOReactorStatus getStatus()

Specified by:

getStatus in class CloseableHttpAsyncClient

initiateShutdown

public final void initiateShutdown()

Specified by:

initiateShutdown in class CloseableHttpAsyncClient

register

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

Specified by:

register in class CloseableHttpAsyncClient

start

public final void start()

Specified by:

start in class CloseableHttpAsyncClient