インターフェースの使用
org.springframework.web.socket.WebSocketSession
パッケージ
説明
WebSocket アプリケーションの一般的な抽象化と Spring 構成のサポート。
Spring の WebSocket API を WebSocket プロバイダーとの間で適合させるクラス。
Jetty WebSocket API のアダプタークラス。
標準 Jakarta WebSocket API のアダプタークラス。
WebSocket アプリケーションのクライアント側の抽象化。
Jetty WebSocket API のクライアント側サポート。
標準の Jakarta WebSocket エンドポイントで使用するクライアント側クラス。
便利な
WebSocketHandler
実装とデコレーター。Spring のメッセージングモジュール用の WebSocket 統合。
WebSocketClient
の SockJS クライアント実装。 受信リクエストを処理するための
TransportHandler
実装、さまざまなトランスポートを介してメッセージを送信するための session
の実装、および DefaultSockJsService
を含む SockJS トランスポートのサーバー側サポート。TransportHandler
実装クラスおよび具体的な SockJsService
WebSocketSession
の SockJS 固有の実装。org.springframework.web.socket 内の WebSocketSession 使用
修飾子と型メソッド説明void
WebSocketHandler.afterConnectionClosed
(WebSocketSession session, CloseStatus closeStatus) WebSocket 接続がいずれかの側で閉じられた後、またはトランスポートエラーが発生した後に呼び出されます。void
WebSocketHandler.afterConnectionEstablished
(WebSocketSession session) WebSocket ネゴシエーションが成功し、WebSocket 接続が開かれ、使用可能な状態になった後に呼び出されます。void
WebSocketHandler.handleMessage
(WebSocketSession session, WebSocketMessage<?> message) 新しい WebSocket メッセージが到着すると呼び出されます。void
WebSocketHandler.handleTransportError
(WebSocketSession session, ThrowableSE exception) 基礎となる WebSocket メッセージトランスポートからのエラーを処理します。org.springframework.web.socket.adapter 内の WebSocketSession 使用
org.springframework.web.socket.adapter.jetty 内の WebSocketSession 使用
org.springframework.web.socket.adapter.standard 内の WebSocketSession 使用
org.springframework.web.socket.client 内の WebSocketSession 使用
修飾子と型メソッド説明default ListenableFuture<WebSocketSession>
WebSocketClient.doHandshake
(WebSocketHandler webSocketHandler, StringSE uriTemplate, ObjectSE... uriVariables) 使用すべきではありません。default ListenableFuture<WebSocketSession>
WebSocketClient.doHandshake
(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URISE uri) 使用すべきではありません。protected ListenableFuture<WebSocketSession>
AbstractWebSocketClient.doHandshakeInternal
(WebSocketHandler webSocketHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> subProtocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE, ObjectSE> attributes) 使用すべきではありません。AbstractWebSocketClient.execute
(WebSocketHandler webSocketHandler, StringSE uriTemplate, ObjectSE... uriVars) AbstractWebSocketClient.execute
(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URISE uri) WebSocketClient.execute
(WebSocketHandler webSocketHandler, StringSE uriTemplate, ObjectSE... uriVariables) 指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。WebSocketClient.execute
(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URISE uri) 指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。protected abstract CompletableFutureSE<WebSocketSession>
AbstractWebSocketClient.executeInternal
(WebSocketHandler webSocketHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> subProtocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE, ObjectSE> attributes) 実際のハンドシェイクを実行して、サーバーへの接続を確立します。org.springframework.web.socket.client.jetty 内の WebSocketSession 使用
修飾子と型メソッド説明JettyWebSocketClient.executeInternal
(WebSocketHandler wsHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> protocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE, ObjectSE> attributes) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。org.springframework.web.socket.client.standard 内の WebSocketSession 使用
修飾子と型メソッド説明protected CompletableFutureSE<WebSocketSession>
StandardWebSocketClient.executeInternal
(WebSocketHandler webSocketHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> protocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE, ObjectSE> attributes) org.springframework.web.socket.handler 内の WebSocketSession 使用
修飾子と型クラス説明class
WebSocketSession
をラップして、一度に 1 つのスレッドのみがメッセージを送信できるようにします。class
別のWebSocketSession
インスタンスをラップし、それに委譲します。修飾子と型メソッド説明WebSocketSessionDecorator.getDelegate()
WebSocketSessionDecorator.getLastSession()
static WebSocketSession
WebSocketSessionDecorator.unwrap
(WebSocketSession session) 修飾子と型メソッド説明void
AbstractWebSocketHandler.afterConnectionClosed
(WebSocketSession session, CloseStatus status) void
ExceptionWebSocketHandlerDecorator.afterConnectionClosed
(WebSocketSession session, CloseStatus closeStatus) void
LoggingWebSocketHandlerDecorator.afterConnectionClosed
(WebSocketSession session, CloseStatus closeStatus) void
PerConnectionWebSocketHandler.afterConnectionClosed
(WebSocketSession session, CloseStatus closeStatus) void
WebSocketHandlerDecorator.afterConnectionClosed
(WebSocketSession session, CloseStatus closeStatus) void
AbstractWebSocketHandler.afterConnectionEstablished
(WebSocketSession session) void
ExceptionWebSocketHandlerDecorator.afterConnectionEstablished
(WebSocketSession session) void
LoggingWebSocketHandlerDecorator.afterConnectionEstablished
(WebSocketSession session) void
PerConnectionWebSocketHandler.afterConnectionEstablished
(WebSocketSession session) void
WebSocketHandlerDecorator.afterConnectionEstablished
(WebSocketSession session) protected void
AbstractWebSocketHandler.handleBinaryMessage
(WebSocketSession session, BinaryMessage message) protected void
TextWebSocketHandler.handleBinaryMessage
(WebSocketSession session, BinaryMessage message) void
AbstractWebSocketHandler.handleMessage
(WebSocketSession session, WebSocketMessage<?> message) void
ExceptionWebSocketHandlerDecorator.handleMessage
(WebSocketSession session, WebSocketMessage<?> message) void
LoggingWebSocketHandlerDecorator.handleMessage
(WebSocketSession session, WebSocketMessage<?> message) void
PerConnectionWebSocketHandler.handleMessage
(WebSocketSession session, WebSocketMessage<?> message) void
WebSocketHandlerDecorator.handleMessage
(WebSocketSession session, WebSocketMessage<?> message) protected void
AbstractWebSocketHandler.handlePongMessage
(WebSocketSession session, PongMessage message) protected void
AbstractWebSocketHandler.handleTextMessage
(WebSocketSession session, TextMessage message) protected void
BinaryWebSocketHandler.handleTextMessage
(WebSocketSession session, TextMessage message) void
AbstractWebSocketHandler.handleTransportError
(WebSocketSession session, ThrowableSE exception) void
ExceptionWebSocketHandlerDecorator.handleTransportError
(WebSocketSession session, ThrowableSE exception) void
LoggingWebSocketHandlerDecorator.handleTransportError
(WebSocketSession session, ThrowableSE exception) void
PerConnectionWebSocketHandler.handleTransportError
(WebSocketSession session, ThrowableSE exception) void
WebSocketHandlerDecorator.handleTransportError
(WebSocketSession session, ThrowableSE exception) static void
ExceptionWebSocketHandlerDecorator.tryCloseWithError
(WebSocketSession session, ThrowableSE exception, Log logger) static WebSocketSession
WebSocketSessionDecorator.unwrap
(WebSocketSession session) 修飾子コンストラクター説明ConcurrentWebSocketSessionDecorator
(WebSocketSession delegate, int sendTimeLimit, int bufferSizeLimit) 基本コンストラクター。ConcurrentWebSocketSessionDecorator
(WebSocketSession delegate, int sendTimeLimit, int bufferSizeLimit, ConcurrentWebSocketSessionDecorator.OverflowStrategy overflowStrategy) 使用するオーバーフロー戦略も指定するコンストラクター。org.springframework.web.socket.messaging 内の WebSocketSession 使用
修飾子と型メソッド説明protected WebSocketSession
SubProtocolWebSocketHandler.decorateSession
(WebSocketSession session) 必要に応じて、指定されたWebSocketSession
を装飾します。修飾子と型メソッド説明void
SubProtocolWebSocketHandler.afterConnectionClosed
(WebSocketSession session, CloseStatus closeStatus) void
SubProtocolWebSocketHandler.afterConnectionEstablished
(WebSocketSession session) void
StompSubProtocolHandler.afterSessionEnded
(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel) void
SubProtocolHandler.afterSessionEnded
(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel) WebSocketSession
が終了した後に呼び出されます。void
StompSubProtocolHandler.afterSessionStarted
(WebSocketSession session, MessageChannel outputChannel) void
SubProtocolHandler.afterSessionStarted
(WebSocketSession session, MessageChannel outputChannel) WebSocketSession
が開始した後に呼び出されます。protected WebSocketSession
SubProtocolWebSocketHandler.decorateSession
(WebSocketSession session) 必要に応じて、指定されたWebSocketSession
を装飾します。protected final SubProtocolHandler
SubProtocolWebSocketHandler.findProtocolHandler
(WebSocketSession session) 指定されたセッションのSubProtocolHandler
を見つけます。void
SubProtocolWebSocketHandler.handleMessage
(WebSocketSession session, WebSocketMessage<?> message) WebSocket クライアントからの受信メッセージを処理します。void
StompSubProtocolHandler.handleMessageFromClient
(WebSocketSession session, WebSocketMessage<?> webSocketMessage, MessageChannel outputChannel) クライアントからの受信 WebSocket メッセージを処理します。void
SubProtocolHandler.handleMessageFromClient
(WebSocketSession session, WebSocketMessage<?> message, MessageChannel outputChannel) クライアントから受信した特定のWebSocketMessage
を処理します。void
StompSubProtocolHandler.handleMessageToClient
(WebSocketSession session, Message<?> message) WebSocket クライアントに戻る STOMP メッセージを処理します。void
SubProtocolHandler.handleMessageToClient
(WebSocketSession session, Message<?> message) 指定された WebSocket セッションに関連付けられたクライアントに対して、指定されたMessage
を処理します。void
SubProtocolWebSocketHandler.handleTransportError
(WebSocketSession session, ThrowableSE exception) org.springframework.web.socket.sockjs.client 内の WebSocketSession 使用
修飾子と型クラス説明class
WebSocketSession
の SockJS クライアント実装の基本クラス。class
AbstractClientSockJsSession
の拡張であり、実際の WebSocket セッションにラップして委譲します。class
WebSocket セッションをシミュレートする HTTP トランスポートで使用するためのAbstractClientSockJsSession
の拡張。修飾子と型メソッド説明default ListenableFuture<WebSocketSession>
Transport.connect
(TransportRequest request, WebSocketHandler webSocketHandler) 使用すべきではありません。AbstractXhrTransport.connectAsync
(TransportRequest request, WebSocketHandler handler) Transport.connectAsync
(TransportRequest request, WebSocketHandler webSocketHandler) トランスポートを接続します。WebSocketTransport.connectAsync
(TransportRequest request, WebSocketHandler handler) SockJsClient.execute
(WebSocketHandler handler, StringSE uriTemplate, ObjectSE... uriVars) SockJsClient.execute
(WebSocketHandler handler, WebSocketHttpHeaders headers, URISE url) 修飾子と型メソッド説明protected abstract void
AbstractXhrTransport.connectInternal
(TransportRequest request, WebSocketHandler handler, URISE receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFutureSE<WebSocketSession> connectFuture) protected void
AbstractXhrTransport.connectInternal
(TransportRequest request, WebSocketHandler handler, URISE receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, SettableListenableFuture<WebSocketSession> connectFuture) 使用すべきではありません。protected void
JettyXhrTransport.connectInternal
(TransportRequest transportRequest, WebSocketHandler handler, URISE url, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFutureSE<WebSocketSession> connectFuture) protected void
RestTemplateXhrTransport.connectInternal
(TransportRequest transportRequest, WebSocketHandler handler, URISE receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFutureSE<WebSocketSession> connectFuture) protected void
UndertowXhrTransport.connectInternal
(TransportRequest request, WebSocketHandler handler, URISE receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFutureSE<WebSocketSession> connectFuture) 修飾子コンストラクター説明protected
AbstractClientSockJsSession
(TransportRequest request, WebSocketHandler handler, CompletableFutureSE<WebSocketSession> connectFuture) protected
AbstractClientSockJsSession
(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture) 使用すべきではありません。WebSocketClientSockJsSession
(TransportRequest request, WebSocketHandler handler, CompletableFutureSE<WebSocketSession> connectFuture) WebSocketClientSockJsSession
(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture) 使用すべきではありません。XhrClientSockJsSession
(TransportRequest request, WebSocketHandler handler, XhrTransport transport, CompletableFutureSE<WebSocketSession> connectFuture) 新しいXhrClientSockJsSession
を作成します。XhrClientSockJsSession
(TransportRequest request, WebSocketHandler handler, XhrTransport transport, SettableListenableFuture<WebSocketSession> connectFuture) 使用すべきではありません。org.springframework.web.socket.sockjs.transport 内の WebSocketSession 使用
org.springframework.web.socket.sockjs.transport.handler 内の WebSocketSession 使用
修飾子と型メソッド説明void
SockJsWebSocketHandler.afterConnectionClosed
(WebSocketSession wsSession, CloseStatus status) void
SockJsWebSocketHandler.afterConnectionEstablished
(WebSocketSession wsSession) void
SockJsWebSocketHandler.handleTextMessage
(WebSocketSession wsSession, TextMessage message) void
SockJsWebSocketHandler.handleTransportError
(WebSocketSession webSocketSession, ThrowableSE exception) org.springframework.web.socket.sockjs.transport.session 内の WebSocketSession 使用
修飾子と型クラス説明class
HTTP トランスポート SockJS セッションで使用する抽象基本クラス。class
SockJsSession
を実装する SockJS セッションの抽象基本クラス。class
HTTP トランスポートのポーリングで使用する SockJS セッション。class
ストリーミング HTTP トランスポートで使用するための SockJS セッション。class
WebSocket トランスポートで使用する SockJS セッション。修飾子と型メソッド説明void
WebSocketServerSockJsSession.handleMessage
(TextMessage message, WebSocketSession wsSession) void
WebSocketServerSockJsSession.initializeDelegateSession
(WebSocketSession session)
WebSocketClient.execute(WebSocketHandler, String, Object...)
を推奨