クラス AbstractWebSocketHandler
java.lang.ObjectSE
org.springframework.web.socket.handler.AbstractWebSocketHandler
- 実装されたすべてのインターフェース:
WebSocketHandler
- 既知の直属サブクラス
BinaryWebSocketHandler
,TextWebSocketHandler
空のメソッドを使用した
WebSocketHandler
実装の便利な基本クラス。- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev, Phillip Webb
コンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明void
afterConnectionClosed
(WebSocketSession session, CloseStatus status) WebSocket 接続がいずれかの側で閉じられた後、またはトランスポートエラーが発生した後に呼び出されます。void
WebSocket ネゴシエーションが成功し、WebSocket 接続が開かれ、使用可能な状態になった後に呼び出されます。protected void
handleBinaryMessage
(WebSocketSession session, BinaryMessage message) void
handleMessage
(WebSocketSession session, WebSocketMessage<?> message) 新しい WebSocket メッセージが到着すると呼び出されます。protected void
handlePongMessage
(WebSocketSession session, PongMessage message) protected void
handleTextMessage
(WebSocketSession session, TextMessage message) void
handleTransportError
(WebSocketSession session, ThrowableSE exception) 基礎となる WebSocket メッセージトランスポートからのエラーを処理します。boolean
WebSocketHandler が部分的なメッセージを処理するかどうか。
コンストラクターの詳細
AbstractWebSocketHandler
public AbstractWebSocketHandler()
メソッドの詳細
afterConnectionEstablished
インターフェースからコピーされた説明:WebSocketHandler
WebSocket ネゴシエーションが成功し、WebSocket 接続が開かれ、使用可能な状態になった後に呼び出されます。- 次で指定:
- インターフェース
WebSocketHandler
のafterConnectionEstablished
- 例外:
ExceptionSE
- このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。
handleMessage
インターフェースからコピーされた説明:WebSocketHandler
新しい WebSocket メッセージが到着すると呼び出されます。- 次で指定:
- インターフェース
WebSocketHandler
のhandleMessage
- 例外:
ExceptionSE
- このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。
handleTextMessage
- 例外:
ExceptionSE
handleBinaryMessage
protected void handleBinaryMessage(WebSocketSession session, BinaryMessage message) throws ExceptionSE - 例外:
ExceptionSE
handlePongMessage
- 例外:
ExceptionSE
handleTransportError
public void handleTransportError(WebSocketSession session, ThrowableSE exception) throws ExceptionSE インターフェースからコピーされた説明:WebSocketHandler
基礎となる WebSocket メッセージトランスポートからのエラーを処理します。- 次で指定:
- インターフェース
WebSocketHandler
のhandleTransportError
- 例外:
ExceptionSE
- このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。
afterConnectionClosed
インターフェースからコピーされた説明:WebSocketHandler
WebSocket 接続がどちらかの側で閉じられた後、または転送エラーが発生した後に呼び出されます。セッションは技術的にはまだ開いている可能性がありますが、基盤となる実装によっては、この時点でメッセージを送信することはお勧めできません。おそらく成功しません。- 次で指定:
- インターフェース
WebSocketHandler
のafterConnectionClosed
- 例外:
ExceptionSE
- このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。
supportsPartialMessages
public boolean supportsPartialMessages()インターフェースからコピーされた説明:WebSocketHandler
WebSocketHandler が部分的なメッセージを処理するかどうか。このフラグがtrue
に設定され、基礎となる WebSocket サーバーが部分メッセージをサポートする場合、大きな WebSocket メッセージまたは不明なサイズのメッセージが分割され、WebSocketHandler.handleMessage(WebSocketSession, WebSocketMessage)
への複数の呼び出しで受信される可能性があります。フラグWebSocketMessage.isLast()
は、メッセージが部分的であるかどうか、およびメッセージが最後の部分であるかどうかを示します。- 次で指定:
- インターフェース
WebSocketHandler
のsupportsPartialMessages