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.

#include <C_CkRest.h>
#include <C_CkStringBuilder.h>
#include <C_CkBinData.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkRest rest;
    BOOL bTls;
    BOOL bAutoReconnect;
    int statusCode;
    HCkStringBuilder sbError;
    HCkBinData bdBody;
    int chunkResult;

    success = FALSE;

    rest = CkRest_Create();
    bTls = TRUE;
    bAutoReconnect = TRUE;
    success = CkRest_Connect(rest,"example.com",443,bTls,bAutoReconnect);
    if (success == FALSE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        return;
    }

    success = CkRest_SendReqNoBody(rest,"GET","/api/largefile");
    if (success == FALSE) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        return;
    }

    statusCode = CkRest_ReadResponseHeader(rest);
    if (statusCode < 0) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        return;
    }

    //  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 = CkStringBuilder_Create();
        success = CkRest_ReadRespSb(rest,sbError);
        if (success == FALSE) {
            printf("%s\n",CkRest_lastErrorText(rest));
            CkRest_Dispose(rest);
            CkStringBuilder_Dispose(sbError);
            return;
        }

        printf("Request failed with status code %d\n",statusCode);
        printf("%s\n",CkStringBuilder_getAsString(sbError));
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbError);
        return;
    }

    //  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 = CkBinData_Create();
    chunkResult = CkRest_ReadRespChunkBd(rest,8192,bdBody);
    while (chunkResult > 0) {
        chunkResult = CkRest_ReadRespChunkBd(rest,8192,bdBody);
    }

    if (chunkResult < 0) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        CkStringBuilder_Dispose(sbError);
        CkBinData_Dispose(bdBody);
        return;
    }

    printf("Received %d bytes.\n",CkBinData_getNumBytes(bdBody));


    CkRest_Dispose(rest);
    CkStringBuilder_Dispose(sbError);
    CkBinData_Dispose(bdBody);

    }