Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

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

List of all members.

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

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 

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

Default constructor for the SubscriptionHandle class.


Member Function Documentation

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

Method equals

Parameters:
object 
Returns:
boolean

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

Return the TopicSession object.

Returns:
TopicSession the topic session.

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

Return the TopicSubscriber object.

Returns:
TopicSubscriber

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

Return MessageListener associated with the subscription.

Returns:
MessageListener the listener.

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

Return the String defining the filter associated with the subscription.

Returns:
String the defined filter.

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

Return the key identifying the subscription.

Returns:
long the subscription token.

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

Return the String that identifies the subscribed topic.

Returns:
String the topic name.

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

Set the TopicSession Object

Parameters:
session the TopicSession instance

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

Set the TopicSubscriber Object

Parameters:
subscriber the TopicSubscriber instance

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

Set the subscription listener

Parameters:
listener the subscription listener

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

Set the subscription selector

Parameters:
selector the subscription selector

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

Set the topic name

Parameters:
topic the topic name


Member Data Documentation

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

The message listener associated to the subscription.

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

The selector associated to the subscription.

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

The TopicSession object associated to the subscription.

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

The TopicSubscriber object associated to the subscription.

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

The unique key that identifies a specific subscription.

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

The unique identifier generator for the subscriptions.

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

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

The topic associated to the subscription.


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 03:08:04 2009 for ACS Java API by doxygen 1.3.8