net.callumtaylor.asynchttp.response

Class AsyncHttpResponseHandler

java.lang.Object

net.callumtaylor.asynchttp.response.AsyncHttpResponseHandler

Direct Known Subclasses:

BitmapResponseHandler, ByteArrayResponseHandler, CacheResponseHandler, GsonResponseHandler, JSONArrayResponseHandler, JSONObjectResponseHandler, JsonResponseHandler, StringResponseHandler

public abstract class AsyncHttpResponseHandler
extends java.lang.Object

This is the base class for response handlers in AsyncHttpClient. The method flow is as follows:

 onSend -> onPublishedUploadProgress -> onPublishedDownloadProgress -> beforeCallback -> onSuccess/onFailure -> beforeFinish -> onFinish
 

onPublishedDownloadProgress(byte[], int, long), onPublishedUploadProgress(byte[], int, long), beforeCallback(), onSuccess(), and onFailure() all run in the background thread. All your processing should be handled in one of those 4 methods and then either call to run on UI thread a new runnable, or handle in onFinish() which runs on the UI thread In order to get the content created from the response handler, you must call getContent() which can be accessed in onSuccess() or onFailure()

Constructor Summary

Constructors

Constructor and Description
AsyncHttpResponseHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	beforeCallback() Called just before onSuccess()
void	beforeFinish() Called before onFinish()
abstract void	generateContent() Override this method to efficiently generate your content from any buffers you have have used.
ConnectionInfo	getConnectionInfo()
abstract java.lang.Object	getContent() Gets the content generated from the response.
void	onBeginPublishedDownloadProgress(java.io.InputStream stream, AsyncHttpClient.ClientExecutorTask client, long totalLength) Called when processing the response from a stream.
void	onFailure() Called when a response was not 2xx.
void	onFinish() Called when the streams have all finished, success or not
void	onFinish(boolean failed) Called when the streams have all finished, success or not
void	onPublishedDownloadProgress(byte[] chunk, int chunkLength, long totalLength) Called when a chunk has been downloaded from the request.
void	onPublishedDownloadProgress(byte[] chunk, int chunkLength, long totalProcessed, long totalLength) Called when a chunk has been downloaded from the request.
void	onPublishedDownloadProgressUI(long totalProcessed, long totalLength) Runs on the UI thread.
void	onPublishedUploadProgress(byte[] chunk, int chunkLength, long totalLength) Called when a chunk has been uploaded to the request.
void	onPublishedUploadProgress(byte[] chunk, int chunkLength, long totalProcessed, long totalLength) Called when a chunk has been uploaded to the request.
void	onPublishedUploadProgressUI(long totalProcessed, long totalLength) Runs on the UI thread.
void	onSend() Called when the connection is first made
abstract void	onSuccess() Processes the response from the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncHttpResponseHandler

public AsyncHttpResponseHandler()

Method Detail

getConnectionInfo

public ConnectionInfo getConnectionInfo()

onSend

public void onSend()

Called when the connection is first made

onBeginPublishedDownloadProgress

public void onBeginPublishedDownloadProgress(java.io.InputStream stream,
                                    AsyncHttpClient.ClientExecutorTask client,
                                    long totalLength)
                                      throws java.net.SocketTimeoutException,
                                             java.lang.Exception

Called when processing the response from a stream. Use this to override the processing of the InputStream to handle the response differently. Default is to read the response as a byte-array which gets passed, chunk by chunk, to onPublishedDownloadProgress(byte[], int, long)

Parameters:

stream - The response InputStream

client - The client task. In order to call onPublishedDownloadProgressUI(long, long), you must call client.postPublishProgress(new Packet(int readCount, int totalLength, boolean isDownload)) This is required when displaying a progress indicator.

totalLength - The total length of the stream

Throws:

java.net.SocketTimeoutException

java.lang.Exception

onPublishedDownloadProgress

public void onPublishedDownloadProgress(byte[] chunk,
                               int chunkLength,
                               long totalLength)

Called when a chunk has been downloaded from the request. This will be called once every chunk request, and once extra when all the content is downloaded.

Parameters:

chunk - The chunk of data. This will be the null after the total amount has been downloaded.

chunkLength - The length of the chunk

totalLength - The total size of the request. note: This can be -1 during download.

onPublishedDownloadProgress

public void onPublishedDownloadProgress(byte[] chunk,
                               int chunkLength,
                               long totalProcessed,
                               long totalLength)

Called when a chunk has been downloaded from the request. This will be called once every chunk request, and once extra when all the content is downloaded.

Parameters:

chunk - The chunk of data. This will be the null after the total amount has been downloaded.

chunkLength - The length of the chunk

totalProcessed - The total amount of data processed from the request.

totalLength - The total size of the request. note: This can be -1 during download.

onPublishedDownloadProgressUI

public void onPublishedDownloadProgressUI(long totalProcessed,
                                 long totalLength)

Runs on the UI thread. Useful for updating progress bars.

Parameters:

totalProcessed - The total processed sized of the request

totalLength - The total length of the request

onPublishedUploadProgress

public void onPublishedUploadProgress(byte[] chunk,
                             int chunkLength,
                             long totalLength)

Called when a chunk has been uploaded to the request. This will be called once every chunk request

Parameters:

chunk - will be the total byte array when this is called.

chunk - The chunk of data

chunkLength - The length of the chunk

totalLength - The total size of the request.

onPublishedUploadProgress

public void onPublishedUploadProgress(byte[] chunk,
                             int chunkLength,
                             long totalProcessed,
                             long totalLength)

Called when a chunk has been uploaded to the request. This will be called once every chunk request

Parameters:

chunk - will be the total byte array when this is called.

chunk - The chunk of data

chunkLength - The length of the chunk

totalProcessed - The total amount of data processed from the request.

totalLength - The total size of the request.

onPublishedUploadProgressUI

public void onPublishedUploadProgressUI(long totalProcessed,
                               long totalLength)

Runs on the UI thread. Useful for updating progress bars.

Parameters:

totalProcessed - The total processed sized of the request

totalLength - The total length of the request

beforeCallback

public void beforeCallback()

Called just before onSuccess()

generateContent

public abstract void generateContent()

Override this method to efficiently generate your content from any buffers you have have used. This is called directly after onBeginPublishedDownloadProgress(java.io.InputStream, net.callumtaylor.asynchttp.AsyncHttpClient.ClientExecutorTask, long) has finished

getContent

public abstract java.lang.Object getContent()

Gets the content generated from the response. You should only call this once

Returns:

The generated content object

onSuccess

public abstract void onSuccess()

Processes the response from the stream. This is not ran on the UI thread

onFailure

public void onFailure()

Called when a response was not 2xx.

beforeFinish

public void beforeFinish()

Called before onFinish()

onFinish

public void onFinish()

Called when the streams have all finished, success or not

onFinish

public void onFinish(boolean failed)

Called when the streams have all finished, success or not

Parameters:

failed - If the stream failed or not. Useful to display any UI updates here.