Perl

REST Download Bandwidth Throttle

See more REST Examples

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

use chilkat();

$success = 0;

# 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 download bandwidth throttle rate to 50000 bytes per second.
$socket->put_BandwidthThrottleDown(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 Download File.

# Add request headers.
$rest->AddHeader("Authorization","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",
# }

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

# Setup a file stream for the download
$fileStream = chilkat::CkStream->new();
$fileStream->put_SinkFile("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.
$expectedStatus = 200;
$rest->SetResponseBodyStream($expectedStatus,1,$fileStream);

$responseStr = $rest->fullRequestNoBody("POST","/2/files/download");
if ($rest->get_LastMethodSuccess() == 0) {
    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;
}

# 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:
$apiResult = $rest->responseHdrByName("dropbox-api-result");
print $apiResult . "\r\n";

# 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...
$jsonResult = chilkat::CkJsonObject->new();
$jsonResult->put_EmitCompact(0);
$jsonResult->Load($apiResult);
# Show the JSON pretty-printed...
print $jsonResult->emit() . "\r\n";

# Sample code to get data from the JSON response:
$size = $jsonResult->IntOf("size");
print "size = " . $size . "\r\n";

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

$clientModified = $jsonResult->stringOf("client_modified");
$ckdt = chilkat::CkDateTime->new();
$ckdt->SetFromTimestamp($clientModified);
$bLocalTime = 1;
$dt = chilkat::CkDtObj->new();
$ckdt->ToDtObj($bLocalTime,$dt);

print $dt->get_Day() . "/" . $dt->get_Month() . "/" . $dt->get_Year() . " " . $dt->get_Hour() . ":"
     . $dt->get_Minute() . "\r\n";