WebSocket

WebSocket オブジェクトは、サーバーへの WebSocket 接続の作成と管理、および接続上のデータの送受信に使用する API を提供します。

WebSocket を構築するには、 WebSocket() コンストラクターを使用してください。

注: この機能は Web Worker 内で利用可能です

EventTarget WebSocket

コンストラクター

WebSocket()

新しく作成された WebSocket オブジェクトを返します。

インスタンスプロパティ

WebSocket.binaryType

接続で使用されるバイナリデータ型。

WebSocket.bufferedAmount 読取専用

キューに入れられたデータのバイト数。

WebSocket.extensions 読取専用

サーバーによって選択された拡張機能。

WebSocket.protocol 読取専用

サーバーによって選択されたサブプロトコル。

WebSocket.readyState 読取専用

接続の現在の状態。

WebSocket.url 読取専用

WebSocket の絶対 URL。

インスタンスメソッド

WebSocket.close()

接続を閉じます。

WebSocket.send()

送信するデータをキューに入れます。

イベント

これらのイベントを待ち受けするには、 addEventListener() を使用するか、イベントリスナーをこのインターフェイスの onイベント名 プロパティへ代入するかします。

close

WebSocket による接続が閉じられたときに発生します。 onclose プロパティからも利用できます。

error

WebSocket による接続が、データの一部が送信できなかったなどのエラーのために閉じた時に発生します。 onerror プロパティからも利用できます。

message

WebSocket を通じてデータを受信したときに発生します。 onmessage プロパティからも利用できます。

open

WebSocket による接続が開いたときに発生します。 onopen プロパティからも利用できます。

例

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

仕様書

Specification
WebSockets Standard
# the-websocket-interface

ブラウザーの互換性

BCD tables only load in the browser

関連情報