AutoIt

Send and Receive WebSocket Messages

See more WebSocket Examples

This example how to send and receive websocket messages.

A WebSocket message can be composed of one or more frames. The simple case is where a single frame is both the first and last frame in a message. This is the case where the 1st frame in the message has the "final frame" bit set.

This example demonstrates sending and receiving multi-frame messages.

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.

AutoIt

Local $bSuccess = False

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

$oWs = ObjCreate("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.

$oRest = ObjCreate("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.
$bSuccess = $oRest.Connect("websockets.chilkat.io",80,False,False)
$oWs.UseConnection($oRest)
$oWs.AddClientHeaders()
Local $sResponseBodyIgnored = $oRest.FullRequestNoBody("GET","/wsChilkatEcho.ashx")
$bSuccess = $oWs.ValidateServerHandshake()
If ($bSuccess <> True) Then
    ConsoleWrite($oWs.LastErrorText & @CRLF)
    Exit
EndIf

; This example demonstrates sending and receiving a multi-frame message.

; The websocket message will be composed of three text lines, each frame will contain a single line.

; Send the 1st frame in the message.
Local $bFinalFrame = False
$bSuccess = $oWs.SendFrame("This is the 1st frame" & @CRLF,$bFinalFrame)
If ($bSuccess <> True) Then
    ConsoleWrite($oWs.LastErrorText & @CRLF)
    Exit
EndIf

; Send the 2nd frame in the message.
$bSuccess = $oWs.SendFrame("This is the 2nd frame" & @CRLF,$bFinalFrame)
If ($bSuccess <> True) Then
    ConsoleWrite($oWs.LastErrorText & @CRLF)
    Exit
EndIf

; Send the 3rd and final frame in the message.
$bFinalFrame = True
$bSuccess = $oWs.SendFrame("This is the 3rd frame" & @CRLF,$bFinalFrame)
If ($bSuccess <> True) Then
    ConsoleWrite($oWs.LastErrorText & @CRLF)
    Exit
EndIf

; Read an incoming frames until we receive the final frame.
; Note: It may be that the echo server (websockets.chilkat.io) responds with 
; the full message in a single final frame.
Local $bReceivedFinalFrame = False
While $bReceivedFinalFrame = False

    $bSuccess = $oWs.ReadFrame()
    If ($bSuccess <> True) Then
        ConsoleWrite("Failed to receive a frame" & @CRLF)
        ConsoleWrite("ReadFrame fail reason = " & $oWs.ReadFrameFailReason & @CRLF)
        ConsoleWrite($oWs.LastErrorText & @CRLF)
        Exit
    EndIf

    $bReceivedFinalFrame = $oWs.FinalFrame

    ; Show the opcode and final frame bit for the frame just received:
    ConsoleWrite("Frame opcode: " & $oWs.FrameOpcode & @CRLF)
    ConsoleWrite("Final frame: " & $bReceivedFinalFrame & @CRLF)
Wend

; Return the message accumulated in the above calls to ReadFrame.
Local $sReceivedMsg = $oWs.GetFrameData()
ConsoleWrite("Received: " & $sReceivedMsg & @CRLF)

; Close the websocket connection.
$bSuccess = $oWs.SendClose(True,1000,"Closing this websocket.")
If ($bSuccess <> True) Then
    ConsoleWrite($oWs.LastErrorText & @CRLF)
    Exit
EndIf

; Read the Close response.
$bSuccess = $oWs.ReadFrame()
If ($bSuccess <> True) Then
    ConsoleWrite("ReadFrame fail reason = " & $oWs.ReadFrameFailReason & @CRLF)
    ConsoleWrite($oWs.LastErrorText & @CRLF)
    Exit
EndIf

; Should receive the "Close" opcode.
ConsoleWrite("Received opcode: " & $oWs.FrameOpcode & @CRLF)
; Should be the same status code we sent (1000)
ConsoleWrite("Received close status code: " & $oWs.CloseStatusCode & @CRLF)
; The server may echo the close reason.  If not, this will be empty.
ConsoleWrite("Echoed close reason: " & $oWs.CloseReason & @CRLF)

ConsoleWrite("Success." & @CRLF)