Class: TTelephoneTransferFeatureControl

Declaration: TelephonyClasses.h

Taxonomy Categories:

Member Functions:

~TTelephoneTransferFeatureControl
GetFeatureType
CreateCallAndStartTransfer
CompleteTransfer
CancelTransfer
Hash
operator<<=
operator>>=
TTelephoneTransferFeatureControl
operator=

Interface Category:

API.

Inherits From:

TTelephoneLineFeatureControl

Inherited By:

None.

Purpose:

The standard feature control derived class for the transfer feature.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Can be derived to modify behavior for a specific telephony environment. The interface protocol itself should not be modified.

Concurrency:

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

Resource Use:

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

Member Function: TTelephoneTransferFeatureControl::~TTelephoneTransferFeatureControl

virtual ~ TTelephoneTransferFeatureControl ()

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:

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

Other Considerations:

Attempting to access one of these objects after the demise of its parent line handle results in an exception being thrown.

Member Function: TTelephoneTransferFeatureControl::GetFeatureType

virtual void GetFeatureType (TTypeDescription &) const

Interface Category:

API.

Purpose:

Returns the standard transfer feature type.

Calling Context:

Call directly to identify the type of feature for which this control is intended.

Parameters:

TTypeDescription & -Receives the type description for this feature control.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

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

Other Considerations:

Pure virtual member function.

Member Function: TTelephoneTransferFeatureControl::CreateCallAndStartTransfer

virtual TTelephoneCallHandle * CreateCallAndStartTransfer (const TText & newNumber)

Interface Category:

API.

Purpose:

Initiates the transfer of the currently active call to a new call and creates a call handle representing the new connection. The default implementation calls activate, then calls CreateAndPlaceCall on the associated telephone line handle, returning the resulting call handle.

Calling Context:

Call directly to access the transfer feature.

Parameters:

const TText & newNumber -The telephone number for placing the new call.

Return Value:

Returns a pointer to a new call handle representing the call and its current status.

Exceptions:

Throws TTelephonyException if the feature fails to activate and the new call cannot be placed.

Concurrency:

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

Other Considerations:

The caller must assume responsibility for the storage referenced by the pointer returned.

Member Function: TTelephoneTransferFeatureControl::CompleteTransfer

virtual void CompleteTransfer ()

Interface Category:

API.

Purpose:

Completes the ongoing transfer operation and terminates both calls involved in the transfer. The default implementation makes a second call to Activate.

Calling Context:

Call directly to access the transfer feature.

Parameters:

Takes no 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: TTelephoneTransferFeatureControl::CancelTransfer

virtual void CancelTransfer ()

Interface Category:

API.

Purpose:

Terminates the call being transferred to and retrieves the original call. The default implementation calls Deactivate.

Calling Context:

Call directly to access the transfer feature.

Parameters:

Takes no 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: TTelephoneTransferFeatureControl::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:

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

Other Considerations:

None.

Member Function: TTelephoneTransferFeatureControl::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called by a line handle to stream in feature controls from a line.

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:

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

Other Considerations:

None.

Member Function: TTelephoneTransferFeatureControl::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called by a line to stream out feature controls to a line handle.

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:

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

Other Considerations:

None.

Member Function: TTelephoneTransferFeatureControl::TTelephoneTransferFeatureControl

TTelephoneTransferFeatureControl (const TTelephoneTransferFeature &)
TTelephoneTransferFeatureControl (const TTelephoneTransferFeatureControl &)
TTelephoneTransferFeatureControl ()

Interface Category:

API.

Purpose:

Constructs a control for the specified feature instance. Its use is restricted to transfer feature derived classes.
Copy constructor. Its use is restricted to friends and derived classes.
Default constructor. Its use is restricted to friends and derived classes.

Calling Context:

Called by transfer feature derived classes to construct an object.
Only for internal use by Copy. Developers should treat as protected.
Only for internal use by Resurrect. Developers should treat as protected.

Parameters:

const TTelephoneTransferFeature & -The feature instance for which this class is a control.
const TTelephoneTransferFeatureControl & -The TTelephoneHoldFeatureControl to be copied.
Takes no 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: TTelephoneTransferFeatureControl::operator=

TTelephoneTransferFeatureControl & operator =(const TTelephoneTransferFeatureControl &)

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:

const TTelephoneTransferFeatureControl & -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:

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.