Class CContactOpenOperation

class CContactOpenOperation : private CActive;

Description

A class that manages the asynchronous open operation for a CContactDatabase.

The object can be deleted before the asynchronous open completes. This will set the state of the client supplied TRequestStatus to KErrCancel.

When the client supplied TRequestStatus is completed with KErrNone the TakeDatabase() method is called to pass ownership of the open database to the client.

Derivation

• CBase - Base class for all classes to be instantiated on the heap
• CActive - The core class of the active object abstraction
• CContactOpenOperation - A class that manages the asynchronous open operation for a CContactDatabase

Members

Defined in CContactOpenOperation:
DoCancel(), RunError(), RunL(), TakeDatabase(), ~CContactOpenOperation()

Inherited from CActive:
Cancel(), Deque(), EPriorityHigh, EPriorityIdle, EPriorityLow, EPriorityStandard, EPriorityUserInput, Extension_(), IsActive(), IsAdded(), Priority(), SetActive(), SetPriority(), TPriority, iStatus

Inherited from CBase:
Delete(), operator new()

See also:

• CContactDatabase::OpenL()

IMPORT_C ~CContactOpenOperation();

Description

Deletes the active object.

If the asynchronous open is still in progress it is cancelled.

If the TakeDatabase() API has not been called and the database has been opened it is closed.

IMPORT_C CContactDatabase *TakeDatabase();

Description

Takes ownership of the contact database.

Ownership of the contact database is passed to the client. Subsequent calls return NULL.

Return value

See also:

• CContactDatabase::Open()

private: virtual void RunL();

Description

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's RunL() or RunError() functions.

See also:

• CActiveScheduler::Start
• CActiveScheduler::Error
• CActiveScheduler::WaitForAnyRequest
• TRAPD

private: virtual TInt RunError(TInt aError);

Description

Parameters

Return value

private: virtual void DoCancel();

Description

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel().

See also:

• CActive::Cancel