Collapse all Symbian^3 Product Developer Library

CNotifyIncomingCallAct Class Reference

class CNotifyIncomingCallAct : public CAsyncRequestBaseAct

This is an active object responsible for interacting with Multimode ETel.

This active object is owned by the CTelephonyFunctions object and continuously monitors for the the NotifyIncomingCall event. When an incoming call arrives, this AO stores the call name and sends a notification of an incoming call to any observers that want to be notified of this event.

One of the observers of this AO is CAnswerIncomingCallAct. If a client requests to answer an incoming call, the request is only passed on to the tsy (by CAnswerIncomingCallAct) if this AO has sent the notification of an incoming call to it (and has a valid call name available). This ensures that an attempt to answer a call before the call object has been created is not made since the call object is only guaranteed to exist when an incoming call notification has been sent.

Inherits from

CNotifyIncomingCallAct
- CAsyncRequestBaseAct
  - CActive
    - CBase

Public Member Functions
	~CNotifyIncomingCallAct()
TInt	CallName(TName &)
void	DeregisterObserver(MEventObserver *)
CNotifyIncomingCallAct *	NewL(CTelephonyFunctions *)
void	NotifyIncomingCall()
void	RegisterObserver(MEventObserver *)
void	ResetCallName()

Protected Member Functions
void	Complete()
void	DoCancel()
TInt	RunError()

Private Member Functions
	CNotifyIncomingCallAct(CTelephonyFunctions *)

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::RunError(TInt)
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CAsyncRequestBaseAct::CAsyncRequestBaseAct()
	CAsyncRequestBaseAct::RunL()
	CAsyncRequestBaseAct::~CAsyncRequestBaseAct()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Member Enumerations
enum	TNotifyIncomingCallActState { ENotifyIncomingCallActStateOperating, ENotifyIncomingCallActStateCleanUp }

Inherited Enumerations
	CActive:TPriority

Private Attributes
TName	iCallName
RPointerArray< MEventObserver >	iIncomingCallCompletionObservers
TNotifyIncomingCallActState	iState
CTelephonyFunctions *	iTelephonyFunctions

Inherited Attributes
	CActive::iStatus

Constructor & Destructor Documentation

CNotifyIncomingCallAct(CTelephonyFunctions *)

CNotifyIncomingCallAct

(

CTelephonyFunctions *

aTelephonyFunctions

)

[private]

First-phase constructor which cannot Leave().

Parameters

CTelephonyFunctions * aTelephonyFunctions

Pointer to the CTelephonyFunctions object that created this object.

~CNotifyIncomingCallAct()

~CNotifyIncomingCallAct

(

)

Default destructor.

Member Functions Documentation

CallName(TName &)

TInt

CallName

(

TName &

)

const

Checks if there is a valid call name available and stores it in aCallName if there is.

Parameters

TName &

Stores the call name of the new incoming call if there is one available.

Complete()

void

Complete

(

)

[protected, virtual]

Service completed request.

DeregisterObserver(MEventObserver *)

void

DeregisterObserver

(

MEventObserver *

aObserver

)

Deregisters an observer with this object. The deregistered observer will no longer be notified when this active object completes. If the observer was registered more than once with this AO, this method will only deregister one of those registrations.

Parameters

MEventObserver * aObserver

DoCancel()

void

DoCancel

(

)

[protected, virtual]

Cancel NotifyIncomingCall request.

NewL(CTelephonyFunctions *)

CNotifyIncomingCallAct *

NewL

(

CTelephonyFunctions *

aTelephonyFunctions

)

[static]

Public constructor which can Leave().

leave: Leaves if no memory.

Parameters

CTelephonyFunctions * aTelephonyFunctions

Object that constructs the returned object.

NotifyIncomingCall()

void

NotifyIncomingCall

(

)

Issue request to be notified of an incoming call so that the call name can be retrieved.

RegisterObserver(MEventObserver *)

void

RegisterObserver

(

MEventObserver *

aObserver

)

Registers an observer with this object. Observers of this AO are AOs owned by CTelephonyFunctions which want to be notified when this AO completes (i.e. of the arrival of an incomingcall).

Parameters

MEventObserver * aObserver

Pointer to the observer object.

ResetCallName()

void

ResetCallName

(

)

Deletes the contents of iCallName.

RunError()

TInt

RunError

(

)

[protected]

Handle any Leave() from inside RunL().

Member Enumerations Documentation

Enum TNotifyIncomingCallActState

Possible states that CNotifyIncomingCallAct can be in.

Enumerators

ENotifyIncomingCallActStateOperating
ENotifyIncomingCallActStateCleanUp

Member Data Documentation

TName iCallName

TName

iCallName

[private]

Stores the call name retrieved from the completion of RLine::NotifyIncomingCall(). Empty when there is no incoming call.

RPointerArray< MEventObserver > iIncomingCallCompletionObservers

RPointerArray< MEventObserver >

iIncomingCallCompletionObservers

[private]

Stores pointers to objects which want to be notified when this object completes.

TNotifyIncomingCallActState iState

TNotifyIncomingCallActState

iState

[private]

The current state of this active object.

CTelephonyFunctions * iTelephonyFunctions

CTelephonyFunctions *

iTelephonyFunctions

[private]

Pointer to the CTelephonyFunctions object which owns this object.