ReactorNettyWebSocketSession (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession<T>
- - org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport<ReactorNettyWebSocketSession.WebSocketConnection>
  - - org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession

実装されたすべてのインターフェース:
WebSocketSession
```
public class ReactorNettyWebSocketSession
extends NettyWebSocketSessionSupport<ReactorNettyWebSocketSession.WebSocketConnection>
```
Reactor Netty の NettyInbound および NettyOutbound で使用する WebSocketSession 実装。
導入:
5.0
作成者:
Rossen Stoyanchev

ネストされたクラスのサマリー

ネストされたクラス
修飾子と型	クラスと説明
`static class`	`ReactorNettyWebSocketSession.WebSocketConnection` `NettyInbound` および `NettyOutbound` のシンプルなコンテナー。

フィールドサマリー
- クラス org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport から継承されたフィールド
  DEFAULT_FRAME_MAX_SIZE
- クラス org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession から継承されたフィールド
  logger

コンストラクターのサマリー

コンストラクター
コンストラクターと説明
`ReactorNettyWebSocketSession(reactor.netty.http.websocket.WebsocketInbound inbound, reactor.netty.http.websocket.WebsocketOutbound outbound, HandshakeInfo info, NettyDataBufferFactory bufferFactory)` `NettyWebSocketSessionSupport.DEFAULT_FRAME_MAX_SIZE` 値を使用するセッションのコンストラクター。
`ReactorNettyWebSocketSession(reactor.netty.http.websocket.WebsocketInbound inbound, reactor.netty.http.websocket.WebsocketOutbound outbound, HandshakeInfo info, NettyDataBufferFactory bufferFactory, int maxFramePayloadLength)` 追加の maxFramePayloadLength 引数を持つコンストラクター。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`reactor.core.publisher.Mono<VoidSE>`	`close(CloseStatus status)` 指定されたステータスで WebSocket セッションを閉じます。
`reactor.core.publisher.Mono<CloseStatus>`	`closeStatus()` セッションがローカルまたはリモートで閉じられる `CloseStatus` へのアクセスを提供します。セッションがステータスなしで終了した場合は、空になります。
`io.netty.channel.ChannelId`	`getChannelId()` 基になる Netty チャネルの ID を返します。
`boolean`	`isOpen()` 基になる接続が開いているかどうか。
`reactor.core.publisher.Flux<WebSocketMessage>`	`receive()` 受信メッセージのストリームへのアクセスを提供します。
`reactor.core.publisher.Mono<VoidSE>`	`send(Publisher<WebSocketMessage> messages)` 発信メッセージのソースを提供し、メッセージを書き込み、ソースが完了して書き込みが完了すると完了する `Mono<Void>` を返します。

クラス org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport から継承されたメソッド
bufferFactory, toFrame, toMessage

クラス org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession から継承されたメソッド
binaryMessage, getAttributes, getDelegate, getHandshakeInfo, getId, getLogPrefix, pingMessage, pongMessage, textMessage, toString

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

インターフェース org.springframework.web.reactive.socket.WebSocketSession から継承されたメソッド
close

- コンストラクターの詳細
  - ReactorNettyWebSocketSession
```
public ReactorNettyWebSocketSession(reactor.netty.http.websocket.WebsocketInbound inbound,
                                    reactor.netty.http.websocket.WebsocketOutbound outbound,
                                    HandshakeInfo info,
                                    NettyDataBufferFactory bufferFactory)
```
    NettyWebSocketSessionSupport.DEFAULT_FRAME_MAX_SIZE 値を使用するセッションのコンストラクター。
  - ReactorNettyWebSocketSession
```
public ReactorNettyWebSocketSession(reactor.netty.http.websocket.WebsocketInbound inbound,
                                    reactor.netty.http.websocket.WebsocketOutbound outbound,
                                    HandshakeInfo info,
                                    NettyDataBufferFactory bufferFactory,
                                    int maxFramePayloadLength)
```
    追加の maxFramePayloadLength 引数を持つコンストラクター。
    導入:
    5.1
- メソッドの詳細
  - getChannelId
```
public io.netty.channel.ChannelId getChannelId()
```
    基になる Netty チャネルの ID を返します。
    導入:
    5.3.4
  - receive
```
public reactor.core.publisher.Flux<WebSocketMessage> receive()
```
    インターフェースからコピーされた説明: WebSocketSession
    受信メッセージのストリームへのアクセスを提供します。
    このストリームは、接続が閉じられたときに完了またはエラー信号を受け取ります。典型的な WebSocketHandler 実装では、このストリームは全体的な処理フローに組み込まれるため、接続が閉じられると処理が終了します。
    セッションの処理方法の詳細と例については、WebSocketHandler のクラスレベルのドキュメントとリファレンスを参照してください。
    次で指定:
    インターフェース WebSocketSession の receive
    次で指定:
    クラス AbstractWebSocketSession<ReactorNettyWebSocketSession.WebSocketConnection> の receive
  - send
```
public reactor.core.publisher.Mono<VoidSE> send(Publisher<WebSocketMessage> messages)
```
    インターフェースからコピーされた説明: WebSocketSession
    発信メッセージのソースを提供し、メッセージを書き込み、ソースが完了して書き込みが完了すると完了する Mono<Void> を返します。
    セッションの処理方法の詳細と例については、WebSocketHandler のクラスレベルのドキュメントとリファレンスを参照してください。
    次で指定:
    インターフェース WebSocketSession の send
    次で指定:
    クラス AbstractWebSocketSession<ReactorNettyWebSocketSession.WebSocketConnection> の send
  - isOpen
```
public boolean isOpen()
```
    インターフェースからコピーされた説明: WebSocketSession
    基になる接続が開いているかどうか。
  - close
```
public reactor.core.publisher.Mono<VoidSE> close(CloseStatus status)
```
    インターフェースからコピーされた説明: WebSocketSession
    指定されたステータスで WebSocket セッションを閉じます。
    パラメーター:
    status - 終了ステータス
  - closeStatus
```
public reactor.core.publisher.Mono<CloseStatus> closeStatus()
```
    インターフェースからコピーされた説明: WebSocketSession
    セッションがローカルまたはリモートで閉じられる CloseStatus へのアクセスを提供します。セッションがステータスなしで終了した場合は、空になります。

クラス ReactorNettyWebSocketSession

ネストされたクラスのサマリー

フィールドサマリー

クラス org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport から継承されたフィールド

クラス org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport から継承されたメソッド

クラス org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

インターフェース org.springframework.web.reactive.socket.WebSocketSession から継承されたメソッド

コンストラクターの詳細

ReactorNettyWebSocketSession

ReactorNettyWebSocketSession

メソッドの詳細

getChannelId

receive

send

isOpen

close

closeStatus