Collapse all Symbian^3 Application Developer Library

MShutdownEventObserver Class Reference

class MShutdownEventObserver

This class describes an interface, which is used by LaF Shutdown Manager to notify the Shutdown Server of device shutdown, so that the server can take appropriate power management steps. The concrete implementation of this interface is provided by CServShutdownServer class.

Public Member Functions
CArrayFix < TThreadId > *	ClientArrayLC ()
void	GetShutdownState ( TBool &, TBool &)
void	HandleShutdownEventL ( MSaveObserver::TSaveType , TBool , TPowerState )
TBool	IsClientHung ( TThreadId )

Member Functions Documentation

ClientArrayLC()

CArrayFix < TThreadId > *

ClientArrayLC

(

)

[pure virtual]

This method creates an array of CArrayFix<TThreadId> type and appends to it the thread id-s of all the registered clients. The created CArrayFix<TThreadId> instance will be pushed on the cleanup stack. The caller becomes responsible for the memory allocated for this array.

leave: Some system-wide error codes including KErrNoMemory.

GetShutdownState(TBool &, TBool &)

void	GetShutdownState	(	TBool &	aPowerOff,
			TBool &	aAllSessionsHavePendingRequest
		)	const [pure virtual]

This method returns information about the shutdown status.

Parameters

TBool & aPowerOff	An output parameter, where power-off status will be stored. It will be non-zero, if a powerdown sequence has been initiated.
TBool & aAllSessionsHavePendingRequest	An output parameter. It will be non-zero, if all clients have pending requests to receive further events from the Shutdown Manager.

HandleShutdownEventL(MSaveObserver::TSaveType, TBool, TPowerState)

void	HandleShutdownEventL	(	MSaveObserver::TSaveType	aAction,
			TBool	aPowerOff,
			TPowerState	aEvent = EPwStandby
		)	[pure virtual]

This method has to be called, when the observed object requires the Shutdown Server to notify registered clients about the shutdown event, such as MSaveObserver::ESaveData , MSaveObserver::ESaveAll , MSaveObserver::EReleaseRAM ,...

leave: KErrNotSupported Leaves if aEvent is invalid

Parameters

MSaveObserver::TSaveType aAction	The type of the requested action
TBool aPowerOff	If it is non-zero, this is the beginning of a powerdown sequence.
TPowerState aEvent = EPwStandby	The type of the powerdown event

IsClientHung(TThreadId)

TBool

IsClientHung

(

TThreadId

aId

)

const [pure virtual]

Checks if a particular client is hung in that the client has not re-registered with the Shutdown Server indicating it is ready for the next stage of the shutdown.

Parameters

TThreadId aId

Client's thread id.