Collapse all Symbian^3 Product Developer Library

CPhonebookEnDispatcher Class Reference

class CPhonebookEnDispatcher : public CBase

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

Inherits from

CPhonebookEnDispatcher
- CBase

Public Member Functions
	~CPhonebookEnDispatcher()
void	CallbackStoreGetInfo(TInt, TInt)
void	CallbackStoreReadAll(TInt, TInt, const TDesC &, TBool)
void	CallbackStoreReadEntry(TInt, TInt, const TDesC &)
void	CallbackSync(CRequestQueueOneShot::TIpcDataPackage &)
TInt	DispatchStoreGetInfoL()
TInt	DispatchStoreReadAllL()
TInt	DispatchStoreReadEntryL(const CMmDataPackage *)
CPhonebookEnDispatcher *	NewL(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)
CPhonebookEnDispatcher *	NewLC(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)
void	SetDispatcherHolder(TDispatcherHolder &)

Private Member Functions
	CPhonebookEnDispatcher(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)
void	ConstructL()
void	FillEnStoreResponseListL(TInt, const TDesC &)

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
const TInt	KMaxTotalEntries
TDispatcherHolder *	iDispatcherHolder
CArrayPtrFlat< TENStoreResponse > *	iEnEntriesArray
MLtsyDispatchPhonebookEnStoreGetInfo *	iLtsyDispatchPhonebookEnStoreGetInfo
MLtsyDispatchPhonebookEnStoreReadAll *	iLtsyDispatchPhonebookEnStoreReadAll
MLtsyDispatchPhonebookEnStoreReadEntry *	iLtsyDispatchPhonebookEnStoreReadEntry
MLtsyDispatchFactoryV1 &	iLtsyFactoryV1
MmMessageManagerCallback &	iMessageManagerCallback
CRequestQueueOneShot &	iRequestAsyncOneShot

Constructor & Destructor Documentation

CPhonebookEnDispatcher(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)

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

Parameters

MLtsyDispatchFactoryV1 & aLtsyFactory
MmMessageManagerCallback & aMessageManagerCallback
CRequestQueueOneShot & aRequestAsyncOneShot

~CPhonebookEnDispatcher()

~CPhonebookEnDispatcher

(

)

[virtual]

Member Functions Documentation

CallbackStoreGetInfo(TInt, TInt)

void	CallbackStoreGetInfo	(	TInt	aError,
			TInt	aUsedEntries
		)

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

RMobileENStore::GetInfo()

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
TInt aUsedEntries	The number of used entries in the EN storage.

CallbackStoreReadAll(TInt, TInt, const TDesC &, TBool)

void	CallbackStoreReadAll	(	TInt	aError,
			TInt	aIndex,
			const TDesC &	aNumber,
			TBool	aMoreToCome
		)

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

CRetrieveMobilePhoneENList::Start()

Parameters

TInt aError	KErrNone on success, or another error code indicating the error otherwise.
TInt aIndex	The index of the entry.
const TDesC & aNumber	The number stored in the EN entry. The length of this should not be more than 6.
TBool aMoreToCome	ETrue if there are more entries to be read, EFalse otherwise.

CallbackStoreReadEntry(TInt, TInt, const TDesC &)

void	CallbackStoreReadEntry	(	TInt	aError,
			TInt	aIndex,
			const TDesC &	aNumber
		)

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

RMobileENStore::Read()

Parameters

TInt aError	KErrNone on success, or another error code indicating the error otherwise.
TInt aIndex	The index of the entry.
const TDesC & aNumber	The number stored in the EN entry. The length of this should not be more than 6.

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.

ConstructL()

void

ConstructL

(

)

[private]

Second phase constructor.

DispatchStoreGetInfoL()

TInt

DispatchStoreGetInfoL

(

)

Pass request on to Licensee LTSY.

DispatchStoreReadAllL()

TInt

DispatchStoreReadAllL

(

)

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

DispatchStoreReadEntryL(const CMmDataPackage *)

TInt

DispatchStoreReadEntryL

(

const CMmDataPackage *

aDataPackage

)

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

Parameters

const CMmDataPackage * aDataPackage

FillEnStoreResponseListL(TInt, const TDesC &)

void	FillEnStoreResponseListL	(	TInt	aIndex,
			const TDesC &	aNumber
		)	[private]

Parameters

TInt aIndex
const TDesC & aNumber

NewL(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)

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

Parameters

MLtsyDispatchFactoryV1 & aLtsyFactory
MmMessageManagerCallback & aMessageManagerCallback
CRequestQueueOneShot & aRequestAsyncOneShot

NewLC(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)

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