public interface SubProtocolHandler
WebSocketMessages
とクライアントへの Messages
の両方を処理します。 このインターフェースの実装は、Sec-WebSocket-Protocol
リクエストヘッダーを介してクライアントからリクエストされたサブプロトコルに基づいてメッセージを委譲するサブプロトコルハンドラーを選択する SubProtocolWebSocketHandler
で構成できます。
修飾子と型 | メソッドと説明 |
---|---|
void | afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel) WebSocketSession が終了した後に呼び出されます。 |
void | afterSessionStarted(WebSocketSession session, MessageChannel outputChannel) WebSocketSession が開始した後に呼び出されます。 |
ListSE<StringSE> | getSupportedProtocols() このハンドラーでサポートされているサブプロトコルのリストを返します(非 null )。 |
void | handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> message, MessageChannel outputChannel) クライアントから受信した特定の WebSocketMessage を処理します。 |
void | handleMessageToClient(WebSocketSession session, Message<?> message) 指定された WebSocket セッションに関連付けられたクライアントに対して、指定された Message を処理します。 |
StringSE | resolveSessionId(Message<?> message) 指定されたメッセージからセッション ID を解決するか、 null を返します。 |
ListSE<StringSE> getSupportedProtocols()
null
)。void handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> message, MessageChannel outputChannel) throws ExceptionSE
WebSocketMessage
を処理します。session
- クライアントセッション message
- クライアントメッセージ outputChannel
- メッセージを送信する出力チャネル ExceptionSE
void handleMessageToClient(WebSocketSession session, Message<?> message) throws ExceptionSE
Message
を処理します。session
- クライアントセッション message
- クライアントメッセージ ExceptionSE
@Nullable StringSE resolveSessionId(Message<?> message)
null
を返します。message
- セッション ID を解決するメッセージ void afterSessionStarted(WebSocketSession session, MessageChannel outputChannel) throws ExceptionSE
WebSocketSession
が開始した後に呼び出されます。session
- クライアントセッション outputChannel
- チャンネル ExceptionSE
void afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel) throws ExceptionSE
WebSocketSession
が終了した後に呼び出されます。session
- クライアントセッション closeStatus
- セッションが閉じられた理由 outputChannel
- チャンネル ExceptionSE