(PureBasic) Explaining the Rest ClearResponseBodyStream Method

See more Azure Cloud Storage Examples

The ClearResponseBodyStream method would be needed if your applicaiton called SetResponseBodyStream to send the response to a stream for one request, but then wants to subsequently do something else. The application must call ClearResponseBodyStream to no longer send responses to the stream.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkBinData.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkStream.pb"

Procedure ChilkatExample()

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

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to the web server
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    success.i = CkRest::ckConnect(rest,"www.chilkatsoft.com",port,bTls,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; Setup a file stream for the download
    fileStream.i = CkStream::ckCreate()
    If fileStream.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStream::setCkSinkFile(fileStream, "qa_output/starfish.jpg")

    ; 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.i = 200
    CkRest::ckSetResponseBodyStream(rest,expectedStatus,1,fileStream)

    responseStr.s = CkRest::ckFullRequestNoBody(rest,"GET","/images/starfish.jpg")
    If CkRest::ckLastMethodSuccess(rest) = 0
        ; Examine the request/response to see what happened.
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body (if any): " + responseStr
        Debug "---"
        Debug "LastRequestStartLine: " + CkRest::ckLastRequestStartLine(rest)
        Debug "LastRequestHeader: " + CkRest::ckLastRequestHeader(rest)
        CkRest::ckDispose(rest)
        CkStream::ckDispose(fileStream)
        ProcedureReturn
    EndIf

    Debug "downloaded starfish.jpg"

    ; Clear the response body stream previously set in the call to SetResponseBodyStream.
    CkRest::ckClearResponseBodyStream(rest)

    ; Download something else, but this time send the response body to bd.
    bd.i = CkBinData::ckCreate()
    If bd.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkRest::ckFullRequestNoBodyBd(rest,"GET","/images/penguins.jpg",bd)
    If success = 0
        ; Examine the request/response to see what happened.
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body (if any): " + CkBinData::ckGetString(bd,"utf-8")
        Debug "---"
        Debug "LastRequestStartLine: " + CkRest::ckLastRequestStartLine(rest)
        Debug "LastRequestHeader: " + CkRest::ckLastRequestHeader(rest)
        CkRest::ckDispose(rest)
        CkStream::ckDispose(fileStream)
        CkBinData::ckDispose(bd)
        ProcedureReturn
    EndIf

    ; Save the contents of bd to a file.
    success = CkBinData::ckWriteFile(bd,"qa_output/penguins.jpg")

    Debug "Success: " + Str(success)


    CkRest::ckDispose(rest)
    CkStream::ckDispose(fileStream)
    CkBinData::ckDispose(bd)


    ProcedureReturn
EndProcedure