cern::cmw::mom::pubsub::impl::SubscriptionHandle Class Reference

Collaboration diagram for cern::cmw::mom::pubsub::impl::SubscriptionHandle:

Public Member Functions
	SubscriptionHandle (TopicSubscriber subscriber, String topic, String selector, MessageListener listener)
	SubscriptionHandle ()
void	setSession (TopicSession session)
TopicSession	getSession ()
void	setSubscriber (TopicSubscriber subscriber)
TopicSubscriber	getSubscriber ()
void	setSubscriptionListener (MessageListener listener)
MessageListener	getSubscriptionListener ()
void	setSubscriptionSelector (String selector)
String	getSubscriptionSelector ()
long	getSubscriptionToken ()
void	setSubscriptionTopic (String topic)
String	getSubscriptionTopic ()
boolean	equals (Object object)
Private Attributes
Boolean	subscriptionTokenGeneratorLock = Boolean.TRUE
MessageListener	listener = null
String	selector = null
String	topic = null
TopicSession	session = null
TopicSubscriber	subscriber = null
long	subscriptionToken = 0
Static Private Attributes
static long	subscriptionTokenGenerator = 1

Detailed Description

Internal class. Incapsulate all the information related to a subscription.

Version:: 1.0 23 Jan 2001

Author:: Controls Middleware Project

Constructor & Destructor Documentation

cern::cmw::mom::pubsub::impl::SubscriptionHandle::SubscriptionHandle	(	TopicSubscriber	subscriber,
		String	topic,
		String	selector,
		MessageListener	listener
	)			`[inline]`

Constructor for the SubscriptionHandle class.

Parameters:

	subscriber	the TopicSubscriber instance.
	topic
	selector
	listener

References subscriptionToken, subscriptionTokenGenerator, and subscriptionTokenGeneratorLock.

cern::cmw::mom::pubsub::impl::SubscriptionHandle::SubscriptionHandle ( ) [inline]

Default constructor for the SubscriptionHandle class.

References listener, selector, subscriber, subscriptionToken, subscriptionTokenGenerator, subscriptionTokenGeneratorLock, and topic.

Member Function Documentation

boolean cern::cmw::mom::pubsub::impl::SubscriptionHandle::equals ( Object object ) [inline]

Method equals

Parameters:

object

Returns:: boolean

References getSubscriptionToken(), and subscriptionToken.

TopicSession cern::cmw::mom::pubsub::impl::SubscriptionHandle::getSession ( ) [inline]

Return the TopicSession object.

Returns:: TopicSession the topic session.

References session.

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::close(), cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::unSubscribe(), and cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::unSubscribeAll().

TopicSubscriber cern::cmw::mom::pubsub::impl::SubscriptionHandle::getSubscriber ( ) [inline]

Return the TopicSubscriber object.

Returns:: TopicSubscriber

References subscriber.

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::close(), cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::unSubscribe(), and cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::unSubscribeAll().

MessageListener cern::cmw::mom::pubsub::impl::SubscriptionHandle::getSubscriptionListener ( ) [inline]

Return MessageListener associated with the subscription.

Returns:: MessageListener the listener.

References listener.

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::recoverSubscriptions().

String cern::cmw::mom::pubsub::impl::SubscriptionHandle::getSubscriptionSelector ( ) [inline]

Return the String defining the filter associated with the subscription.

Returns:: String the defined filter.

References selector.

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::recoverSubscriptions().

long cern::cmw::mom::pubsub::impl::SubscriptionHandle::getSubscriptionToken ( ) [inline]

Return the key identifying the subscription.

Returns:: long the subscription token.

References subscriptionToken.

Referenced by equals(), and cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::subscribe().

String cern::cmw::mom::pubsub::impl::SubscriptionHandle::getSubscriptionTopic ( ) [inline]

Return the String that identifies the subscribed topic.

Returns:: String the topic name.

References topic.

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::close(), cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::publishKeepAliveNotifications(), cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::recoverSubscriptions(), cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::unSubscribe(), and cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::unSubscribeAll().

void cern::cmw::mom::pubsub::impl::SubscriptionHandle::setSession ( TopicSession session ) [inline]

Set the TopicSession Object

Parameters:

session

the TopicSession instance

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::recoverSubscriptions(), and cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::subscribe().

void cern::cmw::mom::pubsub::impl::SubscriptionHandle::setSubscriber ( TopicSubscriber subscriber ) [inline]

Set the TopicSubscriber Object

Parameters:

subscriber

the TopicSubscriber instance

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::recoverSubscriptions(), and cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::subscribe().

void cern::cmw::mom::pubsub::impl::SubscriptionHandle::setSubscriptionListener ( MessageListener listener ) [inline]

Set the subscription listener

Parameters:

listener

the subscription listener

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::subscribe().

void cern::cmw::mom::pubsub::impl::SubscriptionHandle::setSubscriptionSelector ( String selector ) [inline]

Set the subscription selector

Parameters:

selector

the subscription selector

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::subscribe().

void cern::cmw::mom::pubsub::impl::SubscriptionHandle::setSubscriptionTopic ( String topic ) [inline]

Set the topic name

Parameters:

topic

the topic name

Referenced by cern::cmw::mom::pubsub::impl::DefaultSubscriberImpl::subscribe().

Member Data Documentation

MessageListener cern::cmw::mom::pubsub::impl::SubscriptionHandle::listener = null [private]

The message listener associated to the subscription.

Referenced by getSubscriptionListener(), and SubscriptionHandle().

String cern::cmw::mom::pubsub::impl::SubscriptionHandle::selector = null [private]

The selector associated to the subscription.

Referenced by getSubscriptionSelector(), and SubscriptionHandle().

TopicSession cern::cmw::mom::pubsub::impl::SubscriptionHandle::session = null [private]

The TopicSession object associated to the subscription.

Referenced by getSession().

TopicSubscriber cern::cmw::mom::pubsub::impl::SubscriptionHandle::subscriber = null [private]

The TopicSubscriber object associated to the subscription.

Referenced by getSubscriber(), and SubscriptionHandle().

long cern::cmw::mom::pubsub::impl::SubscriptionHandle::subscriptionToken = 0 [private]

The unique key that identifies a specific subscription.

Referenced by equals(), getSubscriptionToken(), and SubscriptionHandle().

long cern::cmw::mom::pubsub::impl::SubscriptionHandle::subscriptionTokenGenerator = 1 [static, private]

The unique identifier generator for the subscriptions.

Referenced by SubscriptionHandle().

Boolean cern::cmw::mom::pubsub::impl::SubscriptionHandle::subscriptionTokenGeneratorLock = Boolean.TRUE [private]

Referenced by SubscriptionHandle().

String cern::cmw::mom::pubsub::impl::SubscriptionHandle::topic = null [private]

The topic associated to the subscription.

Referenced by getSubscriptionTopic(), and SubscriptionHandle().

The documentation for this class was generated from the following file:

SubscriptionHandle.java

cern::cmw::mom::pubsub::impl::SubscriptionHandle Class Reference

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation