インターフェース RedisPubSubCommands
- すべての既知のサブインターフェース:
DefaultedRedisClusterConnection
、DefaultedRedisConnection
、RedisClusterConnection
、RedisCommands
、RedisConnection
、RedisConnectionUtils.RedisConnectionProxy
、StringRedisConnection
- すべての既知の実装クラス:
AbstractRedisConnection
、DefaultStringRedisConnection
、JedisClusterConnection
、JedisConnection
、LettuceClusterConnection
、LettuceConnection
public interface RedisPubSubCommands
PubSub 固有の Redis コマンド。
- 作成者:
- Costin Leau, Mark Paluch, Christoph Strobl
メソッドのサマリー
修飾子と型メソッド説明この接続の現在のサブスクリプションを返します。接続がサブスクライブされていない場合は null を返します。boolean
現在の接続が(少なくとも 1 つのチャネルに)サブスクライブされているかどうかを示します。void
pSubscribe
(MessageListener listener, byte[]... patterns) 指定されたパターンに一致するすべてのチャネルへの接続をサブスクライブします。publish
(byte[] channel, byte[] message) 指定されたメッセージを指定されたチャネルに公開します。void
subscribe
(MessageListener listener, byte[]... channels) 指定されたチャネルへの接続をサブスクライブします。
メソッドの詳細
isSubscribed
boolean isSubscribed()現在の接続が(少なくとも 1 つのチャネルに)サブスクライブされているかどうかを示します。- 戻り値:
- 接続がサブスクライブされている場合は true、それ以外の場合は false
getSubscription
この接続の現在のサブスクリプションを返します。接続がサブスクライブされていない場合は null を返します。- 戻り値:
- 現在のサブスクリプション。使用可能なサブスクリプションがない場合は null。
publish
指定されたメッセージを指定されたチャネルに公開します。- パラメーター:
channel
- 公開するチャネル。null であってはなりません。message
- 公開するメッセージ。null であってはなりません。- 戻り値:
- メッセージを受信したクライアントの数、またはパイプライン / トランザクションで使用されたときに null。
- 関連事項:
subscribe
指定されたチャネルへの接続をサブスクライブします。サブスクライブすると、接続はリスニングモードになり、他のチャネルにサブスクライブするか、サブスクライブを解除することしかできません。接続がサブスクライブ解除されるまで、他のコマンドは受け入れられません。この操作はブロックされており、現在のスレッドはすぐに新しいメッセージの待機を開始することに注意してください。
- パラメーター:
listener
- メッセージリスナー。null であってはなりません。channels
- チャネル名は null であってはなりません。- 関連事項:
pSubscribe
指定されたパターンに一致するすべてのチャネルへの接続をサブスクライブします。サブスクライブすると、接続はリスニングモードになり、他のチャネルにサブスクライブするか、サブスクライブを解除することしかできません。接続がサブスクライブ解除されるまで、他のコマンドは受け入れられません。この操作はブロックされており、現在のスレッドはすぐに新しいメッセージの待機を開始することに注意してください。
- パラメーター:
listener
- メッセージリスナー。null であってはなりません。patterns
- チャネル名パターン。null であってはなりません。- 関連事項: