Android™
Android™
Read the REST Response Body in Chunks
See more REST Examples
Demonstrates Rest.ReadRespChunkBd, which reads the response body one chunk at a time, appending each chunk to a BinData. A return value of 0 signals the body is complete, while -1 indicates a read failure.
Background. Chunked reading lets an application process a large response incrementally rather than buffering the entire body at once. It is used after ReadResponseHeader within the staged request model.
Chilkat Android™ Downloads
// 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);
boolean success = false;
CkRest rest = new CkRest();
boolean bTls = true;
boolean bAutoReconnect = true;
success = rest.Connect("example.com",443,bTls,bAutoReconnect);
if (success == false) {
Log.i(TAG, rest.lastErrorText());
return;
}
success = rest.SendReqNoBody("GET","/api/largefile");
if (success == false) {
Log.i(TAG, rest.lastErrorText());
return;
}
int statusCode = rest.ReadResponseHeader();
if (statusCode < 0) {
Log.i(TAG, rest.lastErrorText());
return;
}
// Check for the expected success status code. If the response is not 200, the body is likely
// error text formatted as JSON, XML, or HTML rather than the expected content. In that case read
// the body as text, report it, and return.
if (statusCode != 200) {
CkStringBuilder sbError = new CkStringBuilder();
success = rest.ReadRespSb(sbError);
if (success == false) {
Log.i(TAG, rest.lastErrorText());
return;
}
Log.i(TAG, "Request failed with status code " + String.valueOf(statusCode));
Log.i(TAG, sbError.getAsString());
return;
}
// The status code is 200. Read the response body in chunks, appending each chunk to the BinData.
// Each call waits until at least the requested number of bytes is available, unless the response
// ends first. A return value of 0 means the final bytes were returned and the body is complete;
// -1 indicates a read failure.
CkBinData bdBody = new CkBinData();
int chunkResult = rest.ReadRespChunkBd(8192,bdBody);
while (chunkResult > 0) {
chunkResult = rest.ReadRespChunkBd(8192,bdBody);
}
if (chunkResult < 0) {
Log.i(TAG, rest.lastErrorText());
return;
}
Log.i(TAG, "Received " + String.valueOf(bdBody.get_NumBytes()) + " bytes.");
}
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."
}
}