C#
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 C# Downloads
bool success = false;
Chilkat.Rest rest = new Chilkat.Rest();
bool bTls = true;
bool bAutoReconnect = true;
success = rest.Connect("example.com",443,bTls,bAutoReconnect);
if (success == false) {
Debug.WriteLine(rest.LastErrorText);
return;
}
success = rest.SendReqNoBody("GET","/api/largefile");
if (success == false) {
Debug.WriteLine(rest.LastErrorText);
return;
}
int statusCode = rest.ReadResponseHeader();
if (statusCode < 0) {
Debug.WriteLine(rest.LastErrorText);
return;
}
// 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.
Chilkat.BinData bdBody = new Chilkat.BinData();
int chunkResult = rest.ReadRespChunkBd(8192,bdBody);
while (chunkResult > 0) {
chunkResult = rest.ReadRespChunkBd(8192,bdBody);
}
if (chunkResult < 0) {
Debug.WriteLine(rest.LastErrorText);
return;
}
Debug.WriteLine("Received " + Convert.ToString(bdBody.NumBytes) + " bytes.");