CHierarchyObserver Class Reference

class CHierarchyObserver : public CActive

An abstract class to allow a domain controller to interface to the domain manager.

To make use of this class an application must derive from it.

Inherits from

Constructor & Destructor Documentation

CHierarchyObserver(MHierarchyObserver &, TDmHierarchyId)

CHierarchyObserver ( MHierarchyObserver & aHierarchyObserver,
TDmHierarchyId aHierarchyId
) [private]

Parameters

MHierarchyObserver & aHierarchyObserver
TDmHierarchyId aHierarchyId

~CHierarchyObserver()

IMPORT_C ~CHierarchyObserver ( )

Destructor.

Frees resources prior to destruction of the object.

Member Functions Documentation

DoCancel()

void DoCancel ( ) [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

GetEvents()

TInt GetEvents ( ) [private]

GetNotification()

void GetNotification ( ) [private]

NewL(MHierarchyObserver &, TDmHierarchyId)

IMPORT_C CHierarchyObserver * NewL ( MHierarchyObserver & aHierarchyObserver,
TDmHierarchyId aHierarchyId
) [static]

Constructs a new observer on the domain hierarchy.

Note that only one observer per domain hierarchy is allowed.

Parameters

MHierarchyObserver & aHierarchyObserver The implementation of the interface to the domain manager.
TDmHierarchyId aHierarchyId The Id of the domain hierarchy.

ObserverDomainCount()

IMPORT_C TInt ObserverDomainCount ( )

Gets the number of domains that are being observed.

This value is the number of children of the domain member to which the observer is attached, including itself.

RunL()

void RunL ( ) [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

StartObserver(TDmDomainId, TDmNotifyType)

IMPORT_C TInt StartObserver ( TDmDomainId aDomainId,
TDmNotifyType aNotifyType
)

Starts the observer.

Parameters

TDmDomainId aDomainId The Id of the domain to which the obsever is attached.
TDmNotifyType aNotifyType The type of notifications of interest to the observer.

StopObserver()

IMPORT_C TInt StopObserver ( )

Stops the observer.

Member Data Documentation

TDmDomainId iDomainId

TDmDomainId iDomainId [private]

TDmHierarchyId iHierarchyId

TDmHierarchyId iHierarchyId [private]

TDmNotifyType iNotifyType

TDmNotifyType iNotifyType [private]

MHierarchyObserver & iObserver

MHierarchyObserver & iObserver [private]

TBool iObserverStarted

TBool iObserverStarted [private]

RDmManagerSession iSession

RDmManagerSession iSession [private]

RArray< const TTransInfo > iTransitionEvents

RArray < const TTransInfo > iTransitionEvents [private]