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 strict;
use warnings;
use Chilkat2;

my $rest = Chilkat2::Rest->new;
my $bTls = 1;
my $bAutoReconnect = 1;
my $success = $rest->Connect('example.com', 443, $bTls, $bAutoReconnect);
if (!$success) {
    print $rest->LastErrorText, "\n";
    exit;
}

$success = $rest->SendReqNoBody('GET', '/api/largefile');
if (!$success) {
    print $rest->LastErrorText, "\n";
    exit;
}

my $statusCode = $rest->ReadResponseHeader();
if ($statusCode < 0) {
    print $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) {
    my $sbError = Chilkat2::StringBuilder->new;
    $success = $rest->ReadRespSb($sbError);
    if (!$success) {
        print $rest->LastErrorText, "\n";
        exit;
    }

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

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

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