PureBasic

Send a Staged REST Request with a Binary Body

Demonstrates Rest.SendReqBd, which sends a request whose binary body is read from a BinData, then reads the response in separate steps.

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 "CkRest.pb"
IncludeFile "CkBinData.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.

    ;  Send a request whose binary body is read from a BinData.
    bdBody.i = CkBinData::ckCreate()
    If bdBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    bLoaded.i = CkBinData::ckLoadFile(bdBody,"qa_data/image.png")
    If bLoaded <> 1
        Debug "Failed to load the request body file."
        CkRest::ckDispose(rest)
        CkBinData::ckDispose(bdBody)
        ProcedureReturn
    EndIf

    CkRest::ckAddHeader(rest,"Content-Type","image/png")

    success = CkRest::ckSendReqBd(rest,"PUT","/api/images/1",bdBody)
    If success = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkBinData::ckDispose(bdBody)
        ProcedureReturn
    EndIf

    ;  After sending, read the response status line and header fields.  The return value is the HTTP
    ;  status code, or -1 if no response was received.
    statusCode.i = CkRest::ckReadResponseHeader(rest)
    If statusCode < 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkBinData::ckDispose(bdBody)
        ProcedureReturn
    EndIf

    Debug "Response status code: " + Str(statusCode)

    ;  Read the response body as text.
    responseBody.s = CkRest::ckReadRespBodyString(rest)
    If CkRest::ckLastMethodSuccess(rest) = 0
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkBinData::ckDispose(bdBody)
        ProcedureReturn
    EndIf

    Debug responseBody


    CkRest::ckDispose(rest)
    CkBinData::ckDispose(bdBody)


    ProcedureReturn
EndProcedure