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 chilkat

success = False

rest = chilkat.CkRest()
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 = chilkat.CkStringBuilder()
    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 = chilkat.CkBinData()
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.get_NumBytes()) + " bytes.")