Xojo Plugin

Send a Staged REST Request with a Streamed Body

Demonstrates Rest.SendReqStreamBody, which sends a request whose body is read from a Stream, 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 Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

Dim rest As New Chilkat.Rest
Dim bTls As Boolean
bTls = True
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("example.com",443,bTls,bAutoReconnect)
If (success = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

//  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.

//  The request body is read from a Stream whose source is a local file.
Dim bodyStream As New Chilkat.Stream
bodyStream.SourceFile = "qa_data/upload.json"

success = rest.AddHeader("Content-Type","application/json")

//  Send the request, reading the body from the stream.  The 3rd argument is the Stream.
success = rest.SendReqStreamBody("POST","/api/upload",bodyStream)
If (success = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

//  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.
Dim statusCode As Int32
statusCode = rest.ReadResponseHeader()
If (statusCode < 0) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

System.DebugLog("Response status code: " + Str(statusCode))

//  Read the response body as text.
Dim responseBody As String
responseBody = rest.ReadRespBodyString()
If (rest.LastMethodSuccess = False) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

System.DebugLog(responseBody)