Cliente WebSocket

El módulo websocket crea conexiones cliente bidireccionales con servidores WebSocket.

Esta referencia contiene recetas parciales de conexión y suscripción. Las URLs, tokens, handlers y datos proceden de la aplicación. Los ejemplos de ciclo de vida cierran el cliente en cada salida terminal o error comprobado; los fragmentos pequeños presuponen que un propietario circundante realiza esa limpieza.

Carga

local websocket = require("websocket")

Añade websocket a modules: antes de requerirlo. El global channel siempre está disponible; las recetas de JSON y timeout también requieren json y time.

Conexión

connect

local client, err = websocket.connect("wss://api.example.com/ws")
if err then
    return nil, err
end

Pasa una tabla de opciones para configurar la conexión:

local client, err = websocket.connect("wss://api.example.com/ws", {
    headers = {
        ["Authorization"] = "Bearer " .. token
    },
    protocols = {"graphql-ws"},
    dial_timeout = "10s",
    read_timeout = "30s",
    compression = websocket.COMPRESSION.CONTEXT_TAKEOVER
})
if err then
    return nil, err
end

Devuelve: Client, error

Opciones de conexión

Formato de timeout: Los números son milisegundos; los strings usan duración Go, como "5s" o "1m". Los strings no válidos y valores no compatibles se ignoran y conservan el default.

Enviar Mensajes

Mensajes de texto

client:send("Hello, Server!")

client:send("Hello, Server!")

-- Send JSON
local payload, encode_err = json.encode({
    type = "subscribe",
    channel = "orders"
})
if encode_err then return nil, encode_err end
client:send(payload)

Mensajes binarios

Envíe un mensaje binario indicando websocket.BINARY.

client:send(binary_data, websocket.BINARY)

Cede hasta que el mensaje se envía. No devuelve valores.

Ping

client:ping()

Cede hasta que el ping se envía. No devuelve valores.

Recibir Mensajes

channel() devuelve el canal de recepción y receive() es un alias. La primera llamada hace yield mientras se crea la suscripción; después devuelve el mismo canal. Un fallo devuelve nil, error. Puede usarse con channel.select.

Recepcion Basica

local ch, err = client:channel()
if err then
    client:close()
    return nil, err
end

local msg, ok = ch:receive()
if ok then
    print("Type:", msg.type)  -- "text" or "binary"
    print("Data:", msg.data)
end

local _, close_err = client:close()
if close_err then return nil, close_err end

Bucle de Mensajes

local json = require("json")

local ch, err = client:channel()
if err then
    client:close()
    return nil, err
end

while true do
    local msg, ok = ch:receive()
    if not ok then
        break  -- Connection closed
    end

    if msg.type == "text" then
        local data, decode_err = json.decode(msg.data)
        if decode_err then
            client:close()
            return nil, decode_err
        end
        handle_message(data)
    end
end

local _, close_err = client:close()
if close_err then return nil, close_err end

Con selección :id=con-select

local json = require("json")
local time = require("time")

local ch, ch_err = client:channel()
if ch_err then
    client:close()
    return nil, ch_err
end

local timeout, timeout_err = time.after("30s")
if timeout_err then
    client:close()
    return nil, timeout_err
end

while true do
    local r = channel.select {
        ch:case_receive(),
        timeout:case_receive()
    }

    if r.channel == timeout then
        client:ping()  -- Keep-alive
        timeout, timeout_err = time.after("30s")
        if timeout_err then
            client:close()
            return nil, timeout_err
        end
    elseif not r.ok then
        break
    else
        local data, decode_err = json.decode(r.value.data)
        if decode_err then
            client:close()
            return nil, decode_err
        end
        process(data)
    end
end

local _, close_err = client:close()
if close_err then return nil, close_err end

Objeto Message

Cerrar Conexión

local _, close_err = client:close(websocket.CLOSE_CODES.NORMAL, "Session ended")
if close_err then return nil, close_err end

-- Omitting both arguments also uses normal close code 1000.
-- Use INTERNAL_ERROR with an application-owned reason for a failed session.

Cede hasta que se envía el frame de cierre.

Constantes

Tipos de Mensaje

-- Numeric (for send)
websocket.TEXT    -- 1
websocket.BINARY  -- 2

-- Compatibility string constants
websocket.TYPE_TEXT    -- "text"
websocket.TYPE_BINARY  -- "binary"
websocket.TYPE_PING    -- "ping"
websocket.TYPE_PONG    -- "pong"
websocket.TYPE_CLOSE   -- "close"

Los mensajes recibidos solo usan "text" y "binary". El transporte maneja ping y pong, y un evento terminal cierra el canal sin producir un mensaje "close".

Modos de Compresion

websocket.COMPRESSION.DISABLED         -- 0 (no compression)
websocket.COMPRESSION.CONTEXT_TAKEOVER -- 1 (sliding window)
websocket.COMPRESSION.NO_CONTEXT       -- 2 (per-message)

Codigos de Cierre

local _, close_err = client:close(websocket.CLOSE_CODES.NORMAL, "Done")
if close_err then return nil, close_err end

Ejemplos

Chat en Tiempo Real

local json = require("json")

local function connect_chat(room_id, token, on_message)
    local client, err = websocket.connect("wss://chat.example.com/ws", {
        headers = {["Authorization"] = "Bearer " .. token}
    })
    if err then
        return nil, err
    end

    -- Join room. Runtime v0.3.32a does not expose transport send failures.
    local join_payload, encode_err = json.encode({
        type = "join",
        room = room_id
    })
    if encode_err then
        client:close()
        return nil, encode_err
    end
    client:send(join_payload)

    -- Message loop
    local ch, channel_err = client:channel()
    if channel_err then
        client:close()
        return nil, channel_err
    end
    while true do
        local msg, ok = ch:receive()
        if not ok then break end

        local data, decode_err = json.decode(msg.data)
        if decode_err then
            client:close()
            return nil, decode_err
        end
        on_message(data)
    end

    local _, close_err = client:close()
    if close_err then return nil, close_err end
    return true
end

Stream de Precios con Keep-Alive

local json = require("json")
local time = require("time")

local client, err = websocket.connect("wss://stream.example.com/prices")
if err then
    return nil, err
end

local subscribe_payload, encode_err = json.encode({
    action = "subscribe",
    symbols = {"BTC-USD", "ETH-USD"}
})
if encode_err then
    client:close()
    return nil, encode_err
end
client:send(subscribe_payload)

local ch, channel_err = client:channel()
if channel_err then
    client:close()
    return nil, channel_err
end

local heartbeat, heartbeat_err = time.after("30s")
if heartbeat_err then
    client:close()
    return nil, heartbeat_err
end

while true do
    local r = channel.select {
        ch:case_receive(),
        heartbeat:case_receive()
    }

    if r.channel == heartbeat then
        client:ping()
        heartbeat, heartbeat_err = time.after("30s")
        if heartbeat_err then
            client:close()
            return nil, heartbeat_err
        end
    elseif not r.ok then
        break  -- Connection closed
    else
        local price, decode_err = json.decode(r.value.data)
        if decode_err then
            client:close()
            return nil, decode_err
        end
        update_price(price.symbol, price.value)
    end
end

local _, close_err = client:close()
if close_err then return nil, close_err end

Permisos

Las conexiones WebSocket estan sujetas a evaluacion de politica de seguridad.

Acciones de Seguridad

Consulta Modelo de seguridad para configurar políticas.

Errores

Una URL vacía, opciones que no sean una tabla, tipos de argumentos no válidos y la falta de contexto o PID al pedir el canal lanzan errores Lua, no errores estructurados. El entorno de ejecución v0.3.32a no expone a Lua los fallos de transporte de send o ping.

local client, err = websocket.connect(url)
if err then
    if errors.is(err, errors.PERMISSION_DENIED) then
        print("Access denied:", err:message())
    elseif err:retryable() then
        print("Temporary error:", err:message())
    end
    return nil, err
end

Consulta Manejo de errores para trabajar con errores.