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.

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 &)

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

This method returns information about the shutdown status.

Parameters

TBool & aPowerOffAn output parameter, where power-off status will be stored. It will be non-zero, if a powerdown sequence has been initiated.
TBool & aAllSessionsHavePendingRequestAn 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)

voidHandleShutdownEventL(MSaveObserver::TSaveTypeaAction,
TBoolaPowerOff,
TPowerStateaEvent = 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 aActionThe type of the requested action
TBool aPowerOffIf it is non-zero, this is the beginning of a powerdown sequence.
TPowerState aEvent = EPwStandbyThe type of the powerdown event

IsClientHung(TThreadId)

TBool IsClientHung(TThreadIdaId)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 aIdClient's thread id.