UndertowWebSocketSession (Spring Framework 5.0.0.RELEASE API)

java.lang.ObjectSE
- org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession<T>
- - org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession<io.undertow.websockets.core.WebSocketChannel>
  - - org.springframework.web.reactive.socket.adapter.UndertowWebSocketSession

実装されているすべてのインターフェース:
org.reactivestreams.Subscriber<VoidSE>, WebSocketSession
```
public class UndertowWebSocketSession
extends AbstractListenerWebSocketSession<io.undertow.websockets.core.WebSocketChannel>
```
Undertow WebSocketChannel に適応する Spring WebSocketSession 実装。
導入:
5.0
作成者:
Violeta Georgieva, Rossen Stoyanchev

ネストされたクラスの要約
- クラス org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession から継承されたネストクラス / インターフェース
  AbstractListenerWebSocketSession.WebSocketSendProcessor

コンストラクターの概要

コンストラクター
コンストラクターと説明
`UndertowWebSocketSession(io.undertow.websockets.core.WebSocketChannel channel, HandshakeInfo info, DataBufferFactory factory)`
`UndertowWebSocketSession(io.undertow.websockets.core.WebSocketChannel channel, HandshakeInfo info, DataBufferFactory factory, reactor.core.publisher.MonoProcessor<VoidSE> completionMono)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected boolean`	`canSuspendReceiving()` 基礎となる WebSocket API にフロー制御があり、メッセージの受信を一時停止および再開できるかどうか。
`reactor.core.publisher.Mono<VoidSE>`	`close(CloseStatus status)` 指定されたステータスで WebSocket セッションを閉じます。
`protected void`	`resumeReceiving()` ダウンストリームサブスクライバによって要求が生成された後、新しいメッセージの受信を再開します。
`protected boolean`	`sendMessage(WebSocketMessage message)` 指定された WebSocket メッセージを送信します。
`protected void`	`suspendReceiving()` 受信したメッセージが処理され、ダウンストリームサブスクライバーによってより多くの要求が生成されるまで、受信を中断します。

クラス org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession から継承されたメソッド
getSendProcessor, onComplete, onError, onNext, onSubscribe, receive, send

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

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

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

- コンストラクターの詳細
  - UndertowWebSocketSession
```
public UndertowWebSocketSession(io.undertow.websockets.core.WebSocketChannel channel,
                                HandshakeInfo info,
                                DataBufferFactory factory)
```
  - UndertowWebSocketSession
```
public UndertowWebSocketSession(io.undertow.websockets.core.WebSocketChannel channel,
                                HandshakeInfo info,
                                DataBufferFactory factory,
                                @Nullable
                                reactor.core.publisher.MonoProcessor<VoidSE> completionMono)
```
- メソッドの詳細
  - canSuspendReceiving
```
protected boolean canSuspendReceiving()
```
    クラスからコピーされた説明: AbstractListenerWebSocketSession
    基礎となる WebSocket API にフロー制御があり、メッセージの受信を一時停止および再開できるかどうか。
    次で指定:
    クラス AbstractListenerWebSocketSession<io.undertow.websockets.core.WebSocketChannel> の canSuspendReceiving
  - suspendReceiving
```
protected void suspendReceiving()
```
    クラスからコピーされた説明: AbstractListenerWebSocketSession
    受信したメッセージが処理され、ダウンストリームサブスクライバーによってより多くの要求が生成されるまで、受信を中断します。
    注意 : 基礎となる WebSocket API がメッセージを受信するためのフロー制御を提供せず、このメソッドが何も実行されず、AbstractListenerWebSocketSession.canSuspendReceiving() が false を返す場合。
    次で指定:
    クラス AbstractListenerWebSocketSession<io.undertow.websockets.core.WebSocketChannel> の suspendReceiving
  - resumeReceiving
```
protected void resumeReceiving()
```
    クラスからコピーされた説明: AbstractListenerWebSocketSession
    ダウンストリームサブスクライバによって要求が生成された後、新しいメッセージの受信を再開します。
    注意 : 基礎となる WebSocket API がメッセージを受信するためのフロー制御を提供せず、このメソッドが何も実行されず、AbstractListenerWebSocketSession.canSuspendReceiving() が false を返す場合。
    次で指定:
    クラス AbstractListenerWebSocketSession<io.undertow.websockets.core.WebSocketChannel> の resumeReceiving
  - sendMessage
```
protected boolean sendMessage(WebSocketMessage message)
                       throws IOExceptionSE
```
    クラスからコピーされた説明: AbstractListenerWebSocketSession
    指定された WebSocket メッセージを送信します。
    次で指定:
    クラス AbstractListenerWebSocketSession<io.undertow.websockets.core.WebSocketChannel> の sendMessage
    例外:
    IOExceptionSE
  - close
```
public reactor.core.publisher.Mono<VoidSE> close(CloseStatus status)
```
    インターフェースからコピーされた説明: WebSocketSession
    指定されたステータスで WebSocket セッションを閉じます。
    パラメーター:
    status - 終了ステータス

クラス UndertowWebSocketSession

ネストされたクラスの要約

クラス org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession から継承されたネストクラス / インターフェース

コンストラクターの概要

メソッドのサマリー

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

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

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

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

コンストラクターの詳細

UndertowWebSocketSession

UndertowWebSocketSession

メソッドの詳細

canSuspendReceiving

suspendReceiving

resumeReceiving

sendMessage

close