org.apache.hedwig.client.netty.impl

Class AbstractSubscribeResponseHandler

java.lang.Object

org.apache.hedwig.client.handlers.AbstractResponseHandler

org.apache.hedwig.client.handlers.SubscribeResponseHandler

org.apache.hedwig.client.netty.impl.AbstractSubscribeResponseHandler

Direct Known Subclasses:

MultiplexSubscribeResponseHandler, SimpleSubscribeResponseHandler

public abstract class AbstractSubscribeResponseHandler
extends SubscribeResponseHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractHChannelManager	aChannelManager
protected ReentrantReadWriteLock	disconnectLock
protected ConcurrentMap<TopicSubscriber,ActiveSubscriber>	subscriptions

Fields inherited from class org.apache.hedwig.client.handlers.AbstractResponseHandler

cfg, channelManager

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSubscribeResponseHandler(ClientConfiguration cfg, HChannelManager channelManager)

Method Summary

Modifier and Type	Method and Description
protected void	asyncMessageDeliver(TopicSubscriber topicSubscriber, PubSubProtocol.Message message) Method called when a message arrives for a subscribe Channel and we want to deliver it asynchronously via the registered MessageHandler (should not be null when called here).
void	consume(TopicSubscriber topicSubscriber, PubSubProtocol.MessageSeqId messageSeqId) Consume a given message for given topic subscriber thru this handler.
protected ActiveSubscriber	createActiveSubscriber(ClientConfiguration cfg, AbstractHChannelManager channelManager, TopicSubscriber ts, PubSubData op, PubSubProtocol.SubscriptionPreferences preferences, org.jboss.netty.channel.Channel channel, HChannel hChannel)
protected ActiveSubscriber	getActiveSubscriber(TopicSubscriber ts)
protected ClientConfiguration	getConfiguration()
protected HChannelManager	getHChannelManager()
void	handleResponse(PubSubProtocol.PubSubResponse response, PubSubData pubSubData, org.jboss.netty.channel.Channel channel) Logic to handle received response.
void	handleSubscribeMessage(PubSubProtocol.PubSubResponse response) Handle Message delivered by the server.
void	handleSubscriptionEvent(com.google.protobuf.ByteString topic, com.google.protobuf.ByteString subscriberId, PubSubProtocol.SubscriptionEvent event) Handle a subscription event delivered by the server.
protected abstract Either<PubSubProtocol.StatusCode,HChannel>	handleSuccessResponse(TopicSubscriber ts, PubSubData pubSubData, org.jboss.netty.channel.Channel channel) Handle success response for a specific TopicSubscriber ts.
boolean	hasSubscription(TopicSubscriber topicSubscriber) Whether the given topic subscriber subscribed thru this handler.
protected void	messageConsumed(TopicSubscriber topicSubscriber, PubSubProtocol.Message message) Method called when the client app's MessageHandler has asynchronously completed consuming a subscribed message sent from the server.
void	onChannelDisconnected(InetSocketAddress host, org.jboss.netty.channel.Channel channel) This method is called when the underlying channel is disconnected due to server failure.
protected void	postHandleSuccessResponse(TopicSubscriber ts, ActiveSubscriber ss)
protected void	processSubscriptionEvent(ActiveSubscriber as, PubSubProtocol.SubscriptionEvent event)
protected boolean	removeSubscription(TopicSubscriber ts, ActiveSubscriber ss)
protected void	resubscribeIfNecessary(ActiveSubscriber ss, PubSubProtocol.SubscriptionEvent event)
void	startDelivery(TopicSubscriber topicSubscriber, MessageHandler messageHandler) Start delivering messages for a given topic subscriber.
void	stopDelivery(TopicSubscriber topicSubscriber) Stop delivering messages for a given topic subscriber.

Methods inherited from class org.apache.hedwig.client.handlers.SubscribeResponseHandler

asyncCloseSubscription

Methods inherited from class org.apache.hedwig.client.handlers.AbstractResponseHandler

handleRedirectResponse

Methods inherited from class java.lang.Object

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

Field Detail

disconnectLock

protected final ReentrantReadWriteLock disconnectLock

subscriptions

protected final ConcurrentMap<TopicSubscriber,ActiveSubscriber> subscriptions

aChannelManager

protected final AbstractHChannelManager aChannelManager

Constructor Detail

AbstractSubscribeResponseHandler

protected AbstractSubscribeResponseHandler(ClientConfiguration cfg,
                                           HChannelManager channelManager)

Method Detail

getHChannelManager

protected HChannelManager getHChannelManager()

getConfiguration

protected ClientConfiguration getConfiguration()

getActiveSubscriber

protected ActiveSubscriber getActiveSubscriber(TopicSubscriber ts)

createActiveSubscriber

protected ActiveSubscriber createActiveSubscriber(ClientConfiguration cfg,
                                                  AbstractHChannelManager channelManager,
                                                  TopicSubscriber ts,
                                                  PubSubData op,
                                                  PubSubProtocol.SubscriptionPreferences preferences,
                                                  org.jboss.netty.channel.Channel channel,
                                                  HChannel hChannel)

handleResponse

public void handleResponse(PubSubProtocol.PubSubResponse response,
                           PubSubData pubSubData,
                           org.jboss.netty.channel.Channel channel)
                    throws Exception

Description copied from class: AbstractResponseHandler

Logic to handle received response.

Specified by:

handleResponse in class AbstractResponseHandler

Parameters:

response - PubSubResponse received from hub server.

pubSubData - PubSubData for the pub/sub request.

channel - Channel we used to make the request.

Throws:

Exception

handleSuccessResponse

protected abstract Either<PubSubProtocol.StatusCode,HChannel> handleSuccessResponse(TopicSubscriber ts,
                                                                                    PubSubData pubSubData,
                                                                                    org.jboss.netty.channel.Channel channel)

Handle success response for a specific TopicSubscriber ts. The method is triggered after subscribed successfully.

Parameters:

ts - Topic Subscriber.

pubSubData - Pub/Sub Request data for this subscribe request.

channel - Subscription Channel.

Returns:

status code to indicate what happened

postHandleSuccessResponse

protected void postHandleSuccessResponse(TopicSubscriber ts,
                                         ActiveSubscriber ss)

handleSubscribeMessage

public void handleSubscribeMessage(PubSubProtocol.PubSubResponse response)

Description copied from class: SubscribeResponseHandler

Handle Message delivered by the server.

Specified by:

handleSubscribeMessage in class SubscribeResponseHandler

Parameters:

response - Message received from the server.

asyncMessageDeliver

protected void asyncMessageDeliver(TopicSubscriber topicSubscriber,
                                   PubSubProtocol.Message message)

Description copied from class: SubscribeResponseHandler

Method called when a message arrives for a subscribe Channel and we want to deliver it asynchronously via the registered MessageHandler (should not be null when called here).

Specified by:

asyncMessageDeliver in class SubscribeResponseHandler

message - Message from Subscribe Channel we want to consume.

messageConsumed

protected void messageConsumed(TopicSubscriber topicSubscriber,
                               PubSubProtocol.Message message)

Description copied from class: SubscribeResponseHandler

Method called when the client app's MessageHandler has asynchronously completed consuming a subscribed message sent from the server. The contract with the client app is that messages sent to the handler to be consumed will have the callback response done in the same order. So if we asynchronously call the MessageHandler to consume messages #1-5, that should call the messageConsumed method here via the VoidCallback in the same order. To make this thread safe, since multiple outstanding messages could be consumed by the client app and then called back to here, make this method synchronized.

Specified by:

messageConsumed in class SubscribeResponseHandler

Parameters:

topicSubscriber - Topic Subscriber

message - Message sent from server for topic subscription that has been consumed by the client.

handleSubscriptionEvent

public void handleSubscriptionEvent(com.google.protobuf.ByteString topic,
                                    com.google.protobuf.ByteString subscriberId,
                                    PubSubProtocol.SubscriptionEvent event)

Description copied from class: SubscribeResponseHandler

Handle a subscription event delivered by the server.

Specified by:

handleSubscriptionEvent in class SubscribeResponseHandler

Parameters:

topic - Topic Name

subscriberId - Subscriber Id

event - Subscription Event describes its status

processSubscriptionEvent

protected void processSubscriptionEvent(ActiveSubscriber as,
                                        PubSubProtocol.SubscriptionEvent event)

startDelivery

public void startDelivery(TopicSubscriber topicSubscriber,
                          MessageHandler messageHandler)
                   throws PubSubException.ClientNotSubscribedException,
                          AlreadyStartDeliveryException

Description copied from class: SubscribeResponseHandler

Start delivering messages for a given topic subscriber.

Specified by:

startDelivery in class SubscribeResponseHandler

Parameters:

topicSubscriber - Topic Subscriber

messageHandler - MessageHandler to register for this ResponseHandler instance.

Throws:

PubSubException.ClientNotSubscribedException - If the client is not currently subscribed to the topic

AlreadyStartDeliveryException - If someone started delivery a message handler before stopping existed one.

stopDelivery

public void stopDelivery(TopicSubscriber topicSubscriber)
                  throws PubSubException.ClientNotSubscribedException

Description copied from class: SubscribeResponseHandler

Stop delivering messages for a given topic subscriber.

Specified by:

stopDelivery in class SubscribeResponseHandler

Parameters:

topicSubscriber - Topic Subscriber

Throws:

PubSubException.ClientNotSubscribedException - If the client is not currently subscribed to the topic

hasSubscription

public boolean hasSubscription(TopicSubscriber topicSubscriber)

Description copied from class: SubscribeResponseHandler

Whether the given topic subscriber subscribed thru this handler.

Specified by:

hasSubscription in class SubscribeResponseHandler

Parameters:

topicSubscriber - Topic Subscriber

Returns:

whether the given topic subscriber subscribed thru this handler.

consume

public void consume(TopicSubscriber topicSubscriber,
                    PubSubProtocol.MessageSeqId messageSeqId)

Description copied from class: SubscribeResponseHandler

Consume a given message for given topic subscriber thru this handler.

Specified by:

consume in class SubscribeResponseHandler

Parameters:

topicSubscriber - Topic Subscriber

onChannelDisconnected

public void onChannelDisconnected(InetSocketAddress host,
                                  org.jboss.netty.channel.Channel channel)

Description copied from class: SubscribeResponseHandler

This method is called when the underlying channel is disconnected due to server failure. The implementation should take the responsibility to clear subscriptions and retry reconnecting subscriptions to new hub servers.

Specified by:

onChannelDisconnected in class SubscribeResponseHandler

Parameters:

host - Host that channel connected to has disconnected.

channel - Channel connected to.

removeSubscription

protected boolean removeSubscription(TopicSubscriber ts,
                                     ActiveSubscriber ss)

resubscribeIfNecessary

protected void resubscribeIfNecessary(ActiveSubscriber ss,
                                      PubSubProtocol.SubscriptionEvent event)