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 associatedFuture
- All Implemented Interfaces:
AsyncHandler<T>
,ProgressAsyncHandler<T>
- Direct Known Subclasses:
AsyncCompletionHandlerBase
public abstract class AsyncCompletionHandler<T> extends Object implements ProgressAsyncHandler<T>
AnAsyncHandler
augmented with anonCompleted(Response)
convenience method which gets called when theResponse
processing is finished. This class also implements theProgressAsyncHandler
callback, all doing nothing except returningAsyncHandler.State.CONTINUE
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.asynchttpclient.AsyncHandler
AsyncHandler.State
-
-
Constructor Summary
Constructors Constructor Description AsyncCompletionHandler()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods 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(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 theRequest
body as been progressed.AsyncHandler.State
onContentWritten()
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 receivedvoid
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
-
-
-
-
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 interfaceAsyncHandler<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 interfaceAsyncHandler<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 interfaceAsyncHandler<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 interfaceAsyncHandler<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
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 interfaceAsyncHandler<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 interfaceAsyncHandler<T>
- Parameters:
t
- aThrowable
-
onCompleted
public abstract T onCompleted(Response response) throws Exception
Invoked once the HTTP response processing is finished.
-
onHeadersWritten
public AsyncHandler.State onHeadersWritten()
Invoked when the HTTP headers have been fully written on the I/O socket.- Specified by:
onHeadersWritten
in interfaceProgressAsyncHandler<T>
- Returns:
- a
AsyncHandler.State
telling to CONTINUE or ABORT the current processing.
-
onContentWritten
public AsyncHandler.State onContentWritten()
- Specified by:
onContentWritten
in interfaceProgressAsyncHandler<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 theRequest
body as been progressed.- Specified by:
onContentWriteProgress
in interfaceProgressAsyncHandler<T>
- Parameters:
amount
- The amount of bytes to transfercurrent
- The amount of bytes transferredtotal
- The total number of bytes transferred- Returns:
- a
AsyncHandler.State
telling to CONTINUE or ABORT the current processing.
-
-