TSmsSettings Class Reference

#include <smsuset.h>

Link against: smsu.lib

class TSmsSettings

Public Member Functions
	TSmsSettings()
const TTimeIntervalMicroSeconds32 &	BootTimerTimeout()
TBool	DeletePDUsFromCombinedStores()
TBool	DeletePDUsFromPhoneStores()
TBool	DeletePDUsFromSIM()
IMPORT_C void	ExternalizeL(RWriteStream &)
IMPORT_C void	InternalizeL(RReadStream &)
TInt	KSegmentationLifetimeMultiplier()
const TTimeIntervalMicroSeconds32 &	ModemInitializationTimeout()
const TTimeIntervalMinutes &	ReassemblyLifetime()
TInt	SendTryLimit()
const TTimeIntervalMicroSeconds32 &	SendTryTimeout()
void	SetBootTimerTimeout(const TTimeIntervalMicroSeconds32 &)
void	SetDeletePDUsFromCombinedStores(TBool)
void	SetDeletePDUsFromPhoneStores(TBool)
void	SetDeletePDUsFromSIM(TBool)
void	SetKSegmentationLifetimeMultiplier(TInt)
void	SetModemInitializationTimeout(const TTimeIntervalMicroSeconds32 &)
void	SetReassemblyLifetime(const TTimeIntervalMinutes &)
void	SetSendTryLimit(TInt)
void	SetSendTryTimeout(const TTimeIntervalMicroSeconds32 &)
void	SetTimeout(const TTimeIntervalMicroSeconds32 &)
const TTimeIntervalMicroSeconds32 &	Timeout()

Detailed Description

SMS settings.

SMSPROT uses an instance of TSmsSettings to configure the sms stack timeouts.

The SMSPROT calls TSmsSettings' default constructor during initialisation. It then parses smswap.sms.esk for customised settings and updates its instance of TSmsSettings accordingly.

Customised settings in smswap.sms.esk should comply with the following syntax:

[customTimeoutSettings] sendTryTimeout= value bootTimerTimeout = value

where the identifier 'value' is to be substituted with an integer value. Integer values less than zero will cause the stack to leave.

Only parameters that need to be customised are required in smswap.sms.esk

Constructor & Destructor Documentation

TSmsSettings ( )

IMPORT_C

TSmsSettings

(

)

Constructor.

Initialises the settings with default values.

Capability
None

Member Function Documentation

BootTimerTimeout ( )

const TTimeIntervalMicroSeconds32 &

BootTimerTimeout

(

)

[inline]

Gets the Boot Timer Timeout value

Return Value: Boot Timer Time-out value

DeletePDUsFromCombinedStores ( )

TBool

DeletePDUsFromCombinedStores

(

)

const [inline]

Gets whether the PDU can be deleted from the combined store.

Return Value: True if the PDU can be deleted from the combined store

DeletePDUsFromPhoneStores ( )

TBool

DeletePDUsFromPhoneStores

(

)

const [inline]

Gets whether the PDU can be deleted from the phone store.

Return Value: True if the PDU can be deleted from the phone store

DeletePDUsFromSIM ( )

TBool

DeletePDUsFromSIM

(

)

const [inline]

Gets whether the PDU can be deleted from the SIM.

Return Value: True if the PDU can be deleted from the SIM

ExternalizeL ( RWriteStream & )

IMPORT_C void

ExternalizeL

(

RWriteStream &

aStream

)

const

Externalises the object.

Gets the SMS sttings from the stream store.

Parameters
aStream	Stream to write to

Capability
None

InternalizeL ( RReadStream & )

IMPORT_C void

InternalizeL

(

RReadStream &

aStream

)

Internalises the object.

Sets the SMS sttings from the stream store.

Parameters
aStream	Stream to read from

Capability
None

KSegmentationLifetimeMultiplier ( )

TInt

KSegmentationLifetimeMultiplier

(

)

const [inline]

Gets the value of the segmentation store multiplier.

Return Value: Segmentation store multiplier

ModemInitializationTimeout ( )

const TTimeIntervalMicroSeconds32 &

ModemInitializationTimeout

(

)

const [inline]

Gets the value of the modem initialisation timeout duration.

Return Value: Modem initialisation timeout duration

ReassemblyLifetime ( )

const TTimeIntervalMinutes &

ReassemblyLifetime

(

)

const [inline]

Gets the value of the Reassembly store life time.

Return Value: Reassembly store life time

SendTryLimit ( )

TInt

SendTryLimit

(

)

const [inline]

Gets the maximum number of attempts to send an SMS.

Return Value: Maximum number of attempts to send a SMS

SendTryTimeout ( )

const TTimeIntervalMicroSeconds32 &

SendTryTimeout

(

)

const [inline]

Gets the Send Try Timeout value

Return Value: Time-out value

SetBootTimerTimeout ( const TTimeIntervalMicroSeconds32 & )

void

SetBootTimerTimeout

(

const TTimeIntervalMicroSeconds32 &

aTimeout

)

[inline]

Sets the Boot Timer Timeout value

Parameters
aTimeout	Time-out value

SetDeletePDUsFromCombinedStores ( TBool )

void

SetDeletePDUsFromCombinedStores

(

TBool

aDelete

)

[inline]

Sets whether the PDU can be deleted from the combined store.

Parameters
aDelete	True if the PDU can be deleted from the combined store

SetDeletePDUsFromPhoneStores ( TBool )

void

SetDeletePDUsFromPhoneStores

(

TBool

aDelete

)

[inline]

Sets whether the PDU can be deleted from the phone store.

Parameters
aDelete	True if the PDU can be deleted from phone store

SetDeletePDUsFromSIM ( TBool )

void

SetDeletePDUsFromSIM

(

TBool

aDelete

)

[inline]

Sets whether the PDU can be deleted from the SIM.

Parameters
aDelete	True if the PDU can be deleted from the SIM

SetKSegmentationLifetimeMultiplier ( TInt )

void

SetKSegmentationLifetimeMultiplier

(

TInt

aKSegmentationLifetimeMultiplier

)

[inline]

Sets the value of the segmentation store multiplier.

Parameters
aKSegmentationLifetimeMultiplier	Segmentation store multiplier

SetModemInitializationTimeout ( const TTimeIntervalMicroSeconds32 & )

void

SetModemInitializationTimeout

(

const TTimeIntervalMicroSeconds32 &

aTimeout

)

[inline]

Sets the value of the modem initialisation timeout duration.

Parameters
aTimeout	Modem initialisation timeout duration

SetReassemblyLifetime ( const TTimeIntervalMinutes & )

void

SetReassemblyLifetime

(

const TTimeIntervalMinutes &

aReassemblyLifetime

)

[inline]

Sets the value of the Reassembly store life time.

Parameters
aReassemblyLifetime	Reassembly store life time

SetSendTryLimit ( TInt )

void

SetSendTryLimit

(

TInt

aLimit

)

[inline]

Sets the maximum number of attempts to send an SMS.

Parameters
aLimit	Maximum number of attempts to send a SMS

SetSendTryTimeout ( const TTimeIntervalMicroSeconds32 & )

void

SetSendTryTimeout

(

const TTimeIntervalMicroSeconds32 &

aTimeout

)

[inline]

Sets the Send Try Timeout value.

Parameters
aTimeout	Time-out value

SetTimeout ( const TTimeIntervalMicroSeconds32 & )

void

SetTimeout

(

const TTimeIntervalMicroSeconds32 &

aTimeout

)

[inline]

Sets the time-out value.

Parameters
aTimeout	Time-out value

Timeout ( )

const TTimeIntervalMicroSeconds32 &

Timeout

(

)

const [inline]