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.

import sys
import chilkat2

success = False

rest = chilkat2.Rest()
bTls = True
bAutoReconnect = True
success = rest.Connect("example.com",443,bTls,bAutoReconnect)
if (success == False):
    print(rest.LastErrorText)
    sys.exit()

success = rest.SendReqNoBody("GET","/api/largefile")
if (success == False):
    print(rest.LastErrorText)
    sys.exit()

statusCode = rest.ReadResponseHeader()
if (statusCode < 0):
    print(rest.LastErrorText)
    sys.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 = chilkat2.StringBuilder()
    success = rest.ReadRespSb(sbError)
    if (success == False):
        print(rest.LastErrorText)
        sys.exit()

    print("Request failed with status code " + str(statusCode))
    print(sbError.GetAsString())
    sys.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 = chilkat2.BinData()
chunkResult = rest.ReadRespChunkBd(8192,bdBody)
while chunkResult > 0 :
    chunkResult = rest.ReadRespChunkBd(8192,bdBody)

if (chunkResult < 0):
    print(rest.LastErrorText)
    sys.exit()

print("Received " + str(bdBody.NumBytes) + " bytes.")