AutoIt

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.

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 sends a small JPG file (about 7KB) in a websocket frame.
$oJpgData = ObjCreate("Chilkat.BinData")
$bSuccess = $oJpgData.LoadFile("qa_data/jpg/starfish.jpg")

ConsoleWrite("Number of bytes to send = " & $oJpgData.NumBytes & @CRLF)

; Send a frame containing the JPG image data.
; This will be the first and final frame, and therefore this constitutes the entire message.
Local $bFinalFrame = True
$bSuccess = $oWs.SendFrameBd($oJpgData,$bFinalFrame)
If ($bSuccess <> True) Then
    ConsoleWrite($oWs.LastErrorText & @CRLF)
    Exit
EndIf

; 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.
Local $bReceivedFinalFrame = False
While $bReceivedFinalFrame = 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.
    $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

; Get the accumulated received data.
$oJpgReceivedData = ObjCreate("Chilkat.BinData")
$oWs.GetFrameDataBd($oJpgReceivedData)
ConsoleWrite("Received " & $oJpgReceivedData.NumBytes & " bytes" & @CRLF)

; Save the received JPG to a file so we can check it..
$oJpgReceivedData.WriteFile("qa_output/starfish_ws.jpg")

; 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)