SubscriptionHandle

A SubscriptionHandle object identifies a subscription that was registered with a Proxy object and can be used to have the Proxy perform various operations on the subscription.

Clients cannot create these objects directly on their own, but instead must have them created as a result of calls to Proxy::Subscribe.

Hierarchy

precache::util:: Serializable

--> precache::event::SubscriptionHandle

Constructors

SubscriptionHandle

This default constructor creates an empty SubscriptionHandle which is not associated with any Proxy or registered with a particular subscription.

This constructor is useful for situations requiring default initialization of elements (such as arrays and STL containers).

SubscriptionHandle()

Copy

Creates a copy of a SubscriptionHandle object in a safe manner, preventing duplication of handled elements.

SubscriptionHandle(
const SubscriptionHandle& rkhSubscription)

rkhSubscription —: the SubscriptionHandle to be copied

Destructor

~SubscriptionHandle()

Frees up resources allocated for this object.

Note: While this object can be copied, the destruction of the last remaining instance of the original object also automatically unsubscribes the object's registration of its associated Subscription with its Proxy.

~SubscriptionHandle()

Methods

Operator=

Assigns one SubscriptionHandle object to another in a safe manner, preventing duplication of handled elements.

SubscriptionHandle& Operator=(const SubscriptionHandle& rkhSubscription)

rkhSubscription —: the SubscriptionHandle to be assigned
returns —: the assigned SubscriptionHandle

Operator==

bool operator==(const SubscriptionHandle& rkhSubscription)

Compares two SubscriptionHandle objects for equality.

rkhSubscription —: the SubscriptionHandle against which this object is to be compared
returns —: true, if this object equals rkhSubscription; otherwise, false

operator!=

bool operator!=(
const SubscriptionHandle& rkhSubscription)

Compares two SubscriptionHandle objects for inequality.

rkhSubscription —: the SubscriptionHandle against which this object is to be compared
returns —: true, if this object does not equal rkhSubscription; otherwise, false

GetAttrFilterString

const PC_CHAR* GetAttrFilterString ()

Retrives the string representation of the attribute filter associated with the subscription

GetSubjectFilter

PCSmallString GetSubjectFilter()

Retrives the string representation of the subject filter associated with the subscription

GetClosure

void* GetClosure()

Retrieves a pointer to the cloasure associated with the current subscription

GetSubscriber

const Subscriber* GetSubscriber()

Retrieves a pointer to the Subscriber object associated with the current subscription