Visual FoxPro

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. Visual FoxPro

LOCAL lnSuccess
LOCAL loSocket
LOCAL lnMaxWaitMs
LOCAL loRest
LOCAL loJson
LOCAL loFileStream
LOCAL lcResponseStr
LOCAL loJsonResp
LOCAL lnSize
LOCAL lcRev
LOCAL lcClientModified
LOCAL loCkdt
LOCAL lnBLocalTime
LOCAL loDt

lnSuccess = 0

* 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('Chilkat.Socket')
lnMaxWaitMs = 5000
lnSuccess = loSocket.Connect("content.dropboxapi.com",443,1,lnMaxWaitMs)
IF (lnSuccess <> 1) THEN
    ? loSocket.LastErrorText
    ? "Connect Fail Reason: " + STR(loSocket.ConnectFailReason)
    RELEASE loSocket
    CANCEL
ENDIF

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

loRest = CreateObject('Chilkat.Rest')

* Tell the REST object to use the connected socket.
loRest.UseConnection(loSocket,1)

* 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('Chilkat.JsonObject')
loJson.AppendString("path","/Homework/lit/hamlet.xml")
loJson.AppendString("mode","add")
loJson.AppendBool("autorename",1)
loJson.AppendBool("mute",0)
loRest.AddHeader("Dropbox-API-Arg",loJson.Emit())

* Almost ready to go...
* Let's setup a file stream to point to a file.
loFileStream = CreateObject('Chilkat.Stream')
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 = 0) THEN
    ? loRest.LastErrorText
    RELEASE loSocket
    RELEASE loRest
    RELEASE loJson
    RELEASE loFileStream
    CANCEL
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
    CANCEL
ENDIF

* The response is JSON.
loJsonResp = CreateObject('Chilkat.JsonObject')
loJsonResp.EmitCompact = 0
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('Chilkat.CkDateTime')
loCkdt.SetFromTimestamp(lcClientModified)
lnBLocalTime = 1
loDt = CreateObject('Chilkat.DtObj')
loCkdt.ToDtObj(lnBLocalTime,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