インターフェース WebSocketSession

メソッドの詳細

• getId

  StringSE getId()

  セッションの ID を返します。

• getHandshakeInfo

  HandshakeInfo getHandshakeInfo()

  ハンドシェイクリクエストから情報を返します。

• bufferFactory

  DataBufferFactory bufferFactory()

  メッセージペイロードを作成する DataBuffer ファクトリを返します。

  戻り値:

  セッションのバッファファクトリ

• getAttributes

  MapSE<StringSE,ObjectSE> getAttributes()

  WebSocket セッションに関連付けられた属性を持つマップを返します。

  戻り値:

  セッション属性を持つマップ (非 null)

  導入:

  5.1

• receive

  reactor.core.publisher.Flux<WebSocketMessage> receive()

  受信メッセージのストリームへのアクセスを提供します。

  このストリームは、接続が閉じられたときに完了またはエラーシグナルを受け取ります。典型的な WebSocketHandler 実装では、このストリームは全体的な処理フローに組み込まれるため、接続が閉じられると処理が終了します。

  セッションの処理方法の詳細と例については、WebSocketHandler のクラスレベルのドキュメントとリファレンスを参照してください。

• send

  reactor.core.publisher.Mono<VoidSE> send(Publisher<WebSocketMessage> messages)

  発信メッセージのソースを提供し、メッセージを書き込み、ソースが完了して書き込みが完了すると完了する Mono<Void> を返します。

  セッションの処理方法の詳細と例については、WebSocketHandler のクラスレベルのドキュメントとリファレンスを参照してください。

• isOpen

  boolean isOpen()

  基になる接続が開いているかどうか。

  導入:

  5.3.1

• close

  default reactor.core.publisher.Mono<VoidSE> close()

  CloseStatus.NORMAL で WebSocket セッションを閉じます。

• close

  reactor.core.publisher.Mono<VoidSE> close(CloseStatus status)

  指定されたステータスで WebSocket セッションを閉じます。

  パラメーター:

  status - 終了ステータス

• closeStatus

  reactor.core.publisher.Mono<CloseStatus> closeStatus()

  セッションがローカルまたはリモートで閉じられる CloseStatus へのアクセスを提供します。セッションがステータスなしで終了した場合は、空になります。

  導入:

  5.3

• textMessage

  WebSocketMessage textMessage(StringSE payload)

  セッションに bufferFactory() を使用してテキスト WebSocketMessage を作成するファクトリメソッド。

• binaryMessage

  WebSocketMessage binaryMessage(FunctionSE<DataBufferFactory,DataBuffer> payloadFactory)

  セッションに bufferFactory() を使用してバイナリ WebSocketMessage を作成するファクトリメソッド。

• pingMessage

  WebSocketMessage pingMessage(FunctionSE<DataBufferFactory,DataBuffer> payloadFactory)

  セッションに bufferFactory() を使用して ping WebSocketMessage を作成するファクトリメソッド。

• pongMessage

  WebSocketMessage pongMessage(FunctionSE<DataBufferFactory,DataBuffer> payloadFactory)

  セッションに bufferFactory() を使用してポン WebSocketMessage を作成するファクトリメソッド。