(Android™) Cancel HTTP Get Async Task if not Completed after a Max Time

Demonstrates how to wait a maximum amount of time for an asynchronous task to completed. If not completed in the allotted amount of time, the task is cancelled.

Chilkat Android™ Downloads Android™ Java Libraries Android C/C++ Libraries

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    boolean success;
    CkHttp http = new CkHttp();

    // Set some timeouts, in seconds:
    http.put_ConnectTimeout(15);
    // ReadTimeout specifies the max number of seconds that must elapse when no additional data is received before
    // timing out.  For example, if a server sends a 300 byte response at the rate of 1 byte per second, then
    // ReadTimeout would never cause a timeout because there is never a 15 second interval when nothing arrives.
    http.put_ReadTimeout(15);

    String url = "https://your-url.com/something";
    CkTask task = http.QuickGetStrAsync(url);
    task.Run();

    // Wait a maximum of waitMaxMs for the task (i.e. the HTTP GET) to complete.
    // The Wait method returns when the task has been canceled, aborted, or completed, or when the max allotted time has passed.
    int waitMaxMs = 20000;
    task.Wait(waitMaxMs);

    // At this point, the GET may or may not have completed.  
    // Rather than checking the Task status, we can call task.Cancel because
    // if the Task is no longer running (because it already completed, was canceled or aborted), then the 
    // call to Cancel is a NO-OP (meaning it does nothing and the Task's status is unaffected).
    // Also, task.Cancel returns true if the task was in the "queued" or "running" state and was canceled or aborted. 
    // The method returns false if the task has any other status.
    boolean wasCanceled = task.Cancel();
    if (wasCanceled == true) {
        Log.i(TAG, "The HTTP GET took too long and was canceled.");
        }
    else {
        // Find out what happened.
        if (task.get_StatusInt() == 7) {
            // The task completed, which means the background thread's call to QuickGetStr completed
            // with success or failure.  Find out which...
            if (task.get_TaskSuccess() == true) {
                // Get the string response for the call to QuickGetStr (which happened in Chilkat's background thread).
                String responseStr = task.getResultString();
                Log.i(TAG, responseStr);
                Log.i(TAG, "HTTP GET successful!");
                }
            else {
                Log.i(TAG, "HTTP GET failed prior to waitMaxMs...");
                Log.i(TAG, task.resultErrorText());
                }

            }
        else {
            // The task must've been canceled or aborted by some other means..
            Log.i(TAG, "Task did not complete.  Final status: " + task.status());
            }

        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}