(PowerBuilder) 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.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Ws
oleobject loo_Rest
integer li_Success
string ls_ResponseBodyIgnored
integer li_FinalFrame
string ls_ReceivedStr

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

loo_Ws = create oleobject
// Use "Chilkat_9_5_0.WebSocket" for versions of Chilkat < 10.0.0
li_rc = loo_Ws.ConnectToNewObject("Chilkat.WebSocket")
if li_rc < 0 then
    destroy loo_Ws
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

loo_Rest = create oleobject
// Use "Chilkat_9_5_0.Rest" for versions of Chilkat < 10.0.0
li_rc = loo_Rest.ConnectToNewObject("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.
li_Success = loo_Rest.Connect("websockets.chilkat.io",80,0,0)
loo_Ws.UseConnection(loo_Rest)
loo_Ws.AddClientHeaders()
ls_ResponseBodyIgnored = loo_Rest.FullRequestNoBody("GET","/wsChilkatEcho.ashx")
li_Success = loo_Ws.ValidateServerHandshake()
if li_Success <> 1 then
    Write-Debug loo_Ws.LastErrorText
    destroy loo_Ws
    destroy loo_Rest
    return
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.
li_FinalFrame = 1
li_Success = loo_Ws.SendFrame("Hello World!",li_FinalFrame)
if li_Success <> 1 then
    Write-Debug loo_Ws.LastErrorText
    destroy loo_Ws
    destroy loo_Rest
    return
end if

// Read an incoming frame.
li_Success = loo_Ws.ReadFrame()
if li_Success <> 1 then
    Write-Debug "Failed to receive a frame"
    Write-Debug "ReadFrame fail reason = " + string(loo_Ws.ReadFrameFailReason)
    Write-Debug loo_Ws.LastErrorText
    destroy loo_Ws
    destroy loo_Rest
    return
end if

// Show the string that was received.
ls_ReceivedStr = loo_Ws.GetFrameData()
Write-Debug "Received: " + ls_ReceivedStr

// Close the websocket connection.
li_Success = loo_Ws.SendClose(1,1000,"Closing this websocket.")
if li_Success <> 1 then
    Write-Debug loo_Ws.LastErrorText
    destroy loo_Ws
    destroy loo_Rest
    return
end if

// Read the Close response.
li_Success = loo_Ws.ReadFrame()
if li_Success <> 1 then
    Write-Debug "ReadFrame fail reason = " + string(loo_Ws.ReadFrameFailReason)
    Write-Debug loo_Ws.LastErrorText
    destroy loo_Ws
    destroy loo_Rest
    return
end if

// Should receive the "Close" opcode.
Write-Debug "Received opcode: " + loo_Ws.FrameOpcode
// Should be the same status code we sent (1000)
Write-Debug "Received close status code: " + string(loo_Ws.CloseStatusCode)
// The server may echo the close reason.  If not, this will be empty.
Write-Debug "Echoed close reason: " + loo_Ws.CloseReason

Write-Debug "Success."


destroy loo_Ws
destroy loo_Rest