WebSocket.onopen - 接続を開始した時に発火するイベント
onopenは、WebSocketのイベントです。ソケット通信で接続が確立した時にopenイベントが発生し、ここに設定したコールバック関数が呼び出されます。
概要
- 名前
- onopen
- 所属
- WebSocket
- イベント
- open
- IDL
attribute EventHandler onopen; typedef EventHandlerNonNull? EventHandler; callback EventHandlerNonNull = any (Event event);
- 仕様書
- https://html.spec.whatwg.org/multipage/web-sockets.html#handler-websocket-onopen
チュートリアル
onopenでイベントを設定する例です。
var ws = new WebSocket( "wss://socket.syncer.jp/connect" ) ;
ws.onopen = function ( event ) {
console.log( event ) ;
}
Event.addEventListener()でも、同様にイベントを設定できます。
ws.addEventListener( "open", function ( event ) {
console.log( event ) ;
} ) ;
デモ
WebSocket.onopenのデモです。接続のタイミングで、メッセージが流れます。
<!-- このコードは編集できます。 -->
<!DOCTYPE html>
<html>
<head>
<style>
div#result { white-space: pre-wrap ; }
</style>
</head>
<body>
<p>
<button id="hoge">接続</button>
<button id="fuga">切断</button>
</p>
<hr>
<div id="result"></div>
<script>
var ws = null ;
var element1 = document.getElementById( "hoge" ) ;
var element2 = document.getElementById( "fuga" ) ;
// 接続
element1.onclick = function () {
if ( ws && ws.readyState === 1 ) return false ;
ws = new WebSocket( "wss://socket.syncer.jp/connect" ) ;
ws.onopen = function( event ) {
console.log( event ) ;
ws.onmessage = function( message ) {
logUpdate( message.data ) ;
}
ws.onclose = function() {
logUpdate( "通信を切断しました。" ) ;
}
}
}
// 切断
element2.onclick = function () {
if ( ws && ws.readyState === 1 ) ws.close() ;
}
var logUpdate = function ( text, noDate ) {
var resultElement = document.getElementById( "result" ) ;
resultElement.textContent = text + ( noDate ? "" : "(" + new Date().toLocaleString() + ")" ) + "\n" + resultElement.textContent ;
}
</script>
</body>
</html>
サポート状況
Chrome | Firefox | Safari | Edge | IE | Opera | iOS Safari | Android |
---|---|---|---|---|---|---|---|
● | ● 11+ | ● 5.1+ | ● | ● 10+ | ● 15+ | ● | ● 4.4+ |
関連記事
- WebSocket.onclose
- oncloseは、WebSocketのイベントです。ソケット通信で切断が完了した時にcloseイベントが発生し、ここに設定したコールバック関数が呼び出されます。
- WebSocket.OPEN
- OPENは、WebSocketの定数です。1を返します。この値は、ソケット通信の接続が確立し、通信中であることを表します。
- WebSocket.binaryType
- binaryTypeは、WebSocketのプロパティです。send()でこれからサーバーに送信する予定の、バイナリデータの種類を返すプロパティです。値を代入することで、次回以降に送信するバイナリデータの種類を指定できます。
- WebSocket.protocol
- protocolは、WebSocketのプロパティです。ソケット通信しているサーバー側が許可する、下位プロトコルの情報を返すプロパティです。