CEnvironmentChangeNotifier Class Reference

class CEnvironmentChangeNotifier : public CActive

Environment change notifier. This is an active object and can be used to handle environment change events.

Inherits from

Constructor & Destructor Documentation

CEnvironmentChangeNotifier(TInt)

CEnvironmentChangeNotifier(TIntaPriority)[private, inline]

Parameters

TInt aPriority

~CEnvironmentChangeNotifier()

IMPORT_C~CEnvironmentChangeNotifier()

Member Functions Documentation

Change()

TInt Change()const [inline]

Returns the last set of change events.

If the last outstanding request completed normally, the function returns a bit pattern where each bit value corresponds to one of the enumerators defined by TChanges. A set bit indicates that the corresponding change event occurred.

For example, if the bit value TChanges::EChangesMidnightCrossover is set, then the system time has passed midnight.

A set of bits consisting of one or more of the values defined by TChanges, or KErrCancel if the last outstanding request was cancelled.

TChanges

DoCancel()

voidDoCancel()[private, 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

NewL(TInt, const TCallBack &)

IMPORT_C CEnvironmentChangeNotifier *NewL(TIntaPriority,
const TCallBack &aCallBack
)[static]

Parameters

TInt aPriority
const TCallBack & aCallBack

RunL()

voidRunL()[private, 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

Set(const TCallBack &)

IMPORT_C TIntSet(const TCallBack &aCallBack)

Parameters

const TCallBack & aCallBack

Start()

IMPORT_C voidStart()

Member Data Documentation

TCallBack iCallBack

TCallBack iCallBack[private]

TInt iChange

TInt iChange[private]

RChangeNotifier iChangeNotifier

RChangeNotifier iChangeNotifier[private]