Go

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

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

    socket := chilkat.NewSocket()
    maxWaitMs := 5000
    success = socket.Connect("content.dropboxapi.com",443,true,maxWaitMs)
    if success != true {
        fmt.Println(socket.LastErrorText())
        fmt.Println("Connect Fail Reason: ", socket.ConnectFailReason())
        socket.DisposeSocket()
        return
    }

    // Set the download bandwidth throttle rate to 50000 bytes per second.
    socket.SetBandwidthThrottleDown(50000)

    rest := chilkat.NewRest()

    // Tell the REST object to use the connected socket.
    rest.UseConnection(socket,true)

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

    // Add request headers.
    rest.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",
    // }

    json := chilkat.NewJsonObject()
    json.AppendString("path","/Homework/lit/hamlet.xml")
    rest.AddHeader("Dropbox-API-Arg",*json.Emit())

    // Setup a file stream for the download
    fileStream := chilkat.NewStream()
    fileStream.SetSinkFile("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.
    expectedStatus := 200
    rest.SetResponseBodyStream(expectedStatus,true,fileStream)

    responseStr := rest.FullRequestNoBody("POST","/2/files/download")
    if rest.LastMethodSuccess() == false {
        fmt.Println(rest.LastErrorText())
        socket.DisposeSocket()
        rest.DisposeRest()
        json.DisposeJsonObject()
        fileStream.DisposeStream()
        return
    }

    // When successful, Dropbox responds with a 200 response code.
    if rest.ResponseStatusCode() != 200 {
        // Examine the request/response to see what happened.
        fmt.Println("response status code = ", rest.ResponseStatusCode())
        fmt.Println("response status text = ", rest.ResponseStatusText())
        fmt.Println("response header: ", rest.ResponseHeader())
        fmt.Println("response body (if any): ", *responseStr)
        fmt.Println("---")
        fmt.Println("LastRequestStartLine: ", rest.LastRequestStartLine())
        fmt.Println("LastRequestHeader: ", rest.LastRequestHeader())
        socket.DisposeSocket()
        rest.DisposeRest()
        json.DisposeJsonObject()
        fileStream.DisposeStream()
        return
    }

    // 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:
    apiResult := rest.ResponseHdrByName("dropbox-api-result")
    fmt.Println(*apiResult)

    // 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...
    jsonResult := chilkat.NewJsonObject()
    jsonResult.SetEmitCompact(false)
    jsonResult.Load(*apiResult)
    // Show the JSON pretty-printed...
    fmt.Println(*jsonResult.Emit())

    // Sample code to get data from the JSON response:
    size := jsonResult.IntOf("size")
    fmt.Println("size = ", size)

    rev := jsonResult.StringOf("rev")
    fmt.Println("rev = ", *rev)

    clientModified := jsonResult.StringOf("client_modified")
    ckdt := chilkat.NewCkDateTime()
    ckdt.SetFromTimestamp(*clientModified)
    bLocalTime := true
    dt := chilkat.NewDtObj()
    ckdt.ToDtObj(bLocalTime,dt)

    fmt.Println(dt.Day(), "/", dt.Month(), "/", dt.Year(), " ", dt.Hour(), ":", dt.Minute())

    socket.DisposeSocket()
    rest.DisposeRest()
    json.DisposeJsonObject()
    fileStream.DisposeStream()
    jsonResult.DisposeJsonObject()
    ckdt.DisposeCkDateTime()
    dt.DisposeDtObj()