VBScript

Asynchronous Sockets - Reading/Writing Data

See more Socket/SSL/TLS Examples

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.

VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

success = 0

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

set socket = CreateObject("Chilkat.Socket")

' Connect using TLS to www.chilkatsoft.com
' We could also use a normal TCP connection also by specifying port 80 with useTls = 0.
useTls = 1
maxWaitMillisec = 20000
' connectTask is a Chilkat.Task
Set connectTask = socket.ConnectAsync("www.chilkatsoft.com",443,useTls,maxWaitMillisec)
If (socket.LastMethodSuccess <> 1) Then
    outFile.WriteLine(socket.LastErrorText)
    WScript.Quit
End If

' Schedule the task for running on the thread pool.  This changes the task's state
' from Inert to Live.
success = connectTask.Run()
If (success <> 1) Then
    outFile.WriteLine(connectTask.LastErrorText)

    WScript.Quit
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.
Do While connectTask.Finished <> 1

    ' Sleep 10 ms.
    connectTask.SleepMs 10

Loop

' 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
    outFile.WriteLine("Task did not complete.")
    outFile.WriteLine("task status: " & connectTask.Status)

    WScript.Quit
End If

connectSuccess = connectTask.GetResultBool()
If (connectSuccess <> 1) Then
    outFile.WriteLine("Connect failed.")
    outFile.WriteLine(connectTask.ResultErrorText)

    WScript.Quit
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:
' sendTask is a Chilkat.Task
Set sendTask = socket.SendStringAsync("HEAD / HTTP/1.1" & vbCrLf & "Host: www.chilkatsoft.com" & vbCrLf & vbCrLf)
If (socket.LastMethodSuccess <> 1) Then
    outFile.WriteLine(socket.LastErrorText)
    WScript.Quit
End If

success = sendTask.Run()
If (success <> 1) Then
    outFile.WriteLine(sendTask.LastErrorText)

    WScript.Quit
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...
Do While sendTask.Finished <> 1
    ' Sleep 10 ms.
    sendTask.SleepMs 10
Loop
If (sendTask.StatusInt <> 7) Then
    outFile.WriteLine("Task did not complete.")
    outFile.WriteLine("task status: " & sendTask.Status)

    WScript.Quit
End If

sendSuccess = sendTask.GetResultBool()
If (sendSuccess <> 1) Then
    outFile.WriteLine("Send failed.")
    outFile.WriteLine(sendTask.ResultErrorText)

    WScript.Quit
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"
' receiveTask is a Chilkat.Task
Set receiveTask = socket.ReceiveToCRLFAsync()
If (socket.LastMethodSuccess <> 1) Then
    outFile.WriteLine(socket.LastErrorText)
    WScript.Quit
End If

success = receiveTask.Run()
If (success <> 1) Then
    outFile.WriteLine(receiveTask.LastErrorText)

    WScript.Quit
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...
Do While receiveTask.Finished <> 1
    ' Sleep 10 ms.
    receiveTask.SleepMs 10
Loop
If (receiveTask.StatusInt <> 7) Then
    outFile.WriteLine("Task did not complete.")
    outFile.WriteLine("task status: " & receiveTask.Status)

    WScript.Quit
End If

responseStatusLine = receiveTask.GetResultString()

outFile.WriteLine("StatusLine: " & responseStatusLine)

' Now get the 1st line of the response header:
responseHeaderLine = socket.ReceiveToCRLF()
If (socket.LastMethodSuccess <> 1) Then
    outFile.WriteLine(socket.LastErrorText)
    WScript.Quit
End If

outFile.WriteLine("HeaderLine: " & responseHeaderLine)

' Now read the remainder of the response header by reading until a double CRLF is seen:
' receiveTask is a Chilkat.Task
Set receiveTask = socket.ReceiveUntilMatchAsync(vbCrLf & vbCrLf)
If (socket.LastMethodSuccess <> 1) Then
    outFile.WriteLine(socket.LastErrorText)
    WScript.Quit
End If

success = receiveTask.Run()
If (success <> 1) Then
    outFile.WriteLine(receiveTask.LastErrorText)

    WScript.Quit
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...
Do While receiveTask.Finished <> 1
    ' Sleep 10 ms.
    receiveTask.SleepMs 10
Loop
If (receiveTask.StatusInt <> 7) Then
    outFile.WriteLine("Task did not complete.")
    outFile.WriteLine("task status: " & receiveTask.Status)

    WScript.Quit
End If

remainderOfHeader = receiveTask.GetResultString()

outFile.WriteLine("Remainder: " & remainderOfHeader)

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

outFile.Close