PubSubCommands (Buession Redis Client 2.3.0 API)

所有超级接口:

RedisCommands

所有已知子接口:

PubSubOperations, PubSubOperations

所有已知实现类:

AbstractPubSubOperations, AbstractRedisTemplate, BaseRedisTemplate, JedisClusterPubSubOperations, JedisPubSubOperations, JedisSentinelPubSubOperations, RedisTemplate
```
public interface PubSubCommands
extends RedisCommands
```
发布与订阅命令
详情说明 http://redisdoc.com/pubsub/index.html

作者:

Yong.Teng

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`void`	`pSubscribe(byte[][] patterns, PubSubListener<byte[]> pubSubListener)` 订阅一个或多个符合给定模式的频道的信息详情说明 http://redisdoc.com/pubsub/psubscribe.html
`void`	`pSubscribe(String[] patterns, PubSubListener<String> pubSubListener)` 订阅一个或多个符合给定模式的频道的信息详情说明 http://redisdoc.com/pubsub/psubscribe.html
`Long`	`publish(byte[] channel, byte[] message)` 将信息 message 发送到指定的频道 channel 详情说明 http://redisdoc.com/pubsub/publish.html
`Long`	`publish(String channel, String message)` 将信息 message 发送到指定的频道 channel 详情说明 http://redisdoc.com/pubsub/publish.html
`List<String>`	`pubsubChannels()` 列出当前 active channels 活跃是指信道含有一个或多个订阅者(不包括从模式接收订阅的客户端) 如果 pattern未提供，所有的信道都被列出，否则只列出匹配上指定全局-类型模式的信道被列出详情说明 https://www.redis.com.cn/commands/pubsub.html
`List<byte[]>`	`pubsubChannels(byte[] pattern)` 列出当前 active channels 活跃是指信道含有一个或多个订阅者(不包括从模式接收订阅的客户端) 如果 pattern未提供，所有的信道都被列出，否则只列出匹配上指定全局-类型模式的信道被列出详情说明 https://www.redis.com.cn/commands/pubsub.html
`List<String>`	`pubsubChannels(String pattern)` 列出当前 active channels 活跃是指信道含有一个或多个订阅者(不包括从模式接收订阅的客户端) 如果 pattern未提供，所有的信道都被列出，否则只列出匹配上指定全局-类型模式的信道被列出详情说明 https://www.redis.com.cn/commands/pubsub.html
`Long`	`pubsubNumPat()` 返回订阅模式的数量(使用命令PSUBSCRIBE实现)。
`Map<byte[],Long>`	`pubsubNumSub(byte[]... channels)` 列出指定信道的订阅者个数(不包括订阅模式的客户端订阅者) 详情说明 https://www.redis.com.cn/commands/pubsub.html
`Map<String,Long>`	`pubsubNumSub(String... channels)` 列出指定信道的订阅者个数(不包括订阅模式的客户端订阅者) 详情说明 https://www.redis.com.cn/commands/pubsub.html
`Object`	`pUnSubscribe()` 指示客户端退订使用 PSUBSCRIBE pattern [pattern …] 命令订阅的所有模式消息详情说明 http://redisdoc.com/pubsub/punsubscribe.html
`Object`	`pUnSubscribe(byte[]... patterns)` 指示客户端退订所有给定一个或多个模式的消息详情说明 http://redisdoc.com/pubsub/punsubscribe.html
`Object`	`pUnSubscribe(String... patterns)` 指示客户端退订所有给定一个或多个模式的消息详情说明 http://redisdoc.com/pubsub/punsubscribe.html
`void`	`subscribe(byte[][] channels, PubSubListener<byte[]> pubSubListener)` 订阅给定的一个或多个频道的信息详情说明 http://redisdoc.com/pubsub/subscribe.html
`void`	`subscribe(String[] channels, PubSubListener<String> pubSubListener)` 订阅给定的一个或多个频道的信息详情说明 http://redisdoc.com/pubsub/subscribe.html
`Object`	`unSubscribe()` 指示客户端退订所有频道详情说明 http://redisdoc.com/pubsub/unsubscribe.html
`Object`	`unSubscribe(byte[]... channels)` 指示客户端退订给定的一个或多个频道详情说明 http://redisdoc.com/pubsub/unsubscribe.html
`Object`	`unSubscribe(String... channels)` 指示客户端退订给定的一个或多个频道详情说明 http://redisdoc.com/pubsub/unsubscribe.html

- 方法详细资料
  - pSubscribe
```
void pSubscribe(String[] patterns,
                PubSubListener<String> pubSubListener)
```
    订阅一个或多个符合给定模式的频道的信息
    详情说明 http://redisdoc.com/pubsub/psubscribe.html
    
    参数:
    
    patterns - 一个或多个模式
    
    pubSubListener - 订阅监听者
  - pSubscribe
```
void pSubscribe(byte[][] patterns,
                PubSubListener<byte[]> pubSubListener)
```
    订阅一个或多个符合给定模式的频道的信息
    详情说明 http://redisdoc.com/pubsub/psubscribe.html
    
    参数:
    
    patterns - 一个或多个模式
    
    pubSubListener - 订阅监听者
  - publish
```
Long publish(String channel,
             String message)
```
    将信息 message 发送到指定的频道 channel
    详情说明 http://redisdoc.com/pubsub/publish.html
    
    参数:
    
    channel - 频道名称
    
    message - 信息
    
    返回:
    
    接收到信息 message 的订阅者数量
  - publish
```
Long publish(byte[] channel,
             byte[] message)
```
    将信息 message 发送到指定的频道 channel
    详情说明 http://redisdoc.com/pubsub/publish.html
    
    参数:
    
    channel - 频道名称
    
    message - 信息
    
    返回:
    
    接收到信息 message 的订阅者数量
  - pubsubChannels
```
List<String> pubsubChannels()
```
    列出当前 active channels 活跃是指信道含有一个或多个订阅者(不包括从模式接收订阅的客户端) 如果 pattern未提供，所有的信道都被列出，否则只列出匹配上指定全局-类型模式的信道被列出
    详情说明 https://www.redis.com.cn/commands/pubsub.html
    
    返回:
    
    活跃的信道列表，或者符合指定模式的信道
  - pubsubChannels
```
List<String> pubsubChannels(String pattern)
```
    列出当前 active channels 活跃是指信道含有一个或多个订阅者(不包括从模式接收订阅的客户端) 如果 pattern未提供，所有的信道都被列出，否则只列出匹配上指定全局-类型模式的信道被列出
    详情说明 https://www.redis.com.cn/commands/pubsub.html
    
    参数:
    
    pattern - 匹配模式
    
    返回:
    
    活跃的信道列表，或者符合指定模式的信道
  - pubsubChannels
```
List<byte[]> pubsubChannels(byte[] pattern)
```
    列出当前 active channels 活跃是指信道含有一个或多个订阅者(不包括从模式接收订阅的客户端) 如果 pattern未提供，所有的信道都被列出，否则只列出匹配上指定全局-类型模式的信道被列出
    详情说明 https://www.redis.com.cn/commands/pubsub.html
    
    参数:
    
    pattern - 匹配模式
    
    返回:
    
    活跃的信道列表，或者符合指定模式的信道
  - pubsubNumPat
```
Long pubsubNumPat()
```
    返回订阅模式的数量(使用命令PSUBSCRIBE实现)。注意，这个命令返回的不是订阅模式的客户端的数量，而是客户端订阅的所有模式的数量总和。
    详情说明 https://www.redis.com.cn/commands/pubsub.html
    
    返回:
    
    阅模式的数量
  - pubsubNumSub
```
Map<String,Long> pubsubNumSub(String... channels)
```
    列出指定信道的订阅者个数(不包括订阅模式的客户端订阅者)
    详情说明 https://www.redis.com.cn/commands/pubsub.html
    
    参数:
    
    channels - 一个或多个频道
    
    返回:
    
    指定信道的订阅者个数
  - pubsubNumSub
```
Map<byte[],Long> pubsubNumSub(byte[]... channels)
```
    列出指定信道的订阅者个数(不包括订阅模式的客户端订阅者)
    详情说明 https://www.redis.com.cn/commands/pubsub.html
    
    参数:
    
    channels - 一个或多个频道
    
    返回:
    
    指定信道的订阅者个数
  - pUnSubscribe
```
Object pUnSubscribe()
```
    指示客户端退订使用 PSUBSCRIBE pattern [pattern …] 命令订阅的所有模式消息
    详情说明 http://redisdoc.com/pubsub/punsubscribe.html
    
    返回:
    
    在不同的客户端中有不同的表现
  - pUnSubscribe
```
Object pUnSubscribe(String... patterns)
```
    指示客户端退订所有给定一个或多个模式的消息
    详情说明 http://redisdoc.com/pubsub/punsubscribe.html
    
    参数:
    
    patterns - 一个或多个模式
    
    返回:
    
    在不同的客户端中有不同的表现
  - pUnSubscribe
```
Object pUnSubscribe(byte[]... patterns)
```
    指示客户端退订所有给定一个或多个模式的消息
    详情说明 http://redisdoc.com/pubsub/punsubscribe.html
    
    参数:
    
    patterns - 一个或多个模式
    
    返回:
    
    在不同的客户端中有不同的表现
  - subscribe
```
void subscribe(String[] channels,
               PubSubListener<String> pubSubListener)
```
    订阅给定的一个或多个频道的信息
    详情说明 http://redisdoc.com/pubsub/subscribe.html
    
    参数:
    
    channels - 一个或多个频道
    
    pubSubListener - 订阅监听者
  - subscribe
```
void subscribe(byte[][] channels,
               PubSubListener<byte[]> pubSubListener)
```
    订阅给定的一个或多个频道的信息
    详情说明 http://redisdoc.com/pubsub/subscribe.html
    
    参数:
    
    channels - 一个或多个频道
    
    pubSubListener - 订阅监听者
  - unSubscribe
```
Object unSubscribe()
```
    指示客户端退订所有频道
    详情说明 http://redisdoc.com/pubsub/unsubscribe.html
    
    返回:
    
    在不同的客户端中有不同的表现
  - unSubscribe
```
Object unSubscribe(String... channels)
```
    指示客户端退订给定的一个或多个频道
    详情说明 http://redisdoc.com/pubsub/unsubscribe.html
    
    参数:
    
    channels - 一个或多个频道
    
    返回:
    
    在不同的客户端中有不同的表现
  - unSubscribe
```
Object unSubscribe(byte[]... channels)
```
    指示客户端退订给定的一个或多个频道
    详情说明 http://redisdoc.com/pubsub/unsubscribe.html
    
    参数:
    
    channels - 一个或多个频道
    
    返回:
    
    在不同的客户端中有不同的表现

接口 PubSubCommands

方法概要

方法详细资料

pSubscribe

pSubscribe

publish

publish

pubsubChannels

pubsubChannels

pubsubChannels

pubsubNumPat

pubsubNumSub

pubsubNumSub

pUnSubscribe

pUnSubscribe

pUnSubscribe

subscribe

subscribe

unSubscribe

unSubscribe

unSubscribe