Chilkat HOME .NET Core C# Android™ AutoIt C C# C++ Chilkat2-Python CkPython Classic ASP DataFlex Delphi ActiveX Delphi DLL Go Java Lianja Mono C# Node.js Objective-C PHP ActiveX PHP Extension Perl PowerBuilder PowerShell PureBasic Ruby SQL Server Swift 2 Swift 3,4,5... Tcl Unicode C Unicode C++ VB.NET VBScript Visual Basic 6.0 Visual FoxPro Xojo Plugin
(Unicode C) REST Read Response with Stream APIDemonstrates how to make a REST call that returns a binary body, and to receive the body through a stream API.
#include <C_CkRestW.h> #include <C_CkAuthAwsW.h> #include <C_CkStreamW.h> #include <C_CkTaskW.h> #include <C_CkByteData.h> void ChilkatSample(void) { HCkRestW rest; BOOL bTls; int port; BOOL bAutoReconnect; BOOL success; HCkAuthAwsW authAws; int responseStatusCode; const wchar_t *errResponse; HCkStreamW bodyStream; HCkTaskW readResponseBodyTask; HCkByteData nextChunk; // This example requires the Chilkat API to have been previously unlocked. // See Global Unlock Sample for sample code. rest = CkRestW_Create(); // Connect to the Amazon AWS REST server. bTls = TRUE; port = 443; bAutoReconnect = TRUE; success = CkRestW_Connect(rest,L"s3.amazonaws.com",port,bTls,bAutoReconnect); // ---------------------------------------------------------------------------- // Important: For buckets created in regions outside us-east-1, // there are three important changes that need to be made. // See Working with S3 Buckets in Non-us-east-1 Regions for the details. // ---------------------------------------------------------------------------- // Provide AWS credentials for the REST call. authAws = CkAuthAwsW_Create(); CkAuthAwsW_putAccessKey(authAws,L"AWS_ACCESS_KEY"); CkAuthAwsW_putSecretKey(authAws,L"AWS_SECRET_KEY"); CkAuthAwsW_putServiceName(authAws,L"s3"); success = CkRestW_SetAuthAws(rest,authAws); // Set the bucket name via the HOST header. // In this case, the bucket name is "chilkat100". CkRestW_putHost(rest,L"chilkat100.s3.amazonaws.com"); // Send the request to download the JPG. success = CkRestW_SendReqNoBody(rest,L"GET",L"/starfish.jpg"); if (success != TRUE) { wprintf(L"%s\n",CkRestW_lastErrorText(rest)); CkRestW_Dispose(rest); CkAuthAwsW_Dispose(authAws); return; } // Read the response header. responseStatusCode = CkRestW_ReadResponseHeader(rest); if (responseStatusCode < 0) { wprintf(L"%s\n",CkRestW_lastErrorText(rest)); CkRestW_Dispose(rest); CkAuthAwsW_Dispose(authAws); return; } wprintf(L"Response status code = %d\n",responseStatusCode); // We expect a 200 response status if the JPG data is coming. // Otherwise, we'll get a string response body with an error message(or no response body). if (responseStatusCode != 200) { errResponse = CkRestW_readRespBodyString(rest); if (CkRestW_getLastMethodSuccess(rest) != TRUE) { wprintf(L"%s\n",CkRestW_lastErrorText(rest)); } else { wprintf(L"%s\n",errResponse); } CkRestW_Dispose(rest); CkAuthAwsW_Dispose(authAws); return; } bodyStream = CkStreamW_Create(); // Set a 10 second read timeout for the stream. // (Give up if no data arrives within 10 seconds after calling a read method.) CkStreamW_putReadTimeoutMs(bodyStream,10000); // Create a background thread task to read the response body (which feeds // it to the bodyStream object.) readResponseBodyTask = CkRestW_ReadRespBodyStreamAsync(rest,bodyStream,TRUE); // Start the task. success = CkTaskW_Run(readResponseBodyTask); // The application can now read the bodyStream... nextChunk = CkByteData_Create(); while ((CkStreamW_getEndOfStream(bodyStream) != TRUE)) { // Read the next chunk of bytes (whatever is immediately available, // or wait for more data (up to 10 seconds because we set the stream's ReadTimeoutMs property) success = CkStreamW_ReadBytes(bodyStream,nextChunk); if (success != TRUE) { wprintf(L"Failed to receive more response data.\n"); // Make sure the background task is aborted/cancelled. success = CkTaskW_Cancel(readResponseBodyTask); CkTaskW_Dispose(readResponseBodyTask); CkRestW_Dispose(rest); CkAuthAwsW_Dispose(authAws); CkStreamW_Dispose(bodyStream); CkByteData_Dispose(nextChunk); return; } // OK.. the app has the next chunk of the body, and may do whatever it wishes with it... // See the CkByteData online reference documentation for // information about accessing and manipulating the byte data. } CkTaskW_Dispose(readResponseBodyTask); wprintf(L"Successfully received the entire response body.\n"); CkRestW_Dispose(rest); CkAuthAwsW_Dispose(authAws); CkStreamW_Dispose(bodyStream); CkByteData_Dispose(nextChunk); } |
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.