(Excel) WebSocket Send/Receive Binary Data

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.

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim ws As Chilkat.WebSocket
Set ws = Chilkat.NewWebSocket

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

Dim rest As Chilkat.Rest
Set rest = Chilkat.NewRest
' 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,False,False)
success = ws.UseConnection(rest)
success = ws.AddClientHeaders()

responseBodyIgnored = rest.FullRequestNoBody("GET","/wsChilkatEcho.ashx")
success = ws.ValidateServerHandshake()
If (success <> True) Then
    Debug.Print ws.LastErrorText
    Exit Sub
End If

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

Debug.Print "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 = True
success = ws.SendFrameBd(jpgData,finalFrame)
If (success <> True) Then
    Debug.Print ws.LastErrorText
    Exit Sub
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 = False
Do While receivedFinalFrame = False

    ' 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 <> True) Then
        Debug.Print "Failed to receive a frame"
        Debug.Print "ReadFrame fail reason = "; ws.ReadFrameFailReason
        Debug.Print ws.LastErrorText
        Exit Sub
    End If

    receivedFinalFrame = ws.FinalFrame

    ' Show the opcode and final frame bit for the frame just received:
    Debug.Print "Frame opcode: "; ws.FrameOpcode
    Debug.Print "Final frame: "; receivedFinalFrame
Loop

' Get the accumulated received data.
Dim jpgReceivedData As Chilkat.BinData
Set jpgReceivedData = Chilkat.NewBinData
success = ws.GetFrameDataBd(jpgReceivedData)
Debug.Print "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(True,1000,"Closing this websocket.")
If (success <> True) Then
    Debug.Print ws.LastErrorText
    Exit Sub
End If

' Read the Close response.
success = ws.ReadFrame()
If (success <> True) Then
    Debug.Print "ReadFrame fail reason = "; ws.ReadFrameFailReason
    Debug.Print ws.LastErrorText
    Exit Sub
End If

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

Debug.Print "Success."