org.asynchttpclient.handler

Class TransferCompletionHandler

java.lang.Object

org.asynchttpclient.AsyncCompletionHandler<Response>

org.asynchttpclient.AsyncCompletionHandlerBase

org.asynchttpclient.handler.TransferCompletionHandler

All Implemented Interfaces:

AsyncHandler<Response>, ProgressAsyncHandler<Response>

public class TransferCompletionHandler
extends AsyncCompletionHandlerBase

A AsyncHandler that can be used to notify a set of TransferListener

 AsyncHttpClient client = new AsyncHttpClient();
 TransferCompletionHandler tl = new TransferCompletionHandler();
 tl.addTransferListener(new TransferListener() {

 public void onRequestHeadersSent(HttpHeaders headers) {
 }

 public void onResponseHeadersReceived(HttpHeaders headers) {
 }

 public void onBytesReceived(ByteBuffer buffer) {
 }

 public void onBytesSent(long amount, long current, long total) {
 }

 public void onRequestResponseCompleted() {
 }

 public void onThrowable(Throwable t) {
 }
 });

 Response response = httpClient.prepareGet("http://...").execute(tl).get();
 

Nested Class Summary

Nested classes/interfaces inherited from interface org.asynchttpclient.AsyncHandler

AsyncHandler.State

Constructor Summary

Constructors

Constructor and Description
TransferCompletionHandler() Create a TransferCompletionHandler that will not accumulate bytes.
TransferCompletionHandler(boolean accumulateResponseBytes) Create a TransferCompletionHandler that can or cannot accumulate bytes and make it available when Response.getResponseBody() get called.

Method Summary

Modifier and Type	Method and Description
TransferCompletionHandler	addTransferListener(TransferListener t)
void	headers(io.netty.handler.codec.http.HttpHeaders headers)
AsyncHandler.State	onBodyPartReceived(HttpResponseBodyPart content) Invoked as soon as some response body part are received.
Response	onCompleted(Response response) Invoked once the HTTP response processing is finished.
AsyncHandler.State	onContentWriteProgress(long amount, long current, long total) Invoked when the I/O operation associated with the Request body as been progressed.
AsyncHandler.State	onHeadersReceived(io.netty.handler.codec.http.HttpHeaders headers) Invoked as soon as the HTTP headers have been received.
AsyncHandler.State	onHeadersWritten() Invoked when the HTTP headers have been fully written on the I/O socket.
void	onThrowable(java.lang.Throwable t) Invoked when an unexpected exception occurs during the processing of the response.
AsyncHandler.State	onTrailingHeadersReceived(io.netty.handler.codec.http.HttpHeaders headers) Invoked when trailing headers have been received.
TransferCompletionHandler	removeTransferListener(TransferListener t)

Methods inherited from class org.asynchttpclient.AsyncCompletionHandler

onCompleted, onContentWritten, onStatusReceived

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.asynchttpclient.AsyncHandler

onConnectionOffer, onConnectionPoolAttempt, onConnectionPooled, onHostnameResolutionAttempt, onHostnameResolutionFailure, onHostnameResolutionSuccess, onRequestSend, onRetry, onTcpConnectAttempt, onTcpConnectFailure, onTcpConnectSuccess, onTlsHandshakeAttempt, onTlsHandshakeFailure, onTlsHandshakeSuccess

Constructor Detail

TransferCompletionHandler

public TransferCompletionHandler()

Create a TransferCompletionHandler that will not accumulate bytes. The resulting Response.getResponseBody(), Response.getResponseBodyAsStream() will throw an IllegalStateException if called.

TransferCompletionHandler

public TransferCompletionHandler(boolean accumulateResponseBytes)

Create a TransferCompletionHandler that can or cannot accumulate bytes and make it available when Response.getResponseBody() get called. The default is false.

Parameters:

accumulateResponseBytes - true to accumulates bytes in memory.

Method Detail

addTransferListener

public TransferCompletionHandler addTransferListener(TransferListener t)

removeTransferListener

public TransferCompletionHandler removeTransferListener(TransferListener t)

headers

public void headers(io.netty.handler.codec.http.HttpHeaders headers)

onHeadersReceived

public AsyncHandler.State onHeadersReceived(io.netty.handler.codec.http.HttpHeaders headers)
                                     throws java.lang.Exception

Description copied from interface: AsyncHandler

Invoked as soon as the HTTP headers have been received.

Specified by:

onHeadersReceived in interface AsyncHandler<Response>

Overrides:

onHeadersReceived in class AsyncCompletionHandler<Response>

Parameters:

headers - the HTTP headers.

Returns:

a AsyncHandler.State telling to CONTINUE or ABORT the current processing.

Throws:

java.lang.Exception - if something wrong happens

onTrailingHeadersReceived

public AsyncHandler.State onTrailingHeadersReceived(io.netty.handler.codec.http.HttpHeaders headers)
                                             throws java.lang.Exception

Description copied from interface: AsyncHandler

Invoked when trailing headers have been received.

Specified by:

onTrailingHeadersReceived in interface AsyncHandler<Response>

Overrides:

onTrailingHeadersReceived in class AsyncCompletionHandler<Response>

Parameters:

headers - the trailing HTTP headers.

Returns:

a AsyncHandler.State telling to CONTINUE or ABORT the current processing.

Throws:

java.lang.Exception - if something wrong happens

onBodyPartReceived

public AsyncHandler.State onBodyPartReceived(HttpResponseBodyPart content)
                                      throws java.lang.Exception

Description copied from interface: AsyncHandler

Invoked as soon as some response body part are received. Could be invoked many times. Beware that, depending on the provider (Netty) this can be notified with empty body parts.

Specified by:

onBodyPartReceived in interface AsyncHandler<Response>

Overrides:

onBodyPartReceived in class AsyncCompletionHandler<Response>

Parameters:

content - response's body part.

Returns:

a AsyncHandler.State telling to CONTINUE or ABORT the current processing. Aborting will also close the connection.

Throws:

java.lang.Exception - if something wrong happens

onCompleted

public Response onCompleted(Response response)
                     throws java.lang.Exception

Description copied from class: AsyncCompletionHandlerBase

Invoked once the HTTP response processing is finished.

Overrides:

onCompleted in class AsyncCompletionHandlerBase

Parameters:

response - The Response

Returns:

T Value that will be returned by the associated Future

Throws:

java.lang.Exception - if something wrong happens

onHeadersWritten

public AsyncHandler.State onHeadersWritten()

Description copied from class: AsyncCompletionHandler

Invoked when the HTTP headers have been fully written on the I/O socket.

Specified by:

onHeadersWritten in interface ProgressAsyncHandler<Response>

Overrides:

onHeadersWritten in class AsyncCompletionHandler<Response>

Returns:

a AsyncHandler.State telling to CONTINUE or ABORT the current processing.

onContentWriteProgress

public AsyncHandler.State onContentWriteProgress(long amount,
                                                 long current,
                                                 long total)

Description copied from class: AsyncCompletionHandler

Invoked when the I/O operation associated with the Request body as been progressed.

Specified by:

onContentWriteProgress in interface ProgressAsyncHandler<Response>

Overrides:

onContentWriteProgress in class AsyncCompletionHandler<Response>

Parameters:

amount - The amount of bytes to transfer

current - The amount of bytes transferred

total - The total number of bytes transferred

Returns:

a AsyncHandler.State telling to CONTINUE or ABORT the current processing.

onThrowable

public void onThrowable(java.lang.Throwable t)

Description copied from interface: AsyncHandler

Invoked when an unexpected exception occurs during the processing of the response. The exception may have been produced by implementation of onXXXReceived method invocation.

Specified by:

onThrowable in interface AsyncHandler<Response>

Overrides:

onThrowable in class AsyncCompletionHandler<Response>

Parameters:

t - a Throwable