AutoIt

REST Receive Response in Chunks

See more REST Examples

Demonstrates how to receive a REST HTTP response in chunks.

Note: This example requires Chilkat 10.1.0 or greater.

AutoIt

Local $bSuccess = False

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

$oRest = ObjCreate("Chilkat.Rest")

; Connect to the web server
Local $bTls = True
Local $iPort = 443
Local $bAutoReconnect = True
$bSuccess = $oRest.Connect("chilkatsoft.com",$iPort,$bTls,$bAutoReconnect)
If ($bSuccess = False) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

; Send the request.
; This can be *any* kind of request: POST, GET, PUT, etc. using *any* of the Chilkat REST methods that send requests.
; For this example, we'll just GET a simple XML document that is about 274K in size.

$bSuccess = $oRest.SendReqNoBody("GET","/hamlet.xml")
If ($bSuccess = False) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

; Get the response header.
Local $iStatusCode = $oRest.ReadResponseHeader()
If ($iStatusCode < 0) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite("response status code = " & $iStatusCode & @CRLF)

Local $sOutputFile = "c:/temp/qa_output/hamlet.xml"

$oFac = ObjCreate("Chilkat.FileAccess")
$bSuccess = $oFac.OpenForWrite($sOutputFile)
If ($iStatusCode < 0) Then
    ConsoleWrite($oFac.LastErrorText & @CRLF)
    Exit
EndIf

; Get the response in chunks.
; (Note: There are more efficient ways to simply download a file from a web server, such as by calling Chilkat's Http.Download method.
; The purpose of this method is to show how to receive a response chunk-by-chunk.)
$oBd = ObjCreate("Chilkat.BinData")
Local $iStatus = 1
While $iStatus = 1
    ; Read a minimum of 16000 bytes.
    ; Note: Because of TLS message lengths, or the possibility of the response being either compressed (gzip/deflate) or in the HTTP chunked encoding,
    ; the amount of data received in each call can be greater than the specified min size.
    ; Chilkat will return from the call as soon as it has received an amount equal to or more than the specified size,
    ; except for the very last chunk, which can be less that the min size or even 0 bytes.

    ; The status will be one of three values:
    ; -1 = error
    ; 0 = received the last chunk of the response.
    ; 1 = received a chunk, and more chunks are coming..

    ; The received data is *appended* to the contents of the BinData object.
    $iStatus = $oRest.ReadRespChunkBd(16000,$oBd)
    If ($iStatus >= 0) Then
        ConsoleWrite("Received chunk: " & $oBd.NumBytes & " bytes" & @CRLF)
        $oFac.FileWriteBd($oBd,0,0)
        $oBd.Clear()
    EndIf

Wend

$oFac.FileClose 

ConsoleWrite("Success." & @CRLF)