Lianja

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

llSuccess = .F.

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

loSocket = createobject("CkSocket")
lnMaxWaitMs = 5000
llSuccess = loSocket.Connect("content.dropboxapi.com",443,.T.,lnMaxWaitMs)
if (llSuccess <> .T.) then
    ? loSocket.LastErrorText
    ? "Connect Fail Reason: " + str(loSocket.ConnectFailReason)
    release loSocket
    return
endif

// Set the upload bandwidth throttle rate to 50000 bytes per second.
loSocket.BandwidthThrottleUp = 50000

loRest = createobject("CkRest")

// Tell the REST object to use the connected socket.
loRest.UseConnection(loSocket,.T.)

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

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

loJson = createobject("CkJsonObject")
loJson.AppendString("path","/Homework/lit/hamlet.xml")
loJson.AppendString("mode","add")
loJson.AppendBool("autorename",.T.)
loJson.AppendBool("mute",.F.)
loRest.AddHeader("Dropbox-API-Arg",loJson.Emit())

// Almost ready to go...
// Let's setup a file stream to point to a file.
loFileStream = createobject("CkStream")
loFileStream.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.)
lcResponseStr = loRest.FullRequestStream("POST","/2/files/upload",loFileStream)
if (loRest.LastMethodSuccess = .F.) then
    ? loRest.LastErrorText
    release loSocket
    release loRest
    release loJson
    release loFileStream
    return
endif

// When successful, Dropbox responds with a 200 response code.
if (loRest.ResponseStatusCode <> 200) then
    // Examine the request/response to see what happened.
    ? "response status code = " + str(loRest.ResponseStatusCode)
    ? "response status text = " + loRest.ResponseStatusText
    ? "response header: " + loRest.ResponseHeader
    ? "response body (if any): " + lcResponseStr
    ? "---"
    ? "LastRequestStartLine: " + loRest.LastRequestStartLine
    ? "LastRequestHeader: " + loRest.LastRequestHeader
    release loSocket
    release loRest
    release loJson
    release loFileStream
    return
endif

// The response is JSON.
loJsonResp = createobject("CkJsonObject")
loJsonResp.EmitCompact = .F.
loJsonResp.Load(lcResponseStr)

// Show the JSON response.
? loJsonResp.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:
lnSize = loJsonResp.IntOf("size")
? "size = " + str(lnSize)

lcRev = loJsonResp.StringOf("rev")
? "rev = " + lcRev

lcClientModified = loJsonResp.StringOf("client_modified")
loCkdt = createobject("CkDateTime")
loCkdt.SetFromTimestamp(lcClientModified)
llBLocalTime = .T.
loDt = createobject("CkDtObj")
loCkdt.ToDtObj(llBLocalTime,loDt)

? str(loDt.Day) + "/" + str(loDt.Month) + "/" + str(loDt.Year) + " " + str(loDt.Hour) + ":" + str(loDt.Minute)


release loSocket
release loRest
release loJson
release loFileStream
release loJsonResp
release loCkdt
release loDt