PureBasic

Read the REST Response Body into a Stream

Demonstrates Rest.ReadRespBodyStream, which reads the response body into a Stream. The optional flag sets the stream character set from the response Content-Type charset for textual responses.

The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background. The staged request model separates sending from reading: a SendReq method transmits the request, ReadResponseHeader reads the status line and headers, and a ReadResp method reads the body. This gives fine control over large or streamed messages compared with the single-call full-request methods.

Chilkat PureBasic Downloads

Download Chilkat for PureBasic

PureBasic

IncludeFile "CkStream.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    success.i = 0

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

    bTls.i = 1
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"example.com",443,bTls,bAutoReconnect)
    If success = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ;  The file paths are relative to the application's current working directory.  Absolute paths
    ;  may also be used.  Supply the paths appropriate to your own environment.

    success = CkRest::ckSendReqNoBody(rest,"GET","/api/images/1")
    If success = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    statusCode.i = CkRest::ckReadResponseHeader(rest)
    If statusCode < 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ;  Check for the expected success status code.  If the response is not 200, the body is likely
    ;  error text formatted as JSON, XML, or HTML rather than the expected binary content.  In that case
    ;  read the body as text, report it, and return.
    If statusCode <> 200
        sbError.i = CkStringBuilder::ckCreate()
        If sbError.i = 0
            Debug "Failed to create object."
            ProcedureReturn
        EndIf

        success = CkRest::ckReadRespSb(rest,sbError)
        If success = 0
            Debug CkRest::ckLastErrorText(rest)
            CkRest::ckDispose(rest)
            CkStringBuilder::ckDispose(sbError)
            ProcedureReturn
        EndIf

        Debug "Request failed with status code " + Str(statusCode)
        Debug CkStringBuilder::ckGetAsString(sbError)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbError)
        ProcedureReturn
    EndIf

    ;  The status code is 200.  Read the response body into a Stream.  Here the stream's sink is a local
    ;  file, which is appropriate for large or binary responses.
    respStream.i = CkStream::ckCreate()
    If respStream.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStream::setCkSinkFile(respStream, "qa_output/image.png")

    ;  If the 2nd argument is 1 and the response is textual, the stream's character set is set from
    ;  the response Content-Type charset.  It has no effect for binary responses.
    bAutoSetCharset.i = 1
    success = CkRest::ckReadRespBodyStream(rest,respStream,bAutoSetCharset)
    If success = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkStringBuilder::ckDispose(sbError)
        CkStream::ckDispose(respStream)
        ProcedureReturn
    EndIf

    Debug "Response body written to the stream sink."


    CkRest::ckDispose(rest)
    CkStringBuilder::ckDispose(sbError)
    CkStream::ckDispose(respStream)


    ProcedureReturn
EndProcedure