Collapse all Symbian^3 Product Developer Library

RDmDomainManager Class Reference

class RDmDomainManager

The policy's interface to the domain manager.

Public Member Functions
IMPORT_C TInt	AddDomainHierarchy(TDmHierarchyId)
IMPORT_C void	CancelTransition()
IMPORT_C void	Close()
IMPORT_C TInt	Connect()
IMPORT_C TInt	Connect(TDmHierarchyId)
IMPORT_C TInt	GetTransitionFailureCount()
IMPORT_C TInt	GetTransitionFailures(RArray< const TTransitionFailure > &)
IMPORT_C void	RequestDomainTransition(TDmDomainId, TPowerState, TRequestStatus &)
IMPORT_C void	RequestDomainTransition(TDmDomainId, TDmDomainState, TDmTraverseDirection, TRequestStatus &)
IMPORT_C void	RequestSystemTransition(TPowerState, TRequestStatus &)
IMPORT_C void	RequestSystemTransition(TDmDomainState, TDmTraverseDirection, TRequestStatus &)
IMPORT_C void	SystemShutdown()
IMPORT_C TInt	WaitForInitialization()

Private Attributes
RDmManagerSession	iSession

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 be added.

CancelTransition()

IMPORT_C void

CancelTransition

(

)

Cancels a state transition, whether initiated by a call to RequestSystemTransition() or RequestDomainTransition().

An outstanding state transition request completes with KErrCancel.

Close()

IMPORT_C void

(

)

Closes this connection to the domain manager.

If there is no existing connection, then it returns silently.

Connect()

IMPORT_C TInt

Connect

(

)

Opens a controlling connection to the standard power domain hierarchy in the domain manager.

The domain manger allows only one open connection at any one time to the power domain hierarchy. Connection is usually made by the power policy entity.

KDmErrAlreadyJoin

Connect(TDmHierarchyId)

IMPORT_C TInt

Connect

(

TDmHierarchyId

aHierarchyId

)

Opens a controlling connection to a specific domain hieararchy owned by the domain manager.

The domain manger allows only one open connection at any one time to a particular hierarchy.

KDmErrAlreadyJoin KErrBadHierarchyId

Parameters

TDmHierarchyId aHierarchyId

The Id of the domain hierarchy to connect to.

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, TPowerState, TRequestStatus &)

IMPORT_C void	RequestDomainTransition	(	TDmDomainId	aDomain,
			TPowerState	aState,
			TRequestStatus &	aStatus
		)

Requests a domain state transition.

The domain hierarchy is traversed in the default direction.

RDmDomainManager::CancelTransition()

Parameters

TDmDomainId aDomain	The Id of the domain for which the state transition is being requested.
TPowerState aState	The target state.
TRequestStatus & aStatus	The request status object for this asynchronous request.

RequestDomainTransition(TDmDomainId, TDmDomainState, TDmTraverseDirection, TRequestStatus &)

IMPORT_C void	RequestDomainTransition	(	TDmDomainId	aDomain,
			TDmDomainState	aState,
			TDmTraverseDirection	aDirection,
			TRequestStatus &	aStatus
		)

Requests a domain state transition.

The domain hierarchy is traversed in the specified direction

RDmDomainManager::CancelTransition()

panic: domainCli.cpp; assertion failed VARNUM if the numerical value of aDirection is greater than the value of ETraverseMax. NOTE: VARNUM is the line number in the source code and may change if the implementation changes.

Parameters

TDmDomainId aDomain	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.
TRequestStatus & aStatus	The request status object for this asynchronous request.

RequestSystemTransition(TPowerState, TRequestStatus &)

IMPORT_C void	RequestSystemTransition	(	TPowerState	aState,
			TRequestStatus &	aStatus
		)

Requests a system-wide power state transition.

The domain hierarchy is traversed in the default direction

RDmDomainManager::CancelTransition()

Parameters

TPowerState aState	The target power state.
TRequestStatus & aStatus	The request status object for this asynchronous request.

RequestSystemTransition(TDmDomainState, TDmTraverseDirection, TRequestStatus &)

IMPORT_C void	RequestSystemTransition	(	TDmDomainState	aState,
			TDmTraverseDirection	aDirection,
			TRequestStatus &	aStatus
		)

Requests a system-wide state transition.

The domain hierarchy is traversed in the specified direction.

RDmDomainManager::CancelTransition()

panic: domainCli.cpp; assertion failed VARNUM if the numerical value of aDirection is greater than the value of ETraverseMax. NOTE: VARNUM is the line number in the source code and may change if the implementation changes.

Parameters

TDmDomainState aState	The target state.
TDmTraverseDirection aDirection	The direction in which to traverse the hierarchy
TRequestStatus & aStatus	The request status object for this asynchronous request.

SystemShutdown()

IMPORT_C void

SystemShutdown

(

)

Requests a system-wide power shutdown.

This is a request to change the system's power state to EPwOff. This call does not return; the system can only return by rebooting.

WaitForInitialization()

IMPORT_C TInt

WaitForInitialization

(

)

[static]

Member Data Documentation

RDmManagerSession iSession

RDmManagerSession

iSession

[private]