Unicode C++
Unicode C++
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.
Background. Chunked reading lets an application process a large response incrementally rather than buffering the entire body at once. It is used after ReadResponseHeader within the staged request model.
Chilkat Unicode C++ Downloads
#include <CkRestW.h>
#include <CkStringBuilderW.h>
#include <CkBinDataW.h>
void ChilkatSample(void)
{
bool success = false;
CkRestW rest;
bool bTls = true;
bool bAutoReconnect = true;
success = rest.Connect(L"example.com",443,bTls,bAutoReconnect);
if (success == false) {
wprintf(L"%s\n",rest.lastErrorText());
return;
}
success = rest.SendReqNoBody(L"GET",L"/api/largefile");
if (success == false) {
wprintf(L"%s\n",rest.lastErrorText());
return;
}
int statusCode = rest.ReadResponseHeader();
if (statusCode < 0) {
wprintf(L"%s\n",rest.lastErrorText());
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) {
CkStringBuilderW sbError;
success = rest.ReadRespSb(sbError);
if (success == false) {
wprintf(L"%s\n",rest.lastErrorText());
return;
}
wprintf(L"Request failed with status code %d\n",statusCode);
wprintf(L"%s\n",sbError.getAsString());
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.
CkBinDataW bdBody;
int chunkResult = rest.ReadRespChunkBd(8192,bdBody);
while (chunkResult > 0) {
chunkResult = rest.ReadRespChunkBd(8192,bdBody);
}
if (chunkResult < 0) {
wprintf(L"%s\n",rest.lastErrorText());
return;
}
wprintf(L"Received %d bytes.\n",bdBody.get_NumBytes());
}