(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

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

loRest = createobject("CkRest")

// Connect to the web server
llBTls = .T.
lnPort = 443
llBAutoReconnect = .T.
llSuccess = loRest.Connect("www.chilkatsoft.com",lnPort,llBTls,llBAutoReconnect)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loRest
    return
endif

// Setup a file stream for the download
loFileStream = createobject("CkStream")
loFileStream.SinkFile = "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.
lnExpectedStatus = 200
loRest.SetResponseBodyStream(lnExpectedStatus,.T.,loFileStream)

lcResponseStr = loRest.FullRequestNoBody("GET","/images/starfish.jpg")
if (loRest.LastMethodSuccess = .F.) then
    // Examine the request/response to see what happened.
    ? "response status code = " + str(loRest.ResponseStatusCode)
    ? "response status text = " + loRest.ResponseStatusText
    ? "response header: " + loRest.ResponseHeader
    ? "response body (if any): " + lcResponseStr
    ? "---"
    ? "LastRequestStartLine: " + loRest.LastRequestStartLine
    ? "LastRequestHeader: " + loRest.LastRequestHeader
    release loRest
    release loFileStream
    return
endif

? "downloaded starfish.jpg"

// Clear the response body stream previously set in the call to SetResponseBodyStream.
loRest.ClearResponseBodyStream()

// Download something else, but this time send the response body to bd.
loBd = createobject("CkBinData")
llSuccess = loRest.FullRequestNoBodyBd("GET","/images/penguins.jpg",loBd)
if (llSuccess = .F.) then
    // Examine the request/response to see what happened.
    ? "response status code = " + str(loRest.ResponseStatusCode)
    ? "response status text = " + loRest.ResponseStatusText
    ? "response header: " + loRest.ResponseHeader
    ? "response body (if any): " + loBd.GetString("utf-8")
    ? "---"
    ? "LastRequestStartLine: " + loRest.LastRequestStartLine
    ? "LastRequestHeader: " + loRest.LastRequestHeader
    release loRest
    release loFileStream
    release loBd
    return
endif

// Save the contents of bd to a file.
llSuccess = loBd.WriteFile("qa_output/penguins.jpg")

? "Success: " + str(llSuccess)


release loRest
release loFileStream
release loBd