WebSocket.extensions - サーバー側が許可する拡張機能

2017/10/04

extensionsは、WebSocketのプロパティです。ソケット通信においてサーバー側が許可する拡張機能を返すプロパティです。

概要

名前

extensions

所属

IDL

readonly attribute DOMString extensions;

仕様書

https://html.spec.whatwg.org/multipage/web-sockets.html#dom-websocket-extensions

説明

サーバー側が許可する拡張機能を文字列で返す。具体的には、WebSocketサーバーのレスポンスヘッダーにある、Sec-WebSocket-Extensionsの値です。拡張機能がない場合は空の文字列を返します。

Sec-WebSocket-Extensions: syncer

デモ

WebSocket.extensionsのデモです。「接続」のボタンをクリックして通信中に、「取得」をクリックしてみて下さい。ただし、デモのサーバーに拡張機能はないため、空の文字列が返ります。

<!-- このコードは編集できます。 -->

<!DOCTYPE html>
<html>
<head>
<style>
	div#result { white-space: pre-wrap }
</style>
</head>
<body>
	<p>
		<button id="hoge">接続</button>
		<button id="fuga">切断</button>
		<button id="piyo">取得</button>
	</p>
<hr>
	<div id="result"></div>
<script>
var ws = null ;
var element1 = document.getElementById( "hoge" ) ;
var element2 = document.getElementById( "fuga" ) ;
var element3 = document.getElementById( "piyo" ) ;

// 接続
element1.onclick = function () {
	if ( ws && ws.readyState === 1 ) return false ;

	ws = new WebSocket( "wss://socket.syncer.jp/connect" ) ;

	ws.onopen = function() {
		ws.onmessage = function( message ) {
			logUpdate( message.data ) ;
		}

		ws.onclose = function() {
			logUpdate( "通信を切断しました。" ) ;
		}
	}
}

// 切断
element2.onclick = function () {
	if ( ws && ws.readyState === 1 ) ws.close() ;
}

// 取得
element3.onclick = function () {
	var value = ws.extensions ;
	logUpdate( value, true ) ;
}

var logUpdate = function ( text, noDate ) {
	var resultElement = document.getElementById( "result" ) ;
	resultElement.textContent = text + ( noDate ? "" : "(" + new Date().toLocaleString() + ")" ) + "\n" + resultElement.textContent ;
}
</script>
</body>
</html>