(PHP ActiveX) REST Download Bandwidth Throttle

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.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Socket')
$socket = new COM("Chilkat.Socket");
$maxWaitMs = 5000;
$success = $socket->Connect('content.dropboxapi.com',443,1,$maxWaitMs);
if ($success != 1) {
    print $socket->LastErrorText . "\n";
    print 'Connect Fail Reason: ' . $socket->ConnectFailReason . "\n";
    exit;
}

// Set the download bandwidth throttle rate to 50000 bytes per second.
$socket->BandwidthThrottleDown = 50000;

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Rest')
$rest = new COM("Chilkat.Rest");

// 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",
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->AppendString('path','/Homework/lit/hamlet.xml');
$rest->AddHeader('Dropbox-API-Arg',$json->emit());

// Setup a file stream for the download
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Stream')
$fileStream = new COM("Chilkat.Stream");
$fileStream->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->LastMethodSuccess != 1) {
    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;
}

// 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 . "\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...
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jsonResult = new COM("Chilkat.JsonObject");
$jsonResult->EmitCompact = 0;
$jsonResult->Load($apiResult);
// Show the JSON pretty-printed...
print $jsonResult->emit() . "\n";

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

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

$clientModified = $jsonResult->stringOf('client_modified');
// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.CkDateTime')
$ckdt = new COM("Chilkat.CkDateTime");
$ckdt->SetFromTimestamp($clientModified);
$bLocalTime = 1;
// dt is a Chilkat.DtObj
$dt = $ckdt->GetDtObj($bLocalTime);
print $dt->Day . '/' . $dt->Month . '/' . $dt->Year . ' ' . $dt->Hour . ':' . $dt->Minute . "\n";


?>