Class: TTelephoneInterest

Declaration: TelephoneNotification.h

Taxonomy Categories:

Member Functions:

TTelephoneInterest
~TTelephoneInterest
operator=
Hash
operator<<=
operator>>=

Interface Category:

API.

Inherits From:

TInterest

Inherited By:

None.

Purpose:

TTelephoneInterest is a derived class of TInterest that permits clients to request notification of certain telephony events affecting a particular telephone line or handset. These events include changes in hook status, ring indications from incoming calls, and the arrival of remotely generated digit strings.

Instantiation:

Allocate on the heap or the stack. Allocated on heap by telephony classes.

Deriving Classes:

Do not derive classes from TTelephoneInterest.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTelephoneInterest::TTelephoneInterest

TTelephoneInterest (const TTelephoneInterest &)
TTelephoneInterest ()

Interface Category:

API.

Purpose:

Copy constructor.
Default constructor.

Calling Context:

Called to copy an object. Called by The Notification Framework only. Not to be called by clients.
Called for streaming and assignment. Called by The Notification Framework only. Not to be called by clients.

Parameters:

const TTelephoneInterest & -The TTelephoneInterest to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Clients should create instances of this class by calling the Create Interest functions provided by TTelephoneLineHandle and TTelephoneHandsetHandle.

Member Function: TTelephoneInterest::~TTelephoneInterest

virtual ~ TTelephoneInterest ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTelephoneInterest::operator=

TTelephoneInterest & operator =(const TTelephoneInterest &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called by Notification Framework when an object is assigned to another compatible object.

Parameters:

const TTelephoneInterest & -The source object for the assignment.

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: TTelephoneInterest::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Called by Collection classes to generate a hash value.

Parameters:

Takes no parameters.

Return Value:

The numeric value of the hash.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTelephoneInterest::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called by Notification Framework to stream in data.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

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

Exceptions:

Throws TInvalidVersionError if the versions don't match.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTelephoneInterest::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called by Notification Framework to stream out data.

Parameters:

TStream & toWhere -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.

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