Perl

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

use strict;
use warnings;
use Chilkat2;

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

my $socket = Chilkat2::Socket->new;
my $maxWaitMs = 5000;
my $success = $socket->Connect('content.dropboxapi.com', 443, 1, $maxWaitMs);
if (!$success) {
    print $socket->LastErrorText, "\n";
    print 'Connect Fail Reason: ', $socket->ConnectFailReason, "\n";
    exit;
}

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

my $rest = Chilkat2::Rest->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
# }

my $json = Chilkat2::JsonObject->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.
my $fileStream = Chilkat2::Stream->new;
$fileStream->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.)
my $responseStr = $rest->FullRequestStream('POST', '/2/files/upload', $fileStream);
if (!$rest->LastMethodSuccess) {
    print $rest->LastErrorText, "\n";
    exit;
}

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

# The response is JSON.
my $jsonResp = Chilkat2::JsonObject->new;
$jsonResp->EmitCompact(0);
$jsonResp->Load($responseStr);

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

my $rev = $jsonResp->StringOf('rev');
print 'rev = ', $rev, "\n";

my $clientModified = $jsonResp->StringOf('client_modified');
my $ckdt = Chilkat2::DateTime->new;
$ckdt->SetFromTimestamp($clientModified);
my $bLocalTime = 1;
my $dt = Chilkat2::DtObj->new;
$ckdt->ToDtObj($bLocalTime, $dt);

print $dt->Day, '/', $dt->Month, '/', $dt->Year, ' ', $dt->Hour, ':', $dt->Minute, "\n";