Xbase++

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 Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oRest
LOCAL nBTls
LOCAL nBAutoReconnect
LOCAL oBdBody
LOCAL nBLoaded
LOCAL nStatusCode
LOCAL cResponseBody

nSuccess := 0

oRest := CreateObject("Chilkat.Rest")
nBTls := 1
nBAutoReconnect := 1
nSuccess := oRest:Connect("example.com", 443, nBTls, nBAutoReconnect)
IF (nSuccess == 0)
    ? oRest:LastErrorText
    oRest:destroy()
    RETURN
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.
oBdBody := CreateObject("Chilkat.BinData")
nBLoaded := oBdBody:LoadFile("qa_data/image.png")
IF (nBLoaded != 1)
    ? "Failed to load the request body file."
    oRest:destroy()
    oBdBody:destroy()
    RETURN
ENDIF

oRest:AddHeader("Content-Type", "image/png")

nSuccess := oRest:SendReqBd("PUT", "/api/images/1", oBdBody)
IF (nSuccess == 0)
    ? oRest:LastErrorText
    oRest:destroy()
    oBdBody:destroy()
    RETURN
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.
nStatusCode := oRest:ReadResponseHeader()
IF (nStatusCode < 0)
    ? oRest:LastErrorText
    oRest:destroy()
    oBdBody:destroy()
    RETURN
ENDIF

? "Response status code: " + Str(nStatusCode)

//  Read the response body as text.
cResponseBody := oRest:ReadRespBodyString()
IF (oRest:LastMethodSuccess == 0)
    ? oRest:LastErrorText
    oRest:destroy()
    oBdBody:destroy()
    RETURN
ENDIF

? cResponseBody

oRest:destroy()
oBdBody:destroy()