WebSocketSession (Spring Framework 5.0.0.RELEASE API)

すべての既知の実装クラス:
AbstractListenerWebSocketSession, AbstractWebSocketSession, JettyWebSocketSession, NettyWebSocketSessionSupport, ReactorNettyWebSocketSession, StandardWebSocketSession, TomcatWebSocketSession, UndertowWebSocketSession
```
public interface WebSocketSession
```
Reactive Streams の入出力を備えた WebSocket セッションを表します。
サーバー側では、リクエストを WebSocketHandler にマッピングし、Spring 構成に WebSocketHandlerAdapter 戦略が登録されていることを確認することで、WebSocket セッションを処理できます。クライアント側では、WebSocketHandler を WebSocketClient に提供できます。
導入:
5.0
作成者:
Rossen Stoyanchev

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッドデフォルトメソッド
修飾子と型	メソッドと説明
`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 セッションを閉じます。
`HandshakeInfo`	`getHandshakeInfo()` ハンドシェイクリクエストから情報を返します。
`StringSE`	`getId()` セッションの ID を返します。
`WebSocketMessage`	`pingMessage(FunctionSE<DataBufferFactory, DataBuffer> payloadFactory)` セッションに `bufferFactory()` を使用して ping WebSocketMessage を作成するファクトリメソッド。
`WebSocketMessage`	`pongMessage(FunctionSE<DataBufferFactory, DataBuffer> payloadFactory)` セッションに `bufferFactory()` を使用してポン WebSocketMessage を作成するファクトリメソッド。
`reactor.core.publisher.Flux<WebSocketMessage>`	`receive()` 受信メッセージの flux を取得します。
`reactor.core.publisher.Mono<VoidSE>`	`send(org.reactivestreams.Publisher<WebSocketMessage> messages)` 指定されたメッセージを WebSocket 接続に書き込みます。
`WebSocketMessage`	`textMessage(StringSE payload)` セッションに `bufferFactory()` を使用してテキスト `WebSocketMessage` を作成するファクトリメソッド。

- メソッドの詳細
  - getId
```
StringSE getId()
```
    セッションの ID を返します。
  - getHandshakeInfo
```
HandshakeInfo getHandshakeInfo()
```
    ハンドシェイクリクエストから情報を返します。
  - bufferFactory
```
DataBufferFactory bufferFactory()
```
    メッセージペイロードを作成する DataBuffer ファクトリを返します。
    戻り値:
    セッションのバッファファクトリ
  - receive
```
reactor.core.publisher.Flux<WebSocketMessage> receive()
```
    受信メッセージの flux を取得します。
  - send
```
reactor.core.publisher.Mono<VoidSE> send(org.reactivestreams.Publisher<WebSocketMessage> messages)
```
    指定されたメッセージを WebSocket 接続に書き込みます。
    パラメーター:
    messages - 書き込むメッセージ
  - close
```
default reactor.core.publisher.Mono<VoidSE> close()
```
    CloseStatus.NORMAL で WebSocket セッションを閉じます。
  - close
```
reactor.core.publisher.Mono<VoidSE> close(CloseStatus status)
```
    指定されたステータスで WebSocket セッションを閉じます。
    パラメーター:
    status - 終了ステータス
  - 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 を作成するファクトリメソッド。

インターフェース WebSocketSession

メソッドのサマリー

メソッドの詳細

getId

getHandshakeInfo

bufferFactory

receive

send

close

close

textMessage

binaryMessage

pingMessage

pongMessage