com.crankuptheamps.client

Interface SubscriptionManager

All Known Implementing Classes:

DefaultSubscriptionManager, MemorySubscriptionManager

public interface SubscriptionManager

Interface used to manage all subscriptions in AMPS. This includes: subscribing, unsubscribing and resubscribing.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the subscriptions so they cannot be re-subscribed upon reconnect.
FailedResubscribeHandler	getFailedResubscribeHandler() Gets the FailedResubscribeHandler.
void	resubscribe(Client client) Resubscribes to a subscription.
void	setFailedResubscribeHandler(FailedResubscribeHandler failureHandler) Sets the FailedResubscribeHandler.
void	subscribe(MessageHandler messageHandler, Message message) Creates a subscription.
void	unsubscribe(CommandId subId) Unsubscribes from a subscription.

Method Detail

subscribe

void subscribe(MessageHandler messageHandler,
               Message message)

Creates a subscription. This method is called internally by the client.

Parameters:

messageHandler - The message handler for the subscription.

message - The message for the subscription.

unsubscribe

void unsubscribe(CommandId subId)

Unsubscribes from a subscription.

Parameters:

subId - The subscription ID to identify the subscription.

clear

void clear()

Clears the subscriptions so they cannot be re-subscribed upon reconnect.

resubscribe

void resubscribe(Client client)
          throws AMPSException

Resubscribes to a subscription.

Parameters:

client - The client object for re-subscription.

Throws:

AMPSException - resubscription failed

getFailedResubscribeHandler

FailedResubscribeHandler getFailedResubscribeHandler()

Gets the FailedResubscribeHandler.

Returns:

The FailedResubscribeHandler or null if not set.

setFailedResubscribeHandler

void setFailedResubscribeHandler(FailedResubscribeHandler failureHandler)

Sets the FailedResubscribeHandler.

Parameters:

failureHandler - A FailedResubscribeHandler to call if a resubscribe fails.