ResponseHandlerInterface (library 0.0.99 API)

所有已知实现类:

AsyncHttpResponseHandler, BaseJsonHttpResponseHandler, BinaryHttpResponseHandler, DataAsyncHttpResponseHandler, FileAsyncHttpResponseHandler, JsonHttpResponseHandler, RangeFileAsyncHttpResponseHandler, SaxAsyncHttpResponseHandler, TextHttpResponseHandler
```
public interface ResponseHandlerInterface
```
Interface to standardize implementations

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`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
`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`	`sendCancelMessage()` Notifies callback, that request was cancelled
`void`	`sendFailureMessage(int statusCode, Header[] headers, byte[] responseBody, java.lang.Throwable error)` 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
`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[] responseBody)` Notifies callback, that request was handled successfully
`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 usePoolThread)` Sets whether the handler should be executed on the pool's thread or the UI thread
`void`	`setUseSynchronousMode(boolean useSynchronousMode)` Can set, whether the handler should be asynchronous or synchronous

- 方法详细资料
  - sendResponseMessage
```
void sendResponseMessage(HttpResponse response)
                  throws java.io.IOException
```
    Returns data whether request completed successfully
    
    参数:
    
    response - HttpResponse object with data
    
    抛出:
    
    java.io.IOException - if retrieving data from response fails
  - sendStartMessage
```
void sendStartMessage()
```
    Notifies callback, that request started execution
  - sendFinishMessage
```
void sendFinishMessage()
```
    Notifies callback, that request was completed and is being removed from thread pool
  - sendProgressMessage
```
void sendProgressMessage(int bytesWritten,
                         int bytesTotal)
```
    Notifies callback, that request (mainly uploading) has progressed
    
    参数:
    
    bytesWritten - number of written bytes
    
    bytesTotal - number of total bytes to be written
  - sendCancelMessage
```
void sendCancelMessage()
```
    Notifies callback, that request was cancelled
  - sendSuccessMessage
```
void sendSuccessMessage(int statusCode,
                        Header[] headers,
                        byte[] responseBody)
```
    Notifies callback, that request was handled successfully
    
    参数:
    
    statusCode - HTTP status code
    
    headers - returned headers
    
    responseBody - returned data
  - sendFailureMessage
```
void sendFailureMessage(int statusCode,
                        Header[] headers,
                        byte[] responseBody,
                        java.lang.Throwable error)
```
    Returns if request was completed with error code or failure of implementation
    
    参数:
    
    statusCode - returned HTTP status code
    
    headers - returned headers
    
    responseBody - returned data
    
    error - cause of request failure
  - sendRetryMessage
```
void sendRetryMessage(int retryNo)
```
    Notifies callback of retrying request
    
    参数:
    
    retryNo - number of retry within one request
  - getRequestURI
```
java.net.URI getRequestURI()
```
    Returns URI which was used to request
    
    返回:
    
    uri of origin request
  - getRequestHeaders
```
Header[] getRequestHeaders()
```
    Returns Header[] which were used to request
    
    返回:
    
    headers from origin request
  - setRequestURI
```
void setRequestURI(java.net.URI requestURI)
```
    Helper for handlers to receive Request URI info
    
    参数:
    
    requestURI - claimed request URI
  - setRequestHeaders
```
void setRequestHeaders(Header[] requestHeaders)
```
    Helper for handlers to receive Request Header[] info
    
    参数:
    
    requestHeaders - Headers, claimed to be from original request
  - setUseSynchronousMode
```
void setUseSynchronousMode(boolean useSynchronousMode)
```
    Can set, whether the handler should be asynchronous or synchronous
    
    参数:
    
    useSynchronousMode - whether data should be handled on background Thread on UI Thread
  - getUseSynchronousMode
```
boolean getUseSynchronousMode()
```
    Returns whether the handler is asynchronous or synchronous
    
    返回:
    
    boolean if the ResponseHandler is running in synchronous mode
  - setUsePoolThread
```
void setUsePoolThread(boolean usePoolThread)
```
    Sets whether the handler should be executed on the pool's thread or the UI thread
    
    参数:
    
    usePoolThread - if the ResponseHandler should run on pool's thread
  - getUsePoolThread
```
boolean getUsePoolThread()
```
    Returns whether the handler should be executed on the pool's thread or the UI thread
    
    返回:
    
    boolean if the ResponseHandler should run on pool's thread
  - onPreProcessResponse
```
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. 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.
    
    参数:
    
    instance - An instance of this response object
    
    response - The response to pre-processed
  - onPostProcessResponse
```
void onPostProcessResponse(ResponseHandlerInterface instance,
                           HttpResponse response)
```
    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.
    
    参数:
    
    instance - An instance of this response object
    
    response - The response to post-process

接口 ResponseHandlerInterface

方法概要

方法详细资料

sendResponseMessage

sendStartMessage

sendFinishMessage

sendProgressMessage

sendCancelMessage

sendSuccessMessage

sendFailureMessage

sendRetryMessage

getRequestURI

getRequestHeaders

setRequestURI

setRequestHeaders

setUseSynchronousMode

getUseSynchronousMode

setUsePoolThread

getUsePoolThread

onPreProcessResponse

onPostProcessResponse