パッケージ org.springframework.data.redis.connection.util

クラス AbstractSubscription

java.lang.ObjectSE
org.springframework.data.redis.connection.util.AbstractSubscription
実装済みのインターフェース一覧:
Subscription
既知の直属サブクラス
LettuceSubscription
public abstract class AbstractSubscription extends ObjectSE implements Subscription
チャネル / パターン登録を処理するサブスクリプションの基本実装。サブクラスは実際の登録 / 登録解除のみを処理する必要があります。
作成者:
Costin Leau, Christoph Strobl

  • コンストラクター概要

    コンストラクター
    修飾子
    コンストラクター
    説明
    protected
    AbstractSubscription(MessageListener listener)
    protected
    AbstractSubscription(MessageListener listener, byte[][] channels, byte[][] patterns)
    新しい AbstractSubscription インスタンスを構築します。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    void
    close()
    サブスクリプションをシャットダウンし、保持されているリソースをすべて解放します。
    protected abstract void
    doClose()
    サブスクリプションをシャットダウンし、保持されているリソースをすべて解放します。
    protected abstract void
    doPsubscribe(byte[]... patterns)
    与えられたパターンを購読する
    protected abstract void
    doPUnsubscribe(boolean all, byte[]... patterns)
    パターンの購読解除。
    protected abstract void
    doSubscribe(byte[]... channels)
    指定されたチャネルにサブスクライブします。
    protected abstract void
    doUnsubscribe(boolean all, byte[]... channels)
    チャンネル登録解除。
    CollectionSE<byte[]>
    getChannels()
    このサブスクリプションの（名前付き）チャネルを返します。
    MessageListener
    getListener()
    このサブスクリプションに使用されるリスナーを返します。
    CollectionSE<byte[]>
    getPatterns()
    このサブスクリプションのチャネルパターンを返します。
    boolean
    isAlive()
    このサブスクリプションがまだ「生きている」かどうかを示します。
    void
    pSubscribe(byte[]... patterns)
    指定されたチャネルパターンを現在のサブスクリプションに追加します。
    void
    pUnsubscribe()
    パターンに一致するすべてのチャネルのサブスクリプションをキャンセルします。
    void
    pUnsubscribe(byte[]... patts)
    指定されたパターンに一致するすべてのチャネルのサブスクリプションをキャンセルします。
    void
    subscribe(byte[]... channels)
    指定されたチャネルを現在のサブスクリプションに追加します。
    void
    unsubscribe()
    名前で指定されたすべてのチャネルの現在のサブスクリプションをキャンセルします。
    void
    unsubscribe(byte[]... chans)
    指定されたすべてのチャネルの現在のサブスクリプションをキャンセルします。

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

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

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

    • AbstractSubscription

      protected AbstractSubscription(MessageListener listener)

    • AbstractSubscription

      protected AbstractSubscription(MessageListener listener, @Nullable byte[][] channels, @Nullable byte[][] patterns)
      新しい AbstractSubscription インスタンスを構築します。サブスクリプションアクションをトリガーせずにチャネルとパターンをサブスクリプションに追加できるようにします (一部のクライアント (Jedis) は、リスニングモードに入る前に最初の呼び出しが必要なため)。
      パラメーター:
      listener - null であってはなりません。
      channels - null でもかまいません。
      patterns - null でもかまいません。

  • 方法の詳細

    • doSubscribe

      protected abstract void doSubscribe(byte[]... channels)
      指定されたチャネルにサブスクライブします。
      パラメーター:
      channels - サブスクライブするチャネル

    • doUnsubscribe

      protected abstract void doUnsubscribe(boolean all, byte[]... channels)
      チャンネル登録解除。
      パラメーター:
      all - すべてのチャネルがサブスクライブされていない場合は true（基礎となる実装のヒントとして使用）。
      channels - 退会するチャンネル

    • doPsubscribe

      protected abstract void doPsubscribe(byte[]... patterns)
      与えられたパターンを購読する
      パラメーター:
      patterns - サブスクライブするパターン

    • doPUnsubscribe

      protected abstract void doPUnsubscribe(boolean all, byte[]... patterns)
      パターンの購読解除。
      パラメーター:
      all - すべてのパターンがサブスクライブされていない場合は true（基礎となる実装のヒントとして使用）。
      patterns - 退会するパターン

    • close

      public void close()
      インターフェースからコピーされた説明: Subscription
      サブスクリプションをシャットダウンし、保持されているリソースをすべて解放します。
      次で指定:
      インターフェース Subscription 内の close 

    • doClose

      protected abstract void doClose()
      サブスクリプションをシャットダウンし、保持されているリソースをすべて解放します。

    • getListener

      public MessageListener getListener()
      インターフェースからコピーされた説明: Subscription
      このサブスクリプションに使用されるリスナーを返します。
      次で指定:
      インターフェース Subscription 内の getListener 
      戻り値:
      このサブスクリプションに使用されるリスナー。

    • getChannels

      public CollectionSE<byte[]> getChannels()
      インターフェースからコピーされた説明: Subscription
      このサブスクリプションの（名前付き）チャネルを返します。
      次で指定:
      インターフェース Subscription 内の getChannels 
      戻り値:
      名前付きチャンネルのコレクション

    • getPatterns

      public CollectionSE<byte[]> getPatterns()
      インターフェースからコピーされた説明: Subscription
      このサブスクリプションのチャネルパターンを返します。
      次で指定:
      インターフェース Subscription 内の getPatterns 
      戻り値:
      チャネルパターンのコレクション

    • pSubscribe

      public void pSubscribe(byte[]... patterns)
      インターフェースからコピーされた説明: Subscription
      指定されたチャネルパターンを現在のサブスクリプションに追加します。
      次で指定:
      インターフェース Subscription 内の pSubscribe 
      パラメーター:
      patterns - チャネルパターン。空であってはなりません。

    • pUnsubscribe

      public void pUnsubscribe()
      インターフェースからコピーされた説明: Subscription
      パターンに一致するすべてのチャネルのサブスクリプションをキャンセルします。
      次で指定:
      インターフェース Subscription 内の pUnsubscribe 

    • subscribe

      public void subscribe(byte[]... channels)
      インターフェースからコピーされた説明: Subscription
      指定されたチャネルを現在のサブスクリプションに追加します。
      次で指定:
      インターフェース Subscription 内の subscribe 
      パラメーター:
      channels - チャネル名。空であってはなりません。

    • unsubscribe

      public void unsubscribe()
      インターフェースからコピーされた説明: Subscription
      名前で指定されたすべてのチャネルの現在のサブスクリプションをキャンセルします。
      次で指定:
      インターフェース Subscription 内の unsubscribe 

    • pUnsubscribe

      public void pUnsubscribe(@Nullable byte[]... patts)
      インターフェースからコピーされた説明: Subscription
      指定されたパターンに一致するすべてのチャネルのサブスクリプションをキャンセルします。
      次で指定:
      インターフェース Subscription 内の pUnsubscribe 
      パラメーター:
      patts - 空であってはなりません。

    • unsubscribe

      public void unsubscribe(@Nullable byte[]... chans)
      インターフェースからコピーされた説明: Subscription
      指定されたすべてのチャネルの現在のサブスクリプションをキャンセルします。
      次で指定:
      インターフェース Subscription 内の unsubscribe 
      パラメーター:
      chans - チャネル名。空であってはなりません。

    • isAlive

      public boolean isAlive()
      インターフェースからコピーされた説明: Subscription
      このサブスクリプションがまだ「生きている」かどうかを示します。
      次で指定:
      インターフェース Subscription 内の isAlive 
      戻り値:
      サブスクリプションが引き続き適用される場合は true、それ以外の場合は false。