RSsmRtcAdaptation Class Reference

class RSsmRtcAdaptation : public RSsmAdaptationBase

Client interface for RTC Adaptation part of the Adaptation server.

Inherits from

Public Member Functions
IMPORT_C voidCancel()
IMPORT_C voidSetWakeupAlarm(TDesC8 &, TRequestStatus &)
IMPORT_C voidUnsetWakeupAlarm(TRequestStatus &)
IMPORT_C voidValidateRtc(TDes8 &, 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

Cancel()

IMPORT_C voidCancel()

Cancels the current outstanding request on this R class.

Calling this API does not cancel any wake-up time that is set. Use UnsetWakeupAlarm() to do this.

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

SetWakeupAlarm(TDesC8 &, TRequestStatus &)

IMPORT_C voidSetWakeupAlarm(TDesC8 &aAlarmTimePckg,
TRequestStatus &aStatus
)

Request that the device wake-up at a certain time, even if the device is switched off.

Note:

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

TTime

Parameters

TDesC8 & aAlarmTimePckgA descriptor packaging a TTime object, such as TPckgC<TTime>. The descriptor referenced should exist until aStatus is completed. This descriptor should contain a TTime object representing the UTC time that the device should wake-up.
TRequestStatus & aStatusThe 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 Alarm Server, otherwise one of the other system-wide error codes.

UnsetWakeupAlarm(TRequestStatus &)

IMPORT_C voidUnsetWakeupAlarm(TRequestStatus &aStatus)

Stops the device from waking-up at a time set by a previous call to SetWakeupAlarm().

Note:

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

RSsmRtcAdaptation::SetWakeupAlarm()

Parameters

TRequestStatus & aStatusThe 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 Alarm Server, otherwise one of the other system-wide error codes.

ValidateRtc(TDes8 &, TRequestStatus &)

IMPORT_C voidValidateRtc(TDes8 &aValidityPckg,
TRequestStatus &aStatus
)

Retrieve information about if the real time clock, if present, contains a valid time.

Parameters

TDes8 & aValidityPckgA descriptor packaging a TBool object, such as TPckg<TBool>. The descriptor referenced should exist until aStatus is completed. When aStatus is completed with KErrNone this descriptor will contain ETrue if the real time clock is valid, EFalse otherwise.
TRequestStatus & aStatusThe request status. This is set to KErrNone on completion, KErrNotSupported if this operations is not supported by the adaptation, otherwise one of the other system-wide error codes.