WebSocket-Relay

Die Middleware websocket_relay stuft eine HTTP-Verbindung auf WebSocket hoch und leitet WebSocket-Nachrichten an einen Zielprozess weiter.

Klassifikation: Protokollreferenz mit Teilrezepten zur Integration. Die Blöcke setzen einen HTTP-Server, Router, Prozess-Host, Zielprozess und Sicherheitskontext voraus. Nachrichten-Handler der Anwendung und die Bereinigung des Client-Zustands bleiben Aufgabe der Anwendung.

Funktionsweise

1. HTTP-Handler setzt X-WS-Relay-Header mit Zielprozess-PID
2. Middleware stuft die Verbindung auf WebSocket hoch
3. Relay bindet an den Zielprozess und überwacht ihn
4. Nachrichten fließen bidirektional zwischen Client und Prozess

Prozess-Semantik

WebSocket-Verbindungen sind vollständige Prozesse mit eigener PID. Sie integrieren sich in das Prozesssystem:

• Adressierbar - Jeder Prozess kann Nachrichten an eine WebSocket-PID senden
• Überwachbar - Prozesse können WebSocket-Verbindungen auf Exit-Events überwachen
• Verlinkbar - WebSocket-Verbindungen können mit anderen Prozessen verlinkt werden
• EXIT-Events - Wenn Verbindung schließt, erhalten Monitore Exit-Benachrichtigungen

-- Monitor a WebSocket connection from another process
local _, monitor_err = process.monitor(websocket_pid)
if monitor_err then return nil, monitor_err end

-- Send a message to the WebSocket client from any process.
-- The relay wraps it as {topic, data} JSON; the topic name is arbitrary.
local _, send_err = process.send(websocket_pid, "update", "hello")
if send_err then return nil, send_err end

Verbindungstransfer

Verbindungen können durch Senden einer Steuernachricht an einen anderen Prozess übertragen werden:

local _, transfer_err = process.send(websocket_pid, "ws.control", {
    target_pid = new_process_pid,
    message_topic = "ws.message"
})
if transfer_err then return nil, transfer_err end

Konfiguration

Als Post-Match-Middleware auf einem Router hinzufügen:

- name: ws_router
  kind: http.router
  meta:
    server: gateway
  prefix: /ws
  post_middleware:
    - websocket_relay
  post_options:
    wsrelay.allowed.origins: "https://app.example.com"

Handler-Setup

Der HTTP-Handler startet einen Prozess und konfiguriert das Relay:

local http = require("http")
local json = require("json")

local function handler()
    local req, req_err = http.request()
    if req_err then return nil, req_err end
    local res, res_err = http.response()
    if res_err then return nil, res_err end

    local user_id, query_err = req:query("user_id")
    if query_err then return nil, query_err end

    -- Relay konfigurieren
    res:set_header("X-WS-Relay", json.encode({
        target_pid = tostring(pid),
        message_topic = "ws.message",
        heartbeat_interval = "30s",
        metadata = {
            user_id = user_id
        }
    })
    if encode_err then
        local _, terminate_err = process.terminate(pid)
        return nil, terminate_err or encode_err
    end

    local header_err = res:set_header("X-WS-Relay", relay_config)
    if header_err then
        local _, terminate_err = process.terminate(pid)
        return nil, terminate_err or header_err
    end
end

Relay-Konfigurationsfelder

Nachrichten-Topics

Das Relay sendet diese Nachrichten an den Zielprozess:

Nachrichten empfangen

local function handler()
    local inbox = process.inbox()

    while true do
        local msg, ok = inbox:receive()
        if not ok then break end

        local topic = msg:topic()
        local from = msg:from()                -- client connection PID

        if topic == "ws.join" then
            -- Client connected — payload is {client_pid, metadata}
            local data, payload_err = msg:payload():data()
            if payload_err then return nil, payload_err end
            local client_pid = data.client_pid

        elseif topic == "ws.message" then
            -- Raw client message; from() is the client PID
            local incoming = msg:payload()
            local frame_format = incoming:get_format()     -- "text/plain" or "application/octet-stream"
            local body, payload_err = incoming:data()      -- Lua string in either case
            if payload_err then return nil, payload_err end
            -- Decode or dispatch `body` according to `frame_format` and the
            -- application's protocol.

        elseif topic == "ws.leave" then
            -- Client disconnected — payload is {client_pid, metadata}
            -- Release application state associated with `from`.
        end
    end
end

An Client senden

Nachrichten mit der Client-PID zurücksenden. Jeder Topic, den Sie wählen, wird als {topic, data} JSON verpackt und an den WebSocket weitergeleitet. Jede Server-zu-Client-Nachricht wird als einzelner WebSocket-TEXT-Frame mit dem {topic, data} JSON-Wrapper gesendet. Binäre Payloads werden base64-kodiert im data-Feld übertragen; sie werden NICHT als separate Binär-Frames gesendet.

-- Send a structured message (any topic name)
local _, send_err = process.send(client_pid, "update", {event = "update", value = 42})
if send_err then return nil, send_err end

-- Verbindung schließen (Payload ist der Schließgrund-String)
process.send(client_pid, "ws.close", "Sitzung beendet")

Die reservierten Topics vom Server zum Client sind ws.control für die Relay-Neukonfiguration und ws.close zum Schließen der Verbindung.

Broadcasting

Verfolgen Sie Client-PIDs, um Nachrichten an mehrere Clients zu senden:

local clients = {}

-- On join
clients[client_pid] = true

-- On leave
clients[client_pid] = nil

-- Broadcast
local function broadcast(message)
    for pid, _ in pairs(clients) do
        local _, send_err = process.send(pid, "broadcast", message)
        if send_err then return nil, send_err end
    end
    return true
end

Siehe auch

• Middleware – Middleware-Konfiguration
• Prozess – Prozessnachrichten
• WebSocket-Client – Ausgehende WebSocket-Verbindungen