PowerBuilder

WebSocket over TLS

See more WebSocket Examples

Establishing a WebSocket connection over TLS is exactly the same as for TCP, except for a few arguments passed to the Connect method. PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Rest
integer li_BUseTls
oleobject loo_Ws
string ls_ResponseBody
integer li_StatusCode

li_Success = 0

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

// --------------------------------------------------
// A WebSocket connection begins life as an HTTP GET request containing a few special header fields,
// such as "Upgrade: websocket".   

// Your application will use the Chilkat Rest class to send the initial HTTP GET.  This allows you
// to use the full capability of the Chilkat Rest class to customize the GET for any particular situation.
// For example:
// 
//   - If custom HTTP request header fields must be added.
//   - If authentication is required, such as OAuth2, OAuth1, Basic HTTP Auth, etc.
//   - If HTTPS, SSH Tunneling, Proxies (HTTP or SOCKS), or other advanced connection or TLS features are required.
// 

loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if
// ------------------------------------------------------------------
// To use TLS, connect to the TLS port (typically 443) and tell the rest.Connect method
// that it's a TLS connection.
// ------------------------------------------------------------------
li_BUseTls = 1
li_Success = loo_Rest.Connect("someserver.com",443,li_BUseTls,0)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    return
end if

loo_Ws = create oleobject
li_rc = loo_Ws.ConnectToNewObject("Chilkat.WebSocket")

// Tell the WebSocket to use this connection.
li_Success = loo_Ws.UseConnection(loo_Rest)
if li_Success <> 1 then
    Write-Debug loo_Ws.LastErrorText
    destroy loo_Rest
    destroy loo_Ws
    return
end if

// Add the standard WebSocket open handshake headers that will be needed.
// (This adds the required HTTP request headers to the rest object.)
loo_Ws.AddClientHeaders()

// Add any additional headers that might be desired.
// Two common WebSocketSpecific headers are "Sec-WebSocket-Protocol" and "Origin".
loo_Rest.AddHeader("Sec-WebSocket-Protocol","x-something")
loo_Rest.AddHeader("Origin","http://someserver.com")

// Do the open handshake.
ls_ResponseBody = loo_Rest.FullRequestNoBody("GET","/something")
if loo_Rest.LastMethodSuccess <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_Ws
    return
end if

// If successful, the HTTP response status code should be 101,
// and the response body will be empty. (If it failed, we'll have a look
// at the response body..)
li_StatusCode = loo_Rest.ResponseStatusCode
Write-Debug "Response status code: " + string(li_StatusCode)

if li_StatusCode <> 101 then
    Write-Debug ls_ResponseBody
    Write-Debug "-- Failed because of unexpected response status code."
    destroy loo_Rest
    destroy loo_Ws
    return
end if

// We have the expected 101 response, so let's now validate the 
// contents of the response, such as the value sent by the server in the
// Sec-WebSocket-Accept header. 
li_Success = loo_Ws.ValidateServerHandshake()
if li_Success <> 1 then
    Write-Debug loo_Ws.LastErrorText
    destroy loo_Rest
    destroy loo_Ws
    return
end if

Write-Debug "WebSocket connection successful."

// The application may now begin sending and receiving frames on the WebSocket connection.
// (At this point, we're done with the rest object...)


destroy loo_Rest
destroy loo_Ws