AsyncHttpResponseHandler (library 0.0.99 API)

java.lang.Object
- com.loopj.android.http.AsyncHttpResponseHandler

所有已实现的接口:: ResponseHandlerInterface

直接已知子类:: BinaryHttpResponseHandler, DataAsyncHttpResponseHandler, FileAsyncHttpResponseHandler, SaxAsyncHttpResponseHandler, TextHttpResponseHandler

public abstract class AsyncHttpResponseHandler
extends java.lang.Object
implements ResponseHandlerInterface

Used to intercept and handle the responses from requests made using AsyncHttpClient. The {onSuccess(int, Header[], byte[])} method is designed to be anonymously overridden with your own response handling code.

Additionally, you can override the {onFailure(int, Header[], byte[], Throwable)}, {onStart()}, onFinish(), onRetry(int) and onProgress(int, int) methods as required.

For example:

 AsyncHttpClient client = new AsyncHttpClient();
 client.get("http://www.google.com", new AsyncHttpResponseHandler() {
     @Override
     public void onStart() {
         // Initiated the request
     }

     @Override
     public void onSuccess(int statusCode, Header[] headers, byte[] responseBody) {
         // Successfully got a response
     }

     @Override
     public void onFailure(int statusCode, Header[] headers, byte[] responseBody, Throwable
 error)
 {
         // Response failed :(
     }

     @Override
     public void onRetry(int retryNo) {
         // Request was retried
     }

     @Override
     public void onProgress(int bytesWritten, int totalSize) {
         // Progress notification
     }

     @Override
     public void onFinish() {
         // Completed the request (either success or failure)
     }
 });

字段概要

字段
限定符和类型	字段和说明
`protected static int`	`BUFFER_SIZE`
`protected static int`	`CANCEL_MESSAGE`
`static java.lang.String`	`DEFAULT_CHARSET`
`protected static int`	`FAILURE_MESSAGE`
`protected static int`	`FINISH_MESSAGE`
`protected static int`	`PROGRESS_MESSAGE`
`protected static int`	`RETRY_MESSAGE`
`protected static int`	`START_MESSAGE`
`protected static int`	`SUCCESS_MESSAGE`
`static java.lang.String`	`UTF8_BOM`

构造器概要

构造器
构造器和说明
`AsyncHttpResponseHandler()` Creates a new AsyncHttpResponseHandler
`AsyncHttpResponseHandler(boolean usePoolThread)` Creates a new AsyncHttpResponseHandler and decide whether the callbacks will be fired on current thread's looper or the pool thread's.
`AsyncHttpResponseHandler(android.os.Looper looper)` Creates a new AsyncHttpResponseHandler with a user-supplied looper.

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`java.lang.String`	`getCharset()`
`Header[]`	`getRequestHeaders()` Returns Header[] which were used to request
`java.net.URI`	`getRequestURI()` Returns URI which was used to request
`boolean`	`getUsePoolThread()` Returns whether the handler should be executed on the pool's thread or the UI thread
`boolean`	`getUseSynchronousMode()` Returns whether the handler is asynchronous or synchronous
`protected void`	`handleMessage(android.os.Message message)`
`protected android.os.Message`	`obtainMessage(int responseMessageId, java.lang.Object responseMessageData)` Helper method to create Message instance from handler
`void`	`onCancel()`
`abstract void`	`onFailure(int statusCode, Header[] headers, byte[] responseBody, java.lang.Throwable error)` Fired when a request fails to complete, override to handle in your own code
`void`	`onFinish()` Fired in all cases when the request is finished, after both success and failure, override to handle in your own code
`void`	`onPostProcessResponse(ResponseHandlerInterface instance, HttpResponse response)` This method is called once by the system when the request has been fully sent, handled and finished.
`void`	`onPreProcessResponse(ResponseHandlerInterface instance, HttpResponse response)` This method is called once by the system when the response is about to be processed by the system.
`void`	`onProgress(int bytesWritten, int totalSize)` Fired when the request progress, override to handle in your own code
`void`	`onRetry(int retryNo)` Fired when a retry occurs, override to handle in your own code
`void`	`onStart()` Fired when the request is started, override to handle in your own code
`abstract void`	`onSuccess(int statusCode, Header[] headers, byte[] responseBody)` Fired when a request returns successfully, override to handle in your own code
`void`	`onUserException(java.lang.Throwable error)`
`protected void`	`postRunnable(java.lang.Runnable runnable)` Helper method to send runnable into local handler loop
`void`	`sendCancelMessage()` Notifies callback, that request was cancelled
`void`	`sendFailureMessage(int statusCode, Header[] headers, byte[] responseBody, java.lang.Throwable throwable)` Returns if request was completed with error code or failure of implementation
`void`	`sendFinishMessage()` Notifies callback, that request was completed and is being removed from thread pool
`protected void`	`sendMessage(android.os.Message msg)`
`void`	`sendProgressMessage(int bytesWritten, int bytesTotal)` Notifies callback, that request (mainly uploading) has progressed
`void`	`sendResponseMessage(HttpResponse response)` Returns data whether request completed successfully
`void`	`sendRetryMessage(int retryNo)` Notifies callback of retrying request
`void`	`sendStartMessage()` Notifies callback, that request started execution
`void`	`sendSuccessMessage(int statusCode, Header[] headers, byte[] responseBytes)` Notifies callback, that request was handled successfully
`void`	`setCharset(java.lang.String charset)` Sets the charset for the response string.
`void`	`setRequestHeaders(Header[] requestHeaders)` Helper for handlers to receive Request Header[] info
`void`	`setRequestURI(java.net.URI requestURI)` Helper for handlers to receive Request URI info
`void`	`setUsePoolThread(boolean pool)` Sets whether the handler should be executed on the pool's thread or the UI thread
`void`	`setUseSynchronousMode(boolean sync)` Can set, whether the handler should be asynchronous or synchronous

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - SUCCESS_MESSAGE
```
protected static final int SUCCESS_MESSAGE
```
    另请参阅:
    
    常量字段值
  - FAILURE_MESSAGE
```
protected static final int FAILURE_MESSAGE
```
    另请参阅:
    
    常量字段值
  - START_MESSAGE
```
protected static final int START_MESSAGE
```
    另请参阅:
    
    常量字段值
  - FINISH_MESSAGE
```
protected static final int FINISH_MESSAGE
```
    另请参阅:
    
    常量字段值
  - PROGRESS_MESSAGE
```
protected static final int PROGRESS_MESSAGE
```
    另请参阅:
    
    常量字段值
  - RETRY_MESSAGE
```
protected static final int RETRY_MESSAGE
```
    另请参阅:
    
    常量字段值
  - CANCEL_MESSAGE
```
protected static final int CANCEL_MESSAGE
```
    另请参阅:
    
    常量字段值
  - BUFFER_SIZE
```
protected static final int BUFFER_SIZE
```
    另请参阅:
    
    常量字段值
  - DEFAULT_CHARSET
```
public static final java.lang.String DEFAULT_CHARSET
```
    另请参阅:
    
    常量字段值
  - UTF8_BOM
```
public static final java.lang.String UTF8_BOM
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - AsyncHttpResponseHandler
```
public AsyncHttpResponseHandler()
```
    Creates a new AsyncHttpResponseHandler
  - AsyncHttpResponseHandler
```
public AsyncHttpResponseHandler(android.os.Looper looper)
```
    Creates a new AsyncHttpResponseHandler with a user-supplied looper. If the passed looper is null, the looper attached to the current thread will be used.
    
    参数:
    
    looper - The looper to work with
  - AsyncHttpResponseHandler
```
public AsyncHttpResponseHandler(boolean usePoolThread)
```
    Creates a new AsyncHttpResponseHandler and decide whether the callbacks will be fired on current thread's looper or the pool thread's.
    
    参数:
    
    usePoolThread - Whether to use the pool's thread to fire callbacks
- 方法详细资料
  - getRequestURI
```
public java.net.URI getRequestURI()
```
    从接口复制的说明: ResponseHandlerInterface
    
    Returns URI which was used to request
    
    指定者:
    
    getRequestURI 在接口中 ResponseHandlerInterface
    
    返回:
    
    uri of origin request
  - getRequestHeaders
```
public Header[] getRequestHeaders()
```
    从接口复制的说明: ResponseHandlerInterface
    
    Returns Header[] which were used to request
    
    指定者:
    
    getRequestHeaders 在接口中 ResponseHandlerInterface
    
    返回:
    
    headers from origin request
  - setRequestURI
```
public void setRequestURI(java.net.URI requestURI)
```
    从接口复制的说明: ResponseHandlerInterface
    
    Helper for handlers to receive Request URI info
    
    指定者:
    
    setRequestURI 在接口中 ResponseHandlerInterface
    
    参数:
    
    requestURI - claimed request URI
  - setRequestHeaders
```
public void setRequestHeaders(Header[] requestHeaders)
```
    从接口复制的说明: ResponseHandlerInterface
    
    Helper for handlers to receive Request Header[] info
    
    指定者:
    
    setRequestHeaders 在接口中 ResponseHandlerInterface
    
    参数:
    
    requestHeaders - Headers, claimed to be from original request
  - getUseSynchronousMode
```
public boolean getUseSynchronousMode()
```
    从接口复制的说明: ResponseHandlerInterface
    
    Returns whether the handler is asynchronous or synchronous
    
    指定者:
    
    getUseSynchronousMode 在接口中 ResponseHandlerInterface
    
    返回:
    
    boolean if the ResponseHandler is running in synchronous mode
  - setUseSynchronousMode
```
public void setUseSynchronousMode(boolean sync)
```
    从接口复制的说明: ResponseHandlerInterface
    
    Can set, whether the handler should be asynchronous or synchronous
    
    指定者:
    
    setUseSynchronousMode 在接口中 ResponseHandlerInterface
    
    参数:
    
    sync - whether data should be handled on background Thread on UI Thread
  - getUsePoolThread
```
public boolean getUsePoolThread()
```
    从接口复制的说明: ResponseHandlerInterface
    
    Returns whether the handler should be executed on the pool's thread or the UI thread
    
    指定者:
    
    getUsePoolThread 在接口中 ResponseHandlerInterface
    
    返回:
    
    boolean if the ResponseHandler should run on pool's thread
  - setUsePoolThread
```
public void setUsePoolThread(boolean pool)
```
    从接口复制的说明: ResponseHandlerInterface
    
    Sets whether the handler should be executed on the pool's thread or the UI thread
    
    指定者:
    
    setUsePoolThread 在接口中 ResponseHandlerInterface
    
    参数:
    
    pool - if the ResponseHandler should run on pool's thread
  - setCharset
```
public void setCharset(java.lang.String charset)
```
    Sets the charset for the response string. If not set, the default is UTF-8.
    
    参数:
    
    charset - to be used for the response string.
    
    另请参阅:
    
    Charset
  - getCharset
```
public java.lang.String getCharset()
```
  - onProgress
```
public void onProgress(int bytesWritten,
                       int totalSize)
```
    Fired when the request progress, override to handle in your own code
    
    参数:
    
    bytesWritten - offset from start of file
    
    totalSize - total size of file
  - onStart
```
public void onStart()
```
    Fired when the request is started, override to handle in your own code
  - onFinish
```
public void onFinish()
```
    Fired in all cases when the request is finished, after both success and failure, override to handle in your own code
  - onPreProcessResponse
```
public void onPreProcessResponse(ResponseHandlerInterface instance,
                                 HttpResponse response)
```
    从接口复制的说明: ResponseHandlerInterface
    
    This method is called once by the system when the response is about to be processed by the system. The library makes sure that a single response is pre-processed only once. Please note: pre-processing does NOT run on the main thread, and thus any UI activities that you must perform should be properly dispatched to the app's UI thread.
    
    指定者:
    
    onPreProcessResponse 在接口中 ResponseHandlerInterface
    
    参数:
    
    instance - An instance of this response object
    
    response - The response to pre-processed
  - onPostProcessResponse
```
public void onPostProcessResponse(ResponseHandlerInterface instance,
                                  HttpResponse response)
```
    从接口复制的说明: ResponseHandlerInterface
    
    This method is called once by the system when the request has been fully sent, handled and finished. The library makes sure that a single response is post-processed only once. Please note: post-processing does NOT run on the main thread, and thus any UI activities that you must perform should be properly dispatched to the app's UI thread.
    
    指定者:
    
    onPostProcessResponse 在接口中 ResponseHandlerInterface
    
    参数:
    
    instance - An instance of this response object
    
    response - The response to post-process
  - onSuccess
```
public abstract void onSuccess(int statusCode,
                               Header[] headers,
                               byte[] responseBody)
```
    Fired when a request returns successfully, override to handle in your own code
    
    参数:
    
    statusCode - the status code of the response
    
    headers - return headers, if any
    
    responseBody - the body of the HTTP response from the server
  - onFailure
```
public abstract void onFailure(int statusCode,
                               Header[] headers,
                               byte[] responseBody,
                               java.lang.Throwable error)
```
    Fired when a request fails to complete, override to handle in your own code
    
    参数:
    
    statusCode - return HTTP status code
    
    headers - return headers, if any
    
    responseBody - the response body, if any
    
    error - the underlying cause of the failure
  - onRetry
```
public void onRetry(int retryNo)
```
    Fired when a retry occurs, override to handle in your own code
    
    参数:
    
    retryNo - number of retry
  - onCancel
```
public void onCancel()
```
  - onUserException
```
public void onUserException(java.lang.Throwable error)
```
  - sendProgressMessage
```
public final void sendProgressMessage(int bytesWritten,
                                      int bytesTotal)
```
    从接口复制的说明: ResponseHandlerInterface
    
    Notifies callback, that request (mainly uploading) has progressed
    
    指定者:
    
    sendProgressMessage 在接口中 ResponseHandlerInterface
    
    参数:
    
    bytesWritten - number of written bytes
    
    bytesTotal - number of total bytes to be written
  - sendSuccessMessage
```
public final void sendSuccessMessage(int statusCode,
                                     Header[] headers,
                                     byte[] responseBytes)
```
    从接口复制的说明: ResponseHandlerInterface
    
    Notifies callback, that request was handled successfully
    
    指定者:
    
    sendSuccessMessage 在接口中 ResponseHandlerInterface
    
    参数:
    
    statusCode - HTTP status code
    
    headers - returned headers
    
    responseBytes - returned data
  - sendFailureMessage
```
public final void sendFailureMessage(int statusCode,
                                     Header[] headers,
                                     byte[] responseBody,
                                     java.lang.Throwable throwable)
```
    从接口复制的说明: ResponseHandlerInterface
    
    Returns if request was completed with error code or failure of implementation
    
    指定者:
    
    sendFailureMessage 在接口中 ResponseHandlerInterface
    
    参数:
    
    statusCode - returned HTTP status code
    
    headers - returned headers
    
    responseBody - returned data
    
    throwable - cause of request failure
  - sendStartMessage
```
public final void sendStartMessage()
```
    从接口复制的说明: ResponseHandlerInterface
    
    Notifies callback, that request started execution
    
    指定者:
    
    sendStartMessage 在接口中 ResponseHandlerInterface
  - sendFinishMessage
```
public final void sendFinishMessage()
```
    从接口复制的说明: ResponseHandlerInterface
    
    Notifies callback, that request was completed and is being removed from thread pool
    
    指定者:
    
    sendFinishMessage 在接口中 ResponseHandlerInterface
  - sendRetryMessage
```
public final void sendRetryMessage(int retryNo)
```
    从接口复制的说明: ResponseHandlerInterface
    
    Notifies callback of retrying request
    
    指定者:
    
    sendRetryMessage 在接口中 ResponseHandlerInterface
    
    参数:
    
    retryNo - number of retry within one request
  - sendCancelMessage
```
public final void sendCancelMessage()
```
    从接口复制的说明: ResponseHandlerInterface
    
    Notifies callback, that request was cancelled
    
    指定者:
    
    sendCancelMessage 在接口中 ResponseHandlerInterface
  - handleMessage
```
protected void handleMessage(android.os.Message message)
```
  - sendMessage
```
protected void sendMessage(android.os.Message msg)
```
  - postRunnable
```
protected void postRunnable(java.lang.Runnable runnable)
```
    Helper method to send runnable into local handler loop
    
    参数:
    
    runnable - runnable instance, can be null
  - obtainMessage
```
protected android.os.Message obtainMessage(int responseMessageId,
                                           java.lang.Object responseMessageData)
```
    Helper method to create Message instance from handler
    
    参数:
    
    responseMessageId - constant to identify Handler message
    
    responseMessageData - object to be passed to message receiver
    
    返回:
    
    Message instance, should not be null
  - sendResponseMessage
```
public void sendResponseMessage(HttpResponse response)
                         throws java.io.IOException
```
    从接口复制的说明: ResponseHandlerInterface
    
    Returns data whether request completed successfully
    
    指定者:
    
    sendResponseMessage 在接口中 ResponseHandlerInterface
    
    参数:
    
    response - HttpResponse object with data
    
    抛出:
    
    java.io.IOException - if retrieving data from response fails

类 AsyncHttpResponseHandler

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

SUCCESS_MESSAGE

FAILURE_MESSAGE

START_MESSAGE

FINISH_MESSAGE

PROGRESS_MESSAGE

RETRY_MESSAGE

CANCEL_MESSAGE

BUFFER_SIZE

DEFAULT_CHARSET

UTF8_BOM

构造器详细资料

AsyncHttpResponseHandler

AsyncHttpResponseHandler

AsyncHttpResponseHandler

方法详细资料

getRequestURI

getRequestHeaders

setRequestURI

setRequestHeaders

getUseSynchronousMode

setUseSynchronousMode

getUsePoolThread

setUsePoolThread

setCharset

getCharset

onProgress

onStart

onFinish

onPreProcessResponse

onPostProcessResponse

onSuccess

onFailure

onRetry

onCancel

onUserException

sendProgressMessage

sendSuccessMessage

sendFailureMessage

sendStartMessage

sendFinishMessage

sendRetryMessage

sendCancelMessage

handleMessage

sendMessage

postRunnable

obtainMessage

sendResponseMessage