WebSocket API (WebSockets)

インターフェイス

WebSocket サーバーに接続し、その接続を通じてデータを送受信するための主要インターフェイス

WebSocket サーバーに接続するためのプロミスベースのインターフェイス。ストリームを使用して接続上のデータの送受信を行います。

接続が閉じた時に WebSocket オブジェクトによって送信されるイベントです。

サーバーからメッセージを受信した時に WebSocket オブジェクトによって送信されるイベント

関連 HTTP ヘッダー

WebSocket のハンドシェイクでは、HTTP ヘッダーが使用されます。

クライアントからのノンスを保持する HTTP リクエストヘッダー。 これは、WebSocket 開始時のハンドシェイクで使用され、クライアントが明示的に WebSocket を開く意図があることを確認します。 ブラウザーによって自動的に追加されます。 ブラウザーによって自動的に追加されます。

WebSocket の開くためのハンドシェイクで使用する HTTP レスポンスヘッダーで、サーバーが WebSocket 接続へのアップグレードを望んでいることを示します。 ディレクティブの値は、対応するリクエストの Sec-WebSocket-Key の値から計算されます。

リクエストで、クライアントが理解する WebSocket プロトコルのバージョンを示す HTTP ヘッダー。 レスポンスでは、リクエストされたプロトコルバージョンがサーバーで対応していない場合にのみ送信され、サーバーが対応しているバージョンが掲載されています。

リクエストでは、クライアントが対応しているサブプロトコルを推奨する順番で示す HTTP ヘッダーです。 レスポンスでは、サーバーがクライアントの環境設定から選択したサブプロトコルを示します。

リクエストでは、クライアントが対応している WebSocket 拡張機能を推奨する順番で示す HTTP ヘッダーです。 レスポンスでは、サーバーがクライアントの環境設定から選択した拡張機能です。

ガイド

• WebSocket クライアントアプリケーションを書く
• WebSocket サーバーの記述
• WebSocket サーバーを C# で書く
• WebSocket サーバーを Java で書く
• WebSocket サーバーを JavaScript (Deno) で書く
• WebSocketStream を用いてクライアントを書く

ツール

• AsyncAPI: WebSocket のようなプロトコルに基づいたイベントドリブン型アーキテクチャを記述するための仕様です。 OpenAPI 仕様で REST API を記述するのと同じように、 WebSocket ベースの API を記述するために使用することができます。 WebSocket で AsyncAPI の利用を検討すべき理由と利用する方法を紹介します。
• µWebSockets: C++11 および Node.js で書かれた可用性の高い WebSocket サーバーとクライアントの実装です。
• Socket.IO: 長いポーリングと WebSocket ベースのサードバーティ―の Node.js 用転送プロトコルです。
• SocketCluster: スケーラビリティに焦点を当てた Node.js 用の pub/sub WebSocket フレームワークです。
• WebSocket-Node: Node.js 用の WebSocket サーバー API 実装です。
• Total.js: Node.js 用の ウェブアプリケーションフレームワーク(使用例: WebSocket chat)
• SignalR: SignalR は単一のコードだけで、もし WebSockets が使用可能な場合、基盤として WebSockets を使用し、そうでない場合はほかの代替技術にフォールバックします。
• Caddy: WebSocket として任意のコマンド (stdin/stdout) を中継することができるウェブサーバーです。
• ws: Node.js のための有名な WebSocket クライアント＆サーバーライブラリーです。
• cowboy: Cowboy は高速で最新の HTTP サーバーで、 Erlang/OTP のためのものであり、 WebSocket に対応しています。
• ZeroMQ: ZeroMQ は、インプロセス、IPC、TCP、UDP、TIPC、マルチキャスト、WebSocket でメッセージを伝送する組み込み可能なネットワーキングライブラリーです。
• WebSocket King: WebSocket サーバーの開発、テスト、作業を支援するクライアントツールです。
• PHP WebSocket Server: WebSocket の wss:// または ws:// および通常ソケットの ssl://, tcp:// を介して接続を処理するために PHP で書かれたサーバーです。
• Django Channels: WebSocket（および長時間動作する非同期接続を必要とする他のプロトコル）の対応を追加する Django ライブラリーです。
• (Phoenix) Channels: Elixir Phoenix フレームワークで WebSocket を使用したスケーラブルなリアルタイム通信です。
• Phoenix LiveView: Elixir Phoenix フレームワークで WebSocket によるリアルタイムの対話型ウェブ体験です。
• Flask-SocketIO: Flask アプリケーションに、クライアントとサーバー間の低遅延な双方向通信を提供します。
• Gorilla WebSocket: Gorilla WebSocket は、WebSocket プロトコルの Go による実装です。

仕様書

ブラウザーの互換性

api.WebSocket

Enable JavaScript to view this browser compatibility table.

api.WebSocketStream

Enable JavaScript to view this browser compatibility table.

関連情報

• RFC 6455 — The WebSocket Protocol
• WebSocket API Specification
• サーバー送信イベント