インターフェースの使用
org.springframework.web.socket.WebSocketSession
WebSocketSession を使用するパッケージ
パッケージ
説明
WebSocket アプリケーションの一般的な抽象化と Spring 構成のサポート。
Spring の WebSocket API を WebSocket プロバイダーとの間で適合させるクラス。
Jetty WebSocket API のアダプタークラス。
標準 Java WebSocket API のアダプタークラス。
WebSocket アプリケーションのクライアント側の抽象化。
Jetty WebSocket API のクライアント側サポート。
標準 Java WebSocket エンドポイントで使用するクライアント側クラス。
便利な
WebSocketHandler 実装とデコレーター。Spring のメッセージングモジュール用の WebSocket 統合。
WebSocketClient の SockJS クライアント実装。 受信リクエストを処理するための
TransportHandler 実装、さまざまなトランスポートを介してメッセージを送信するための session の実装、および DefaultSockJsService を含む SockJS トランスポートのサーバー側サポート。TransportHandler 実装クラスおよび具体的な SockJsServiceWebSocketSession の SockJS 固有の実装。org.springframework.web.socket 内の WebSocketSession 使用
型 WebSocketSession のパラメーターを持つ org.springframework.web.socket のメソッド修飾子と型メソッド説明voidWebSocketHandler.afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) WebSocket 接続がいずれかの側で閉じられた後、またはトランスポートエラーが発生した後に呼び出されます。voidWebSocketHandler.afterConnectionEstablished(WebSocketSession session) WebSocket ネゴシエーションが成功し、WebSocket 接続が開かれ、使用可能な状態になった後に呼び出されます。voidWebSocketHandler.handleMessage(WebSocketSession session, WebSocketMessage<?> message) 新しい WebSocket メッセージが到着すると呼び出されます。voidWebSocketHandler.handleTransportError(WebSocketSession session, ThrowableSE exception) 基礎となる WebSocket メッセージトランスポートからのエラーを処理します。org.springframework.web.socket.adapter 内の WebSocketSession 使用
org.springframework.web.socket.adapter 内の WebSocketSession サブインターフェースWebSocketSession を実装している org.springframework.web.socket.adapter のクラスorg.springframework.web.socket.adapter.jetty 内の WebSocketSession 使用
org.springframework.web.socket.adapter.standard 内の WebSocketSession 使用
org.springframework.web.socket.client 内の WebSocketSession 使用
型 WebSocketSession の引数を持つ型を返す org.springframework.web.socket.client のメソッド修飾子と型メソッド説明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 使用
型 WebSocketSession の引数を持つ型を返す org.springframework.web.socket.client.jetty のメソッド修飾子と型メソッド説明JettyWebSocketClient.executeInternal(WebSocketHandler wsHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> protocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE, ObjectSE> attributes) org.springframework.web.socket.client.standard 内の WebSocketSession 使用
型 WebSocketSession の引数を持つ型を返す org.springframework.web.socket.client.standard のメソッド修飾子と型メソッド説明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 使用
WebSocketSession を実装している org.springframework.web.socket.handler のクラス修飾子と型クラス説明classWebSocketSessionをラップして、一度に 1 つのスレッドのみがメッセージを送信できるようにします。class別のWebSocketSessionインスタンスをラップし、それに委譲します。修飾子と型メソッド説明WebSocketSessionDecorator.getDelegate()WebSocketSessionDecorator.getLastSession()static WebSocketSessionWebSocketSessionDecorator.unwrap(WebSocketSession session) 型 WebSocketSession のパラメーターを持つ org.springframework.web.socket.handler のメソッド修飾子と型メソッド説明voidAbstractWebSocketHandler.afterConnectionClosed(WebSocketSession session, CloseStatus status) voidExceptionWebSocketHandlerDecorator.afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) voidLoggingWebSocketHandlerDecorator.afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) voidPerConnectionWebSocketHandler.afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) voidWebSocketHandlerDecorator.afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) voidAbstractWebSocketHandler.afterConnectionEstablished(WebSocketSession session) voidExceptionWebSocketHandlerDecorator.afterConnectionEstablished(WebSocketSession session) voidLoggingWebSocketHandlerDecorator.afterConnectionEstablished(WebSocketSession session) voidPerConnectionWebSocketHandler.afterConnectionEstablished(WebSocketSession session) voidWebSocketHandlerDecorator.afterConnectionEstablished(WebSocketSession session) protected voidAbstractWebSocketHandler.handleBinaryMessage(WebSocketSession session, BinaryMessage message) protected voidTextWebSocketHandler.handleBinaryMessage(WebSocketSession session, BinaryMessage message) voidAbstractWebSocketHandler.handleMessage(WebSocketSession session, WebSocketMessage<?> message) voidExceptionWebSocketHandlerDecorator.handleMessage(WebSocketSession session, WebSocketMessage<?> message) voidLoggingWebSocketHandlerDecorator.handleMessage(WebSocketSession session, WebSocketMessage<?> message) voidPerConnectionWebSocketHandler.handleMessage(WebSocketSession session, WebSocketMessage<?> message) voidWebSocketHandlerDecorator.handleMessage(WebSocketSession session, WebSocketMessage<?> message) protected voidAbstractWebSocketHandler.handlePongMessage(WebSocketSession session, PongMessage message) protected voidAbstractWebSocketHandler.handleTextMessage(WebSocketSession session, TextMessage message) protected voidBinaryWebSocketHandler.handleTextMessage(WebSocketSession session, TextMessage message) voidAbstractWebSocketHandler.handleTransportError(WebSocketSession session, ThrowableSE exception) voidExceptionWebSocketHandlerDecorator.handleTransportError(WebSocketSession session, ThrowableSE exception) voidLoggingWebSocketHandlerDecorator.handleTransportError(WebSocketSession session, ThrowableSE exception) voidPerConnectionWebSocketHandler.handleTransportError(WebSocketSession session, ThrowableSE exception) voidWebSocketHandlerDecorator.handleTransportError(WebSocketSession session, ThrowableSE exception) static voidExceptionWebSocketHandlerDecorator.tryCloseWithError(WebSocketSession session, ThrowableSE exception, Log logger) static WebSocketSessionWebSocketSessionDecorator.unwrap(WebSocketSession session) 型 WebSocketSession のパラメーターを持つ org.springframework.web.socket.handler のコンストラクター修飾子コンストラクター説明ConcurrentWebSocketSessionDecorator(WebSocketSession delegate, int sendTimeLimit, int bufferSizeLimit) 基本コンストラクター。ConcurrentWebSocketSessionDecorator(WebSocketSession delegate, int sendTimeLimit, int bufferSizeLimit, ConcurrentWebSocketSessionDecorator.OverflowStrategy overflowStrategy) 使用するオーバーフロー戦略も指定するコンストラクター。org.springframework.web.socket.messaging 内の WebSocketSession 使用
修飾子と型メソッド説明protected WebSocketSessionSubProtocolWebSocketHandler.decorateSession(WebSocketSession session) 必要に応じて、指定されたWebSocketSessionを装飾します。型 WebSocketSession のパラメーターを持つ org.springframework.web.socket.messaging のメソッド修飾子と型メソッド説明voidSubProtocolWebSocketHandler.afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) voidSubProtocolWebSocketHandler.afterConnectionEstablished(WebSocketSession session) voidStompSubProtocolHandler.afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel) voidSubProtocolHandler.afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel) WebSocketSessionが終了した後に呼び出されます。voidStompSubProtocolHandler.afterSessionStarted(WebSocketSession session, MessageChannel outputChannel) voidSubProtocolHandler.afterSessionStarted(WebSocketSession session, MessageChannel outputChannel) WebSocketSessionが開始した後に呼び出されます。protected WebSocketSessionSubProtocolWebSocketHandler.decorateSession(WebSocketSession session) 必要に応じて、指定されたWebSocketSessionを装飾します。protected final SubProtocolHandlerSubProtocolWebSocketHandler.findProtocolHandler(WebSocketSession session) 指定されたセッションのSubProtocolHandlerを見つけます。voidSubProtocolWebSocketHandler.handleMessage(WebSocketSession session, WebSocketMessage<?> message) WebSocket クライアントからの受信メッセージを処理します。voidStompSubProtocolHandler.handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> webSocketMessage, MessageChannel outputChannel) クライアントからの受信 WebSocket メッセージを処理します。voidSubProtocolHandler.handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> message, MessageChannel outputChannel) クライアントから受信した特定のWebSocketMessageを処理します。voidStompSubProtocolHandler.handleMessageToClient(WebSocketSession session, Message<?> message) WebSocket クライアントに戻る STOMP メッセージを処理します。voidSubProtocolHandler.handleMessageToClient(WebSocketSession session, Message<?> message) 指定された WebSocket セッションに関連付けられたクライアントに対して、指定されたMessageを処理します。voidSubProtocolWebSocketHandler.handleTransportError(WebSocketSession session, ThrowableSE exception) org.springframework.web.socket.sockjs.client 内の WebSocketSession 使用
修飾子と型クラス説明classWebSocketSessionの SockJS クライアント実装の基本クラス。classAbstractClientSockJsSessionの拡張であり、実際の WebSocket セッションにラップして委譲します。classWebSocket セッションをシミュレートする HTTP トランスポートで使用するためのAbstractClientSockJsSessionの拡張。型 WebSocketSession の引数を持つ型を返す org.springframework.web.socket.sockjs.client のメソッド修飾子と型メソッド説明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) 型 WebSocketSession のパラメーターを持つ org.springframework.web.socket.sockjs.client のメソッド型 WebSocketSession の型引数を持つ org.springframework.web.socket.sockjs.client のメソッドパラメーター修飾子と型メソッド説明protected abstract voidAbstractXhrTransport.connectInternal(TransportRequest request, WebSocketHandler handler, URISE receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFutureSE<WebSocketSession> connectFuture) protected voidAbstractXhrTransport.connectInternal(TransportRequest request, WebSocketHandler handler, URISE receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, SettableListenableFuture<WebSocketSession> connectFuture) 使用すべきではありません。protected voidJettyXhrTransport.connectInternal(TransportRequest transportRequest, WebSocketHandler handler, URISE url, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFutureSE<WebSocketSession> connectFuture) protected voidRestTemplateXhrTransport.connectInternal(TransportRequest transportRequest, WebSocketHandler handler, URISE receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFutureSE<WebSocketSession> connectFuture) protected voidUndertowXhrTransport.connectInternal(TransportRequest request, WebSocketHandler handler, URISE receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, CompletableFutureSE<WebSocketSession> connectFuture) 型の型引数を持つ org.springframework.web.socket.sockjs.client のコンストラクターパラメーター WebSocketSession修飾子コンストラクター説明protectedAbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, CompletableFutureSE<WebSocketSession> connectFuture) protectedAbstractClientSockJsSession(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 使用
型 WebSocketSession のパラメーターを持つ org.springframework.web.socket.sockjs.transport.handler のメソッド修飾子と型メソッド説明voidSockJsWebSocketHandler.afterConnectionClosed(WebSocketSession wsSession, CloseStatus status) voidSockJsWebSocketHandler.afterConnectionEstablished(WebSocketSession wsSession) voidSockJsWebSocketHandler.handleTextMessage(WebSocketSession wsSession, TextMessage message) voidSockJsWebSocketHandler.handleTransportError(WebSocketSession webSocketSession, ThrowableSE exception) org.springframework.web.socket.sockjs.transport.session 内の WebSocketSession 使用
修飾子と型クラス説明classHTTP トランスポート SockJS セッションで使用する抽象基本クラス。classSockJsSessionを実装する SockJS セッションの抽象基本クラス。classHTTP トランスポートのポーリングで使用する SockJS セッション。classストリーミング HTTP トランスポートで使用するための SockJS セッション。classWebSocket トランスポートで使用する SockJS セッション。型 WebSocketSession のパラメーターを持つ org.springframework.web.socket.sockjs.transport.session のメソッド修飾子と型メソッド説明voidWebSocketServerSockJsSession.handleMessage(TextMessage message, WebSocketSession wsSession) voidWebSocketServerSockJsSession.initializeDelegateSession(WebSocketSession session)
WebSocketClient.execute(WebSocketHandler, String, Object...)を推奨