How to Set HTTP Response Timeouts in Android Using Java?

Setting HTTP Response Timeout in Android Using Java

The ability to check the connection status of a remote server is critical in many Android applications. However, extended connection timeouts can lead to significant delays. This article explores how to set the timeout of an HTTP response to prevent unnecessary waiting.

Consider the following code snippet for checking connection status:

private void checkConnectionStatus() {
    HttpClient httpClient = new DefaultHttpClient();

    try {
        String url = "http://xxx.xxx.xxx.xxx:8000/GaitLink/"
                     + strSessionString + "/ConnectionStatus";
        Log.d("phobos", "performing get " + url);
        HttpGet method = new HttpGet(new URI(url));
        HttpResponse response = httpClient.execute(method);

        if (response != null) {
            String result = getResponse(response.getEntity());
            ...
        }
    }
}

When the server is down for testing, the execution gets stuck at the line:

HttpResponse response = httpClient.execute(method);

To address this issue, timeouts can be set to limit the waiting period. In the example below, two timeouts are established:

1. Connection Timeout: Specifies the maximum time allowed for establishing a connection with the remote server. By default, this value is 0 (no timeout).
2. Socket Timeout: Defines the maximum time allowed for receiving data from the remote server. The default value is also 0.

HttpGet httpGet = new HttpGet(url);
HttpParams httpParameters = new BasicHttpParams();
// Set the connection timeout in milliseconds until a connection is established.
int timeoutConnection = 3000;
HttpConnectionParams.setConnectionTimeout(httpParameters, timeoutConnection);
// Set the default socket timeout (SO_TIMEOUT) 
// in milliseconds which is the timeout for waiting for data.
int timeoutSocket = 5000;
HttpConnectionParams.setSoTimeout(httpParameters, timeoutSocket);

DefaultHttpClient httpClient = new DefaultHttpClient(httpParameters);
HttpResponse response = httpClient.execute(httpGet);

When this code is executed, a connection exception will be thrown after 3 seconds if the connection cannot be established, and a socket exception will be raised after 5 seconds if no data is received from the server.

Alternatively, if you have an existing HTTPClient instance (e.g., DefaultHttpClient or AndroidHttpClient), you can use the setParams() function to set its timeout parameters:

httpClient.setParams(httpParameters);

The above is the detailed content of How to Set HTTP Response Timeouts in Android Using Java?. For more information, please follow other related articles on the PHP Chinese website!