AutoIt

REST Download Bandwidth Throttle

See more REST Examples

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

Local $bSuccess = False

; 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 = ObjCreate("Chilkat.Socket")
Local $iMaxWaitMs = 5000
$bSuccess = $oSocket.Connect("content.dropboxapi.com",443,True,$iMaxWaitMs)
If ($bSuccess <> True) Then
    ConsoleWrite($oSocket.LastErrorText & @CRLF)
    ConsoleWrite("Connect Fail Reason: " & $oSocket.ConnectFailReason & @CRLF)
    Exit
EndIf

; Set the download bandwidth throttle rate to 50000 bytes per second.
$oSocket.BandwidthThrottleDown = 50000

$oRest = ObjCreate("Chilkat.Rest")

; Tell the REST object to use the connected socket.
$oRest.UseConnection($oSocket,True)

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

; Add request headers.
$oRest.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",
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.AppendString("path","/Homework/lit/hamlet.xml")
$oRest.AddHeader("Dropbox-API-Arg",$oJson.Emit())

; Setup a file stream for the download
$oFileStream = ObjCreate("Chilkat.Stream")
$oFileStream.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.
Local $iExpectedStatus = 200
$oRest.SetResponseBodyStream($iExpectedStatus,True,$oFileStream)

Local $sResponseStr = $oRest.FullRequestNoBody("POST","/2/files/download")
If ($oRest.LastMethodSuccess = False) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

; When successful, Dropbox responds with a 200 response code.
If ($oRest.ResponseStatusCode <> 200) Then
    ; Examine the request/response to see what happened.
    ConsoleWrite("response status code = " & $oRest.ResponseStatusCode & @CRLF)
    ConsoleWrite("response status text = " & $oRest.ResponseStatusText & @CRLF)
    ConsoleWrite("response header: " & $oRest.ResponseHeader & @CRLF)
    ConsoleWrite("response body (if any): " & $sResponseStr & @CRLF)
    ConsoleWrite("---" & @CRLF)
    ConsoleWrite("LastRequestStartLine: " & $oRest.LastRequestStartLine & @CRLF)
    ConsoleWrite("LastRequestHeader: " & $oRest.LastRequestHeader & @CRLF)
    Exit
EndIf

; 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:
Local $sApiResult = $oRest.ResponseHdrByName("dropbox-api-result")
ConsoleWrite($sApiResult & @CRLF)

; 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...
$oJsonResult = ObjCreate("Chilkat.JsonObject")
$oJsonResult.EmitCompact = False
$oJsonResult.Load($sApiResult)
; Show the JSON pretty-printed...
ConsoleWrite($oJsonResult.Emit() & @CRLF)

; Sample code to get data from the JSON response:
Local $iSize = $oJsonResult.IntOf("size")
ConsoleWrite("size = " & $iSize & @CRLF)

Local $sRev = $oJsonResult.StringOf("rev")
ConsoleWrite("rev = " & $sRev & @CRLF)

Local $sClientModified = $oJsonResult.StringOf("client_modified")
$oCkdt = ObjCreate("Chilkat.CkDateTime")
$oCkdt.SetFromTimestamp($sClientModified)
Local $bLocalTime = True
$oDt = ObjCreate("Chilkat.DtObj")
$oCkdt.ToDtObj $bLocalTime,$oDt

ConsoleWrite($oDt.Day & "/" & $oDt.Month & "/" & $oDt.Year & " " & $oDt.Hour & ":" & $oDt.Minute & @CRLF)