public interface WebSocketHandler
このインターフェースの実装は、意味のある場所で例外をローカルで処理するか、例外をバブルアップさせることをお勧めします。この場合、デフォルトで例外がログに記録され、セッションは SERVER_ERROR(1011)
で閉じられます。例外処理戦略は ExceptionWebSocketHandlerDecorator
によって提供され、WebSocketHandler
を別のデコレーターで装飾することでカスタマイズまたは置換できます。
修飾子と型 | メソッドと説明 |
---|---|
void | afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) WebSocket 接続がいずれかの側で閉じられた後、またはトランスポートエラーが発生した後に呼び出されます。 |
void | afterConnectionEstablished(WebSocketSession session) WebSocket ネゴシエーションが成功し、WebSocket 接続が開かれ、使用可能な状態になった後に呼び出されます。 |
void | handleMessage(WebSocketSession session, WebSocketMessage<?> message) 新しい WebSocket メッセージが到着すると呼び出されます。 |
void | handleTransportError(WebSocketSession session, java.lang.Throwable exception) 基礎となる WebSocket メッセージトランスポートからのエラーを処理します。 |
boolean | supportsPartialMessages() WebSocketHandler が部分的なメッセージを処理するかどうか。 |
void afterConnectionEstablished(WebSocketSession session) throws java.lang.Exception
java.lang.Exception
- このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws java.lang.Exception
java.lang.Exception
- このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。void handleTransportError(WebSocketSession session, java.lang.Throwable exception) throws java.lang.Exception
java.lang.Exception
- このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws java.lang.Exception
java.lang.Exception
- このメソッドは例外を処理または伝播できます。詳細については、クラスレベルの Javadoc を参照してください。boolean supportsPartialMessages()
true
に設定され、基礎となる WebSocket サーバーが部分メッセージをサポートする場合、大きな WebSocket メッセージまたは不明なサイズのメッセージが分割され、handleMessage(WebSocketSession, WebSocketMessage)
への複数の呼び出しで受信される可能性があります。フラグ WebSocketMessage.isLast()
は、メッセージが部分的であるかどうか、およびメッセージが最後の部分であるかどうかを示します。