Collapse all Symbian^3 Product Developer Library

CPhonebookOnDispatcher Class Reference

class CPhonebookOnDispatcher : public CBase

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

Inherits from

CPhonebookOnDispatcher
- CBase

Public Member Functions
	~CPhonebookOnDispatcher()
void	CallbackStoreDeleteAll(TInt)
void	CallbackStoreDeleteEntry(TInt)
void	CallbackStoreGetInfo(TInt, TInt, TInt, TInt, TInt)
void	CallbackStoreGetReadStoreSize(TInt, TInt)
void	CallbackStoreGetStoreSize(TInt, TInt)
void	CallbackStoreRead(TInt, TInt, const TDesC &, const TDesC &)
void	CallbackStoreReadAll(TInt)
void	CallbackStoreReadEntry(TInt, TInt, const TDesC &, const TDesC &)
void	CallbackStoreWrite(TInt, TInt)
void	CallbackStoreWriteEntry(TInt)
void	CallbackSync(CRequestQueueOneShot::TIpcDataPackage &)
TInt	DispatchStoreDeleteAllL()
TInt	DispatchStoreDeleteEntryL(const CMmDataPackage *)
TInt	DispatchStoreGetInfoL()
TInt	DispatchStoreGetReadStoreSizeL()
TInt	DispatchStoreGetStoreSizeL()
TInt	DispatchStoreReadEntryL(const CMmDataPackage *)
TInt	DispatchStoreReadL(const CMmDataPackage *)
TInt	DispatchStoreWriteEntryL(const CMmDataPackage *)
TInt	DispatchStoreWriteL(const CMmDataPackage *)
CPhonebookOnDispatcher *	NewL(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)
CPhonebookOnDispatcher *	NewLC(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)
void	SetDispatcherHolder(TDispatcherHolder &)

Private Member Functions
	CPhonebookOnDispatcher(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
MLtsyDispatchPhonebookOnStoreDeleteAll *	iLtsyDispatchPhonebookOnStoreDeleteAll
MLtsyDispatchPhonebookOnStoreDeleteEntry *	iLtsyDispatchPhonebookOnStoreDeleteEntry
MLtsyDispatchPhonebookOnStoreGetInfo *	iLtsyDispatchPhonebookOnStoreGetInfo
MLtsyDispatchPhonebookOnStoreGetReadStoreSize *	iLtsyDispatchPhonebookOnStoreGetReadStoreSize
MLtsyDispatchPhonebookOnStoreGetStoreSize *	iLtsyDispatchPhonebookOnStoreGetStoreSize
MLtsyDispatchPhonebookOnStoreRead *	iLtsyDispatchPhonebookOnStoreRead
MLtsyDispatchPhonebookOnStoreReadEntry *	iLtsyDispatchPhonebookOnStoreReadEntry
MLtsyDispatchPhonebookOnStoreWrite *	iLtsyDispatchPhonebookOnStoreWrite
MLtsyDispatchPhonebookOnStoreWriteEntry *	iLtsyDispatchPhonebookOnStoreWriteEntry
MLtsyDispatchFactoryV1 &	iLtsyFactoryV1
MmMessageManagerCallback &	iMessageManagerCallback
CRequestQueueOneShot &	iRequestAsyncOneShot

Constructor & Destructor Documentation

CPhonebookOnDispatcher(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)

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

Parameters

MLtsyDispatchFactoryV1 & aLtsyFactory
MmMessageManagerCallback & aMessageManagerCallback
CRequestQueueOneShot & aRequestAsyncOneShot

~CPhonebookOnDispatcher()

~CPhonebookOnDispatcher

(

)

[virtual]

Member Functions Documentation

CallbackStoreDeleteAll(TInt)

void

CallbackStoreDeleteAll

(

TInt

aError

)

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

RMobileONStore::DeleteAll()

Parameters

TInt aError

The error code to be returned to the CTSY Dispatcher.

CallbackStoreDeleteEntry(TInt)

void

CallbackStoreDeleteEntry

(

TInt

aError

)

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

RMobileONStore::Delete()

Parameters

TInt aError

The error code to be returned to the CTSY Dispatcher.

CallbackStoreGetInfo(TInt, TInt, TInt, TInt, TInt)

void	CallbackStoreGetInfo	(	TInt	aError,
			TInt	aNumOfEntries,
			TInt	aUsedEntries,
			TInt	aNameLen,
			TInt	aNumLen
		)

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

RMobileONStore::GetInfo()

Parameters

TInt aError	KErrNone on success, or another error code indicating the error otherwise.
TInt aNumOfEntries	The number of entries.
TInt aUsedEntries	The number of used entries.
TInt aNameLen	The length of a name.
TInt aNumLen	The length of a number.

CallbackStoreGetReadStoreSize(TInt, TInt)

void	CallbackStoreGetReadStoreSize	(	TInt	aError,
			TInt	aSize
		)

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

CRetrieveMobilePhoneONList::Start()

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
TInt aSize	The number of entries stored in the storage.

CallbackStoreGetStoreSize(TInt, TInt)

void	CallbackStoreGetStoreSize	(	TInt	aError,
			TInt	aSize
		)

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

RMobileONStore::StoreAllL()

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
TInt aSize	The number of entries that can be stored in the storage.

CallbackStoreRead(TInt, TInt, const TDesC &, const TDesC &)

void	CallbackStoreRead	(	TInt	aError,
			TInt	aIndex,
			const TDesC &	aName,
			const TDesC &	aNumber
		)

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

RMobileONStore::Read()

Parameters

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

CallbackStoreReadAll(TInt)

void

CallbackStoreReadAll

(

TInt

aError

)

Parameters

TInt aError

CallbackStoreReadEntry(TInt, TInt, const TDesC &, const TDesC &)

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

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

RMobileONStore::Read()

Parameters

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

CallbackStoreWrite(TInt, TInt)

void	CallbackStoreWrite	(	TInt	aError,
			TInt	aLocation
		)

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

RMobileONStore::Write()

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
TInt aLocation	The location where the ON entry was stored.

CallbackStoreWriteEntry(TInt)

void

CallbackStoreWriteEntry

(

TInt

aError

)

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

RMobileONStore::StoreAllL()

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.

ConstructL()

void

ConstructL

(

)

[private]

Second phase constructor.

DispatchStoreDeleteAllL()

TInt

DispatchStoreDeleteAllL

(

)

Pass request on to Licensee LTSY.

DispatchStoreDeleteEntryL(const CMmDataPackage *)

TInt

DispatchStoreDeleteEntryL

(

const CMmDataPackage *

aDataPackage

)

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

Parameters

const CMmDataPackage * aDataPackage

DispatchStoreGetInfoL()

TInt

DispatchStoreGetInfoL

(

)

Pass request on to Licensee LTSY.

DispatchStoreGetReadStoreSizeL()

TInt

DispatchStoreGetReadStoreSizeL

(

)

Pass request on to Licensee LTSY to retrieve the number of entries that are stored in the storage.

DispatchStoreGetStoreSizeL()

TInt

DispatchStoreGetStoreSizeL

(

)

Pass request on to Licensee LTSY to retrieve the number of entries that can be stored in the storage.

DispatchStoreReadEntryL(const CMmDataPackage *)

TInt

DispatchStoreReadEntryL

(

const CMmDataPackage *

aDataPackage

)

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

Parameters

const CMmDataPackage * aDataPackage

DispatchStoreReadL(const CMmDataPackage *)

TInt

DispatchStoreReadL

(

const CMmDataPackage *

aDataPackage

)

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

Parameters

const CMmDataPackage * aDataPackage

DispatchStoreWriteEntryL(const CMmDataPackage *)

TInt

DispatchStoreWriteEntryL

(

const CMmDataPackage *

aDataPackage

)

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

Parameters

const CMmDataPackage * aDataPackage

DispatchStoreWriteL(const CMmDataPackage *)

TInt

DispatchStoreWriteL

(

const CMmDataPackage *

aDataPackage

)

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

Parameters

const CMmDataPackage * aDataPackage

NewL(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)

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

Parameters

MLtsyDispatchFactoryV1 & aLtsyFactory
MmMessageManagerCallback & aMessageManagerCallback
CRequestQueueOneShot & aRequestAsyncOneShot

NewLC(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)

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