CIdle Class Reference

class CIdle : public CActive

An active object that performs low-priority processing when no higher-priority active objects are ready to run.

An idle time active object together with its associated callback function may be used to implement potentially long running background tasks, such as spreadsheet recalculation and word processor repagination.

Inherits from

Constructor & Destructor Documentation

CIdle(TInt)

IMPORT_CCIdle(TIntaPriority)[protected]

Parameters

TInt aPriority

~CIdle()

IMPORT_C~CIdle()

Member Functions Documentation

DoCancel()

IMPORT_C voidDoCancel()[protected, virtual]

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().

CActive::Cancel

New(TInt)

IMPORT_C CIdle *New(TIntaPriority)[static]

Parameters

TInt aPriority

NewL(TInt)

IMPORT_C CIdle *NewL(TIntaPriority)[static]

Parameters

TInt aPriority

RunL()

IMPORT_C voidRunL()[protected, virtual]

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.

CActiveScheduler::Start

CActiveScheduler::Error

CActiveScheduler::WaitForAnyRequest

TRAPD

Start(TCallBack)

IMPORT_C voidStart(TCallBackaCallBack)

Parameters

TCallBack aCallBack

Member Data Documentation

TCallBack iCallBack

TCallBack iCallBack[protected]

The callback object that encapsulates the background task.

Start