org.aredis.messaging

Class RedisSubscription

java.lang.Object

org.aredis.cache.RedisSubscriptionConnection

org.aredis.messaging.RedisSubscription

public class RedisSubscription
extends RedisSubscriptionConnection

Used to create a subscription connection to a Redis Server after which you can subscribe to channels.

Author:

suresh

Nested Class Summary

Nested classes/interfaces inherited from class org.aredis.cache.RedisSubscriptionConnection

RedisSubscriptionConnection.CommandType

Field Summary

Fields inherited from class org.aredis.cache.RedisSubscriptionConnection

taskExecutor

Constructor Summary

Constructors

Constructor and Description
RedisSubscription(AsyncSocketTransport pcon, int pdbIndex, Executor ptaskExecutor) Creates a RedisSubscription.

Method Summary

Methods

Modifier and Type	Method and Description
void	subscribe(SubscriptionInfo subscriptionInfo) Subscribe to a channel or to a channel pattern.
void	unsubscribe(String channelName, boolean isPatternSubscription) Unsubscribe to a channel or from a channel pattern.
void	unsubscribeAll(boolean isPatternSubscription) Unsubscribe from all channels or from all channel patterns.

Methods inherited from class org.aredis.cache.RedisSubscriptionConnection

closeStaleConnection, getConnection, shutdown, submitCommand

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RedisSubscription

public RedisSubscription(AsyncSocketTransport pcon,
                 int pdbIndex,
                 Executor ptaskExecutor)

Creates a RedisSubscription. The preferred way to create a RedisSubscription is via AsyncRedisFactory.

Parameters:

pcon - Async Socket Transport for the connection

pdbIndex - dbIndex of the connection

ptaskExecutor - Executor to use for sending the messages to the listeners. It is strongly recommended to pass a non null value. If null an internal Thread Pool will be used to make the calls to the listeners.

Method Detail

subscribe

public void subscribe(SubscriptionInfo subscriptionInfo)

Subscribe to a channel or to a channel pattern. The subscription happens asynchronously. If the server is down the subscription happens upon re-connection when the server comes back up.

Parameters:

subscriptionInfo - subscription info

unsubscribe

public void unsubscribe(String channelName,
               boolean isPatternSubscription)

Unsubscribe to a channel or from a channel pattern. The unsubscription happens asynchronously. If the server is down the unsubscription happens upon re-connection when the server comes back up.

Parameters:

channelName - channel name

isPatternSubscription - true for a pattern unsubscription false otherwise

unsubscribeAll

public void unsubscribeAll(boolean isPatternSubscription)

Unsubscribe from all channels or from all channel patterns. The unsubscription happens asynchronously. If the server is down the unsubscription happens upon re-connection when the server comes back up.

Parameters:

isPatternSubscription - true for a pattern unsubscription false otherwise