| class CDmDomain : public CActive |
An abstract class for interfacing to a domain managed by the domain manager.
To make use of this class an application must derive from it and implement a RunL() method to handle notifications.
| Public Member Functions | |
|---|---|
| CDmDomain ( TDmHierarchyId , TDmDomainId ) | |
| ~CDmDomain () | |
| IMPORT_C void | AcknowledgeLastState ( TInt ) |
| IMPORT_C TDmDomainState | GetState () |
| IMPORT_C void | RequestTransitionNotification () |
| void | RunL () |
| Protected Member Functions | |
|---|---|
| IMPORT_C void | ConstructL () |
| IMPORT_C void | DoCancel () |
| Inherited Enumerations | |
|---|---|
| CActive:TPriority | |
| Private Attributes | |
|---|---|
| RDmDomain | iDomain |
| TDmDomainId | iDomainId |
| TDmHierarchyId | iHierarchyId |
| TInt | iReserved |
| Inherited Attributes | |
|---|---|
| CActive::iStatus | |
| IMPORT_C | CDmDomain | ( | TDmHierarchyId | aHierarchyId, |
| TDmDomainId | aDomainId | |||
| ) | ||||
Constructor.
Adds this active object to the active scheduler. The priority of the active object is the standard value, i.e. CActive::EPriorityStandard .
| TDmHierarchyId aHierarchyId | The Id of the domain hierarchy to connect to. |
| TDmDomainId aDomainId | The Id of the domain to connect to. |
| IMPORT_C void | AcknowledgeLastState | ( | TInt | aError | ) |
Acknowledges the last state change.
An application must acknowledge that it has performed all actions required by the last known state of the domain.
| TInt aError | The error to return to the domain manager. The client should set this to KErrNone if it successfully transitioned to the new state or to one of the system-wide error codes. |
| IMPORT_C void | ConstructL | ( | ) | [protected] |
Second-phase constructor.
The function attempts to connect to the domain specified in the constructor.
| IMPORT_C void | DoCancel | ( | ) | [protected, virtual] |
Cancels an outstanding notification request.
Any outstanding notification request completes with KErrCancel.
| IMPORT_C TDmDomainState | GetState | ( | ) |
Gets the domain's state.
An application normally calls this function after a notification request has completed. It then performs any application-dependent action demanded by the state, and then acknowledges the state transition.
| IMPORT_C void | RequestTransitionNotification | ( | ) |
Requests notification when the domain's state changes.
RunL() will be called when this happens.
| void | RunL | ( | ) | [pure 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
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.