B4X

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

Dim success As Boolean = False

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

Dim rest As ChilkatRest
rest.Initialize("rest")

'  The URL we want to download is: 
'  https://github.com/chilkatsoft/OAuth2-CSharp-Desktop/archive/master.zip
Dim url As ChilkatUrl
url.Initialize
url.ParseUrl("https://github.com/chilkatsoft/OAuth2-CSharp-Desktop/archive/master.zip")

'  Connect to the web server
Dim bAutoReconnect As Boolean = True
success = rest.Connect(url.Host, url.Port, url.Ssl, bAutoReconnect)
If success <> True Then
    Log(rest.LastErrorText)
    Return
End If


success = rest.SendReqNoBody("GET", url.Path)
If success <> True Then
    Log(rest.LastErrorText)
    Return
End If


'  Read the response header.
Dim responseStatusCode As Int = rest.ReadResponseHeader
If responseStatusCode < 0 Then
    Log(rest.LastErrorText)
    Return
End If


Log("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

    Dim bodyStream As ChilkatStream
    bodyStream.Initialize("bodyStream")

    '  The stream's sink will be a file.
    bodyStream.SinkFile = "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.
    success = rest.ReadRespBodyStream(bodyStream, True)
    If success <> True Then
        Log(rest.LastErrorText)
        Return
    End If


    Log("Successfully downloaded the file.")

Else
    Dim errResponse As String = rest.ReadRespBodyString
    If rest.LastMethodSuccess <> True Then
        Log(rest.LastErrorText)
    Else
        Log(errResponse)
    End If

End If