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.

use chilkat();

$success = 0;

$rest = chilkat::CkRest->new();
$bTls = 1;
$bAutoReconnect = 1;
$success = $rest->Connect("example.com",443,$bTls,$bAutoReconnect);
if ($success == 0) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$success = $rest->SendReqNoBody("GET","/api/largefile");
if ($success == 0) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$statusCode = $rest->ReadResponseHeader();
if ($statusCode < 0) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

#  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) {
    $sbError = chilkat::CkStringBuilder->new();
    $success = $rest->ReadRespSb($sbError);
    if ($success == 0) {
        print $rest->lastErrorText() . "\r\n";
        exit;
    }

    print "Request failed with status code " . $statusCode . "\r\n";
    print $sbError->getAsString() . "\r\n";
    exit;
}

#  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.
$bdBody = chilkat::CkBinData->new();
$chunkResult = $rest->ReadRespChunkBd(8192,$bdBody);
while ($chunkResult > 0) {
    $chunkResult = $rest->ReadRespChunkBd(8192,$bdBody);
}

if ($chunkResult < 0) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

print "Received " . $bdBody->get_NumBytes() . " bytes." . "\r\n";