Collapse all Symbian^3 Product Developer Library

CDmDomainManager Class Reference

class CDmDomainManager : 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 and implement a RunL() method to handle notifications. After the derived class has been instantiated, it must call ConstructL().

Inherits from

CDmDomainManager
- CActive
  - CBase

Public Member Functions
	CDmDomainManager(TDmHierarchyId)
	~CDmDomainManager()
IMPORT_C TInt	AddDomainHierarchy(TDmHierarchyId)
IMPORT_C TInt	GetTransitionFailureCount()
IMPORT_C TInt	GetTransitionFailures(RArray< const TTransitionFailure > &)
IMPORT_C void	RequestDomainTransition(TDmDomainId, TDmDomainState, TDmTraverseDirection)
IMPORT_C void	RequestSystemTransition(TDmDomainState, TDmTraverseDirection)
void	RunL()

Protected Member Functions
IMPORT_C void	ConstructL()
IMPORT_C void	DoCancel()

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::RunError(TInt)
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Inherited Enumerations
	CActive:TPriority

Private Attributes
TDmHierarchyId	iHierarchyId
RDmDomainManager	iManager
TInt	iReserved

Inherited Attributes
	CActive::iStatus

Constructor & Destructor Documentation

CDmDomainManager(TDmHierarchyId)

IMPORT_C

CDmDomainManager

(

TDmHierarchyId

aHierarchyId

)

Constructor.

Adds this active object to the active scheduler.

Parameters

TDmHierarchyId aHierarchyId

The Id of the domain hierarchy to connect to

~CDmDomainManager()

IMPORT_C

~CDmDomainManager

(

)

Destructor.

Closes the session to the domain manager.

Member Functions Documentation

AddDomainHierarchy(TDmHierarchyId)

IMPORT_C TInt

AddDomainHierarchy

(

TDmHierarchyId

aHierarchyId

)

[static]

Adds a domain hierarchy to the domain manager.

Parameters

TDmHierarchyId aHierarchyId

The Id of the domain hierarchy to add

ConstructL()

IMPORT_C void

ConstructL

(

)

[protected]

The second-phase constructor.

This function attempts to connect to the hierarchy specified in the constructor.

leave: One of the system-wide error codes.

DoCancel()

IMPORT_C void

DoCancel

(

)

[protected, virtual]

Cancels a pending event.

GetTransitionFailureCount()

IMPORT_C TInt

GetTransitionFailureCount

(

)

Gets the number of transition failures since the last transition request.

GetTransitionFailures(RArray< const TTransitionFailure > &)

IMPORT_C TInt

GetTransitionFailures

(

RArray< const TTransitionFailure > &

aTransitionFailures

)

Requests a list of transition failures since the last transition request.

Pre-condition: The session must be connected.

Parameters

RArray< const TTransitionFailure > & aTransitionFailures

A client-supplied array of TTransitionFailure objects which on exit will contain the failures that have occurred since the last transition request.

RequestDomainTransition(TDmDomainId, TDmDomainState, TDmTraverseDirection)

IMPORT_C void	RequestDomainTransition	(	TDmDomainId	aDomainId,
			TDmDomainState	aState,
			TDmTraverseDirection	aDirection
		)

Requests a domain state transition.

The domain hierarchy is traversed in the specified direction.

Parameters

TDmDomainId aDomainId	The Id of the domain for which the state transition is being requested.
TDmDomainState aState	The target state.
TDmTraverseDirection aDirection	The direction in which to traverse the hierarchy.

RequestSystemTransition(TDmDomainState, TDmTraverseDirection)

IMPORT_C void	RequestSystemTransition	(	TDmDomainState	aState,
			TDmTraverseDirection	aDirection
		)

Requests a system-wide state transition.

The domain hierarchy is traversed in the specified direction

Parameters

TDmDomainState aState	The target state.
TDmTraverseDirection aDirection	The direction in which to traverse the hierarchy.

RunL()

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

Member Data Documentation

TDmHierarchyId iHierarchyId

TDmHierarchyId

iHierarchyId

[private]

RDmDomainManager iManager

RDmDomainManager

iManager

[private]

TInt iReserved

TInt

iReserved

[private]