net.callumtaylor.asynchttp.response

Class ResponseHandler<E>

java.lang.Object

net.callumtaylor.asynchttp.response.ResponseHandler<E>

Direct Known Subclasses:

BasicResponseHandler, BitmapResponseHandler, ByteArrayResponseHandler, CacheResponseHandler, JSONArrayResponseHandler, JSONObjectResponseHandler, StreamResponseHandler, StringResponseHandler

public abstract class ResponseHandler<E>
extends Object

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

 onSend -> onByteChunkSent -> onByteChunkReceived -> beforeResponse -> onSuccess/onFailure -> beforeFinish -> onFinish
 

onByteChunkReceived(byte[], long, long, long), onByteChunkSent(byte[], long, long, long), beforeResponse(), 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
ResponseHandler()

Method Summary

Modifier and Type	Method and Description
void	beforeFinish() Called before onFinish()
void	beforeResponse() Called just before onSuccess()
abstract void	generateContent() Override this method to efficiently generate your content from any buffers you have have used.
ConnectionInfo	getConnectionInfo()
abstract E	getContent() Gets the content generated from the response.
void	onByteChunkReceived(byte[] chunk, long chunkLength, long totalProcessed, long totalLength) Called when a chunk has been downloaded from the request.
void	onByteChunkReceivedProcessed(long totalProcessed, long totalLength) Runs on the UI thread.
void	onByteChunkSent(byte[] chunk, long chunkLength, long totalProcessed, long totalLength) Called when a chunk has been uploaded to the request.
void	onByteChunkSentProcessed(long totalProcessed, long totalLength) Runs on the UI thread.
void	onFailure() Called when a response was not 2xx.
void	onFinish() Called when the streams have all finished, success or not.
void	onReceiveStream(InputStream stream, ClientTaskImpl client, long totalLength) Called when processing the response from a stream.
void	onSend() Called when the connection is first made
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

ResponseHandler

public ResponseHandler()

Method Detail

getConnectionInfo

public ConnectionInfo getConnectionInfo()

onSend

@WorkerThread
public void onSend()

Called when the connection is first made

onReceiveStream

@WorkerThread
public void onReceiveStream(InputStream stream,
                                          ClientTaskImpl client,
                                          long totalLength)
                                   throws SocketTimeoutException,
                                          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 onByteChunkReceived(byte[], long, long, long)

Parameters:

stream - The response InputStream

client - The client task. In order to call onByteChunkReceivedProcessed(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:

SocketTimeoutException

Exception

onByteChunkReceived

@WorkerThread
public void onByteChunkReceived(@Nullable
                                              byte[] chunk,
                                              long 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.

onByteChunkReceivedProcessed

@UiThread
public void onByteChunkReceivedProcessed(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

onByteChunkSent

@WorkerThread
public void onByteChunkSent(@NonNull
                                          byte[] chunk,
                                          long 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 - 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.

onByteChunkSentProcessed

@UiThread
public void onByteChunkSentProcessed(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

beforeResponse

@WorkerThread
public void beforeResponse()

Called just before onSuccess()

generateContent

@WorkerThread
public abstract void generateContent()

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

getContent

@Nullable
public abstract E getContent()

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

Returns:

The generated content object

onSuccess

@WorkerThread
public void onSuccess()

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

onFailure

@WorkerThread
public void onFailure()

Called when a response was not 2xx.

beforeFinish

@WorkerThread
public void beforeFinish()

Called before onFinish()

onFinish

@UiThread
public void onFinish()

Called when the streams have all finished, success or not. This is called on the UI Thread