(Android™) REST Receive Response in Chunks

See more REST Examples

Demonstrates how to receive a REST HTTP response in chunks.

Note: This example requires Chilkat 10.1.0 or greater.

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.

    CkRest rest = new CkRest();

    // Connect to the web server
    boolean bTls = true;
    int port = 443;
    boolean bAutoReconnect = true;
    boolean success = rest.Connect("chilkatsoft.com",port,bTls,bAutoReconnect);
    if (success == false) {
        Log.i(TAG, rest.lastErrorText());
        return;
        }

    // Send the request.
    // This can be *any* kind of request: POST, GET, PUT, etc. using *any* of the Chilkat REST methods that send requests.
    // For this example, we'll just GET a simple XML document that is about 274K in size.

    success = rest.SendReqNoBody("GET","/hamlet.xml");
    if (success == false) {
        Log.i(TAG, rest.lastErrorText());
        return;
        }

    // Get the response header.
    int statusCode = rest.ReadResponseHeader();
    if (statusCode < 0) {
        Log.i(TAG, rest.lastErrorText());
        return;
        }

    Log.i(TAG, "response status code = " + String.valueOf(statusCode));

    String outputFile = "c:/temp/qa_output/hamlet.xml";

    CkFileAccess fac = new CkFileAccess();
    success = fac.OpenForWrite(outputFile);
    if (statusCode < 0) {
        Log.i(TAG, fac.lastErrorText());
        return;
        }

    // Get the response in chunks.
    // (Note: There are more efficient ways to simply download a file from a web server, such as by calling Chilkat's Http.Download method.
    // The purpose of this method is to show how to receive a response chunk-by-chunk.)
    CkBinData bd = new CkBinData();
    int status = 1;
    while (status == 1) {
        // Read a minimum of 16000 bytes.
        // Note: Because of TLS message lengths, or the possibility of the response being either compressed (gzip/deflate) or in the HTTP chunked encoding,
        // the amount of data received in each call can be greater than the specified min size.
        // Chilkat will return from the call as soon as it has received an amount equal to or more than the specified size,
        // except for the very last chunk, which can be less that the min size or even 0 bytes.

        // The status will be one of three values:
        // -1 = error
        // 0 = received the last chunk of the response.
        // 1 = received a chunk, and more chunks are coming..

        // The received data is *appended* to the contents of the BinData object.
        status = rest.ReadRespChunkBd(16000,bd);
        if (status >= 0) {
            Log.i(TAG, "Received chunk: " + String.valueOf(bd.get_NumBytes()) + " bytes");
            fac.FileWriteBd(bd,0,0);
            bd.Clear();
            }

        }

    fac.FileClose();

    Log.i(TAG, "Success.");

  }

  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."
  }
}