Class BasicClientExchangeHandler<T>
java.lang.Object
org.apache.hc.core5.http.nio.support.BasicClientExchangeHandler<T>
- All Implemented Interfaces:
AsyncClientExchangeHandler
,AsyncDataConsumer
,AsyncDataExchangeHandler
,AsyncDataProducer
,ResourceHolder
public final class BasicClientExchangeHandler<T>
extends Object
implements AsyncClientExchangeHandler
Basic
AsyncClientExchangeHandler
implementation that makes use
of AsyncRequestProducer
to generate request message
and AsyncResponseConsumer
to process the response message returned by the server.- Since:
- 5.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final AtomicBoolean
private final AtomicBoolean
private final AsyncRequestProducer
private final AsyncResponseConsumer
<T> private final FutureCallback
<T> -
Constructor Summary
ConstructorsConstructorDescriptionBasicClientExchangeHandler
(AsyncRequestProducer requestProducer, AsyncResponseConsumer<T> responseConsumer, FutureCallback<T> resultCallback) -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the number of bytes immediately available for output.void
cancel()
Triggered to cancel the message exchange.void
consume
(ByteBuffer src) Triggered to pass incoming data to the data consumer.void
consumeInformation
(HttpResponse response, HttpContext httpContext) Triggered to signal receipt of an intermediate (1xx) HTTP response.void
consumeResponse
(HttpResponse response, EntityDetails entityDetails, HttpContext httpContext) Triggered to signal receipt of a response message head.void
Triggered to signal a failure in data processing.private void
void
produce
(DataStreamChannel channel) Triggered to signal the ability of the underlying data channel to accept more data.void
produceRequest
(RequestChannel requestChannel, HttpContext httpContext) Triggered to signal the ability of the underlying request channel to accept a request messages.void
void
Triggered to signal termination of the data stream.void
updateCapacity
(CapacityChannel capacityChannel) Triggered to signal ability of the underlying data stream to receive data capacity update.
-
Field Details
-
requestProducer
-
responseConsumer
-
completed
-
resultCallback
-
outputTerminated
-
-
Constructor Details
-
BasicClientExchangeHandler
public BasicClientExchangeHandler(AsyncRequestProducer requestProducer, AsyncResponseConsumer<T> responseConsumer, FutureCallback<T> resultCallback)
-
-
Method Details
-
produceRequest
public void produceRequest(RequestChannel requestChannel, HttpContext httpContext) throws HttpException, IOException Description copied from interface:AsyncClientExchangeHandler
Triggered to signal the ability of the underlying request channel to accept a request messages. The data producer can choose to send a request message immediately inside the call or asynchronously at some later point.- Specified by:
produceRequest
in interfaceAsyncClientExchangeHandler
- Parameters:
requestChannel
- the request channel capable to accepting a request message.httpContext
- the actual execution context.- Throws:
HttpException
IOException
-
available
public int available()Description copied from interface:AsyncDataProducer
Returns the number of bytes immediately available for output. This method can be used as a hint to control output events of the underlying I/O session.- Specified by:
available
in interfaceAsyncDataProducer
- Returns:
- the number of bytes immediately available for output
-
produce
Description copied from interface:AsyncDataProducer
Triggered to signal the ability of the underlying data channel to accept more data. The data producer can choose to write data immediately inside the call or asynchronously at some later point.- Specified by:
produce
in interfaceAsyncDataProducer
- Parameters:
channel
- the data channel capable to accepting more data.- Throws:
IOException
-
consumeInformation
public void consumeInformation(HttpResponse response, HttpContext httpContext) throws HttpException, IOException Description copied from interface:AsyncClientExchangeHandler
Triggered to signal receipt of an intermediate (1xx) HTTP response.- Specified by:
consumeInformation
in interfaceAsyncClientExchangeHandler
- Parameters:
response
- the intermediate (1xx) HTTP response.httpContext
- the actual execution context.- Throws:
HttpException
IOException
-
consumeResponse
public void consumeResponse(HttpResponse response, EntityDetails entityDetails, HttpContext httpContext) throws HttpException, IOException Description copied from interface:AsyncClientExchangeHandler
Triggered to signal receipt of a response message head.- Specified by:
consumeResponse
in interfaceAsyncClientExchangeHandler
- Parameters:
response
- the response message head.entityDetails
- the response entity details ornull
if the response does not enclose an entity.httpContext
- the actual execution context.- Throws:
HttpException
IOException
-
cancel
public void cancel()Description copied from interface:AsyncClientExchangeHandler
Triggered to cancel the message exchange.- Specified by:
cancel
in interfaceAsyncClientExchangeHandler
-
updateCapacity
Description copied from interface:AsyncDataConsumer
Triggered to signal ability of the underlying data stream to receive data capacity update. The data consumer can choose to write data immediately inside the call or asynchronously at some later point.- Specified by:
updateCapacity
in interfaceAsyncDataConsumer
- Parameters:
capacityChannel
- the channel for capacity updates.- Throws:
IOException
-
consume
Description copied from interface:AsyncDataConsumer
Triggered to pass incoming data to the data consumer. The consumer must consume the entire content of the data buffer. The consumer must stop incrementing its capacity on the capacity channel if it is unable to accept more data. Once the data consumer has handled accumulated data or allocated more intermediate storage it can update its capacity information on the capacity channel.- Specified by:
consume
in interfaceAsyncDataConsumer
- Parameters:
src
- data source.- Throws:
IOException
-
streamEnd
Description copied from interface:AsyncDataConsumer
Triggered to signal termination of the data stream.- Specified by:
streamEnd
in interfaceAsyncDataConsumer
- Parameters:
trailers
- data stream trailers.- Throws:
HttpException
IOException
-
failed
Description copied from interface:AsyncDataExchangeHandler
Triggered to signal a failure in data processing.- Specified by:
failed
in interfaceAsyncDataExchangeHandler
- Parameters:
cause
- the cause of the failure.
-
internalReleaseResources
private void internalReleaseResources() -
releaseResources
public void releaseResources()- Specified by:
releaseResources
in interfaceResourceHolder
-