(Xojo Plugin) Asynchronous Sockets - Reading/Writing Data

Demonstrates the following using async methods:

Demonstrates receiving text on a socket connection up to and including when an expected CRLF arrives. The example sends an HTTP HEAD request to an HTTP server and then reads the response header using ReceiveToCRLF and ReceiveUntilMatch.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim socket As New Chilkat.Socket

// Connect using TLS to www.chilkatsoft.com
// We could also use a normal TCP connection also by specifying port 80 with useTls = False.
Dim useTls As Boolean
useTls = True
Dim maxWaitMillisec As Int32
maxWaitMillisec = 20000
Dim connectTask As Chilkat.Task
connectTask = socket.ConnectAsync("www.chilkatsoft.com",443,useTls,maxWaitMillisec)
If (socket.LastMethodSuccess <> True) Then
    System.DebugLog(socket.LastErrorText)
    Return
End If

// Schedule the task for running on the thread pool.  This changes the task's state
// from Inert to Live.
Dim success As Boolean
success = connectTask.Run()
If (success <> True) Then
    System.DebugLog(connectTask.LastErrorText)

    Return
End If

// The application is now free to do anything else.
// For programming languages where Chilkat supports events, a TaskCompleted
// event will fire when the task is completed.

// For this example, we'll simply sleep and periodically
// check to see when the connection is ready.
While connectTask.Finished <> True

    // Sleep 10 ms.
    connectTask.SleepMs 10

Wend

// A finished task could be one that was canceled, aborted, or truly finished.  

// If the task was "canceled", it was canceled prior to actually starting.  This could
// happen if the task was canceled while waiting in a thread pool queue to be scheduled by Chilkat's
// background thread pool scheduler.  

// If the task was "aborted", it indicates that it was canceled while running in a background thread.  
// The ResultErrorText will likely indicate that the task was aborted.

// If the task "completed", then it ran to completion, but the actual success/failure of the method
// is determined by the result obtained via a GetResult* method.  (A "completed" task will
// have a StatusInt equal to 7.   If the task finished, but was not completed, then it must've
// been aborted or canceled:
If (connectTask.StatusInt <> 7) Then
    System.DebugLog("Task did not complete.")
    System.DebugLog("task status: " + connectTask.Status)

    Return
End If

Dim connectSuccess As Boolean
connectSuccess = connectTask.GetResultBool()
If (connectSuccess <> True) Then
    System.DebugLog("Connect failed.")
    System.DebugLog(connectTask.ResultErrorText)

    Return
End If

// Tell the socket object that all text is to be sent in the utf-8 encoding,
// and the text received is assumed to be utf-8.
socket.StringCharset = "utf-8"

// Send an HTTP HEAD request:
Dim sendTask As Chilkat.Task
sendTask = socket.SendStringAsync("HEAD / HTTP/1.1" + EndOfLine.Windows + "Host: www.chilkatsoft.com" + EndOfLine.Windows + EndOfLine.Windows)
If (socket.LastMethodSuccess <> True) Then
    System.DebugLog(socket.LastErrorText)
    Return
End If

success = sendTask.Run()
If (success <> True) Then
    System.DebugLog(sendTask.LastErrorText)

    Return
End If

// The application is now free to do anything else.
// For programming languages where Chilkat supports events, 
// a TaskCompleted event will fire when the task is completed.
// This example will simply wait until the task completes...
While sendTask.Finished <> True
    // Sleep 10 ms.
    sendTask.SleepMs 10
Wend
If (sendTask.StatusInt <> 7) Then
    System.DebugLog("Task did not complete.")
    System.DebugLog("task status: " + sendTask.Status)

    Return
End If

Dim sendSuccess As Boolean
sendSuccess = sendTask.GetResultBool()
If (sendSuccess <> True) Then
    System.DebugLog("Send failed.")
    System.DebugLog(sendTask.ResultErrorText)

    Return
End If

// Wait a maximum of 4 seconds while no data is forthcoming:
socket.MaxReadIdleMs = 4000

// To explain MaxReadIdleMs further:  In Chilkat, a max "idle timeout" is the max time to wait
// while no additional data arrives on the socket.  Imagine if 10MB of data will be received
// where the 1st CRLF occurs at the very end.  As long as the data continues arriving and does not
// halt for more than 4000ms, then the ReceiveToCRLF will continue receiving.  It is only after
// the connection becomes idle for more than 4000ms that the app will giveup and fail the read.

// Get the 1st response line, which should be "HTTP/1.1 200 OK"
Dim receiveTask As Chilkat.Task
receiveTask = socket.ReceiveToCRLFAsync()
If (socket.LastMethodSuccess <> True) Then
    System.DebugLog(socket.LastErrorText)
    Return
End If

success = receiveTask.Run()
If (success <> True) Then
    System.DebugLog(receiveTask.LastErrorText)

    Return
End If

// The application is now free to do anything else.
// For programming languages where Chilkat supports events, 
// a TaskCompleted event will fire when the task is completed.
// This example will simply wait until the task completes...
While receiveTask.Finished <> True
    // Sleep 10 ms.
    receiveTask.SleepMs 10
Wend
If (receiveTask.StatusInt <> 7) Then
    System.DebugLog("Task did not complete.")
    System.DebugLog("task status: " + receiveTask.Status)

    Return
End If

Dim responseStatusLine As String
responseStatusLine = receiveTask.GetResultString()

System.DebugLog("StatusLine: " + responseStatusLine)

// Now get the 1st line of the response header:
Dim responseHeaderLine As String
responseHeaderLine = socket.ReceiveToCRLF()
If (socket.LastMethodSuccess <> True) Then
    System.DebugLog(socket.LastErrorText)
    Return
End If

System.DebugLog("HeaderLine: " + responseHeaderLine)

// Now read the remainder of the response header by reading until a double CRLF is seen:
receiveTask = socket.ReceiveUntilMatchAsync(EndOfLine.Windows + EndOfLine.Windows)
If (socket.LastMethodSuccess <> True) Then
    System.DebugLog(socket.LastErrorText)
    Return
End If

success = receiveTask.Run()
If (success <> True) Then
    System.DebugLog(receiveTask.LastErrorText)

    Return
End If

// The application is now free to do anything else.
// For programming languages where Chilkat supports events, 
// a TaskCompleted event will fire when the task is completed.
// This example will simply wait until the task completes...
While receiveTask.Finished <> True
    // Sleep 10 ms.
    receiveTask.SleepMs 10
Wend
If (receiveTask.StatusInt <> 7) Then
    System.DebugLog("Task did not complete.")
    System.DebugLog("task status: " + receiveTask.Status)

    Return
End If

Dim remainderOfHeader As String
remainderOfHeader = receiveTask.GetResultString()

System.DebugLog("Remainder: " + remainderOfHeader)

// Close the connection with the server
// Wait a max of 20 seconds (20000 millsec)
success = socket.Close(20000)