Xbase++

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. Xbase++

LOCAL nSuccess
LOCAL oSocket
LOCAL nMaxWaitMs
LOCAL oRest
LOCAL oJson
LOCAL oFileStream
LOCAL cResponseStr
LOCAL oJsonResp
LOCAL nSize
LOCAL cRev
LOCAL cClientModified
LOCAL oCkdt
LOCAL nBLocalTime
LOCAL oDt

nSuccess := 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.

oSocket := CreateObject("Chilkat.Socket")
nMaxWaitMs := 5000
nSuccess := oSocket:Connect("content.dropboxapi.com", 443, 1, nMaxWaitMs)
IF (nSuccess != 1)
    ? oSocket:LastErrorText
    ? "Connect Fail Reason: " + Str(oSocket:ConnectFailReason)
    oSocket:destroy()
    RETURN
ENDIF

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

oRest := CreateObject("Chilkat.Rest")

//  Tell the REST object to use the connected socket.
oRest:UseConnection(oSocket, 1)

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

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

oJson := CreateObject("Chilkat.JsonObject")
oJson:AppendString("path", "/Homework/lit/hamlet.xml")
oJson:AppendString("mode", "add")
oJson:AppendBool("autorename", 1)
oJson:AppendBool("mute", 0)
oRest:AddHeader("Dropbox-API-Arg", oJson:Emit())

//  Almost ready to go...
//  Let's setup a file stream to point to a file.
oFileStream := CreateObject("Chilkat.Stream")
oFileStream: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.)
cResponseStr := oRest:FullRequestStream("POST", "/2/files/upload", oFileStream)
IF (oRest:LastMethodSuccess == 0)
    ? oRest:LastErrorText
    oSocket:destroy()
    oRest:destroy()
    oJson:destroy()
    oFileStream:destroy()
    RETURN
ENDIF

//  When successful, Dropbox responds with a 200 response code.
IF (oRest:ResponseStatusCode != 200)
    //  Examine the request/response to see what happened.
    ? "response status code = " + Str(oRest:ResponseStatusCode)
    ? "response status text = " + oRest:ResponseStatusText
    ? "response header: " + oRest:ResponseHeader
    ? "response body (if any): " + cResponseStr
    ? "---"
    ? "LastRequestStartLine: " + oRest:LastRequestStartLine
    ? "LastRequestHeader: " + oRest:LastRequestHeader
    oSocket:destroy()
    oRest:destroy()
    oJson:destroy()
    oFileStream:destroy()
    RETURN
ENDIF

//  The response is JSON.
oJsonResp := CreateObject("Chilkat.JsonObject")
oJsonResp:EmitCompact := 0
oJsonResp:Load(cResponseStr)

//  Show the JSON response.
? oJsonResp: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:
nSize := oJsonResp:IntOf("size")
? "size = " + Str(nSize)

cRev := oJsonResp:StringOf("rev")
? "rev = " + cRev

cClientModified := oJsonResp:StringOf("client_modified")
oCkdt := CreateObject("Chilkat.CkDateTime")
oCkdt:SetFromTimestamp(cClientModified)
nBLocalTime := 1
oDt := CreateObject("Chilkat.DtObj")
oCkdt:ToDtObj(nBLocalTime, oDt)

? Str(oDt:Day) + "/" + Str(oDt:Month) + "/" + Str(oDt:Year) + " " + Str(oDt:Hour) + ":" + Str(oDt:Minute)

oSocket:destroy()
oRest:destroy()
oJson:destroy()
oFileStream:destroy()
oJsonResp:destroy()
oCkdt:destroy()
oDt:destroy()