AsyncHttpClient (library API)

java.lang.Object
- net.callumtaylor.asynchttp.AsyncHttpClient

```
public class AsyncHttpClient
extends Object
```
The client class used for initiating HTTP requests using an AsyncTask. It follows a RESTful paradigm for the connections with the 7 possible methods, GET, POST, PUT, DELETE, OPTIONS, PATCH, HEAD. Note: Because AsyncHttpClient uses AsyncTask, only one instance can be created at a time. If one client makes 2 requests, the first request is canceled for the new request. You can either wait for the first to finish before making the second, or you can create two separate instances. Depends on
- ResponseHandler
- RequestBody
- NameValuePair
- ConnectionInfo
- Packet
- RequestMode
- RequestUtil
The library uses OKHttp for its HTTP request client so follows the same patterns for request bodies and headers.
Example GET
```
        new AsyncHttpClient("http://httpbin.org/")
                .get("get", new JsonResponseHandler()
                {
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class AsyncHttpClient.AsyncClientExecutorTask
Delegate wrapper class for ClientExecutorTask inside an AsyncTask

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`AsyncHttpClient.AsyncClientExecutorTask` Delegate wrapper class for ClientExecutorTask inside an AsyncTask

Field Summary

Fields
Modifier and Type Field and Description

static okhttp3.Cache cache
Instance for where to store cached requests.

static String userAgent
User agent to send with every request.

Fields
Modifier and Type	Field and Description
`static okhttp3.Cache`	`cache` Instance for where to store cached requests.
`static String`	`userAgent` User agent to send with every request.

Constructor Summary

Constructors
Constructor and Description
`AsyncHttpClient(String baseUrl)` Creates a new client using a base Url without a timeout
`AsyncHttpClient(String baseUrl, long timeout)` Creates a new client using a base Url with a timeout in MS
`AsyncHttpClient(Uri baseUri)` Creates a new client using a base Uri without a timeout
`AsyncHttpClient(Uri baseUri, long timeout)` Creates a new client using a base Uri with a timeout in MS

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel()` Cancels a request if it's running
`void`	`delete(okhttp3.Headers headers, ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`delete(List<NameValuePair> params, okhttp3.Headers headers, ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`delete(List<NameValuePair> params, okhttp3.RequestBody postData, ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`delete(List<NameValuePair> params, ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`delete(okhttp3.RequestBody postData, okhttp3.Headers headers, ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`delete(okhttp3.RequestBody postData, ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`delete(ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`delete(String path, okhttp3.Headers headers, ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`delete(String path, List<NameValuePair> params, okhttp3.Headers headers, ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`delete(String path, List<NameValuePair> params, okhttp3.RequestBody postData, okhttp3.Headers headers, ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`delete(String path, List<NameValuePair> params, okhttp3.RequestBody postData, ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`delete(String path, List<NameValuePair> params, ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`delete(String path, okhttp3.RequestBody postData, okhttp3.Headers headers, ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`delete(String path, okhttp3.RequestBody postData, ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`delete(String path, ResponseHandler response)` Performs a DELETE request on the baseUri
`void`	`get(okhttp3.Headers headers, ResponseHandler response)` Performs a GET request on the baseUri
`void`	`get(List<NameValuePair> params, okhttp3.Headers headers, ResponseHandler response)` Performs a GET request on the baseUri
`void`	`get(ResponseHandler response)` Performs a GET request on the baseUri
`void`	`get(String path, okhttp3.Headers headers, ResponseHandler response)` Performs a GET request on the baseUri
`void`	`get(String path, List<NameValuePair> params, okhttp3.Headers headers, ResponseHandler response)` Performs a GET request on the baseUri
`void`	`get(String path, List<NameValuePair> params, ResponseHandler response)` Performs a GET request on the baseUri
`void`	`get(String path, ResponseHandler response)` Performs a GET request on the baseUri
`void`	`head(okhttp3.Headers headers, ResponseHandler response)` Performs a HEAD request on the baseUri
`void`	`head(List<NameValuePair> params, okhttp3.Headers headers, ResponseHandler response)` Performs a HEAD request on the baseUri
`void`	`head(List<NameValuePair> params, ResponseHandler response)` Performs a HEAD request on the baseUri
`void`	`head(ResponseHandler response)` Performs a HEAD request on the baseUri
`void`	`head(String path, okhttp3.Headers headers, ResponseHandler response)` Performs a HEAD request on the baseUri
`void`	`head(String path, List<NameValuePair> params, okhttp3.Headers headers, ResponseHandler response)` Performs a HEAD request on the baseUri
`void`	`head(String path, List<NameValuePair> params, ResponseHandler response)` Performs a HEAD request on the baseUri
`void`	`head(String path, ResponseHandler response)` Performs a HEAD request on the baseUri
`void`	`options(okhttp3.Headers headers, ResponseHandler response)` Performs a OPTIONS request on the baseUri
`void`	`options(List<NameValuePair> params, okhttp3.Headers headers, ResponseHandler response)` Performs a OPTIONS request on the baseUri
`void`	`options(List<NameValuePair> params, ResponseHandler response)` Performs a OPTIONS request on the baseUri
`void`	`options(ResponseHandler response)` Performs a OPTIONS request on the baseUri
`void`	`options(String path, okhttp3.Headers headers, ResponseHandler response)` Performs a OPTIONS request on the baseUri
`void`	`options(String path, List<NameValuePair> params, okhttp3.Headers headers, ResponseHandler response)` Performs a OPTIONS request on the baseUri
`void`	`options(String path, List<NameValuePair> params, ResponseHandler response)` Performs a OPTIONS request on the baseUri
`void`	`options(String path, ResponseHandler response)` Performs a OPTIONS request on the baseUri
`void`	`patch(okhttp3.Headers headers, ResponseHandler response)` Performs a PATCH request on the baseUri
`void`	`patch(List<NameValuePair> params, okhttp3.Headers headers, ResponseHandler response)` Performs a PATCH request on the baseUri
`void`	`patch(List<NameValuePair> params, okhttp3.RequestBody postData, ResponseHandler response)` Performs a PATCH request on the baseUri
`void`	`patch(List<NameValuePair> params, ResponseHandler response)` Performs a PATCH request on the baseUri
`void`	`patch(okhttp3.RequestBody postData, okhttp3.Headers headers, ResponseHandler response)` Performs a PATCH request on the baseUri
`void`	`patch(okhttp3.RequestBody postData, ResponseHandler response)` Performs a PATCH request on the baseUri
`void`	`patch(ResponseHandler response)` Performs a PATCH request on the baseUr
`void`	`patch(String path, okhttp3.Headers headers, ResponseHandler response)` Performs a PATCH request on the baseUri
`void`	`patch(String path, List<NameValuePair> params, okhttp3.Headers headers, ResponseHandler response)` Performs a PATCH request on the baseUri
`void`	`patch(String path, List<NameValuePair> params, okhttp3.RequestBody postData, okhttp3.Headers headers, ResponseHandler response)` Performs a PATCH request on the baseUri
`void`	`patch(String path, List<NameValuePair> params, okhttp3.RequestBody postData, ResponseHandler response)` Performs a PATCH request on the baseUri
`void`	`patch(String path, List<NameValuePair> params, ResponseHandler response)` Performs a PATCH request on the baseUri
`void`	`patch(String path, okhttp3.RequestBody postData, okhttp3.Headers headers, ResponseHandler response)` Performs a PATCH request on the baseUri
`void`	`patch(String path, okhttp3.RequestBody postData, ResponseHandler response)` Performs a PATCH request on the baseUri
`void`	`patch(String path, ResponseHandler response)` Performs a PATCH request on the baseUr
`void`	`post(okhttp3.Headers headers, ResponseHandler response)` Performs a POST request on the baseUri
`void`	`post(List<NameValuePair> params, okhttp3.Headers headers, ResponseHandler response)` Performs a POST request on the baseUri
`void`	`post(List<NameValuePair> params, okhttp3.RequestBody postData, ResponseHandler response)` Performs a POST request on the baseUri
`void`	`post(List<NameValuePair> params, ResponseHandler response)` Performs a POST request on the baseUri
`void`	`post(okhttp3.RequestBody postData, okhttp3.Headers headers, ResponseHandler response)` Performs a POST request on the baseUri
`void`	`post(okhttp3.RequestBody postData, ResponseHandler response)` Performs a POST request on the baseUri
`void`	`post(ResponseHandler response)` Performs a POST request on the baseUri
`void`	`post(String path, okhttp3.Headers headers, ResponseHandler response)` Performs a POST request on the baseUri
`void`	`post(String path, List<NameValuePair> params, okhttp3.Headers headers, ResponseHandler response)` Performs a POST request on the baseUri
`void`	`post(String path, List<NameValuePair> params, okhttp3.RequestBody postData, okhttp3.Headers headers, ResponseHandler response)` Performs a POST request on the baseUri
`void`	`post(String path, List<NameValuePair> params, okhttp3.RequestBody postData, ResponseHandler response)` Performs a POST request on the baseUri
`void`	`post(String path, List<NameValuePair> params, ResponseHandler response)` Performs a POST request on the baseUri
`void`	`post(String path, okhttp3.RequestBody postData, okhttp3.Headers headers, ResponseHandler response)` Performs a POST request on the baseUri
`void`	`post(String path, okhttp3.RequestBody postData, ResponseHandler response)` Performs a POST request on the baseUri
`void`	`post(String path, ResponseHandler response)` Performs a POST request on the baseUr
`void`	`put(okhttp3.Headers headers, ResponseHandler response)` Performs a PUT request on the baseUri
`void`	`put(List<NameValuePair> params, okhttp3.Headers headers, ResponseHandler response)` Performs a PUT request on the baseUri
`void`	`put(List<NameValuePair> params, okhttp3.RequestBody postData, ResponseHandler response)` Performs a PUT request on the baseUri
`void`	`put(List<NameValuePair> params, ResponseHandler response)` Performs a PUT request on the baseUri
`void`	`put(okhttp3.RequestBody postData, okhttp3.Headers headers, ResponseHandler response)` Performs a PUT request on the baseUri
`void`	`put(okhttp3.RequestBody postData, ResponseHandler response)` Performs a PUT request on the baseUri
`void`	`put(ResponseHandler response)` Performs a PUT request on the baseUr
`void`	`put(String path, okhttp3.Headers headers, ResponseHandler response)` Performs a PUT request on the baseUri
`void`	`put(String path, List<NameValuePair> params, okhttp3.Headers headers, ResponseHandler response)` Performs a PUT request on the baseUri
`void`	`put(String path, List<NameValuePair> params, okhttp3.RequestBody postData, okhttp3.Headers headers, ResponseHandler response)` Performs a PUT request on the baseUri
`void`	`put(String path, List<NameValuePair> params, okhttp3.RequestBody postData, ResponseHandler response)` Performs a PUT request on the baseUri
`void`	`put(String path, List<NameValuePair> params, ResponseHandler response)` Performs a PUT request on the baseUri
`void`	`put(String path, okhttp3.RequestBody postData, okhttp3.Headers headers, ResponseHandler response)` Performs a PUT request on the baseUri
`void`	`put(String path, okhttp3.RequestBody postData, ResponseHandler response)` Performs a PUT request on the baseUri
`void`	`put(String path, ResponseHandler response)` Performs a PUT request on the baseUr
`void`	`setAllowAllSsl(boolean allow)` Sets to allow all SSL.
`void`	`setAllowRedirect(boolean allow)` Sets to auto redirect on 302 responses

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- userAgent
```
public static String userAgent
```
  User agent to send with every request. Defaults to RequestUtil.getDefaultUserAgent()
- cache
```
public static okhttp3.Cache cache
```
  Instance for where to store cached requests. Defaults to null (off). You should set this to Context.getCacheDir() if you want auto cache-control handling

Constructor Detail
- AsyncHttpClient
```
public AsyncHttpClient(String baseUrl)
```
  Creates a new client using a base Url without a timeout
  
  Parameters:
  
  baseUrl - The base connection url
- AsyncHttpClient
```
public AsyncHttpClient(Uri baseUri)
```
  Creates a new client using a base Uri without a timeout
  
  Parameters:
  
  baseUri - The base connection uri
- AsyncHttpClient
```
public AsyncHttpClient(String baseUrl,
                       long timeout)
```
  Creates a new client using a base Url with a timeout in MS
  
  Parameters:
  
  baseUrl - The base connection url
  
  timeout - The timeout in MS
- AsyncHttpClient
```
public AsyncHttpClient(Uri baseUri,
                       long timeout)
```
  Creates a new client using a base Uri with a timeout in MS
  
  Parameters:
  
  baseUri - The base connection uri
  
  timeout - The timeout in MS

Method Detail

cancel
```
public void cancel()
```
Cancels a request if it's running

get
```
public void get(@Nullable
                ResponseHandler response)
```
Performs a GET request on the baseUri

Parameters:

response - The response handler for the request

get

public void get(String path,
                @Nullable
                ResponseHandler response)

Performs a GET request on the baseUri

Parameters:: path - The path extended from the baseUri; response - The response handler for the request

get

public void get(@Nullable
                okhttp3.Headers headers,
                @Nullable
                ResponseHandler response)

Performs a GET request on the baseUri

Parameters:: headers - The request headers for the connection; response - The response handler for the request

get

public void get(@Nullable
                List<NameValuePair> params,
                @Nullable
                okhttp3.Headers headers,
                @Nullable
                ResponseHandler response)

Performs a GET request on the baseUri

Parameters:: params - The Query params to append to the baseUri; headers - The request headers for the connection; response - The response handler for the request

get

public void get(String path,
                @Nullable
                List<NameValuePair> params,
                @Nullable
                ResponseHandler response)

Performs a GET request on the baseUri

Parameters:: path - The path extended from the baseUri; response - The response handler for the request

get

public void get(String path,
                @Nullable
                okhttp3.Headers headers,
                @Nullable
                ResponseHandler response)

Performs a GET request on the baseUri

Parameters:: path - The path extended from the baseUri; headers - The request headers for the connection; response - The response handler for the request

get

public void get(String path,
                @Nullable
                List<NameValuePair> params,
                @Nullable
                okhttp3.Headers headers,
                @Nullable
                ResponseHandler response)

Performs a GET request on the baseUri

Parameters:: path - The path extended from the baseUri; params - The Query params to append to the baseUri; headers - The request headers for the connection; response - The response handler for the request

options
```
public void options(@Nullable
                    ResponseHandler response)
```
Performs a OPTIONS request on the baseUri

Parameters:

response - The response handler for the request

options

public void options(String path,
                    @Nullable
                    ResponseHandler response)

Performs a OPTIONS request on the baseUri

Parameters:: path - The path extended from the baseUri; response - The response handler for the request

options

public void options(@Nullable
                    okhttp3.Headers headers,
                    @Nullable
                    ResponseHandler response)

Performs a OPTIONS request on the baseUri

Parameters:: headers - The request headers for the connection; response - The response handler for the request

options

public void options(@Nullable
                    List<NameValuePair> params,
                    @Nullable
                    ResponseHandler response)

Performs a OPTIONS request on the baseUri

Parameters:: params - The Query params to append to the baseUri; response - The response handler for the request

options

public void options(@Nullable
                    List<NameValuePair> params,
                    @Nullable
                    okhttp3.Headers headers,
                    @Nullable
                    ResponseHandler response)

Performs a OPTIONS request on the baseUri

Parameters:: params - The Query params to append to the baseUri; headers - The request headers for the connection; response - The response handler for the request

options

public void options(String path,
                    @Nullable
                    List<NameValuePair> params,
                    @Nullable
                    ResponseHandler response)

Performs a OPTIONS request on the baseUri

Parameters:: path - The path extended from the baseUri; response - The response handler for the request

options

public void options(String path,
                    @Nullable
                    okhttp3.Headers headers,
                    @Nullable
                    ResponseHandler response)

Performs a OPTIONS request on the baseUri

Parameters:: path - The path extended from the baseUri; headers - The request headers for the connection; response - The response handler for the request

options

public void options(String path,
                    @Nullable
                    List<NameValuePair> params,
                    @Nullable
                    okhttp3.Headers headers,
                    @Nullable
                    ResponseHandler response)

Performs a OPTIONS request on the baseUri

Parameters:: path - The path extended from the baseUri; params - The Query params to append to the baseUri; headers - The request headers for the connection; response - The response handler for the request

head
```
public void head(@Nullable
                 ResponseHandler response)
```
Performs a HEAD request on the baseUri

Parameters:

response - The response handler for the request

head

public void head(String path,
                 @Nullable
                 ResponseHandler response)

Performs a HEAD request on the baseUri

Parameters:: path - The path extended from the baseUri; response - The response handler for the request

head

public void head(@Nullable
                 okhttp3.Headers headers,
                 @Nullable
                 ResponseHandler response)

Performs a HEAD request on the baseUri

Parameters:: headers - The request headers for the connection; response - The response handler for the request

head

public void head(@Nullable
                 List<NameValuePair> params,
                 @Nullable
                 ResponseHandler response)

Performs a HEAD request on the baseUri

Parameters:: params - The Query params to append to the baseUri; response - The response handler for the request

head

public void head(@Nullable
                 List<NameValuePair> params,
                 @Nullable
                 okhttp3.Headers headers,
                 @Nullable
                 ResponseHandler response)

Performs a HEAD request on the baseUri

Parameters:: params - The Query params to append to the baseUri; headers - The request headers for the connection; response - The response handler for the request

head

public void head(String path,
                 @Nullable
                 List<NameValuePair> params,
                 @Nullable
                 ResponseHandler response)

Performs a HEAD request on the baseUri

Parameters:: path - The path extended from the baseUri; response - The response handler for the request

head

public void head(String path,
                 @Nullable
                 okhttp3.Headers headers,
                 @Nullable
                 ResponseHandler response)

Performs a HEAD request on the baseUri

Parameters:: path - The path extended from the baseUri; headers - The request headers for the connection; response - The response handler for the request

head

public void head(String path,
                 @Nullable
                 List<NameValuePair> params,
                 @Nullable
                 okhttp3.Headers headers,
                 @Nullable
                 ResponseHandler response)

Performs a HEAD request on the baseUri

Parameters:: path - The path extended from the baseUri; params - The Query params to append to the baseUri; headers - The request headers for the connection; response - The response handler for the request

delete
```
public void delete(@Nullable
                   ResponseHandler response)
```
Performs a DELETE request on the baseUri

Parameters:

response - The response handler for the request