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. C++

#include <CkSocket.h>
#include <CkRest.h>
#include <CkJsonObject.h>
#include <CkStream.h>
#include <CkDateTime.h>
#include <CkDtObj.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.

    CkSocket socket;
    int maxWaitMs = 5000;
    success = socket.Connect("content.dropboxapi.com",443,true,maxWaitMs);
    if (success != true) {
        std::cout << socket.lastErrorText() << "\r\n";
        std::cout << "Connect Fail Reason: " << socket.get_ConnectFailReason() << "\r\n";
        return;
    }

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

    CkRest 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("Content-Type","application/octet-stream");
    rest.AddHeader("Authorization","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
    // }

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

    // Almost ready to go...
    // Let's setup a file stream to point to a file.
    CkStream fileStream;
    fileStream.put_SourceFile("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 char *responseStr = rest.fullRequestStream("POST","/2/files/upload",fileStream);
    if (rest.get_LastMethodSuccess() == false) {
        std::cout << rest.lastErrorText() << "\r\n";
        return;
    }

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

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

    // Show the JSON response.
    std::cout << jsonResp.emit() << "\r\n";

    // 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("size");
    std::cout << "size = " << size << "\r\n";

    const char *rev = jsonResp.stringOf("rev");
    std::cout << "rev = " << rev << "\r\n";

    const char *clientModified = jsonResp.stringOf("client_modified");
    CkDateTime ckdt;
    ckdt.SetFromTimestamp(clientModified);
    bool bLocalTime = true;
    CkDtObj dt;
    ckdt.ToDtObj(bLocalTime,dt);

    std::cout << dt.get_Day() << "/" << dt.get_Month() << "/" << dt.get_Year() << " " << dt.get_Hour() << ":"
         << dt.get_Minute() << "\r\n";
    }