(Xojo Plugin) 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 Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim socket As New Chilkat.Socket
Dim maxWaitMs As Int32
maxWaitMs = 5000
Dim success As Boolean
success = socket.Connect("content.dropboxapi.com",443,True,maxWaitMs)
If (success <> True) Then
    System.DebugLog(socket.LastErrorText)
    System.DebugLog("Connect Fail Reason: " + Str(socket.ConnectFailReason))
    Return
End If

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

Dim rest As New Chilkat.Rest

// Tell the REST object to use the connected socket.
success = rest.UseConnection(socket,True)

// The remainder of this example is identical to the example at:
// Dropbox Download File.

// Add request headers.
success = 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",
// }

Dim json As New Chilkat.JsonObject
success = json.AppendString("path","/Homework/lit/hamlet.xml")
success = rest.AddHeader("Dropbox-API-Arg",json.Emit())

// Setup a file stream for the download
Dim fileStream As New 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.
Dim expectedStatus As Int32
expectedStatus = 200
success = rest.SetResponseBodyStream(expectedStatus,True,fileStream)

Dim responseStr As String
responseStr = rest.FullRequestNoBody("POST","/2/files/download")
If (rest.LastMethodSuccess <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

// When successful, Dropbox responds with a 200 response code.
If (rest.ResponseStatusCode <> 200) Then
    // Examine the request/response to see what happened.
    System.DebugLog("response status code = " + Str(rest.ResponseStatusCode))
    System.DebugLog("response status text = " + rest.ResponseStatusText)
    System.DebugLog("response header: " + rest.ResponseHeader)
    System.DebugLog("response body (if any): " + responseStr)
    System.DebugLog("---")
    System.DebugLog("LastRequestStartLine: " + rest.LastRequestStartLine)
    System.DebugLog("LastRequestHeader: " + rest.LastRequestHeader)
    Return
End If

// 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:
Dim apiResult As String
apiResult = rest.ResponseHdrByName("dropbox-api-result")
System.DebugLog(apiResult)

// 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...
Dim jsonResult As New Chilkat.JsonObject
jsonResult.EmitCompact = False
success = jsonResult.Load(apiResult)
// Show the JSON pretty-printed...
System.DebugLog(jsonResult.Emit())

// Sample code to get data from the JSON response:
Dim size As Int32
size = jsonResult.IntOf("size")
System.DebugLog("size = " + Str(size))

Dim rev As String
rev = jsonResult.StringOf("rev")
System.DebugLog("rev = " + rev)

Dim clientModified As String
clientModified = jsonResult.StringOf("client_modified")
Dim ckdt As New Chilkat.CkDateTime
success = ckdt.SetFromTimestamp(clientModified)
Dim bLocalTime As Boolean
bLocalTime = True
Dim dt As Chilkat.DtObj
dt = ckdt.GetDtObj(bLocalTime)
System.DebugLog(Str(dt.Day) + "/" + Str(dt.Month) + "/" + Str(dt.Year) + " " + Str(dt.Hour) + ":" + Str(dt.Minute))