Collapse all Symbian^3 Product Developer Library

CSmsDispatcher Class Reference

class CSmsDispatcher : public CBase

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

Inherits from

CSmsDispatcher
- CBase

Public Member Functions
	~CSmsDispatcher()
void	CallbackAckSmsStored(TInt)
void	CallbackActivateSmsRouting(CRequestQueueOneShot::TIpcDataPackage *)
void	CallbackGetSmsStoreInfo(TInt, TInt, TInt)
void	CallbackGetSmspList(TInt, const TDesC &, const TDesC &, const TDesC &, const DispatcherSim::TSmsParameters &, TBool)
void	CallbackNackSmsStored(TInt)
void	CallbackNotifyReceiveSmsMessage(TInt, TBool, const TSmsMsg &)
void	CallbackResumeSmsReception(TInt)
void	CallbackSendSatSms(TInt)
void	CallbackSendSmsMessage(TInt, TInt, const TDesC8 &)
void	CallbackSendSmsMessageNoFdnCheck(TInt, TInt, const TDesC8 &)
void	CallbackSetMoSmsBearer(TInt)
void	CallbackStoreSmspListEntry(TInt)
void	CallbackSync(CRequestQueueOneShot::TIpcDataPackage &)
TInt	DispatchAckSmsStoredL(const CMmDataPackage *)
TInt	DispatchActivateSmsRoutingL()
TInt	DispatchGetSmsStoreInfoL()
TInt	DispatchGetSmspListL()
TInt	DispatchNackSmsStoredL(const CMmDataPackage *)
TInt	DispatchResumeSmsReceptionL()
TInt	DispatchSendSatSmsL(const CMmDataPackage *)
TInt	DispatchSendSmsMessageL(const CMmDataPackage *)
TInt	DispatchSendSmsMessageNoFdnCheckL(const CMmDataPackage *)
TInt	DispatchSetMoSmsBearerL(const CMmDataPackage *)
TInt	DispatchStoreSmspListEntryL(const CMmDataPackage *)
CSmsDispatcher *	NewL(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)
CSmsDispatcher *	NewLC(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)
void	SetDispatcherHolder(TDispatcherHolder &)

Private Member Functions
	CSmsDispatcher(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
CArrayPtrFlat< TSmsParameters > *	iLtsyDataList
MLtsyDispatchSmsAckSmsStored *	iLtsyDispatchSmsAckSmsStored
MLtsyDispatchSmsGetSmsStoreInfo *	iLtsyDispatchSmsGetSmsStoreInfo
MLtsyDispatchSmsGetSmspList *	iLtsyDispatchSmsGetSmspList
MLtsyDispatchSmsNackSmsStored *	iLtsyDispatchSmsNackSmsStored
MLtsyDispatchSmsResumeSmsReception *	iLtsyDispatchSmsResumeSmsReception
MLtsyDispatchSmsSendSatSms *	iLtsyDispatchSmsSendSatSms
MLtsyDispatchSmsSendSmsMessage *	iLtsyDispatchSmsSendSmsMessage
MLtsyDispatchSmsSendSmsMessageNoFdnCheck *	iLtsyDispatchSmsSendSmsMessageNoFdnCheck
MLtsyDispatchSmsSetMoSmsBearer *	iLtsyDispatchSmsSetMoSmsBearer
MLtsyDispatchSmsStoreSmspListEntry *	iLtsyDispatchSmsStoreSmspListEntry
MLtsyDispatchFactoryV1 &	iLtsyFactoryV1
MmMessageManagerCallback &	iMessageManagerCallback
CRequestQueueOneShot &	iRequestAsyncOneShot

Constructor & Destructor Documentation

CSmsDispatcher(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)

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

Parameters

MLtsyDispatchFactoryV1 & aLtsyFactory
MmMessageManagerCallback & aMessageManagerCallback
CRequestQueueOneShot & aRequestAsyncOneShot

~CSmsDispatcher()

~CSmsDispatcher

(

)

[virtual]

Member Functions Documentation

CallbackAckSmsStored(TInt)

void

CallbackAckSmsStored

(

TInt

aError

)

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

Parameters

TInt aError

The error code to be returned to the CTSY Dispatcher.

CallbackActivateSmsRouting(CRequestQueueOneShot::TIpcDataPackage *)

void

CallbackActivateSmsRouting

(

CRequestQueueOneShot::TIpcDataPackage *

aDataPackage

)

Callback function to be used by the request to complete .

Parameters

CRequestQueueOneShot::TIpcDataPackage * aDataPackage

Package containing the IPC, return data and result code to be completed to CTSY

CallbackGetSmsStoreInfo(TInt, TInt, TInt)

void	CallbackGetSmsStoreInfo	(	TInt	aError,
			TInt	aTotalEntries,
			TInt	aUsedEntries
		)

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

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
TInt aTotalEntries	Indicates the total number of entries that may be held in this store.
TInt aUsedEntries	Indicates the current number of entries held in this store.

CallbackGetSmspList(TInt, const TDesC &, const TDesC &, const TDesC &, const DispatcherSim::TSmsParameters &, TBool)

void	CallbackGetSmspList	(	TInt	aError,
			const TDesC &	aServiceCenterAddress,
			const TDesC &	aDestinationAddress,
			const TDesC &	aAlphaTagData,
			const DispatcherSim::TSmsParameters &	aSmsParameters,
			TBool	aMoreToCome
		)

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

Parameters

TInt aError	KErrNone on success, or another error code indicating the error otherwise.
const TDesC & aServiceCenterAddress	Service center address.
const TDesC & aDestinationAddress	Destination address.
const TDesC & aAlphaTagData	Alpha tag data.
const DispatcherSim::TSmsParameters & aSmsParameters	Sms parametets.
TBool aMoreToCome	Are more elements to come.

CallbackNackSmsStored(TInt)

void

CallbackNackSmsStored

(

TInt

aError

)

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

Parameters

TInt aError

The error code to be returned to the CTSY Dispatcher.

CallbackNotifyReceiveSmsMessage(TInt, TBool, const TSmsMsg &)

void	CallbackNotifyReceiveSmsMessage	(	TInt	aError,
			TBool	aInd,
			const TSmsMsg &	aSmsMessage
		)

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

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
TBool aInd	Set routing activity on/off.
const TSmsMsg & aSmsMessage	Used to buffer incoming SMSes to the TSY.

CallbackResumeSmsReception(TInt)

void

CallbackResumeSmsReception

(

TInt

aError

)

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

Parameters

TInt aError

The error code to be returned to the CTSY Dispatcher.

CallbackSendSatSms(TInt)

void

CallbackSendSatSms

(

TInt

aError

)

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

Parameters

TInt aError

The error code to be returned to the CTSY Dispatcher.

CallbackSendSmsMessage(TInt, TInt, const TDesC8 &)

void	CallbackSendSmsMessage	(	TInt	aError,
			TInt	aMsgRef,
			const TDesC8 &	aSmsSubmitReport
		)

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

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
TInt aMsgRef	the message reference assigned to a sent message.
const TDesC8 & aSmsSubmitReport	message string, , which is expected to be a buffer with a maximum size of RMobileSmsMessaging::KGsmTpduSize

CallbackSendSmsMessageNoFdnCheck(TInt, TInt, const TDesC8 &)

void	CallbackSendSmsMessageNoFdnCheck	(	TInt	aError,
			TInt	aMsgRef,
			const TDesC8 &	aSmsSubmitReport
		)

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

Parameters

TInt aError	The error code to be returned to the CTSY Dispatcher.
TInt aMsgRef	the message reference assigned to a sent message.
const TDesC8 & aSmsSubmitReport	message string, , which is expected to be a buffer with a maximum size of RMobileSmsMessaging::KGsmTpduSize

CallbackSetMoSmsBearer(TInt)

void

CallbackSetMoSmsBearer

(

TInt

aError

)

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

Parameters

TInt aError

The error code to be returned to the CTSY Dispatcher.

CallbackStoreSmspListEntry(TInt)

void

CallbackStoreSmspListEntry

(

TInt

aError

)

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

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.

DispatchAckSmsStoredL(const CMmDataPackage *)

TInt

DispatchAckSmsStoredL

(

const CMmDataPackage *

aDataPackage

)

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

Parameters

const CMmDataPackage * aDataPackage

contains the TPDU defined for a SMS-DELIVER-REPORT

DispatchActivateSmsRoutingL()

TInt

DispatchActivateSmsRoutingL

(

)

Unpack data related to EMmTsyActivateSmsRouting This is not passed to LTSY but just completed by dispatch layer

DispatchGetSmsStoreInfoL()

TInt

DispatchGetSmsStoreInfoL

(

)

DispatchGetSmspListL()

TInt

DispatchGetSmspListL

(

)

DispatchNackSmsStoredL(const CMmDataPackage *)

TInt

DispatchNackSmsStoredL

(

const CMmDataPackage *

aDataPackage

)

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

Parameters

const CMmDataPackage * aDataPackage

Contains packed pointer to TDesC8 (TPDU data) and TInt (RP cause)

DispatchResumeSmsReceptionL()

TInt

DispatchResumeSmsReceptionL

(

)

DispatchSendSatSmsL(const CMmDataPackage *)

TInt

DispatchSendSatSmsL

(

const CMmDataPackage *

aDataPackage

)

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

Parameters

const CMmDataPackage * aDataPackage

DispatchSendSmsMessageL(const CMmDataPackage *)

TInt

DispatchSendSmsMessageL

(

const CMmDataPackage *

aDataPackage

)

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

Parameters

const CMmDataPackage * aDataPackage

DispatchSendSmsMessageNoFdnCheckL(const CMmDataPackage *)

TInt

DispatchSendSmsMessageNoFdnCheckL

(

const CMmDataPackage *

aDataPackage

)

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

Parameters

const CMmDataPackage * aDataPackage

DispatchSetMoSmsBearerL(const CMmDataPackage *)

TInt

DispatchSetMoSmsBearerL

(

const CMmDataPackage *

aDataPackage

)

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

Parameters

const CMmDataPackage * aDataPackage

DispatchStoreSmspListEntryL(const CMmDataPackage *)

TInt

DispatchStoreSmspListEntryL

(

const CMmDataPackage *

aDataPackage

)

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

Parameters

const CMmDataPackage * aDataPackage

NewL(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)

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

Parameters

MLtsyDispatchFactoryV1 & aLtsyFactory
MmMessageManagerCallback & aMessageManagerCallback
CRequestQueueOneShot & aRequestAsyncOneShot

NewLC(MLtsyDispatchFactoryV1 &, MmMessageManagerCallback &, CRequestQueueOneShot &)

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