(Perl) REST Upload Bandwidth Throttle

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.

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

# 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.

$socket = chilkat::CkSocket->new();
$maxWaitMs = 5000;
$success = $socket->Connect("content.dropboxapi.com",443,1,$maxWaitMs);
if ($success != 1) {
    print $socket->lastErrorText() . "\r\n";
    print "Connect Fail Reason: " . $socket->get_ConnectFailReason() . "\r\n";
    exit;
}

# Set the upload bandwidth throttle rate to 50000 bytes per second.
$socket->put_BandwidthThrottleUp(50000);

$rest = chilkat::CkRest->new();

# Tell the REST object to use the connected socket.
$rest->UseConnection($socket,1);

# 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
# }

$json = chilkat::CkJsonObject->new();
$json->AppendString("path","/Homework/lit/hamlet.xml");
$json->AppendString("mode","add");
$json->AppendBool("autorename",1);
$json->AppendBool("mute",0);
$rest->AddHeader("Dropbox-API-Arg",$json->emit());

# Almost ready to go...
# Let's setup a file stream to point to a file.
$fileStream = chilkat::CkStream->new();
$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.)
$responseStr = $rest->fullRequestStream("POST","/2/files/upload",$fileStream);
if ($rest->get_LastMethodSuccess() != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

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

# The response is JSON.
$jsonResp = chilkat::CkJsonObject->new();
$jsonResp->put_EmitCompact(0);
$jsonResp->Load($responseStr);

# Show the JSON response.
print $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:
$size = $jsonResp->IntOf("size");
print "size = " . $size . "\r\n";

$rev = $jsonResp->stringOf("rev");
print "rev = " . $rev . "\r\n";

$clientModified = $jsonResp->stringOf("client_modified");
$ckdt = chilkat::CkDateTime->new();
$ckdt->SetFromTimestamp($clientModified);
$bLocalTime = 1;
# dt is a DtObj
$dt = $ckdt->GetDtObj($bLocalTime);
print $dt->get_Day() . "/" . $dt->get_Month() . "/" . $dt->get_Year() . " " . $dt->get_Hour() . ":"
     . $dt->get_Minute() . "\r\n";