Collapse all Symbian^3 Product Developer Library

RSsmStateAdaptation Class Reference

class RSsmStateAdaptation : public RSsmAdaptationBase

Client interface for State Adaptation part of the Adaptation server.

Inherits from

RSsmStateAdaptation
- RSsmAdaptationBase
  - RSessionBase
    - RHandleBase

Public Member Functions
IMPORT_C void	GetLastCoopSysEvent(TDes8 &)
IMPORT_C void	NotifyCancel()
IMPORT_C void	NotifyCoopSysEvent(TDes8 &, TRequestStatus &)
IMPORT_C void	RequestCancel()
IMPORT_C void	RequestCoopSysPerformRestartActions(TInt, TRequestStatus &)
IMPORT_C void	RequestCoopSysPerformRfsActions(TSsmRfsType, TRequestStatus &)
IMPORT_C void	RequestCoopSysPerformShutdownActions(TInt, TRequestStatus &)
IMPORT_C void	RequestCoopSysSelfTest(TRequestStatus &)
IMPORT_C void	RequestCoopSysStateChange(TSsmState, TRequestStatus &)

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::Close()
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()
	RSsmAdaptationBase::Connect()
	RSsmAdaptationBase::Connect(TInt)

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Inherited Attributes
	RHandleBase::iHandle

Member Functions Documentation

GetLastCoopSysEvent(TDes8 &)

IMPORT_C void

GetLastCoopSysEvent

(

TDes8 &

aTypePckg

)

Returns the last event occured in the aTypePckg which is a package of TSsmCoopSysEventType

Calling this API will get the last notification received by Adaptation server.If the client needs to be notified about the notifications client has to register using NotifyCoopSysEvent But once the client receives a notification it has to register again using NotifyCoopSysEvent for further notification. To get any events that are missed between two notification requests the API GetLastCoopSysEvent can be used. This API can also be used to just get the last notified State event from Adaptation server.

Parameters

TDes8 & aTypePckg

NotifyCancel()

IMPORT_C void

NotifyCancel

(

)

Cancels the current outstanding request for notification of cooperating system events.

Calling this API does not cancel any outstanding 'Request...' request. Use RequestCancel() to cancel outstanding 'Request...' requests.

If the request is successfully cancelled then the TRequestStatus associated with the notification request will be completed with KErrCancel.

NotifyCoopSysEvent(TDes8 &, TRequestStatus &)

IMPORT_C void	NotifyCoopSysEvent	(	TDes8 &	aTypePckg,
			TRequestStatus &	aStatus
		)

Requests notification of cooperating system events.

Note:

This API can only be called by processes with the SecureID of the SSM Utility Server.

TSsmCoopSysEventType

Parameters

TDes8 & aTypePckg
TRequestStatus & aStatus	The request status. This is set to KErrNone on completion, KErrNotSupported if this operations is not supported by the adaptation, KErrPermissionDenied if the current process does not have the SecureID of the SSM Utility Server, otherwise one of the other system-wide error codes.

RequestCancel()

IMPORT_C void

RequestCancel

(

)

Cancels the current outstanding request from the cooperating system.

Calling this API does not cancel any outstanding notification request. Use NotifyCancel() to cancel outstanding notification requests.

If the request is successfully cancelled then the TRequestStatus associated with that request will be completed with KErrCancel.

RequestCoopSysPerformRestartActions(TInt, TRequestStatus &)

IMPORT_C void	RequestCoopSysPerformRestartActions	(	TInt	aReason,
			TRequestStatus &	aStatus
		)

Requests the cooperating system to perform any actions necessary before the system is restarted.

Note:

This API can only be called by processes with the SecureID of the System State Manager.

Parameters

TInt aReason	The reason for the system restart. The meaning of this value is specific to the cooperating system.
TRequestStatus & aStatus	The request status. This is set to KErrNone on completion, KErrNotSupported if this operations is not supported by the adaptation, KErrPermissionDenied if the current process does not have the SecureID of the System State Manager, otherwise one of the other system-wide error codes.

RequestCoopSysPerformRfsActions(TSsmRfsType, TRequestStatus &)

IMPORT_C void	RequestCoopSysPerformRfsActions	(	TSsmRfsType	aType,
			TRequestStatus &	aStatus
		)

Requests the cooperating system to perform any actions necessary for restoring settings to default values.

Note:

This API can only be called by processes with the SecureID of the System State Manager.

TSsmRfsType

Parameters

TSsmRfsType aType	The level of restoring settings to default values to perform.
TRequestStatus & aStatus	The request status. This is set to KErrNone on completion, KErrNotSupported if this operations is not supported by the adaptation, KErrPermissionDenied if the current process does not have the SecureID of the System State Manager, otherwise one of the other system-wide error codes.

RequestCoopSysPerformShutdownActions(TInt, TRequestStatus &)

IMPORT_C void	RequestCoopSysPerformShutdownActions	(	TInt	aReason,
			TRequestStatus &	aStatus
		)

Requests the cooperating system to perform any actions necessary before the system is shutdown.

Note:

This API can only be called by processes with the SecureID of the System State Manager.

Parameters

TInt aReason	The reason for the system shutdown. The meaning of this value is specific to the cooperating system.
TRequestStatus & aStatus	The request status. This is set to KErrNone on completion, KErrNotSupported if this operations is not supported by the adaptation, KErrPermissionDenied if the current process does not have the SecureID of the System State Manager, otherwise one of the other system-wide error codes.

RequestCoopSysSelfTest(TRequestStatus &)

IMPORT_C void

RequestCoopSysSelfTest

(

TRequestStatus &

aStatus

)

Requests the cooperating system to perform self tests.

Note:

This API can only be called by processes with the SecureID of the System State Manager.

Parameters

TRequestStatus & aStatus

The request status. This is set to KErrNone on successful completion of self tests, KErrNotSupported if this operations is not supported by the adaptation, KErrPermissionDenied if the current process does not have the SecureID of the System State Manager, otherwise one of the other system-wide error codes.

RequestCoopSysStateChange(TSsmState, TRequestStatus &)

IMPORT_C void	RequestCoopSysStateChange	(	TSsmState	aState,
			TRequestStatus &	aStatus
		)

Requests the cooperating system to perform a state change matching the current system state.

Note:

The aStatus can be completed with a value other than KErrNone if the cooperating system has rejected the requested state change.

This API can only be called by processes with the SecureID of the System State Manager.

Parameters

TSsmState aState	The requested system state to change to for the cooperating system. After succesful execution of this API the Cooperating system will be the state aState
TRequestStatus & aStatus	The request status. This is set to KErrNone on completion, KErrNotSupported if this operations is not supported by the adaptation, KErrPermissionDenied if the current client process does not have the SecureID of the System State Manager, otherwise one of the other system-wide error codes.