インターフェース WebSocketSession
- すべての既知の実装クラス:
AbstractListenerWebSocketSession
、AbstractWebSocketSession
、JettyWebSocketSession
、Netty5WebSocketSessionSupport
、NettyWebSocketSessionSupport
、ReactorNetty2WebSocketSession
、ReactorNettyWebSocketSession
、StandardWebSocketSession
、TomcatWebSocketSession
、UndertowWebSocketSession
public interface WebSocketSession
WebSocket セッションを表します。
session.receive()
を使用して受信メッセージストリームを作成し、session.send(publisher)
を使用して送信メッセージストリームを提供します。
- 導入:
- 5.0
- 作成者:
- Rossen Stoyanchev
メソッドのサマリー
修飾子と型メソッド説明binaryMessage
(FunctionSE<DataBufferFactory, DataBuffer> payloadFactory) セッションにbufferFactory()
を使用してバイナリ WebSocketMessage を作成するファクトリメソッド。メッセージペイロードを作成するDataBuffer
ファクトリを返します。default reactor.core.publisher.Mono<VoidSE>
close()
CloseStatus.NORMAL
で WebSocket セッションを閉じます。reactor.core.publisher.Mono<VoidSE>
close
(CloseStatus status) 指定されたステータスで WebSocket セッションを閉じます。reactor.core.publisher.Mono<CloseStatus>
セッションがローカルまたはリモートで閉じられるCloseStatus
へのアクセスを提供します。セッションがステータスなしで終了した場合は、空になります。WebSocket セッションに関連付けられた属性を持つマップを返します。ハンドシェイクリクエストから情報を返します。getId()
セッションの ID を返します。boolean
isOpen()
基になる接続が開いているかどうか。pingMessage
(FunctionSE<DataBufferFactory, DataBuffer> payloadFactory) セッションにbufferFactory()
を使用して ping WebSocketMessage を作成するファクトリメソッド。pongMessage
(FunctionSE<DataBufferFactory, DataBuffer> payloadFactory) セッションにbufferFactory()
を使用してポン WebSocketMessage を作成するファクトリメソッド。reactor.core.publisher.Flux<WebSocketMessage>
receive()
受信メッセージのストリームへのアクセスを提供します。reactor.core.publisher.Mono<VoidSE>
send
(Publisher<WebSocketMessage> messages) 発信メッセージのソースを提供し、メッセージを書き込み、ソースが完了して書き込みが完了すると完了するMono<Void>
を返します。textMessage
(StringSE payload) セッションにbufferFactory()
を使用してテキストWebSocketMessage
を作成するファクトリメソッド。
メソッドの詳細
getId
StringSE getId()セッションの ID を返します。getHandshakeInfo
HandshakeInfo getHandshakeInfo()ハンドシェイクリクエストから情報を返します。bufferFactory
DataBufferFactory bufferFactory()メッセージペイロードを作成するDataBuffer
ファクトリを返します。- 戻り値:
- セッションのバッファファクトリ
getAttributes
WebSocket セッションに関連付けられた属性を持つマップを返します。- 戻り値:
- セッション属性を持つマップ (非
null
) - 導入:
- 5.1
receive
reactor.core.publisher.Flux<WebSocketMessage> receive()受信メッセージのストリームへのアクセスを提供します。このストリームは、接続が閉じられたときに完了またはエラーシグナルを受け取ります。典型的な
WebSocketHandler
実装では、このストリームは全体的な処理フローに組み込まれるため、接続が閉じられると処理が終了します。セッションの処理方法の詳細と例については、
WebSocketHandler
のクラスレベルのドキュメントとリファレンスを参照してください。send
発信メッセージのソースを提供し、メッセージを書き込み、ソースが完了して書き込みが完了すると完了するMono<Void>
を返します。セッションの処理方法の詳細と例については、
WebSocketHandler
のクラスレベルのドキュメントとリファレンスを参照してください。isOpen
boolean isOpen()基になる接続が開いているかどうか。- 導入:
- 5.3.1
close
CloseStatus.NORMAL
で WebSocket セッションを閉じます。close
指定されたステータスで WebSocket セッションを閉じます。- パラメーター:
status
- 終了ステータス
closeStatus
reactor.core.publisher.Mono<CloseStatus> closeStatus()セッションがローカルまたはリモートで閉じられるCloseStatus
へのアクセスを提供します。セッションがステータスなしで終了した場合は、空になります。- 導入:
- 5.3
textMessage
セッションにbufferFactory()
を使用してテキストWebSocketMessage
を作成するファクトリメソッド。binaryMessage
セッションにbufferFactory()
を使用してバイナリ WebSocketMessage を作成するファクトリメソッド。pingMessage
セッションにbufferFactory()
を使用して ping WebSocketMessage を作成するファクトリメソッド。pongMessage
セッションにbufferFactory()
を使用してポン WebSocketMessage を作成するファクトリメソッド。