Unicode C++

REST Upload Bandwidth Throttle

See more REST Examples

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

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

void ChilkatSample(void)
    {
    bool success = false;

    // 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;
    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 upload bandwidth throttle rate to 50000 bytes per second.
    socket.put_BandwidthThrottleUp(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 File Stream Upload.

    // Add request headers.
    rest.AddHeader(L"Content-Type",L"application/octet-stream");
    rest.AddHeader(L"Authorization",L"Bearer DROPBOX_ACCESS_TOKEN");

    // The upload "parameters" contained in JSON passed in an HTTP request header.
    // This is the JSON to be added in this example:
    // { 
    //    "path": "/Homework/lit/hamlet.xml",
    //    "mode": "add",
    //    "autorename": true,
    //    "mute": false
    // }

    CkJsonObjectW json;
    json.AppendString(L"path",L"/Homework/lit/hamlet.xml");
    json.AppendString(L"mode",L"add");
    json.AppendBool(L"autorename",true);
    json.AppendBool(L"mute",false);
    rest.AddHeader(L"Dropbox-API-Arg",json.emit());

    // Almost ready to go...
    // Let's setup a file stream to point to a file.
    CkStreamW fileStream;
    fileStream.put_SourceFile(L"qa_data/xml/hamlet.xml");

    // Do the upload.  The URL is https://content.dropboxapi.com/2/files/upload.
    // We already connected to content.dropboxapi.com using TLS (i.e. HTTPS),
    // so now we only need to specify the path "/2/files/upload".

    // Note: The file is streamed directly from disk.  (The entire
    // file will not be loaded into memory.)
    const wchar_t *responseStr = rest.fullRequestStream(L"POST",L"/2/files/upload",fileStream);
    if (rest.get_LastMethodSuccess() == false) {
        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;
    }

    // The response is JSON.
    CkJsonObjectW jsonResp;
    jsonResp.put_EmitCompact(false);
    jsonResp.Load(responseStr);

    // Show the JSON response.
    wprintf(L"%s\n",jsonResp.emit());

    // Returns JSON that 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
    // }

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

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

    const wchar_t *clientModified = jsonResp.stringOf(L"client_modified");
    CkDateTimeW ckdt;
    ckdt.SetFromTimestamp(clientModified);
    bool bLocalTime = true;
    CkDtObjW dt;
    ckdt.ToDtObj(bLocalTime,dt);

    wprintf(L"%d/%d/%d %d:%d\n",dt.get_Day(),dt.get_Month(),dt.get_Year(),dt.get_Hour(),dt.get_Minute());
    }