(Excel) Send and Receive WebSocket Frame

Demonstrates how to send a websocket text frame to a websocket echo server. 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 demonstrates sending a frame and receiving a text frame.

' Send a frame containing the string "Hello World!"
' This will be the first and final frame, and therefore this constitutes the entire message.

finalFrame = True
success = ws.SendFrame("Hello World!",finalFrame)
If (success <> True) Then
    Debug.Print ws.LastErrorText
    Exit Sub
End If

' Read an incoming frame.
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

' Show the string that was received.

receivedStr = ws.GetFrameData()
Debug.Print "Received: "; receivedStr

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