Class: TTelephoneCallHandle

Declaration: TelephonyClasses.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

A lightweight surrogate for a telephone connection. It permits clients to determine the directory number at the remote end of the connection (calling or called party), to obtain the current status of the call, and to terminate the connection.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

It is not recommended that TTelephoneCallHandle be derived.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Resource Use:

This class depends on the existence of the telephone line handle that created it. Attempting to access one of these objects after the demise of its parent line handle results in an exception being thrown.

Member Function: TTelephoneCallHandle::~TTelephoneCallHandle

virtual ~ TTelephoneCallHandle ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Member Function: TTelephoneCallHandle::GetRemoteNumber

void GetRemoteNumber (TText & phoneNumber) const

Interface Category:

API.

Purpose:

Provides the directory number at the remote end of the connection.

Calling Context:

Call directly to find out the calling or called party participating in this call.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Member Function: TTelephoneCallHandle::GetStatus

virtual TToken GetStatus () const

Interface Category:

API.

Purpose:

Returns the current call status.

Calling Context:

Call directly to monitor the progress of the call.

Parameters:

Return Value:

Returns a TToken containing the current call status value. (Potential values are defined in the class TTelephoneStatusNotification.)

Exceptions:

Throws TTelephonyException if the line handle for the call is unspecified or has been deleted.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Member Function: TTelephoneCallHandle::HangUp

virtual void HangUp ()

Interface Category:

API.

Purpose:

Terminates the call.

Calling Context:

Call directly to end the connection established for this call.

Parameters:

Return Value:

None.

Exceptions:

Throws TTelephonyException if the line handle for the call is unspecified or has been deleted.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Member Function: TTelephoneCallHandle::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Called by the Collection classes to generate a hash value.

Parameters:

Return Value:

The numeric value of the hash.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Member Function: TTelephoneCallHandle::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called by a line handle to stream in call handles from a line.

Parameters:

Return Value:

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

Exceptions:

Throws TInvalidVersionError if the versions don't match.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Member Function: TTelephoneCallHandle::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called by a line to stream out call handles to a line handle.

Parameters:

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Member Function: TTelephoneCallHandle::TTelephoneCallHandle

  1. TTelephoneCallHandle (const TTelephoneCallHandle &)
  2. TTelephoneCallHandle ()

Interface Category:

API.

Purpose:

  1. Copy constructor. Its use is restricted to friends and derived classes.
  2. Default constructor. Its use is restricted to friends and derived classes.

Calling Context:

  1. Only for internal use by Copy. Developers should treat as protected.
  2. Only for internal use by Resurrect. Developers should treat as protected.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.

Member Function: TTelephoneCallHandle::operator=

TTelephoneCallHandle & operator =(const TTelephoneCallHandle &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object. Its use is restricted to friends and derived classes.

Parameters:

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe. Not intended to be shared across address spaces.

Other Considerations:

None.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.