(Unicode C++) REST Download Bandwidth Throttle

Demonstrates how to use download bandwidth throttling with the REST API. This example will download a file from Drobox using a file stream, with a limit on the bandwidth that can be used for the transfer.

Chilkat C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <CkSocketW.h>
#include <CkRestW.h>
#include <CkJsonObjectW.h>
#include <CkStreamW.h>
#include <CkDateTimeW.h>
#include <CkDtObjW.h>

void ChilkatSample(void)
    {
    // This example requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // A Dropbox access token should have been previously obtained.
    // Dropbox access tokens do not expire.
    // See Dropbox Access Token.

    // To use bandwidth throttling, the connection should be made using the socket API.
    // This provides numerous properties to customize the connection, such as
    // BandwidthThrottleDown, BandwidthThrottleUp, ClientIpAddress, ClintPort, Http Proxy,
    // KeepAlive, PreferIpv6, RequireSslCertVerify, SoRcvBuf, SoSndBuf, SoReuseAddr,
    // SOCKS proxy, TcpNoSDelay, TlsPinSet, TlsCipherSuite, SslAllowedCiphers, etc.

    CkSocketW socket;
    int maxWaitMs = 5000;
    bool success = socket.Connect(L"content.dropboxapi.com",443,true,maxWaitMs);
    if (success != true) {
        wprintf(L"%s\n",socket.lastErrorText());
        wprintf(L"Connect Fail Reason: %d\n",socket.get_ConnectFailReason());
        return;
    }

    // Set the download bandwidth throttle rate to 50000 bytes per second.
    socket.put_BandwidthThrottleDown(50000);

    CkRestW rest;

    // Tell the REST object to use the connected socket.
    rest.UseConnection(socket,true);

    // The remainder of this example is identical to the example at:
    // Dropbox Download File.

    // Add request headers.
    rest.AddHeader(L"Authorization",L"Bearer DROPBOX_ACCESS_TOKEN");

    // The download "parameters" are contained in JSON passed in an HTTP request header.
    // This is the JSON indicating the file to be downloaded:
    // { 
    //    "path": "/Homework/lit/hamlet.xml",
    // }

    CkJsonObjectW json;
    json.AppendString(L"path",L"/Homework/lit/hamlet.xml");
    rest.AddHeader(L"Dropbox-API-Arg",json.emit());

    // Setup a file stream for the download
    CkStreamW fileStream;
    fileStream.put_SinkFile(L"qa_output/hamletFromDropbox.xml");

    // Indicate that the call to FullRequestNoBody should send the response body
    // to fileStream if the response status code is 200.
    // If a non-success response status code is received, then nothing
    // is streamed to the output file and the error response is returned by FullRequestNoBody.
    int expectedStatus = 200;
    rest.SetResponseBodyStream(expectedStatus,true,fileStream);

    const wchar_t *responseStr = rest.fullRequestNoBody(L"POST",L"/2/files/download");
    if (rest.get_LastMethodSuccess() != true) {
        wprintf(L"%s\n",rest.lastErrorText());
        return;
    }

    // When successful, Dropbox responds with a 200 response code.
    if (rest.get_ResponseStatusCode() != 200) {
        // Examine the request/response to see what happened.
        wprintf(L"response status code = %d\n",rest.get_ResponseStatusCode());
        wprintf(L"response status text = %s\n",rest.responseStatusText());
        wprintf(L"response header: %s\n",rest.responseHeader());
        wprintf(L"response body (if any): %s\n",responseStr);
        wprintf(L"---\n");
        wprintf(L"LastRequestStartLine: %s\n",rest.lastRequestStartLine());
        wprintf(L"LastRequestHeader: %s\n",rest.lastRequestHeader());
        return;
    }

    // Information about the downloaded file is also available as JSON in a response header.
    // The "dropbox-api-result" response header contains the information.  For example:
    const wchar_t *apiResult = rest.responseHdrByName(L"dropbox-api-result");
    wprintf(L"%s\n",apiResult);

    // In this case, the pretty-formatted dropbox-api-result JSON looks like this:
    // { 
    //   "name": "hamlet.xml",
    //   "path_lower": "/homework/lit/hamlet.xml",
    //   "path_display": "/Homework/lit/hamlet.xml",
    //   "id": "id:74FkdeNuyKAAAAAAAAAAAQ",
    //   "client_modified": "2016-06-02T23:19:00Z",
    //   "server_modified": "2016-06-02T23:19:00Z",
    //   "rev": "9482db15f",
    //   "size": 279658
    // }

    // Load the JSON, pretty-print it, and demonstrate how to get some values...
    CkJsonObjectW jsonResult;
    jsonResult.put_EmitCompact(false);
    jsonResult.Load(apiResult);
    // Show the JSON pretty-printed...
    wprintf(L"%s\n",jsonResult.emit());

    // Sample code to get data from the JSON response:
    int size = jsonResult.IntOf(L"size");
    wprintf(L"size = %d\n",size);

    const wchar_t *rev = jsonResult.stringOf(L"rev");
    wprintf(L"rev = %s\n",rev);

    const wchar_t *clientModified = jsonResult.stringOf(L"client_modified");
    CkDateTimeW ckdt;
    ckdt.SetFromTimestamp(clientModified);
    bool bLocalTime = true;
    CkDtObjW *dt = ckdt.GetDtObj(bLocalTime);
    wprintf(L"%d/%d/%d %d:%d\n",dt->get_Day(),dt->get_Month(),dt->get_Year(),dt->get_Hour(),dt->get_Minute());
    delete dt;
    }