(Xojo Plugin) 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 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 upload bandwidth throttle rate to 50000 bytes per second.
socket.BandwidthThrottleUp = 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 File Stream Upload.

// Add request headers.
success = rest.AddHeader("Content-Type","application/octet-stream")
success = 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
// }

Dim json As New Chilkat.JsonObject
success = json.AppendString("path","/Homework/lit/hamlet.xml")
success = json.AppendString("mode","add")
success = json.AppendBool("autorename",True)
success = json.AppendBool("mute",False)
success = rest.AddHeader("Dropbox-API-Arg",json.Emit())

// Almost ready to go...
// Let's setup a file stream to point to a file.
Dim fileStream As New Chilkat.Stream
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.)
Dim responseStr As String
responseStr = rest.FullRequestStream("POST","/2/files/upload",fileStream)
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

// The response is JSON.
Dim jsonResp As New Chilkat.JsonObject
jsonResp.EmitCompact = False
success = jsonResp.Load(responseStr)

// Show the JSON response.
System.DebugLog(jsonResp.Emit())

// 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:
Dim size As Int32
size = jsonResp.IntOf("size")
System.DebugLog("size = " + Str(size))

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

Dim clientModified As String
clientModified = jsonResp.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))