WebSocket
オブジェクトは、サーバーへの WebSocket 接続の作成と管理、および接続上のデータの送受信に使用する API を提供します。
WebSocket
を構築するには、 WebSocket()
コンストラクターを使用してください。
コンストラクター
WebSocket(url[, protocols])
- 新しく作成された
WebSocket
オブジェクトを返します。
定数
定数 | 値 |
WebSocket.CONNECTING |
0 |
WebSocket.OPEN |
1 |
WebSocket.CLOSING |
2 |
WebSocket.CLOSED |
3 |
プロパティ
WebSocket.binaryType
- 接続で使用されるバイナリデータ型。
WebSocket.bufferedAmount
読取専用- キューに入れられたデータのバイト数。
WebSocket.extensions
読取専用- サーバーによって選択された拡張機能。
WebSocket.onclose
- 接続が閉じられたときに呼び出されるイベントリスナー。
WebSocket.onerror
- エラーが発生したときに呼び出されるイベントリスナー。
WebSocket.onmessage
- サーバーからメッセージを受信したときに呼び出されるイベントリスナー。
WebSocket.onopen
- 接続が開かれたときに呼び出されるイベントリスナー。
WebSocket.protocol
読取専用- サーバーによって選択されたサブプロトコル。
WebSocket.readyState
読取専用- 接続の現在の状態。
WebSocket.url
読取専用- WebSocket の絶対 URL。
メソッド
WebSocket.close([code[, reason]])
- 接続を閉じます。
WebSocket.send(data)
- 送信するデータをキューに入れます。
イベント
これらのイベントを待ち受けするには、 addEventListener()
を使用するか、イベントリスナーをこのインターフェイスの oneventname
プロパティへ代入します。
例
// WebSocket 接続を作成
const socket = new WebSocket('ws://localhost:8080');
// 接続が開いたときのイベント
socket.addEventListener('open', function (event) {
socket.send('Hello Server!');
});
// メッセージの待ち受け
socket.addEventListener('message', function (event) {
console.log('Message from server ', event.data);
});
仕様書
仕様書 | 状態 |
---|---|
HTML Living Standard WebSocket の定義 |
現行の標準 |
ブラウザーの互換性
BCD tables only load in the browser
このページの互換性一覧表は構造化データから生成されています。データに協力していただけるのであれば、 https://github.com/mdn/browser-compat-data をチェックアウトしてプルリクエストを送信してください。