com.crankuptheamps.client

Class MemorySubscriptionManager

java.lang.Object

com.crankuptheamps.client.MemorySubscriptionManager

All Implemented Interfaces:

SubscriptionManager

public class MemorySubscriptionManager
extends java.lang.Object
implements SubscriptionManager

An in-memory implementation of SubscriptionManager. Used by HAClient.

Constructor Summary

Constructors

Constructor and Description
MemorySubscriptionManager() Initializes a new instance of the MemorySubscriptionManager class.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all subscriptions.
static long	getDefaultResubscriptionTimeout() Gets the Default Resubscription Timeout for all instances of this class in milliseconds.
FailedResubscribeHandler	getFailedResubscribeHandler() Gets the FailedResubscribeHandler.
protected Message	getMessage() Gets the message associated with this instance.
long	getResubscriptionTimeout() Gets the Resubscription timeout in milliseconds .
void	resubscribe(Client client) Resubscribes all active and resumed subscriptions on the given client.
static void	setDefaultResubscriptionTimeout(long timeout) Sets the Default Resubscription Timeout for all instances of this class in milliseconds.
void	setFailedResubscribeHandler(FailedResubscribeHandler failureHandler) Sets the FailedResubscribeHandler.
void	setResubscriptionTimeout(long timeout) Sets the Resubscription timeout in milliseconds.
void	subscribe(MessageHandler messageHandler, Message message) Subscribes to messages with the specified message handler and message.
void	unsubscribe(CommandId subId) Unsubscribes from messages with the specified subscription ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

MemorySubscriptionManager

public MemorySubscriptionManager()

Initializes a new instance of the MemorySubscriptionManager class.

Method Detail

subscribe

public void subscribe(MessageHandler messageHandler,
                      Message message)

Subscribes to messages with the specified message handler and message.

Specified by:

subscribe in interface SubscriptionManager

Parameters:

messageHandler - The message handler to subscribe.

message - The message to subscribe to.

unsubscribe

public void unsubscribe(CommandId subId)

Unsubscribes from messages with the specified subscription ID.

Specified by:

unsubscribe in interface SubscriptionManager

Parameters:

subId - The subscription ID to unsubscribe from.

clear

public void clear()

Clears all subscriptions.

Specified by:

clear in interface SubscriptionManager

resubscribe

public void resubscribe(Client client)
                 throws AMPSException

Resubscribes all active and resumed subscriptions on the given client.

Specified by:

resubscribe in interface SubscriptionManager

Parameters:

client - The client on which to resubscribe.

Throws:

AMPSException - An error occurred while resubscribing.

getMessage

protected Message getMessage()

Gets the message associated with this instance.

Returns:

The message associated with this instance.

setDefaultResubscriptionTimeout

public static void setDefaultResubscriptionTimeout(long timeout)

Sets the Default Resubscription Timeout for all instances of this class in milliseconds.

Parameters:

timeout - The default timeout for resubscription calls.

getDefaultResubscriptionTimeout

public static long getDefaultResubscriptionTimeout()

Gets the Default Resubscription Timeout for all instances of this class in milliseconds.

Returns:

The default timeout for resubscription calls.

getResubscriptionTimeout

public long getResubscriptionTimeout()

Gets the Resubscription timeout in milliseconds .

Returns:

timeout The timeout for resubscription calls.

setResubscriptionTimeout

public void setResubscriptionTimeout(long timeout)

Sets the Resubscription timeout in milliseconds.

Parameters:

timeout - The timeout for resubscription calls.

getFailedResubscribeHandler

public FailedResubscribeHandler getFailedResubscribeHandler()

Gets the FailedResubscribeHandler.

Specified by:

getFailedResubscribeHandler in interface SubscriptionManager

Returns:

The FailedResubscribeHandler or null if not set.

setFailedResubscribeHandler

public void setFailedResubscribeHandler(FailedResubscribeHandler failureHandler)

Sets the FailedResubscribeHandler.

Specified by:

setFailedResubscribeHandler in interface SubscriptionManager

Parameters:

failureHandler - A FailedResubscribeHandler to call if a resubscribe fails.