WebSocket
@senrijs/senri/websocket の upgradeWebSocket() で、WebSocket のルートを書く
import { } from "@senrijs/senri";
import { } from "@senrijs/senri/websocket";
const = ();
.(
"/chat",
(() => ({
() {
.(`hello ${.("name")}`);
},
(, ) {
.(); // data: 文字は string、バイナリは Uint8Array
},
(, , ) {},
(, ) {}, // ほかのハンドラーが投げたものも、ここに届く
})),
);ルートの書き方は、どのランタイムでも同じです。
ランタイムごとに要るもの
| ランタイム | 要るもの | 1 つのメッセージの上限 |
|---|---|---|
| Bun | serve() なら何も要らない。Bun.serve を自分で呼ぶときは websocket を渡す(Bun) | 16 MiB(Bun の既定) |
| Deno | 何も要らない | Deno の既定 |
| Node.js | ws パッケージを入れて、serve() に渡す(下の例) | ws の maxPayload(既定は 100 MiB なので、必ず付ける) |
| Cloudflare Workers | 何も要らない | 1 MiB(Workers の上限) |
| ブラウザ(Service Worker) | 使えない(501) |
import { } from "ws";
import { } from "@senrijs/senri/serve"; // @senrijs/senri/node の serve() でも同じ
await (, { : new ({ : true, : 1024 * 1024 }) });Node.js では、Senri は WebSocket のフレームを自分では読まず、実績のある ws に任せます(Senri の依存は増えません)。
webSocketServerを渡していないと、WebSocket のルートは 500 です(開発モードでは渡し方を出します)- 開発モードで、渡した
WebSocketServerのmaxPayloadがwsの既定(100 MiB)のままなら、起動するときに注意を出します
守っていること
- よそのサイトのページからの接続は、既定で 403 にします(Cross-Site WebSocket Hijacking の対策)。
OriginのホストがHostと同じときだけ通します。ほかのオリジンはupgradeWebSocket(create, { origin: ["https://app.example.com"] })で足します。Originのない接続(ブラウザ以外)は通します - ミドルウェアは、ふつうのリクエストと同じに動きます。認証のミドルウェアが 401 を返せば、upgrade しません
Upgrade: websocketのないリクエストは 426 です
サブプロトコル(Sec-WebSocket-Protocol)の取り決めと、圧縮(permessage-deflate)の設定は、まだありません。
オプション
名前
型