VBScript

WebSocket Send/Receive Binary Data

See more WebSocket Examples

Demonstrates how to send and receive binary data on a websocket. This example uses Chilkat's websocket test echo server at ws://websockets.chilkat.io/wsChilkatEcho.ashx

Note: The websockets.chilkat.io server imposes the following limitations:
Messages must be 16K or less, and each connection is limited to a max of 16 echoed messages.

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 ws = CreateObject("Chilkat.WebSocket")

' For brevity, this example does not check for errors when etablishing the WebSocket connection.
' See Establish WebSocket Connection for more complete sample code for making the connection.

set rest = CreateObject("Chilkat.Rest")
' Connect to websockets.chilkat.io
' IMPORTANT: websockets.chilkat.io accepts frames of up to 16K in size and echoes them back.
' IMPORTANT: The websockets.chilkat.io server imposes the following limitations: 
' ---------- Messages must be 16K or less, and each connection is limited to a max of 16 echoed messages.
success = rest.Connect("websockets.chilkat.io",80,0,0)
success = ws.UseConnection(rest)
success = ws.AddClientHeaders()
responseBodyIgnored = rest.FullRequestNoBody("GET","/wsChilkatEcho.ashx")
success = ws.ValidateServerHandshake()
If (success <> 1) Then
    outFile.WriteLine(ws.LastErrorText)
    WScript.Quit
End If

' This example sends a small JPG file (about 7KB) in a websocket frame.
set jpgData = CreateObject("Chilkat.BinData")
success = jpgData.LoadFile("qa_data/jpg/starfish.jpg")

outFile.WriteLine("Number of bytes to send = " & jpgData.NumBytes)

' Send a frame containing the JPG image data.
' This will be the first and final frame, and therefore this constitutes the entire message.
finalFrame = 1
success = ws.SendFrameBd(jpgData,finalFrame)
If (success <> 1) Then
    outFile.WriteLine(ws.LastErrorText)
    WScript.Quit
End If

' Read the echoed binary frame(s).
' (We sent the JPG file in a single frame, but we may receive the echo in multiple frames, but it will be one message.)
' Read an incoming frames until we receive the final frame.
receivedFinalFrame = 0
Do While receivedFinalFrame = 0

    ' The ws object is accumulating the received data internally.  Once we get the final frame, we'll get the 
    ' accumulated data which should constitute the entire JPG.
    success = ws.ReadFrame()
    If (success <> 1) Then
        outFile.WriteLine("Failed to receive a frame")
        outFile.WriteLine("ReadFrame fail reason = " & ws.ReadFrameFailReason)
        outFile.WriteLine(ws.LastErrorText)
        WScript.Quit
    End If

    receivedFinalFrame = ws.FinalFrame

    ' Show the opcode and final frame bit for the frame just received:
    outFile.WriteLine("Frame opcode: " & ws.FrameOpcode)
    outFile.WriteLine("Final frame: " & receivedFinalFrame)
Loop

' Get the accumulated received data.
set jpgReceivedData = CreateObject("Chilkat.BinData")
success = ws.GetFrameDataBd(jpgReceivedData)
outFile.WriteLine("Received " & jpgReceivedData.NumBytes & " bytes")

' Save the received JPG to a file so we can check it..
success = jpgReceivedData.WriteFile("qa_output/starfish_ws.jpg")

' Close the websocket connection.
success = ws.SendClose(1,1000,"Closing this websocket.")
If (success <> 1) Then
    outFile.WriteLine(ws.LastErrorText)
    WScript.Quit
End If

' Read the Close response.
success = ws.ReadFrame()
If (success <> 1) Then
    outFile.WriteLine("ReadFrame fail reason = " & ws.ReadFrameFailReason)
    outFile.WriteLine(ws.LastErrorText)
    WScript.Quit
End If

' Should receive the "Close" opcode.
outFile.WriteLine("Received opcode: " & ws.FrameOpcode)
' Should be the same status code we sent (1000)
outFile.WriteLine("Received close status code: " & ws.CloseStatusCode)
' The server may echo the close reason.  If not, this will be empty.
outFile.WriteLine("Echoed close reason: " & ws.CloseReason)

outFile.WriteLine("Success.")

outFile.Close