WebSocketクライアント

サーバーとのリアルタイム双方向通信用WebSocketクライアント。

ロード

local websocket = require("websocket")

接続

基本接続

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

オプション付き

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
})

戻り値: Client, error

接続オプション

タイムアウト形式: 数値はミリ秒、文字列はGo duration形式（"5s"、"1m"）。

メッセージの送信

テキストメッセージ

local ok, err = client:send("Hello, Server!")
if err then
    return nil, err
end

-- JSONを送信
client:send(json.encode({
    type = "subscribe",
    channel = "orders"
}))

バイナリメッセージ

client:send(binary_data, websocket.BINARY)

戻り値: boolean, error

Ping

client:ping()

戻り値: boolean, error

メッセージの受信

channel()メソッドはメッセージ受信用のチャネルを返す。多重化のためにchannel.selectと連携。

基本受信

local ch = client:channel()

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

メッセージループ

local ch = client:channel()

while true do
    local msg, ok = ch:receive()
    if not ok then
        break  -- 接続がクローズ
    end

    if msg.type == "text" then
        local data = json.decode(msg.data)
        handle_message(data)
    end
end

Selectと併用

local ch = client:channel()
local timeout = time.after("30s")

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

    if r.channel == timeout then
        client:ping()  -- Keep-alive
        timeout = time.after("30s")
    else
        local data = json.decode(r.value.data)
        process(data)
    end
end

メッセージオブジェクト

接続のクローズ

-- 通常のクローズ（コード1000）
client:close()

-- コードと理由を指定
client:close(websocket.CLOSE_CODES.NORMAL, "Session ended")

-- エラークローズ
client:close(websocket.CLOSE_CODES.INTERNAL_ERROR, "Processing failed")

戻り値: boolean, error

定数

メッセージタイプ

-- 数値（送信用）
websocket.TEXT    -- 1
websocket.BINARY  -- 2

-- 文字列（受信メッセージのtypeフィールド）
websocket.TYPE_TEXT    -- "text"
websocket.TYPE_BINARY  -- "binary"
websocket.TYPE_PING    -- "ping"
websocket.TYPE_PONG    -- "pong"
websocket.TYPE_CLOSE   -- "close"

圧縮モード

websocket.COMPRESSION.DISABLED         -- 0（圧縮なし）
websocket.COMPRESSION.CONTEXT_TAKEOVER -- 1（スライディングウィンドウ）
websocket.COMPRESSION.NO_CONTEXT       -- 2（メッセージごと）

クローズコード

client:close(websocket.CLOSE_CODES.NORMAL, "Done")

例

リアルタイムチャット

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

    -- ルームに参加
    client:send(json.encode({
        type = "join",
        room = room_id
    }))

    -- メッセージループ
    local ch = client:channel()
    while true do
        local msg, ok = ch:receive()
        if not ok then break end

        local data = json.decode(msg.data)
        on_message(data)
    end

    client:close()
end

Keep-Alive付き価格ストリーム

local client = websocket.connect("wss://stream.example.com/prices")

client:send(json.encode({
    action = "subscribe",
    symbols = {"BTC-USD", "ETH-USD"}
}))

local ch = client:channel()
local heartbeat = time.after("30s")

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

    if r.channel == heartbeat then
        client:ping()
        heartbeat = time.after("30s")
    elseif not r.ok then
        break  -- 接続がクローズ
    else
        local price = json.decode(r.value.data)
        update_price(price.symbol, price.value)
    end
end

client:close()

権限

WebSocket接続はセキュリティポリシー評価の対象。

セキュリティアクション

ポリシー設定についてはセキュリティモデルを参照。

エラー

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

エラーの処理についてはエラー処理を参照。