クラス StandardWebSocketSession
java.lang.ObjectSE
org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession<jakarta.websocket.Session>
org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession<jakarta.websocket.Session>
org.springframework.web.reactive.socket.adapter.StandardWebSocketSession
- 実装されているすべてのインターフェース:
Subscriber<VoidSE>, WebSocketSession
- 既知の直属サブクラス
TomcatWebSocketSession
public class StandardWebSocketSession
extends AbstractListenerWebSocketSession<jakarta.websocket.Session>
標準 Java(JSR 356)
Session 用の Spring WebSocketSession アダプター。- 導入:
- 5.0
- 作成者:
- Violeta Georgieva, Rossen Stoyanchev
ネストされたクラスの要約
クラス AbstractListenerWebSocketSession から継承されたネストクラス / インターフェース
AbstractListenerWebSocketSession.WebSocketSendProcessorフィールドのサマリー
クラス AbstractWebSocketSession から継承されたフィールド
loggerコンストラクターの概要
コンストラクターコンストラクター説明StandardWebSocketSession(jakarta.websocket.Session session, HandshakeInfo info, DataBufferFactory factory) StandardWebSocketSession(jakarta.websocket.Session session, HandshakeInfo info, DataBufferFactory factory, @Nullable reactor.core.publisher.Sinks.Empty<VoidSE> completionSink) メソッドのサマリー
修飾子と型メソッド説明protected boolean基礎となる WebSocket API にフロー制御があり、メッセージの受信を一時停止および再開できるかどうか。reactor.core.publisher.Mono<VoidSE> close(CloseStatus status) 指定されたステータスで WebSocket セッションを閉じます。booleanisOpen()基になる接続が開いているかどうか。protected voidダウンストリームサブスクライバによって要求が生成された後、新しいメッセージの受信を再開します。protected booleansendMessage(WebSocketMessage message) 指定された WebSocket メッセージを送信します。protected void受信したメッセージが処理され、ダウンストリームサブスクライバーによってより多くの要求が生成されるまで、受信を中断します。クラス AbstractListenerWebSocketSession から継承されたメソッド
closeStatus, getSendProcessor, onComplete, onError, onNext, onSubscribe, receive, sendクラス AbstractWebSocketSession から継承されたメソッド
binaryMessage, bufferFactory, getAttributes, getDelegate, getHandshakeInfo, getId, getLogPrefix, pingMessage, pongMessage, textMessage, toStringクラス ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSEインターフェース WebSocketSession から継承されたメソッド
close
コンストラクターの詳細
StandardWebSocketSession
public StandardWebSocketSession(jakarta.websocket.Session session, HandshakeInfo info, DataBufferFactory factory) StandardWebSocketSession
public StandardWebSocketSession(jakarta.websocket.Session session, HandshakeInfo info, DataBufferFactory factory, @Nullable reactor.core.publisher.Sinks.Empty<VoidSE> completionSink)
メソッドの詳細
canSuspendReceiving
protected boolean canSuspendReceiving()クラスからコピーされた説明:AbstractListenerWebSocketSession基礎となる WebSocket API にフロー制御があり、メッセージの受信を一時停止および再開できるかどうか。注意 : サブクラスは、可能であれば一時停止モードで開始し、要求が受信されるまで待機することをお勧めします。
- 次で指定:
- クラス
AbstractListenerWebSocketSession<jakarta.websocket.Session>のcanSuspendReceiving
suspendReceiving
protected void suspendReceiving()クラスからコピーされた説明:AbstractListenerWebSocketSession受信したメッセージが処理され、ダウンストリームサブスクライバーによってより多くの要求が生成されるまで、受信を中断します。注意 : 基礎となる WebSocket API がメッセージを受信するためのフロー制御を提供しない場合、このメソッドは何もしないで、
AbstractListenerWebSocketSession.canSuspendReceiving()はfalseを返す必要があります。- 次で指定:
- クラス
AbstractListenerWebSocketSession<jakarta.websocket.Session>のsuspendReceiving
resumeReceiving
protected void resumeReceiving()クラスからコピーされた説明:AbstractListenerWebSocketSessionダウンストリームサブスクライバによって要求が生成された後、新しいメッセージの受信を再開します。注意 : 基礎となる WebSocket API がメッセージを受信するためのフロー制御を提供しない場合、このメソッドは何もしないで、
AbstractListenerWebSocketSession.canSuspendReceiving()はfalseを返す必要があります。- 次で指定:
- クラス
AbstractListenerWebSocketSession<jakarta.websocket.Session>のresumeReceiving
sendMessage
クラスからコピーされた説明:AbstractListenerWebSocketSession指定された WebSocket メッセージを送信します。注意 : プールされたバッファーが基になるコンテナーに適用される場合、サブクラスは、完全に書き込まれた後、ペイロードデータバッファーを解放します。
- 次で指定:
- クラス
AbstractListenerWebSocketSession<jakarta.websocket.Session>のsendMessage - 例外:
IOExceptionSE
isOpen
close