クラス AbstractWebSocketSession<T>
java.lang.ObjectSE
org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession<T>
- 型パラメーター:
T
- ネイティブデリゲート型
- 実装されたすべてのインターフェース:
WebSocketSession
共通フィールドを保持し、アクセサーを公開する
WebSocketSession
実装の便利な基本クラス。WebSocketMessage
ファクトリメソッドも実装します。- 導入:
- 5.0
- 作成者:
- Rossen Stoyanchev
フィールドのサマリー
フィールドコンストラクターの概要
コンストラクター修飾子コンストラクター説明protected
AbstractWebSocketSession
(T delegate, StringSE id, HandshakeInfo info, DataBufferFactory bufferFactory) 新しい WebSocket セッションを作成します。メソッドのサマリー
修飾子と型メソッド説明binaryMessage
(FunctionSE<DataBufferFactory, DataBuffer> payloadFactory) セッションにWebSocketSession.bufferFactory()
を使用してバイナリ WebSocketMessage を作成するファクトリメソッド。メッセージペイロードを作成するDataBuffer
ファクトリを返します。WebSocket セッションに関連付けられた属性を持つマップを返します。protected T
ハンドシェイクリクエストから情報を返します。getId()
セッションの ID を返します。protected StringSE
pingMessage
(FunctionSE<DataBufferFactory, DataBuffer> payloadFactory) セッションにWebSocketSession.bufferFactory()
を使用して ping WebSocketMessage を作成するファクトリメソッド。pongMessage
(FunctionSE<DataBufferFactory, DataBuffer> payloadFactory) セッションにWebSocketSession.bufferFactory()
を使用してポン WebSocketMessage を作成するファクトリメソッド。abstract reactor.core.publisher.Flux
<WebSocketMessage> receive()
受信メッセージのストリームへのアクセスを提供します。abstract reactor.core.publisher.Mono
<VoidSE> send
(Publisher<WebSocketMessage> messages) 発信メッセージのソースを提供し、メッセージを書き込み、ソースが完了して書き込みが完了すると完了するMono<Void>
を返します。textMessage
(StringSE payload) セッションにWebSocketSession.bufferFactory()
を使用してテキストWebSocketMessage
を作成するファクトリメソッド。toString()
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE
インターフェース org.springframework.web.reactive.socket.WebSocketSession から継承されたメソッド
close, close, closeStatus, isOpen
フィールドの詳細
logger
protected final org.apache.commons.logging.Log logger
コンストラクターの詳細
AbstractWebSocketSession
protected AbstractWebSocketSession(T delegate, StringSE id, HandshakeInfo info, DataBufferFactory bufferFactory) 新しい WebSocket セッションを作成します。
メソッドの詳細
getDelegate
getId
getHandshakeInfo
インターフェースからコピーされた説明:WebSocketSession
ハンドシェイクリクエストから情報を返します。- 次で指定:
- インターフェース
WebSocketSession
のgetHandshakeInfo
bufferFactory
インターフェースからコピーされた説明:WebSocketSession
メッセージペイロードを作成するDataBuffer
ファクトリを返します。- 次で指定:
- インターフェース
WebSocketSession
のbufferFactory
- 戻り値:
- セッションのバッファファクトリ
getAttributes
インターフェースからコピーされた説明:WebSocketSession
WebSocket セッションに関連付けられた属性を持つマップを返します。- 次で指定:
- インターフェース
WebSocketSession
のgetAttributes
- 戻り値:
- セッション属性を持つマップ (非
null
)
getLogPrefix
receive
インターフェースからコピーされた説明:WebSocketSession
受信メッセージのストリームへのアクセスを提供します。このストリームは、接続が閉じられたときに完了またはエラーシグナルを受け取ります。典型的な
WebSocketHandler
実装では、このストリームは全体的な処理フローに組み込まれるため、接続が閉じられると処理が終了します。セッションの処理方法の詳細と例については、
WebSocketHandler
のクラスレベルのドキュメントとリファレンスを参照してください。- 次で指定:
- インターフェース
WebSocketSession
のreceive
send
インターフェースからコピーされた説明:WebSocketSession
発信メッセージのソースを提供し、メッセージを書き込み、ソースが完了して書き込みが完了すると完了するMono<Void>
を返します。セッションの処理方法の詳細と例については、
WebSocketHandler
のクラスレベルのドキュメントとリファレンスを参照してください。- 次で指定:
- インターフェース
WebSocketSession
のsend
textMessage
インターフェースからコピーされた説明:WebSocketSession
セッションにWebSocketSession.bufferFactory()
を使用してテキストWebSocketMessage
を作成するファクトリメソッド。- 次で指定:
- インターフェース
WebSocketSession
のtextMessage
binaryMessage
インターフェースからコピーされた説明:WebSocketSession
セッションにWebSocketSession.bufferFactory()
を使用してバイナリ WebSocketMessage を作成するファクトリメソッド。- 次で指定:
- インターフェース
WebSocketSession
のbinaryMessage
pingMessage
インターフェースからコピーされた説明:WebSocketSession
セッションにWebSocketSession.bufferFactory()
を使用して ping WebSocketMessage を作成するファクトリメソッド。- 次で指定:
- インターフェース
WebSocketSession
のpingMessage
pongMessage
インターフェースからコピーされた説明:WebSocketSession
セッションにWebSocketSession.bufferFactory()
を使用してポン WebSocketMessage を作成するファクトリメソッド。- 次で指定:
- インターフェース
WebSocketSession
のpongMessage
toString