org.aredis.cache

Class RedisSubscriptionConnection

java.lang.Object

org.aredis.cache.RedisSubscriptionConnection

Direct Known Subclasses:

RedisSubscription

public class RedisSubscriptionConnection
extends Object

This is the base class used by RedisSubscription. RedisSubscription calls the submitCommand method for its subscribe and unsubcribe calls. This is an internal class.

Author:

suresh

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RedisSubscriptionConnection.CommandType Different Subscribe Unsubscribe Command Types.

Field Summary

Fields

Modifier and Type	Field and Description
protected Executor	taskExecutor Executor used for calling back message listeners.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	closeStaleConnection() Closes the connection if it has been idle beyond the configured idle timeout or the Redis Server timeout.
AsyncSocketTransport	getConnection() Returns the Async Socket Transport used
void	shutdown() Shutdown the connection.
protected void	submitCommand(RedisCommandInfo commandInfo, SubscriptionInfo subscriptionInfo) Submit a Redis Subscribe or Unsubscribe Command.

Methods inherited from class java.lang.Object

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

Field Detail

taskExecutor

protected Executor taskExecutor

Executor used for calling back message listeners.

Constructor Detail

RedisSubscriptionConnection

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

Creates a RedisSubscriptionConnection.

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

submitCommand

protected void submitCommand(RedisCommandInfo commandInfo,
                 SubscriptionInfo subscriptionInfo)

Submit a Redis Subscribe or Unsubscribe Command.

Parameters:

commandInfo - CommandInfo containing the command which has to be SUBSCRIBE, UNSUSCRIBE, PSUBSCRIBE or PUNSUBSCRIBE

subscriptionInfo - subscription info

closeStaleConnection

public void closeStaleConnection()

Closes the connection if it has been idle beyond the configured idle timeout or the Redis Server timeout. The connection is not closed if there are any active subscriptions. A connection will be automatically re-established on the next command.

shutdown

public void shutdown()

Shutdown the connection. This method however is currently not the preferred way to shutdown because the socket connections close automatically once the JVM is eligible for shutdown.

getConnection

public AsyncSocketTransport getConnection()

Returns the Async Socket Transport used

Returns:

Async Socket Transport used