パッケージ org.springframework.web.reactive.socket.adapter

クラス UndertowWebSocketSession

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
実装済みのインターフェース一覧:
Subscriber<VoidSE>, WebSocketSession
@DeprecatedSE(since="6.2.18", forRemoval=true) public class UndertowWebSocketSession extends AbstractListenerWebSocketSession<io.undertow.websockets.core.WebSocketChannel>
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
6.2.18 現在、代替なし
Undertow WebSocketChannel に適応する Spring WebSocketSession 実装。
導入:
5.0
作成者:
Violeta Georgieva, Rossen Stoyanchev

  • ネストされたクラスの概要

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

    AbstractListenerWebSocketSession.WebSocketSendProcessor

  • フィールド概要

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

    logger

  • コンストラクター概要

    コンストラクター
    コンストラクター
    説明
    UndertowWebSocketSession(io.undertow.websockets.core.WebSocketChannel channel, HandshakeInfo info, DataBufferFactory factory)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    UndertowWebSocketSession(io.undertow.websockets.core.WebSocketChannel channel, HandshakeInfo info, DataBufferFactory factory, reactor.core.publisher.Sinks.Empty<VoidSE> completionSink)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  • 方法の概要

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

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

    closeStatus, getSendProcessor, onComplete, onError, onNext, onSubscribe, receive, send

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

    binaryMessage, bufferFactory, getAttributes, getDelegate, getHandshakeInfo, getId, getLogPrefix, pingMessage, pongMessage, textMessage, toString

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

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, wait, waitSE, waitSE

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

    close

  • コンストラクターの詳細

    • UndertowWebSocketSession

      public UndertowWebSocketSession(io.undertow.websockets.core.WebSocketChannel channel, HandshakeInfo info, DataBufferFactory factory)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • UndertowWebSocketSession

      public UndertowWebSocketSession(io.undertow.websockets.core.WebSocketChannel channel, HandshakeInfo info, DataBufferFactory factory, @Nullable reactor.core.publisher.Sinks.Empty<VoidSE> completionSink)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  • 方法の詳細

    • canSuspendReceiving

      protected boolean canSuspendReceiving()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      クラスからコピーされた説明: AbstractListenerWebSocketSession
      基礎となる WebSocket API にフロー制御があり、メッセージの受信を一時停止および再開できるかどうか。

      注意 : サブクラスは、可能であれば一時停止モードで開始し、要求が受信されるまで待機することをお勧めします。

      次で指定:
      クラス AbstractListenerWebSocketSession<io.undertow.websockets.core.WebSocketChannel> の canSuspendReceiving 

    • suspendReceiving

      protected void suspendReceiving()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      クラスからコピーされた説明: AbstractListenerWebSocketSession
      受信したメッセージが処理され、ダウンストリームサブスクライバーによってより多くの要求が生成されるまで、受信を中断します。

      注意 : 基礎となる WebSocket API がメッセージを受信するためのフロー制御を提供しない場合、このメソッドは何もしないで、AbstractListenerWebSocketSession.canSuspendReceiving() は false を返す必要があります。

      次で指定:
      クラス AbstractListenerWebSocketSession<io.undertow.websockets.core.WebSocketChannel> の suspendReceiving 

    • resumeReceiving

      protected void resumeReceiving()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      クラスからコピーされた説明: AbstractListenerWebSocketSession
      ダウンストリームサブスクライバによって要求が生成された後、新しいメッセージの受信を再開します。

      注意 : 基礎となる WebSocket API がメッセージを受信するためのフロー制御を提供しない場合、このメソッドは何もしないで、AbstractListenerWebSocketSession.canSuspendReceiving() は false を返す必要があります。

      次で指定:
      クラス AbstractListenerWebSocketSession<io.undertow.websockets.core.WebSocketChannel> の resumeReceiving 

    • sendMessage

      protected boolean sendMessage(WebSocketMessage message) throws IOExceptionSE
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      クラスからコピーされた説明: AbstractListenerWebSocketSession
      指定された WebSocket メッセージを送信します。

      注意 : プールされたバッファーが基になるコンテナーに適用される場合、サブクラスは、完全に書き込まれた後、ペイロードデータバッファーを解放します。

      次で指定:
      クラス AbstractListenerWebSocketSession<io.undertow.websockets.core.WebSocketChannel> の sendMessage 
      例外:
      IOExceptionSE

    • isOpen

      public boolean isOpen()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      インターフェースからコピーされた説明: WebSocketSession
      基になる接続が開いているかどうか。

    • close

      public reactor.core.publisher.Mono<VoidSE> close(CloseStatus status)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      インターフェースからコピーされた説明: WebSocketSession
      指定されたステータスで WebSocket セッションを閉じます。
      パラメーター:
      status - 終了ステータス