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