Collapse all Symbian^3 Product Developer Library

CSecurityDispatcher Class Reference

class CSecurityDispatcher : public CBase

This class is responsible for packing and unpacking data belonging to Security related requests to the Licensee LTSY.

Inherits from

CSecurityDispatcher
- CBase

Public Member Functions
	~CSecurityDispatcher()
void	CallbackAbortSecurityCode(TInt)
void	CallbackBootNotifySecurityReady(TInt)
void	CallbackCheckSecurityCode(TInt)
void	CallbackCheckSecurityCodeCancel(TInt)
void	CallbackDisablePhoneLock(TInt)
void	CallbackGetCipheringInfo(TInt, TBool)
void	CallbackGetCurrentActivePin(TInt, RMobilePhone::TMobilePhoneSecurityCode)
void	CallbackGetLockInfo(TInt, RMobilePhone::TMobilePhoneLockStatus, RMobilePhone::TMobilePhoneLockSetting)
void	CallbackGetPin1DisableSupported(TInt, TBool)
void	CallbackGetSecurityCodeInfo(TInt, RMobilePhone::TMobilePhoneSecurityCode, TInt)
void	CallbackIsSecurityCodeBlocked(TInt, TBool)
void	CallbackNotifyCipheringInfoChange(TInt, const RMmCustomAPI::TCipheringInfo &)
void	CallbackNotifyLockInfoChange(TInt, RMobilePhone::TMobilePhoneLockStatus, RMobilePhone::TMobilePhoneLockSetting, RMobilePhone::TMobilePhoneLock)
void	CallbackNotifySecurityEvent(TInt, RMobilePhone::TMobilePhoneSecurityEvent)
void	CallbackSetLockSetting(TInt)
void	CallbackSync(CRequestQueueOneShot::TIpcDataPackage &)
void	CallbackVerifySecurityCode(TInt)
TInt	DispatchAbortSecurityCodeL(const CMmDataPackage *)
TInt	DispatchCheckSecurityCodeCancelL(const CMmDataPackage *)
TInt	DispatchCheckSecurityCodeL(const CMmDataPackage *)
TInt	DispatchDisablePhoneLockL(const CMmDataPackage *)
TInt	DispatchGetCipheringInfoL()
TInt	DispatchGetCurrentActivePinL()
TInt	DispatchGetLockInfoL(const CMmDataPackage *)
TInt	DispatchGetPin1DisableSupportedL()
TInt	DispatchGetSecurityCodeInfoL(const CMmDataPackage *)
TInt	DispatchIsSecurityCodeBlockedL(const CMmDataPackage *)
TInt	DispatchSetLockSettingL(const CMmDataPackage *)
TInt	DispatchVerifySecurityCodeL(const CMmDataPackage *)
CSecurityDispatcher *	NewL(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)
CSecurityDispatcher *	NewLC(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)
void	SetDispatcherHolder(TDispatcherHolder &)

Private Member Functions
	CSecurityDispatcher(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)
void	ConstructL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	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()

Private Attributes
TDispatcherHolder *	iDispatcherHolder
MLtsyDispatchSecurityAbortSecurityCode *	iLtsyDispatchSecurityAbortSecurityCode
MLtsyDispatchSecurityCheckSecurityCode *	iLtsyDispatchSecurityCheckSecurityCode
MLtsyDispatchSecurityCheckSecurityCodeCancel *	iLtsyDispatchSecurityCheckSecurityCodeCancel
MLtsyDispatchSecurityDisablePhoneLock *	iLtsyDispatchSecurityDisablePhoneLock
MLtsyDispatchSecurityGetCipheringInfo *	iLtsyDispatchSecurityGetCipheringInfo
MLtsyDispatchSecurityGetCurrentActivePin *	iLtsyDispatchSecurityGetCurrentActivePin
MLtsyDispatchSecurityGetLockInfo *	iLtsyDispatchSecurityGetLockInfo
MLtsyDispatchSecurityGetPin1DisableSupported *	iLtsyDispatchSecurityGetPin1DisableSupported
MLtsyDispatchSecurityGetSecurityCodeInfo *	iLtsyDispatchSecurityGetSecurityCodeInfo
MLtsyDispatchSecurityIsSecurityCodeBlocked *	iLtsyDispatchSecurityIsSecurityCodeBlocked
MLtsyDispatchSecuritySetLockSetting *	iLtsyDispatchSecuritySetLockSetting
MLtsyDispatchSecurityVerifySecurityCode *	iLtsyDispatchSecurityVerifySecurityCode
MLtsyDispatchFactoryV1 &	iLtsyFactoryV1
MmMessageManagerCallback &	iMessageManagerCallback
CRequestQueueOneShot &	iRequestAsyncOneShot

Constructor & Destructor Documentation

CSecurityDispatcher(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)

CSecurityDispatcher	(	MLtsyDispatchFactoryV1 &	aLtsyFactory,
		MmMessageManagerCallback &	aMessageManagerCallback,
		CRequestQueueOneShot &	aRequestAsyncOneShot
	)	[private]

Parameters

MLtsyDispatchFactoryV1 & aLtsyFactory
MmMessageManagerCallback & aMessageManagerCallback
CRequestQueueOneShot & aRequestAsyncOneShot

~CSecurityDispatcher()

~CSecurityDispatcher

(

)

[virtual]

Member Functions Documentation

CallbackAbortSecurityCode(TInt)

void

CallbackAbortSecurityCode

(

TInt

aError

)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecurityAbortSecurityCodeComp()

Parameters

TInt aError

The error code to be returned to the CTSY Dispatcher.

CallbackBootNotifySecurityReady(TInt)

void

CallbackBootNotifySecurityReady

(

TInt

aError

)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecurityBootNotifySecurityReadyInd()

Parameters

TInt aError

The error code to be returned to the CTSY Dispatcher.

CallbackCheckSecurityCode(TInt)

void

CallbackCheckSecurityCode

(

TInt

aError

)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecurityCheckSecurityCodeComp().

Parameters

TInt aError

The error code to be returned to the CTSY Dispatcher.

CallbackCheckSecurityCodeCancel(TInt)

void

CallbackCheckSecurityCodeCancel

(

TInt

aError

)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecurityCheckSecurityCodeCancelComp().

Parameters

TInt aError

The error code to be returned to the CTSY Dispatcher.

CallbackDisablePhoneLock(TInt)

void

CallbackDisablePhoneLock

(

TInt

aError

)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecurityDisablePhoneLockComp().

Parameters

TInt aError

The error code to be returned to the CTSY Dispatcher.

CallbackGetCipheringInfo(TInt, TBool)

void	CallbackGetCipheringInfo	(	TInt	aError,
			TBool	aIndStatus
		)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecurityGetCipheringInfoComp().

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
TBool aIndStatus	Ciphering indicator status.

CallbackGetCurrentActivePin(TInt, RMobilePhone::TMobilePhoneSecurityCode)

void	CallbackGetCurrentActivePin	(	TInt	aError,
			RMobilePhone::TMobilePhoneSecurityCode	aSecCode
		)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecurityGetCurrentActivePinComp()

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
RMobilePhone::TMobilePhoneSecurityCode aSecCode	Security code.

CallbackGetLockInfo(TInt, RMobilePhone::TMobilePhoneLockStatus, RMobilePhone::TMobilePhoneLockSetting)

void	CallbackGetLockInfo	(	TInt	aError,
			RMobilePhone::TMobilePhoneLockStatus	aLockStatus,
			RMobilePhone::TMobilePhoneLockSetting	aLockSetting
		)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecurityGetLockInfoComp()

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
RMobilePhone::TMobilePhoneLockStatus aLockStatus	Lock status (unknown, locked, unlocked or blocked).
RMobilePhone::TMobilePhoneLockSetting aLockSetting	Lock setting (unknown, enabled, disabled or replaced).

CallbackGetPin1DisableSupported(TInt, TBool)

void	CallbackGetPin1DisableSupported	(	TInt	aError,
			TBool	aIsSupported
		)

Packages the data returned by the Licensee LTSY and completes the EMmTsyPhoneGetPin1DisableSupportedIPC back to the Common TSY.

Parameters

TInt aError	The error code to complete back.
TBool aIsSupported	Is SIM support disabling of PIN1.

CallbackGetSecurityCodeInfo(TInt, RMobilePhone::TMobilePhoneSecurityCode, TInt)

void	CallbackGetSecurityCodeInfo	(	TInt	aError,
			RMobilePhone::TMobilePhoneSecurityCode	aSecCode,
			TInt	aRemainingEntryAttempts
		)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecurityGetSecurityCodeInfoComp()

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
RMobilePhone::TMobilePhoneSecurityCode aSecCode	Security code.
TInt aRemainingEntryAttempts	Number of remaining security code entry attempts before the corresponding lock gets blocked.

CallbackIsSecurityCodeBlocked(TInt, TBool)

void	CallbackIsSecurityCodeBlocked	(	TInt	aError,
			TBool	aIsBlocked
		)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecurityIsSecurityCodeBlockedComp().

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
TBool aIsBlocked	Is security code blocked.

CallbackNotifyCipheringInfoChange(TInt, const RMmCustomAPI::TCipheringInfo &)

void	CallbackNotifyCipheringInfoChange	(	TInt	aError,
			const RMmCustomAPI::TCipheringInfo &	aInfo
		)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecurityNotifyCipheringInfoChangeInd().

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
const RMmCustomAPI::TCipheringInfo & aInfo	Ciphering information data structure: ciphering indicator and ciphering status.

CallbackNotifyLockInfoChange(TInt, RMobilePhone::TMobilePhoneLockStatus, RMobilePhone::TMobilePhoneLockSetting, RMobilePhone::TMobilePhoneLock)

void	CallbackNotifyLockInfoChange	(	TInt	aError,
			RMobilePhone::TMobilePhoneLockStatus	aStatus,
			RMobilePhone::TMobilePhoneLockSetting	aSetting,
			RMobilePhone::TMobilePhoneLock	aLock
		)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecurityNotifyLockInfoChangeInd()

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
RMobilePhone::TMobilePhoneLockStatus aStatus	Status of the lock (unknown, locked, unlocked or blocked).
RMobilePhone::TMobilePhoneLockSetting aSetting	Lock setting (unknown, enabled, disabled or replaced).
RMobilePhone::TMobilePhoneLock aLock	Lock information.

CallbackNotifySecurityEvent(TInt, RMobilePhone::TMobilePhoneSecurityEvent)

void	CallbackNotifySecurityEvent	(	TInt	aError,
			RMobilePhone::TMobilePhoneSecurityEvent	aSecEvent
		)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecurityNotifySecurityEventInd()

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
RMobilePhone::TMobilePhoneSecurityEvent aSecEvent	Security event.

CallbackSetLockSetting(TInt)

void

CallbackSetLockSetting

(

TInt

aError

)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecuritySetLockSettingComp()

Parameters

TInt aError

The error code to be returned to the CTSY Dispatcher.

CallbackSync(CRequestQueueOneShot::TIpcDataPackage &)

void

CallbackSync

(

CRequestQueueOneShot::TIpcDataPackage &

aIpcDataPackage

)

Part of the MDispatcherCallback interface. Used to complete requests handled synchronously by the Licensee LTSY asynchronously back to the Common TSY.

MDispatcherCallback::CallbackSync

Parameters

CRequestQueueOneShot::TIpcDataPackage & aIpcDataPackage

Package encapsulating the request.

CallbackVerifySecurityCode(TInt)

void

CallbackVerifySecurityCode

(

TInt

aError

)

Callback function to be used by the request to complete CCtsyDispatcherCallback::CallbackSecurityVerifySecurityCodeComp().

Parameters

TInt aError

The error code to be returned to the CTSY Dispatcher.

ConstructL()

void

ConstructL

(

)

[private]

Second phase constructor.

DispatchAbortSecurityCodeL(const CMmDataPackage *)

TInt

DispatchAbortSecurityCodeL

(

const CMmDataPackage *

aDataPackage

)

Unpack data related to EMobilePhoneAbortSecurityCode and pass request on to Licensee LTSY.

Parameters

const CMmDataPackage * aDataPackage

DispatchCheckSecurityCodeCancelL(const CMmDataPackage *)

TInt

DispatchCheckSecurityCodeCancelL

(

const CMmDataPackage *

aDataPackage

)

Unpack data related to ECustomCheckSecurityCodeCancelIPC and pass request on to Licensee LTSY.

Parameters

const CMmDataPackage * aDataPackage

DispatchCheckSecurityCodeL(const CMmDataPackage *)

TInt

DispatchCheckSecurityCodeL

(

const CMmDataPackage *

aDataPackage

)

Unpack data related to ECustomCheckSecurityCodeIPC and pass request on to Licensee LTSY.

Parameters

const CMmDataPackage * aDataPackage

DispatchDisablePhoneLockL(const CMmDataPackage *)

TInt

DispatchDisablePhoneLockL

(

const CMmDataPackage *

aDataPackage

)

Unpack data related to ECustomDisablePhoneLockIPC and pass request on to Licensee LTSY.

Parameters

const CMmDataPackage * aDataPackage

DispatchGetCipheringInfoL()

TInt

DispatchGetCipheringInfoL

(

)

Pass request on to Licensee LTSY.

DispatchGetCurrentActivePinL()

TInt

DispatchGetCurrentActivePinL

(

)

Pass request on to Licensee LTSY.

DispatchGetLockInfoL(const CMmDataPackage *)

TInt

DispatchGetLockInfoL

(

const CMmDataPackage *

aDataPackage

)

Unpack data related to EMobilePhoneGetLockInfo and pass request on to Licensee LTSY.

Parameters

const CMmDataPackage * aDataPackage

DispatchGetPin1DisableSupportedL()

TInt

DispatchGetPin1DisableSupportedL

(

)

Pass request on to Licensee LTSY.

DispatchGetSecurityCodeInfoL(const CMmDataPackage *)

TInt

DispatchGetSecurityCodeInfoL

(

const CMmDataPackage *

aDataPackage

)

Unpack data related to EMobilePhoneGetSecurityCodeInfo and pass request on to Licensee LTSY.

Parameters

const CMmDataPackage * aDataPackage

DispatchIsSecurityCodeBlockedL(const CMmDataPackage *)

TInt

DispatchIsSecurityCodeBlockedL

(

const CMmDataPackage *

aDataPackage

)

Unpack data related to ECustomIsBlockedIPC and pass request on to Licensee LTSY.

Parameters

const CMmDataPackage * aDataPackage

DispatchSetLockSettingL(const CMmDataPackage *)

TInt

DispatchSetLockSettingL

(

const CMmDataPackage *

aDataPackage

)

Unpack data related to EMobilePhoneSetLockSetting and pass request on to Licensee LTSY.

Parameters

const CMmDataPackage * aDataPackage

DispatchVerifySecurityCodeL(const CMmDataPackage *)

TInt

DispatchVerifySecurityCodeL

(

const CMmDataPackage *

aDataPackage

)

Unpack data related to EMobilePhoneVerifySecurityCode and pass request on to Licensee LTSY.

Parameters

const CMmDataPackage * aDataPackage

NewL(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)

CSecurityDispatcher *	NewL	(	MLtsyDispatchFactoryV1 &	aLtsyFactory,
			MmMessageManagerCallback &	aMessageManagerCallback,
			CRequestQueueOneShot &	aRequestAsyncOneShot
		)	[static]

Parameters

MLtsyDispatchFactoryV1 & aLtsyFactory
MmMessageManagerCallback & aMessageManagerCallback
CRequestQueueOneShot & aRequestAsyncOneShot

NewLC(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)

CSecurityDispatcher *	NewLC	(	MLtsyDispatchFactoryV1 &	aLtsyFactory,
			MmMessageManagerCallback &	aMessageManagerCallback,
			CRequestQueueOneShot &	aRequestAsyncOneShot
		)	[static]