Lua

WebSocket Connect

See more WebSocket Examples

Demonstrates how to establish a WebSocket connection. Once the connection is established, messages may be sent back-and-forth. Messages are sent in frames, where the last frame in the message is indicated by a "final" bit. A frame constitutes the entire message if the first frame sent has the "final" bit sent. (In most cases, you'll probably be sending single-frame messages.) Lua

local chilkat = require("chilkat")

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

local rest = chilkat.Rest.new()
local success = rest:connect("someserver.com", 80, false, false)
if not success then
    print(rest.last_error_text)
    return
end

local ws = chilkat.WebSocket.new()

-- Tell the WebSocket to use this connection.
success = ws:use_connection(rest)
if not success then
    print(ws.last_error_text)
    return
end

-- Add the standard WebSocket open handshake headers that will be needed.
-- (This adds the required HTTP request headers to the rest object.)
ws:add_client_headers()

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

-- Do the open handshake.
local responseBody = rest:full_request_no_body("GET", "/something")
if not rest.last_method_success then
    print(rest.last_error_text)
    return
end

-- 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..)
local statusCode = rest.response_status_code
print("Response status code: " .. statusCode)

if statusCode ~= 101 then
    print(responseBody)
    print("-- Failed because of unexpected response status code.")
    return
end

-- 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.
success = ws:validate_server_handshake()
if not success then
    print(ws.last_error_text)
    return
end

print("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...)