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.

<?php

use Chilkat2\BinData;
use Chilkat2\Rest;
use Chilkat2\StringBuilder;

$rest = new Rest();
$bTls = true;
$bAutoReconnect = true;
try {
    $rest->Connect('example.com', 443, $bTls, $bAutoReconnect);

    $rest->SendReqNoBody('GET', '/api/largefile');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

$statusCode = $rest->ReadResponseHeader();
if ($statusCode < 0) {
    echo $rest->LastErrorText, "\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 = new StringBuilder();
    try {
        $rest->ReadRespSb($sbError);
    } catch (\Chilkat2\Exception $e) {
        echo $e->getMessage(), "\n";
        exit;
    }

    echo 'Request failed with status code ', $statusCode, "\n";
    echo $sbError->GetAsString(), "\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 = new BinData();
$chunkResult = $rest->ReadRespChunkBd(8192, $bdBody);
while ($chunkResult > 0) {
    $chunkResult = $rest->ReadRespChunkBd(8192, $bdBody);
}

if ($chunkResult < 0) {
    echo $rest->LastErrorText, "\n";
    exit;
}

echo 'Received ', $bdBody->NumBytes, " bytes.\n";