org.aredis.cache

Class SubscriptionInfo

java.lang.Object

org.aredis.cache.SubscriptionInfo

public class SubscriptionInfo
extends Object

Subscription Info for a Redis Subscription including the Listener.

Author:

suresh

Constructor Summary

Constructors

Constructor and Description
SubscriptionInfo(String pchannelName, RedisMessageListener plistener) Creates a SubscriptionInfo.
SubscriptionInfo(String pchannelName, RedisMessageListener plistener, boolean pisPatternSubscription) Creates a SubscriptionInfo.
SubscriptionInfo(String pchannelName, RedisMessageListener plistener, boolean pisPatternSubscription, DataHandler pdataHandler) Creates a SubscriptionInfo.
SubscriptionInfo(String pchannelName, RedisMessageListener plistener, boolean pisPatternSubscription, DataHandler pdataHandler, Executor pexecutor) Creates a SubscriptionInfo.
SubscriptionInfo(String pchannelName, RedisMessageListener plistener, boolean pisPatternSubscription, DataHandler pdataHandler, Object pmetaData) Creates a SubscriptionInfo.
SubscriptionInfo(String pchannelName, RedisMessageListener plistener, boolean pisPatternSubscription, DataHandler pdataHandler, Object pmetaData, Executor pexecutor) Creates a SubscriptionInfo.

Method Summary

Methods

Modifier and Type	Method and Description
String	getChannelName() Gets the channel name.
DataHandler	getDataHandler() Gets the Data Handler.
Executor	getExecutor() Gets the executor.
RedisMessageListener	getListener() Gets the listener.
Object	getMetaData() Gets the meta data.
boolean	isPatternSubscription() Checks if this is a pattern subscription.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionInfo

public SubscriptionInfo(String pchannelName,
                RedisMessageListener plistener,
                boolean pisPatternSubscription,
                DataHandler pdataHandler,
                Object pmetaData,
                Executor pexecutor)

Creates a SubscriptionInfo.

Parameters:

pchannelName - channel name

plistener - listener which is called when messages are received

pisPatternSubscription - true to indicate a pattern subscription

pdataHandler - Data Handler to de-serialize messages. If null OPTI_JAVA_HANDLER is used

pmetaData - Meta Data if any for Data Handler or null

pexecutor - Executor to use for calling the listener with messages. If null the one set in RedisSubscription is used

SubscriptionInfo

public SubscriptionInfo(String pchannelName,
                RedisMessageListener plistener,
                boolean pisPatternSubscription,
                DataHandler pdataHandler,
                Executor pexecutor)

Creates a SubscriptionInfo.

Parameters:

pchannelName - channel name

plistener - listener which is called when messages are received

pisPatternSubscription - true to indicate a pattern subscription

pdataHandler - Data Handler to de-serialize messages. If null OPTI_JAVA_HANDLER is used

pexecutor - Executor to use for calling the listener with messages. If null the one set in RedisSubscription is used

SubscriptionInfo

public SubscriptionInfo(String pchannelName,
                RedisMessageListener plistener,
                boolean pisPatternSubscription,
                DataHandler pdataHandler,
                Object pmetaData)

Creates a SubscriptionInfo.

Parameters:

pchannelName - channel name

plistener - listener which is called when messages are received

pisPatternSubscription - true to indicate a pattern subscription

pdataHandler - Data Handler to de-serialize messages. If null OPTI_JAVA_HANDLER is used

pmetaData - Meta Data if any for Data Handler or null

SubscriptionInfo

public SubscriptionInfo(String pchannelName,
                RedisMessageListener plistener,
                boolean pisPatternSubscription,
                DataHandler pdataHandler)

Creates a SubscriptionInfo.

Parameters:

pchannelName - channel name

plistener - listener which is called when messages are received

pisPatternSubscription - true to indicate a pattern subscription

pdataHandler - Data Handler to de-serialize messages. If null OPTI_JAVA_HANDLER is used

SubscriptionInfo

public SubscriptionInfo(String pchannelName,
                RedisMessageListener plistener,
                boolean pisPatternSubscription)

Creates a SubscriptionInfo.

Parameters:

pchannelName - channel name

plistener - listener which is called when messages are received

pisPatternSubscription - true to indicate a pattern subscription

SubscriptionInfo

public SubscriptionInfo(String pchannelName,
                RedisMessageListener plistener)

Creates a SubscriptionInfo.

Parameters:

pchannelName - channel name or regular subscription

plistener - listener which is called when messages are received

Method Detail

getChannelName

public String getChannelName()

Gets the channel name.

Returns:

channel name

getListener

public RedisMessageListener getListener()

Gets the listener.

Returns:

listener which is called when messages are received

isPatternSubscription

public boolean isPatternSubscription()

Checks if this is a pattern subscription.

Returns:

true to indicate a pattern subscription

getDataHandler

public DataHandler getDataHandler()

Gets the Data Handler.

Returns:

Data Handler to de-serialize messages. null if none is set

getExecutor

public Executor getExecutor()

Gets the executor.

Returns:

Executor to use for calling the listener with messages. If null the one set in RedisSubscription is used

getMetaData

public Object getMetaData()

Gets the meta data.

Returns:

meta data that is used along with the Data Handler to de-serialize messages.