Tcl

HTTP Download to Stream

See more REST Examples

Demonstrates how to stream the response body directly to a stream, which in this case is to a file stream. Tcl

load ./chilkat.dll

set success 0

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set rest [new_CkRest]

# The URL we want to download is: 
# https://github.com/chilkatsoft/OAuth2-CSharp-Desktop/archive/master.zip
set url [new_CkUrl]

CkUrl_ParseUrl $url "https://github.com/chilkatsoft/OAuth2-CSharp-Desktop/archive/master.zip"

# Connect to the web server
set bAutoReconnect 1
set success [CkRest_Connect $rest [CkUrl_host $url] [CkUrl_get_Port $url] [CkUrl_get_Ssl $url] $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkUrl $url
    exit
}

set success [CkRest_SendReqNoBody $rest "GET" [CkUrl_path $url]]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkUrl $url
    exit
}

# Read the response header.
set responseStatusCode [CkRest_ReadResponseHeader $rest]
if {$responseStatusCode < 0} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkUrl $url
    exit
}

puts "Response status code = $responseStatusCode"

# We expect a 200 response status if the file data is coming.
# Otherwise, we'll get a string response body with an error message(or no response body).
if {$responseStatusCode == 200} then {

    set bodyStream [new_CkStream]

    # The stream's sink will be a file.
    CkStream_put_SinkFile $bodyStream "qa_output/OAuth2-CSharp-Desktop/archive/master.zip"

    # Read the response body to the stream.  Given that we've
    # set the stream's sink to a file, it will stream directly
    # to the file.
    set success [CkRest_ReadRespBodyStream $rest $bodyStream 1]
    if {$success != 1} then {
        puts [CkRest_lastErrorText $rest]
        delete_CkRest $rest
        delete_CkUrl $url
        delete_CkStream $bodyStream
        exit
    }

    puts "Successfully downloaded the file."

} else {
    set errResponse [CkRest_readRespBodyString $rest]
    if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
        puts [CkRest_lastErrorText $rest]
    }     else {
        puts "$errResponse"
    }

}


delete_CkRest $rest
delete_CkUrl $url
delete_CkStream $bodyStream