Apache HttpClient 5.3 · org.apache.hc.client5.http.nio.AsyncConnectionEndpoint

Access	Constructor and Description
public	AsyncConnectionEndpoint()

Method Summary

Modifier and Type	Method and Description
public final void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public abstract void	execute(String unique operation ID or `null`. id, AsyncClientExchangeHandler the message exchange handler. exchangeHandler, HandlerFactory<AsyncPushConsumer> the push handler factory. pushHandlerFactory, HttpContext the execution context. context) Initiates a message exchange using the given handler.
public void	execute(final String unique operation ID or `null`. id, final AsyncClientExchangeHandler the message exchange handler. exchangeHandler, final HttpContext the execution context. context) Initiates a message exchange using the given handler.
public final < the result representation. T> Future<T>	Returns: the result future. execute(final String unique operation ID or `null`. id, final AsyncRequestProducer the request producer. requestProducer, final AsyncResponseConsumer<T> the response consumer. responseConsumer, final HandlerFactory<AsyncPushConsumer> the push handler factory. pushHandlerFactory, final HttpContext the execution context. context, final FutureCallback<T> the result callback. callback) Initiates message exchange using the given request producer and response consumer.
public final < the result representation. T> Future<T>	Returns: the result future. execute(final String unique operation ID or `null`. id, final AsyncRequestProducer the request producer. requestProducer, final AsyncResponseConsumer<T> the response consumer. responseConsumer, final HttpContext the execution context. context, final FutureCallback<T> the result callback. callback) Initiates message exchange using the given request producer and response consumer.
public final < the result representation. T> Future<T>	Returns: the result future. execute(final String unique operation ID or `null`. id, final AsyncRequestProducer the request producer. requestProducer, final AsyncResponseConsumer<T> the response consumer. responseConsumer, final HandlerFactory<AsyncPushConsumer> the push handler factory. pushHandlerFactory, final FutureCallback<T> the result callback. callback) Initiates message exchange using the given request producer and response consumer.
public final < the result representation. T> Future<T>	Returns: the result future. execute(final String unique operation ID or `null`. id, final AsyncRequestProducer the request producer. requestProducer, final AsyncResponseConsumer<T> the response consumer. responseConsumer, final FutureCallback<T> the result callback. callback) Initiates message exchange using the given request producer and response consumer.
public abstract boolean	isConnected() Determines if the connection to the remote endpoint is still open and valid.
public abstract void	setSocketTimeout(Timeout the socket timeout. timeout) Sets socket timeout.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

AsyncConnectionEndpoint	back to summary
public AsyncConnectionEndpoint()

Method Detail

close back to summary

close	back to summary
public final void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public final void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

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

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

execute back to summary

execute	back to summary
public abstract void execute(String id, AsyncClientExchangeHandler exchangeHandler, HandlerFactory<AsyncPushConsumer> pushHandlerFactory, HttpContext context) Initiates a message exchange using the given handler. Parameters id:String unique operation ID or `null`. exchangeHandler:AsyncClientExchangeHandler the message exchange handler. pushHandlerFactory:HandlerFactory<AsyncPushConsumer> the push handler factory. context:HttpContext the execution context.

public abstract void execute(String id, AsyncClientExchangeHandler exchangeHandler, HandlerFactory<AsyncPushConsumer> pushHandlerFactory, HttpContext context)

Initiates a message exchange using the given handler.

Parameters

id:String: unique operation ID or null.
exchangeHandler:AsyncClientExchangeHandler: the message exchange handler.
pushHandlerFactory:HandlerFactory<AsyncPushConsumer>: the push handler factory.
context:HttpContext: the execution context.

execute back to summary

execute	back to summary
public void execute(final String id, final AsyncClientExchangeHandler exchangeHandler, final HttpContext context) Initiates a message exchange using the given handler. Parameters id:String unique operation ID or `null`. exchangeHandler:AsyncClientExchangeHandler the message exchange handler. context:HttpContext the execution context.

public void execute(final String id, final AsyncClientExchangeHandler exchangeHandler, final HttpContext context)

Initiates a message exchange using the given handler.

Parameters

id:String: unique operation ID or null.
exchangeHandler:AsyncClientExchangeHandler: the message exchange handler.
context:HttpContext: the execution context.

execute back to summary

execute	back to summary
public final <T> Future<T> execute(final String id, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer<T> responseConsumer, final HandlerFactory<AsyncPushConsumer> pushHandlerFactory, final HttpContext context, final FutureCallback<T> callback) Initiates message exchange using the given request producer and response consumer. Parameters <T> the result representation. id:String unique operation ID or `null`. requestProducer:AsyncRequestProducer the request producer. responseConsumer:AsyncResponseConsumer<T> the response consumer. pushHandlerFactory:HandlerFactory<AsyncPushConsumer> the push handler factory. context:HttpContext the execution context. callback:FutureCallback<T> the result callback. Returns:Future<T> the result future.

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

Initiates message exchange using the given request producer and response consumer.

Parameters

<T>: the result representation.
id:String: unique operation ID or null.
requestProducer:AsyncRequestProducer: the request producer.
responseConsumer:AsyncResponseConsumer<T>: the response consumer.
pushHandlerFactory:HandlerFactory<AsyncPushConsumer>: the push handler factory.
context:HttpContext: the execution context.
callback:FutureCallback<T>: the result callback.

Returns:Future<T>

the result future.

execute back to summary

execute	back to summary
public final <T> Future<T> execute(final String id, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer<T> responseConsumer, final HttpContext context, final FutureCallback<T> callback) Initiates message exchange using the given request producer and response consumer. Parameters <T> the result representation. id:String unique operation ID or `null`. requestProducer:AsyncRequestProducer the request producer. responseConsumer:AsyncResponseConsumer<T> the response consumer. context:HttpContext the execution context. callback:FutureCallback<T> the result callback. Returns:Future<T> the result future.

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

Initiates message exchange using the given request producer and response consumer.

Parameters

<T>: the result representation.
id:String: unique operation ID or null.
requestProducer:AsyncRequestProducer: the request producer.
responseConsumer:AsyncResponseConsumer<T>: the response consumer.
context:HttpContext: the execution context.
callback:FutureCallback<T>: the result callback.

Returns:Future<T>

the result future.

execute back to summary

execute	back to summary
public final <T> Future<T> execute(final String id, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer<T> responseConsumer, final HandlerFactory<AsyncPushConsumer> pushHandlerFactory, final FutureCallback<T> callback) Initiates message exchange using the given request producer and response consumer. Parameters <T> the result representation. id:String unique operation ID or `null`. requestProducer:AsyncRequestProducer the request producer. responseConsumer:AsyncResponseConsumer<T> the response consumer. pushHandlerFactory:HandlerFactory<AsyncPushConsumer> the push handler factory. callback:FutureCallback<T> the result callback. Returns:Future<T> the result future.

Initiates message exchange using the given request producer and response consumer.

Parameters

<T>: the result representation.
id:String: unique operation ID or null.
requestProducer:AsyncRequestProducer: the request producer.
responseConsumer:AsyncResponseConsumer<T>: the response consumer.
pushHandlerFactory:HandlerFactory<AsyncPushConsumer>: the push handler factory.
callback:FutureCallback<T>: the result callback.

Returns:Future<T>

the result future.

execute back to summary

execute	back to summary
public final <T> Future<T> execute(final String id, final AsyncRequestProducer requestProducer, final AsyncResponseConsumer<T> responseConsumer, final FutureCallback<T> callback) Initiates message exchange using the given request producer and response consumer. Parameters <T> the result representation. id:String unique operation ID or `null`. requestProducer:AsyncRequestProducer the request producer. responseConsumer:AsyncResponseConsumer<T> the response consumer. callback:FutureCallback<T> the result callback. Returns:Future<T> the result future.

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

Initiates message exchange using the given request producer and response consumer.

Parameters

<T>: the result representation.
id:String: unique operation ID or null.
requestProducer:AsyncRequestProducer: the request producer.
responseConsumer:AsyncResponseConsumer<T>: the response consumer.
callback:FutureCallback<T>: the result callback.

Returns:Future<T>

the result future.

isConnected	back to summary
public abstract boolean isConnected() Determines if the connection to the remote endpoint is still open and valid.

setSocketTimeout	back to summary
public abstract void setSocketTimeout(Timeout timeout) Sets socket timeout. Parameters timeout:Timeout the socket timeout.

setSocketTimeout

back to summary

public abstract void setSocketTimeout(Timeout timeout)

Sets socket timeout.

Parameters

timeout:Timeout: the socket timeout.

public abstract Class AsyncConnectionEndpoint

Constructor Summary

Method Summary

Constructor Detail

Method Detail