インターフェース org.springframework.web.socket.WebSocketSession の使用 (Spring Framework 5.1.6.RELEASE API)

WebSocketSession を使用するパッケージ
パッケージ	説明
org.springframework.web.socket	WebSocket アプリケーションの一般的な抽象化と Spring 構成のサポート。
org.springframework.web.socket.adapter	Spring の WebSocket API を WebSocket プロバイダーとの間で適合させるクラス。
org.springframework.web.socket.adapter.jetty	Jetty WebSocket API のアダプタークラス。
org.springframework.web.socket.adapter.standard	標準 Java WebSocket API のアダプタークラス。
org.springframework.web.socket.client	WebSocket アプリケーションのクライアント側の抽象化。
org.springframework.web.socket.client.jetty	Jetty WebSocket API のクライアント側サポート。
org.springframework.web.socket.client.standard	標準 Java WebSocket エンドポイントで使用するクライアント側クラス。
org.springframework.web.socket.handler	便利な `WebSocketHandler` 実装とデコレーター。
org.springframework.web.socket.messaging	Spring のメッセージングモジュール用の WebSocket 統合。
org.springframework.web.socket.sockjs.client	`WebSocketClient` の SockJS クライアント実装。
org.springframework.web.socket.sockjs.transport	受信リクエストを処理するための `TransportHandler` 実装、さまざまなトランスポートを介してメッセージを送信するための `session` の実装、および `DefaultSockJsService` を含む SockJS トランスポートのサーバー側サポート。
org.springframework.web.socket.sockjs.transport.handler	`TransportHandler` 実装クラスおよび具体的な `SockJsService`
org.springframework.web.socket.sockjs.transport.session	`WebSocketSession` の SockJS 固有の実装。

org.springframework.web.socket 内の WebSocketSession 使用

型 WebSocketSession のパラメーターを持つ org.springframework.web.socket のメソッド
修飾子と型	メソッドと説明
`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 内の WebSocketSession サブインターフェース
修飾子と型	インターフェースと説明
`interface`	`NativeWebSocketSession` getter を介して基礎となるネイティブ WebSocketSession を公開する `WebSocketSession`。

WebSocketSession を実装している org.springframework.web.socket.adapter のクラス
修飾子と型	クラスと説明
`class`	`AbstractWebSocketSession<T>` `WebSocketSession` の実装の抽象基本クラス。

org.springframework.web.socket.adapter.jetty 内の WebSocketSession 使用

WebSocketSession を実装している org.springframework.web.socket.adapter.jetty のクラス
修飾子と型	クラスと説明
`class`	`JettyWebSocketSession` Jetty 9.4 WebSocket API で使用する `WebSocketSession`。

org.springframework.web.socket.adapter.standard 内の WebSocketSession 使用

WebSocketSession を実装している org.springframework.web.socket.adapter.standard のクラス
修飾子と型	クラスと説明
`class`	`StandardWebSocketSession` Java API の標準 WebSocket で使用する `WebSocketSession`。

org.springframework.web.socket.client 内の WebSocketSession 使用

型 WebSocketSession の引数を持つ型を返す org.springframework.web.socket.client のメソッド
修飾子と型	メソッドと説明
`ListenableFuture<WebSocketSession>`	WebSocketClient.`doHandshake(WebSocketHandler webSocketHandler, StringSE uriTemplate, ObjectSE... uriVariables)`
`ListenableFuture<WebSocketSession>`	AbstractWebSocketClient.`doHandshake(WebSocketHandler webSocketHandler, StringSE uriTemplate, ObjectSE... uriVars)`
`ListenableFuture<WebSocketSession>`	WebSocketClient.`doHandshake(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URISE uri)`
`ListenableFuture<WebSocketSession>`	AbstractWebSocketClient.`doHandshake(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URISE uri)`
`protected abstract ListenableFuture<WebSocketSession>`	AbstractWebSocketClient.`doHandshakeInternal(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 のメソッド
修飾子と型	メソッドと説明
`ListenableFuture<WebSocketSession>`	JettyWebSocketClient.`doHandshake(WebSocketHandler webSocketHandler, StringSE uriTemplate, ObjectSE... uriVars)`
`ListenableFuture<WebSocketSession>`	JettyWebSocketClient.`doHandshakeInternal(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 ListenableFuture<WebSocketSession>`	StandardWebSocketClient.`doHandshakeInternal(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 のクラス
修飾子と型	クラスと説明
`class`	`ConcurrentWebSocketSessionDecorator` `WebSocketSession` をラップして、一度に 1 つのスレッドのみがメッセージを送信できるようにします。
`class`	`WebSocketSessionDecorator` 別の `WebSocketSession` インスタンスをラップし、それに委譲します。

WebSocketSession を返す org.springframework.web.socket.handler のメソッド
修飾子と型	メソッドと説明
`WebSocketSession`	WebSocketSessionDecorator.`getDelegate()`
`WebSocketSession`	WebSocketSessionDecorator.`getLastSession()`
`static WebSocketSession`	WebSocketSessionDecorator.`unwrap(WebSocketSession session)`

型 WebSocketSession のパラメーターを持つ org.springframework.web.socket.handler のメソッド
修飾子と型	メソッドと説明
`void`	WebSocketHandlerDecorator.`afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)`
`void`	LoggingWebSocketHandlerDecorator.`afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)`
`void`	ExceptionWebSocketHandlerDecorator.`afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)`
`void`	PerConnectionWebSocketHandler.`afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)`
`void`	AbstractWebSocketHandler.`afterConnectionClosed(WebSocketSession session, CloseStatus status)`
`void`	WebSocketHandlerDecorator.`afterConnectionEstablished(WebSocketSession session)`
`void`	LoggingWebSocketHandlerDecorator.`afterConnectionEstablished(WebSocketSession session)`
`void`	ExceptionWebSocketHandlerDecorator.`afterConnectionEstablished(WebSocketSession session)`
`void`	PerConnectionWebSocketHandler.`afterConnectionEstablished(WebSocketSession session)`
`void`	AbstractWebSocketHandler.`afterConnectionEstablished(WebSocketSession session)`
`protected void`	TextWebSocketHandler.`handleBinaryMessage(WebSocketSession session, BinaryMessage message)`
`protected void`	AbstractWebSocketHandler.`handleBinaryMessage(WebSocketSession session, BinaryMessage message)`
`void`	WebSocketHandlerDecorator.`handleMessage(WebSocketSession session, WebSocketMessage<?> message)`
`void`	LoggingWebSocketHandlerDecorator.`handleMessage(WebSocketSession session, WebSocketMessage<?> message)`
`void`	ExceptionWebSocketHandlerDecorator.`handleMessage(WebSocketSession session, WebSocketMessage<?> message)`
`void`	PerConnectionWebSocketHandler.`handleMessage(WebSocketSession session, WebSocketMessage<?> message)`
`void`	AbstractWebSocketHandler.`handleMessage(WebSocketSession session, WebSocketMessage<?> message)`
`protected void`	AbstractWebSocketHandler.`handlePongMessage(WebSocketSession session, PongMessage message)`
`protected void`	BinaryWebSocketHandler.`handleTextMessage(WebSocketSession session, TextMessage message)`
`protected void`	AbstractWebSocketHandler.`handleTextMessage(WebSocketSession session, TextMessage message)`
`void`	WebSocketHandlerDecorator.`handleTransportError(WebSocketSession session, ThrowableSE exception)`
`void`	LoggingWebSocketHandlerDecorator.`handleTransportError(WebSocketSession session, ThrowableSE exception)`
`void`	ExceptionWebSocketHandlerDecorator.`handleTransportError(WebSocketSession session, ThrowableSE exception)`
`void`	PerConnectionWebSocketHandler.`handleTransportError(WebSocketSession session, ThrowableSE exception)`
`void`	AbstractWebSocketHandler.`handleTransportError(WebSocketSession session, ThrowableSE exception)`
`static void`	ExceptionWebSocketHandlerDecorator.`tryCloseWithError(WebSocketSession session, ThrowableSE exception, Log logger)`
`static WebSocketSession`	WebSocketSessionDecorator.`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)` 使用するオーバーフロー戦略も指定するコンストラクター。
`WebSocketSessionDecorator(WebSocketSession session)`

org.springframework.web.socket.messaging 内の WebSocketSession 使用

WebSocketSession を返す org.springframework.web.socket.messaging のメソッド
修飾子と型	メソッドと説明
`protected WebSocketSession`	SubProtocolWebSocketHandler.`decorateSession(WebSocketSession session)` 必要に応じて、指定された `WebSocketSession` を装飾します。

型 WebSocketSession のパラメーターを持つ org.springframework.web.socket.messaging のメソッド
修飾子と型	メソッドと説明
`void`	SubProtocolWebSocketHandler.`afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus)`
`void`	SubProtocolWebSocketHandler.`afterConnectionEstablished(WebSocketSession session)`
`void`	SubProtocolHandler.`afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel)` `WebSocketSession` が終了した後に呼び出されます。
`void`	StompSubProtocolHandler.`afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel)`
`void`	SubProtocolHandler.`afterSessionStarted(WebSocketSession session, MessageChannel outputChannel)` `WebSocketSession` が開始した後に呼び出されます。
`void`	StompSubProtocolHandler.`afterSessionStarted(WebSocketSession session, MessageChannel outputChannel)`
`protected WebSocketSession`	SubProtocolWebSocketHandler.`decorateSession(WebSocketSession session)` 必要に応じて、指定された `WebSocketSession` を装飾します。
`protected SubProtocolHandler`	SubProtocolWebSocketHandler.`findProtocolHandler(WebSocketSession session)` 指定されたセッションの `SubProtocolHandler` を見つけます。
`void`	SubProtocolWebSocketHandler.`handleMessage(WebSocketSession session, WebSocketMessage<?> message)` WebSocket クライアントからの受信メッセージを処理します。
`void`	SubProtocolHandler.`handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> message, MessageChannel outputChannel)` クライアントから受信した特定の `WebSocketMessage` を処理します。
`void`	StompSubProtocolHandler.`handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> webSocketMessage, MessageChannel outputChannel)` クライアントからの受信 WebSocket メッセージを処理します。
`void`	SubProtocolHandler.`handleMessageToClient(WebSocketSession session, Message<?> message)` 指定された WebSocket セッションに関連付けられたクライアントに対して、指定された `Message` を処理します。
`void`	StompSubProtocolHandler.`handleMessageToClient(WebSocketSession session, Message<?> message)` WebSocket クライアントに戻る STOMP メッセージを処理します。
`void`	SubProtocolWebSocketHandler.`handleTransportError(WebSocketSession session, ThrowableSE exception)`

org.springframework.web.socket.sockjs.client 内の WebSocketSession 使用

WebSocketSession を実装している org.springframework.web.socket.sockjs.client のクラス
修飾子と型	クラスと説明
`class`	`AbstractClientSockJsSession` `WebSocketSession` の SockJS クライアント実装の基本クラス。
`class`	`WebSocketClientSockJsSession` `AbstractClientSockJsSession` の拡張であり、実際の WebSocket セッションにラップして委譲します。
`class`	`XhrClientSockJsSession` WebSocket セッションをシミュレートする HTTP トランスポートで使用するための `AbstractClientSockJsSession` の拡張。

型 WebSocketSession の引数を持つ型を返す org.springframework.web.socket.sockjs.client のメソッド
修飾子と型	メソッドと説明
`ListenableFuture<WebSocketSession>`	Transport.`connect(TransportRequest request, WebSocketHandler webSocketHandler)` トランスポートを接続します。
`ListenableFuture<WebSocketSession>`	AbstractXhrTransport.`connect(TransportRequest request, WebSocketHandler handler)`
`ListenableFuture<WebSocketSession>`	WebSocketTransport.`connect(TransportRequest request, WebSocketHandler handler)`
`ListenableFuture<WebSocketSession>`	SockJsClient.`doHandshake(WebSocketHandler handler, StringSE uriTemplate, ObjectSE... uriVars)`
`ListenableFuture<WebSocketSession>`	SockJsClient.`doHandshake(WebSocketHandler handler, WebSocketHttpHeaders headers, URISE url)`

型 WebSocketSession のパラメーターを持つ org.springframework.web.socket.sockjs.client のメソッド
修飾子と型	メソッドと説明
`void`	WebSocketClientSockJsSession.`initializeDelegateSession(WebSocketSession session)`

型 WebSocketSession の型引数を持つ org.springframework.web.socket.sockjs.client のメソッドパラメーター
修飾子と型	メソッドと説明
`protected void`	JettyXhrTransport.`connectInternal(TransportRequest transportRequest, WebSocketHandler handler, URISE url, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, SettableListenableFuture<WebSocketSession> connectFuture)`
`protected abstract void`	AbstractXhrTransport.`connectInternal(TransportRequest request, WebSocketHandler handler, URISE receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, SettableListenableFuture<WebSocketSession> connectFuture)`
`protected void`	RestTemplateXhrTransport.`connectInternal(TransportRequest transportRequest, WebSocketHandler handler, URISE receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, SettableListenableFuture<WebSocketSession> connectFuture)`
`protected void`	UndertowXhrTransport.`connectInternal(TransportRequest request, WebSocketHandler handler, URISE receiveUrl, HttpHeaders handshakeHeaders, XhrClientSockJsSession session, SettableListenableFuture<WebSocketSession> connectFuture)`

型の型引数を持つ org.springframework.web.socket.sockjs.client のコンストラクターパラメーター WebSocketSession
コンストラクターと説明
`AbstractClientSockJsSession(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture)`
`WebSocketClientSockJsSession(TransportRequest request, WebSocketHandler handler, SettableListenableFuture<WebSocketSession> connectFuture)`
`XhrClientSockJsSession(TransportRequest request, WebSocketHandler handler, XhrTransport transport, SettableListenableFuture<WebSocketSession> connectFuture)`

org.springframework.web.socket.sockjs.transport 内の WebSocketSession 使用

org.springframework.web.socket.sockjs.transport 内の WebSocketSession サブインターフェース
修飾子と型	インターフェースと説明
`interface`	`SockJsSession` Spring の標準 `WebSocketSession` の SockJS 拡張。

org.springframework.web.socket.sockjs.transport.handler 内の WebSocketSession 使用

型 WebSocketSession のパラメーターを持つ org.springframework.web.socket.sockjs.transport.handler のメソッド
修飾子と型	メソッドと説明
`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 使用

WebSocketSession を実装している org.springframework.web.socket.sockjs.transport.session のクラス
修飾子と型	クラスと説明
`class`	`AbstractHttpSockJsSession` HTTP トランスポート SockJS セッションで使用する抽象基本クラス。
`class`	`AbstractSockJsSession` `SockJsSession` を実装する SockJS セッションの抽象基本クラス。
`class`	`PollingSockJsSession` HTTP トランスポートのポーリングで使用する SockJS セッション。
`class`	`StreamingSockJsSession` ストリーミング HTTP トランスポートで使用するための SockJS セッション。
`class`	`WebSocketServerSockJsSession` WebSocket トランスポートで使用する SockJS セッション。

型 WebSocketSession のパラメーターを持つ org.springframework.web.socket.sockjs.transport.session のメソッド
修飾子と型	メソッドと説明
`void`	WebSocketServerSockJsSession.`handleMessage(TextMessage message, WebSocketSession wsSession)`
`void`	WebSocketServerSockJsSession.`initializeDelegateSession(WebSocketSession session)`

インターフェースの使用 org.springframework.web.socket.WebSocketSession

org.springframework.web.socket 内の WebSocketSession 使用

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 使用

org.springframework.web.socket.client.jetty 内の WebSocketSession 使用

org.springframework.web.socket.client.standard 内の WebSocketSession 使用

org.springframework.web.socket.handler 内の WebSocketSession 使用

org.springframework.web.socket.messaging 内の WebSocketSession 使用

org.springframework.web.socket.sockjs.client 内の WebSocketSession 使用

org.springframework.web.socket.sockjs.transport 内の WebSocketSession 使用

org.springframework.web.socket.sockjs.transport.handler 内の WebSocketSession 使用

org.springframework.web.socket.sockjs.transport.session 内の WebSocketSession 使用

インターフェースの使用
org.springframework.web.socket.WebSocketSession