Collapse all Symbian^3 Product Developer Library

CServShutdownSession Class Reference

class CServShutdownSession : public CSession2

This class describes a server side session object, which handles reqistration requests of clients, which are interested in power down events.

Inherits from

CServShutdownSession
- CSession2
  - CBase

Public Member Functions
	~CServShutdownSession()
TThreadId	ClientThreadId()
TBool	HasPendingRequest()
CServShutdownSession *	NewL()
void	NotifySave(MSaveObserver::TSaveType)

Protected Member Functions
	CServShutdownSession()
IMPORT_C void	ServiceL(const RMessage2 &)

Private Member Functions
void	DoServiceL(const RMessage2 &, TBool &)
void	PowerOffL(const RMessage2 &)
void	PowerStateL(const RMessage2 &)
void	RequestNotifyPowerDown(const RMessage2 &)
void	RequestNotifyPowerDownCancel()

Inherited Functions
	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()
	CSession2::CSession2()
	CSession2::CountResources()
	CSession2::Disconnect(const RMessage2 &)
	CSession2::Extension_(TUint,TAny &,TAny )
	CSession2::ResourceCountMarkEnd(const RMessage2 &)
	CSession2::ResourceCountMarkStart()
	CSession2::Server()const
	CSession2::ServiceError(const RMessage2 &,TInt)
	CSession2::SetServer(const CServer2 *)
	CSession2::~CSession2()

Inherited Enumerations
	CSession2:TPanicNo

Private Attributes
TInt	iCurrentEvent
TInt	iOutstandingEvent
RMessagePtr2	iPtr

Constructor & Destructor Documentation

CServShutdownSession()

IMPORT_C

CServShutdownSession

(

)

[protected]

~CServShutdownSession()

IMPORT_C

~CServShutdownSession

(

)

Member Functions Documentation

ClientThreadId()

TThreadId

ClientThreadId

(

)

const

DoServiceL(const RMessage2 &, TBool &)

void	DoServiceL	(	const RMessage2 &	aMessage,
			TBool &	aCompleteRequest
		)	[private]

This method dispatches all client requests to the appropriate method calls.

Parameters

const RMessage2 & aMessage	The client's message
TBool & aCompleteRequest	An output parameter. If zero, the client request will be completed later.

HasPendingRequest()

TBool

HasPendingRequest

(

)

const

NewL()

CServShutdownSession *

NewL

(

)

[static]

Standard phase-one factor method for creating CServShutdownSession instances.

leave: KErrNoMemory Not enough memory to complete the operation.

NotifySave(MSaveObserver::TSaveType)

void

NotifySave

(

MSaveObserver::TSaveType

aSaveType

)

This method will complete the pending asychronous client request, effectivelly notifying it about the action, which the client has to do.

Parameters

MSaveObserver::TSaveType aSaveType

The type of the requested save action.

PowerOffL(const RMessage2 &)

void

PowerOffL

(

const RMessage2 &

aMessage

)

[private]

This method should be used only with SYSLIBS_TEST macro defined and can be used to initiate a powerdown sequence. Without SYSLIBS_TEST macro defined the method will panic the client with KErrNotSupported error code.

Parameters

const RMessage2 & aMessage

The message containing the client request.

PowerStateL(const RMessage2 &)

void

PowerStateL

(

const RMessage2 &

aMessage

)

const [private]

This method should be used only with SYSLIBS_TEST macro defined and can be used to get the power state of the server. Without SYSLIBS_TEST macro defined the method will panic the client with KErrNotSupported error code.

Parameters

const RMessage2 & aMessage

The message containing the client request.

RequestNotifyPowerDown(const RMessage2 &)

void

RequestNotifyPowerDown

(

const RMessage2 &

aMessage

)

[private]

This method processes a client-side registration request. It is an asynchronous request, which will be completed later, when powerdown/low memory event occurs.

Parameters

const RMessage2 & aMessage

The message containing the client request.

RequestNotifyPowerDownCancel()

void

RequestNotifyPowerDownCancel

(

)

[private]

This method cancels the client registration, completing the requests with KErrCancel error code.

ServiceL(const RMessage2 &)

IMPORT_C void

ServiceL

(

const RMessage2 &

aMessage

)

[protected, virtual]

Handles the servicing of client requests passed to the shutdown server.

Parameters

const RMessage2 & aMessage

The message containing the client request.

Member Data Documentation

TInt iCurrentEvent

TInt

iCurrentEvent

[private]

TInt iOutstandingEvent

TInt

iOutstandingEvent

[private]

RMessagePtr2 iPtr

RMessagePtr2

iPtr

[private]