Collapse all Symbian^3 Application Developer Library

CPsmClient Class Reference

class CPsmClient : public CBase

PSM Client API class

Allows clients to change power save mode. Provides also a reference to PSM Client Settings API.

psmclient.lib

Inherits from

CPsmClient
- CBase

Public Member Functions
void	CancelPowerSaveModeChange ()
void	CancelPowerSaveModeNotificationRequest ()
void	ChangePowerSaveMode (const TInt )
IMPORT_C CPsmClient *	NewL ( MPsmClientObserver &)
IMPORT_C CPsmClient *	NewLC ( MPsmClientObserver &)
CPsmSettings &	PsmSettings ()
void	RequestPowerSaveModeNotification ()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	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()

Member Functions Documentation

CancelPowerSaveModeChange()

void

CancelPowerSaveModeChange

(

)

[pure virtual]

Cancels ongoing power save mode change and restores previous power save mode back. If there is no ongoing change, current mode remains.

CancelPowerSaveModeNotificationRequest()

void

CancelPowerSaveModeNotificationRequest

(

)

[pure virtual]

Cancels notification request of power save mode change.

MPsmClientObserver

ChangePowerSaveMode(const TInt)

void

ChangePowerSaveMode

(

const TInt

aPsmMode

)

[pure virtual]

Enable power save mode. It is possible to get notification of mode change by requesting a notification using RequestPowerSaveModeNotification. On successful change, client gets indication via PowerSaveModeChanged callback. Failure in change is indicated to client via PowerSaveModeChangeError callback.

MPsmClientObserver

Parameters

const TInt aPsmMode

The power save mode to change to

NewL(MPsmClientObserver &)

IMPORT_C CPsmClient *

NewL

(

MPsmClientObserver &

aObserver

)

[static]

Creates a new PSM client.

Parameters

MPsmClientObserver & aObserver

Observer to observe the power save mode change

NewLC(MPsmClientObserver &)

IMPORT_C CPsmClient *

NewLC

(

MPsmClientObserver &

aObserver

)

[static]

Parameters

MPsmClientObserver & aObserver

PsmSettings()

CPsmSettings &

PsmSettings

(

)

const [pure virtual]

Reference to PSM Client Settings API.

RequestPowerSaveModeNotification()

void

RequestPowerSaveModeNotification

(

)

[pure virtual]

Requests notification of power save mode change. Client is notified about mode changes until request cancelled using CancelPowerSaveModeNotificationRequest.

MPsmClientObserver