WebSocket
Baseline
広く利用可能
*
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2015年7月以降、すべてのブラウザーで利用可能です。
* この機能の一部は、対応レベルが異なる場合があります。
メモ: この機能はウェブワーカー内で利用可能です。
WebSocket オブジェクトは、サーバーへの WebSocket 接続の作成と管理、および接続上のデータの送受信に使用する API を提供します。
WebSocket を構築するには、 WebSocket() コンストラクターを使用してください。
メモ:
WebSocket API には背圧を適用する方法がないため、メッセージがアプリケーションの処理速度よりも速く到着すると、アプリケーションはメッセージをバッファリングすることで端末のメモリーを一杯にしたり、 CPU 使用率が 100% になって応答不能になったり、あるいはその両方になったりします。自動的に背圧を提供する代替案については、 WebSocketStream を参照してください。
コンストラクター
WebSocket()-
新しく作成された
WebSocketオブジェクトを返します。
インスタンスプロパティ
WebSocket.binaryType-
接続で使用されるバイナリデータ型。
WebSocket.bufferedAmount読取専用-
キューに入れられたデータのバイト数。
WebSocket.extensions読取専用-
サーバーによって選択された拡張機能。
WebSocket.protocol読取専用-
サーバーによって選択されたサブプロトコル。
WebSocket.readyState読取専用-
接続の現在の状態。
WebSocket.url読取専用-
WebSocket の絶対 URL。
インスタンスメソッド
WebSocket.close()-
接続を閉じます。
WebSocket.send()-
送信するデータをキューに入れます。
イベント
これらのイベントを待ち受けするには、 addEventListener() を使用するか、イベントリスナーをこのインターフェイスの onイベント名 プロパティへ代入するかします。
例
js
// WebSocket 接続を作成
const socket = new WebSocket("ws://localhost:8080");
// 接続が開いたときのイベント
socket.addEventListener("open", (event) => {
socket.send("Hello Server!");
});
// メッセージの待ち受け
socket.addEventListener("message", (event) => {
console.log("Message from server ", event.data);
});
仕様書
| 仕様書 |
|---|
| WebSockets # the-websocket-interface |