Class: TNotificationInterestPair

Declaration: Notification.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

Used by the batch notification to hold a notification and an interest that is used to match interested notifier connections. This is a very simple data structure that exists only to maintain a notification and its associated interest.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is not intended for deriving.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TNotificationInterestPair::TNotificationInterestPair

TNotificationInterestPair (const TNotification &, const TInterest &)
TNotificationInterestPair (const TNotificationInterestPair &)
TNotificationInterestPair ()

Interface Category:

API.

Purpose:

Creates a notification interest pair object containing one notification and its associated interest.
Copy constructor.
Default constructor.

Calling Context:

Call this function directly.
Called to copy an object. Call this function directly.
Called by the stream-in operators and directly.

Parameters:

const TNotification & -The notification to distribute.
const TInterest & -The associated interest.
const TNotificationInterestPair & -The notification/interest pair to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNotificationInterestPair::~TNotificationInterestPair

virtual ~ TNotificationInterestPair ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object. Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNotificationInterestPair::GetNotification

TNotification * GetNotification () const

Interface Category:

API.

Purpose:

Gets the notification in this pair.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the notification.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNotificationInterestPair::GetInterest

TInterest * GetInterest () const

Interface Category:

API.

Purpose:

Gets the interest in this pair.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the interest.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNotificationInterestPair::operator=

TNotificationInterestPair & operator =(const TNotificationInterestPair &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object. Call this function directly.

Parameters:

const TNotificationInterestPair & -The object to be assigned.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNotificationInterestPair::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Used by the collection classes to generate a hash value for quick lookups.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the generated hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNotificationInterestPair::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data. Call this function directly.

Parameters:

TStream & -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNotificationInterestPair::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data. Call this function directly.

Parameters:

TStream & -The object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.