Package org.asynchttpclient

Class AsyncCompletionHandler<T>

java.lang.Object

org.asynchttpclient.AsyncCompletionHandler<T>

Type Parameters:

T - Type of the value that will be returned by the associated Future

All Implemented Interfaces:

AsyncHandler<T>, ProgressAsyncHandler<T>

Direct Known Subclasses:

AsyncCompletionHandlerBase

public abstract class AsyncCompletionHandler<T>
extends Object
implements ProgressAsyncHandler<T>

An AsyncHandler augmented with an onCompleted(Response) convenience method which gets called when the Response processing is finished. This class also implements the ProgressAsyncHandler callback, all doing nothing except returning AsyncHandler.State.CONTINUE

Nested Class Summary

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

AsyncHandler.State

Constructor Summary

Constructors

Constructor	Description
AsyncCompletionHandler()

Method Summary

Modifier and Type	Method	Description
AsyncHandler.State	onBodyPartReceived(HttpResponseBodyPart content)	Invoked as soon as some response body part are received.
T	onCompleted()	Invoked once the HTTP response processing is finished.
abstract T	onCompleted(@Nullable 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	onContentWritten()	Invoked when the content (a File, String) or InputStream has been fully written on the I/O socket.
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.
AsyncHandler.State	onStatusReceived(HttpResponseStatus status)	Invoked as soon as the HTTP status line has been received
void	onThrowable(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.

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

AsyncCompletionHandler

public AsyncCompletionHandler()

Method Detail

onStatusReceived

public AsyncHandler.State onStatusReceived(HttpResponseStatus status)
                                    throws Exception

Description copied from interface: AsyncHandler

Invoked as soon as the HTTP status line has been received

Specified by:

onStatusReceived in interface AsyncHandler<T>

Parameters:

status - the status code and test of the response

Returns:

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

Throws:

Exception - if something wrong happens

onHeadersReceived

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

Description copied from interface: AsyncHandler

Invoked as soon as the HTTP headers have been received.

Specified by:

onHeadersReceived in interface AsyncHandler<T>

Parameters:

headers - the HTTP headers.

Returns:

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

Throws:

Exception - if something wrong happens

onBodyPartReceived

public AsyncHandler.State onBodyPartReceived(HttpResponseBodyPart content)
                                      throws 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<T>

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:

Exception - if something wrong happens

onTrailingHeadersReceived

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

Description copied from interface: AsyncHandler

Invoked when trailing headers have been received.

Specified by:

onTrailingHeadersReceived in interface AsyncHandler<T>

Parameters:

headers - the trailing HTTP headers.

Returns:

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

Throws:

Exception - if something wrong happens

onCompleted

@Nullable
public final T onCompleted()
                    throws Exception

Description copied from interface: AsyncHandler

Invoked once the HTTP response processing is finished.
Gets always invoked as last callback method.

Specified by:

onCompleted in interface AsyncHandler<T>

Returns:

T Value that will be returned by the associated Future

Throws:

Exception - if something wrong happens

onThrowable

public void onThrowable(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<T>

Parameters:

t - a Throwable

onCompleted

@Nullable
public abstract T onCompleted(@Nullable
                              @Nullable Response response)
                       throws Exception

Invoked once the HTTP response processing is finished.

Parameters:

response - The Response

Returns:

T Value that will be returned by the associated Future

Throws:

Exception - if something wrong happens

onHeadersWritten

public AsyncHandler.State onHeadersWritten()

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

Specified by:

onHeadersWritten in interface ProgressAsyncHandler<T>

Returns:

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

onContentWritten

public AsyncHandler.State onContentWritten()

Invoked when the content (a File, String) or InputStream has been fully written on the I/O socket.

Specified by:

onContentWritten in interface ProgressAsyncHandler<T>

Returns:

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

onContentWriteProgress

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

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

Specified by:

onContentWriteProgress in interface ProgressAsyncHandler<T>

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.