パッケージ org.springframework.http.server.reactive

クラス AbstractListenerReadPublisher<T>

java.lang.ObjectSE
org.springframework.http.server.reactive.AbstractListenerReadPublisher<T>
型パラメーター:
T - 通知された要素の型
実装されたすべてのインターフェース:
Publisher<T>
public abstract class AbstractListenerReadPublisher<T> extends ObjectSE implements Publisher<T>
イベントリスナー読み取り API と Reactive Streams の間をブリッジする Publisher 実装の抽象基本クラス。

具体的には、サーブレットのノンブロッキング I/O および Undertow XNIO を使用して HTTP リクエスト本文から読み取り、標準の Jakarta WebSocket (JSR-356)、Jetty、Undertow を使用して受信 WebSocket メッセージを処理するための基本クラスです。

導入:
5.0
作成者:
Arjen Poutsma, Violeta Georgieva, Rossen Stoyanchev

  • フィールドサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    protected static Log
    rsReadLogger
    Reactive Streams 信号をデバッグするための特別なロガー。

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

    コンストラクター
    コンストラクター
    説明
    AbstractListenerReadPublisher()
    AbstractListenerReadPublisher(StringSE logPrefix)
    指定されたログプレフィックスでインスタンスを作成します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    protected abstract void
    checkOnDataAvailable()
    データが利用可能かどうかを確認し、onDataAvailable() をすぐに呼び出すか、通知をスケジュールします。
    protected abstract void
    discardData()
    基盤となるサーバーからの I/O 読み取りエラーの後、またはダウンストリームコンシューマーからのキャンセル信号の後に呼び出され、サブクラスが現在キャッシュされている可能性のあるデータを破棄できるようにします。
    StringSE
    getLogPrefix()
    設定されたログメッセージプレフィックスを返します。
    void
    onAllDataRead()
    サブクラスはこのメソッドを呼び出して onComplete を通知し、すべてのデータが読み取られたときにコンテナーからの通知を委譲できます。
    final void
    onDataAvailable()
    checkOnDataAvailable() によるチェックの後、同じスレッドで、基盤となるコンテナーからのコールバックとして、読み取りが可能なときに呼び出されます。
    final void
    onError(ThrowableSE ex)
    サブクラスはこれを呼び出して onError を通知し、コンテナーからのエラー通知を委譲できます。
    protected abstract T
    read()
    可能であれば、入力から 1 回読み取ります。
    protected abstract void
    readingPaused()
    要求がなかったために読み取りが一時停止されたときに呼び出されます。
    void
    subscribe(Subscriber<? super T> subscriber)

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

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

  • フィールドの詳細

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

    • AbstractListenerReadPublisher

      public AbstractListenerReadPublisher()

    • AbstractListenerReadPublisher

      public AbstractListenerReadPublisher(StringSE logPrefix)
      指定されたログプレフィックスでインスタンスを作成します。
      導入:
      5.1

  • メソッドの詳細

    • getLogPrefix

      public StringSE getLogPrefix()
      設定されたログメッセージプレフィックスを返します。
      導入:
      5.1

    • subscribe

      public void subscribe(Subscriber<? super T> subscriber)
      次で指定:
      インターフェース Publisher<T> の subscribe 

    • onDataAvailable

      public final void onDataAvailable()
      checkOnDataAvailable() によるチェックの後、同じスレッドで、基盤となるコンテナーからのコールバックとして、読み取りが可能なときに呼び出されます。

    • onAllDataRead

      public void onAllDataRead()
      サブクラスはこのメソッドを呼び出して onComplete を通知し、すべてのデータが読み取られたときにコンテナーからの通知を委譲できます。

    • onError

      public final void onError(ThrowableSE ex)
      サブクラスはこれを呼び出して onError を通知し、コンテナーからのエラー通知を委譲できます。

    • checkOnDataAvailable

      protected abstract void checkOnDataAvailable()
      データが利用可能かどうかを確認し、onDataAvailable() をすぐに呼び出すか、通知をスケジュールします。

    • read

      @Nullable protected abstract T read() throws IOExceptionSE
      可能であれば、入力から 1 回読み取ります。
      戻り値:
      読み込まれたアイテム。または null
      例外:
      IOExceptionSE

    • readingPaused

      protected abstract void readingPaused()
      要求がなかったために読み取りが一時停止されたときに呼び出されます。

      注意 : このメソッドは checkOnDataAvailable() と競合しないことが保証されているため、基になる API がサポートしている場合、つまり checkOnDataAvailable() を介して再開する暗黙的な呼び出しと競合することなく、安全に読み取りを中断できます。

      導入:
      5.0.2

    • discardData

      protected abstract void discardData()
      基盤となるサーバーからの I/O 読み取りエラーの後、またはダウンストリームコンシューマーからのキャンセル信号の後に呼び出され、サブクラスが現在キャッシュされている可能性のあるデータを破棄できるようにします。
      導入:
      5.0.11