クラス SockJsWebSocketHandler
java.lang.ObjectSE
org.springframework.web.socket.handler.AbstractWebSocketHandler
org.springframework.web.socket.handler.TextWebSocketHandler
org.springframework.web.socket.sockjs.transport.handler.SockJsWebSocketHandler
- 実装されたすべてのインターフェース:
SubProtocolCapable
,WebSocketHandler
SockJS メッセージフレームを追加し、SockJS ハートビートメッセージを送信し、ライフサイクルイベントとメッセージをターゲット
WebSocketHandler
に委譲する WebSocketHandler
の実装。 このクラスのメソッドを使用すると、ラップされた WebSocketHandler
からの例外を伝播できます。ただし、SockJS メッセージ処理(SockJS フレームやハートビートメッセージの送信中など)に起因する例外はキャッチされ、トランスポートエラーとして処理されます。つまり、ラップされたハンドラーの handleTransportError
メソッドにルーティングされ、セッションが閉じられます。
- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev
コンストラクターのサマリー
コンストラクター説明SockJsWebSocketHandler
(SockJsServiceConfig serviceConfig, WebSocketHandler webSocketHandler, WebSocketServerSockJsSession sockJsSession) メソッドのサマリー
修飾子と型メソッド説明void
afterConnectionClosed
(WebSocketSession wsSession, CloseStatus status) WebSocket 接続がいずれかの側で閉じられた後、またはトランスポートエラーが発生した後に呼び出されます。void
afterConnectionEstablished
(WebSocketSession wsSession) WebSocket ネゴシエーションが成功し、WebSocket 接続が開かれ、使用可能な状態になった後に呼び出されます。protected SockJsServiceConfig
サポートされているサブプロトコルのリストを返します。void
handleTextMessage
(WebSocketSession wsSession, TextMessage message) void
handleTransportError
(WebSocketSession webSocketSession, ThrowableSE exception) 基礎となる WebSocket メッセージトランスポートからのエラーを処理します。クラス org.springframework.web.socket.handler.TextWebSocketHandler から継承されたメソッド
handleBinaryMessage
クラス org.springframework.web.socket.handler.AbstractWebSocketHandler から継承されたメソッド
handleMessage, handlePongMessage, supportsPartialMessages
コンストラクターの詳細
SockJsWebSocketHandler
public SockJsWebSocketHandler(SockJsServiceConfig serviceConfig, WebSocketHandler webSocketHandler, WebSocketServerSockJsSession sockJsSession)
メソッドの詳細
getSubProtocols
インターフェースからコピーされた説明:SubProtocolCapable
サポートされているサブプロトコルのリストを返します。- 次で指定:
- インターフェース
SubProtocolCapable
のgetSubProtocols
getSockJsConfig
afterConnectionEstablished
インターフェースからコピーされた説明:WebSocketHandler
WebSocket ネゴシエーションが成功し、WebSocket 接続が開かれ、使用可能な状態になった後に呼び出されます。- 次で指定:
- インターフェース
WebSocketHandler
のafterConnectionEstablished
- オーバーライド:
- クラス
AbstractWebSocketHandler
のafterConnectionEstablished
- 例外:
ExceptionSE
- このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。
handleTextMessage
- オーバーライド:
- クラス
AbstractWebSocketHandler
のhandleTextMessage
- 例外:
ExceptionSE
afterConnectionClosed
public void afterConnectionClosed(WebSocketSession wsSession, CloseStatus status) throws ExceptionSE インターフェースからコピーされた説明:WebSocketHandler
WebSocket 接続がどちらかの側で閉じられた後、または転送エラーが発生した後に呼び出されます。セッションは技術的にはまだ開いている可能性がありますが、基盤となる実装によっては、この時点でメッセージを送信することはお勧めできません。おそらく成功しません。- 次で指定:
- インターフェース
WebSocketHandler
のafterConnectionClosed
- オーバーライド:
- クラス
AbstractWebSocketHandler
のafterConnectionClosed
- 例外:
ExceptionSE
- このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。
handleTransportError
public void handleTransportError(WebSocketSession webSocketSession, ThrowableSE exception) throws ExceptionSE インターフェースからコピーされた説明:WebSocketHandler
基礎となる WebSocket メッセージトランスポートからのエラーを処理します。- 次で指定:
- インターフェース
WebSocketHandler
のhandleTransportError
- オーバーライド:
- クラス
AbstractWebSocketHandler
のhandleTransportError
- 例外:
ExceptionSE
- このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。