TSmsSettings Class Reference

#include <smsuset.h>

Link against: smsu.lib

class TSmsSettings

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_CTSmsSettings()

Constructor.

Initialises the settings with default values.

capability
None

Member Function Documentation

BootTimerTimeout ( )

const TTimeIntervalMicroSeconds32 &BootTimerTimeout()[inline]

Gets the Boot Timer Timeout value

Returns: Boot Timer Time-out value

DeletePDUsFromCombinedStores ( )

TBool DeletePDUsFromCombinedStores()const [inline]

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

Returns: 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.

Returns: 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.

Returns: True if the PDU can be deleted from the SIM

ExternalizeL ( RWriteStream & )

IMPORT_C voidExternalizeL(RWriteStream &aStream)const

Externalises the object.

Gets the SMS sttings from the stream store.

capability
None
ParameterDescription
aStreamStream to write to

InternalizeL ( RReadStream & )

IMPORT_C voidInternalizeL(RReadStream &aStream)

Internalises the object.

Sets the SMS sttings from the stream store.

capability
None
ParameterDescription
aStreamStream to read from

KSegmentationLifetimeMultiplier ( )

TInt KSegmentationLifetimeMultiplier()const [inline]

Gets the value of the segmentation store multiplier.

Returns: Segmentation store multiplier

ModemInitializationTimeout ( )

const TTimeIntervalMicroSeconds32 &ModemInitializationTimeout()const [inline]

Gets the value of the modem initialisation timeout duration.

Returns: Modem initialisation timeout duration

ReassemblyLifetime ( )

const TTimeIntervalMinutes &ReassemblyLifetime()const [inline]

Gets the value of the Reassembly store life time.

Returns: Reassembly store life time

SendTryLimit ( )

TInt SendTryLimit()const [inline]

Gets the maximum number of attempts to send an SMS.

Returns: Maximum number of attempts to send a SMS

SendTryTimeout ( )

const TTimeIntervalMicroSeconds32 &SendTryTimeout()const [inline]

Gets the Send Try Timeout value

Returns: Time-out value

SetBootTimerTimeout ( const TTimeIntervalMicroSeconds32 & )

voidSetBootTimerTimeout(const TTimeIntervalMicroSeconds32 &aTimeout)[inline]

Sets the Boot Timer Timeout value

ParameterDescription
aTimeoutTime-out value

SetDeletePDUsFromCombinedStores ( TBool )

voidSetDeletePDUsFromCombinedStores(TBoolaDelete)[inline]

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

ParameterDescription
aDeleteTrue if the PDU can be deleted from the combined store

SetDeletePDUsFromPhoneStores ( TBool )

voidSetDeletePDUsFromPhoneStores(TBoolaDelete)[inline]

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

ParameterDescription
aDeleteTrue if the PDU can be deleted from phone store

SetDeletePDUsFromSIM ( TBool )

voidSetDeletePDUsFromSIM(TBoolaDelete)[inline]

Sets whether the PDU can be deleted from the SIM.

ParameterDescription
aDeleteTrue if the PDU can be deleted from the SIM

SetKSegmentationLifetimeMultiplier ( TInt )

voidSetKSegmentationLifetimeMultiplier(TIntaKSegmentationLifetimeMultiplier)[inline]

Sets the value of the segmentation store multiplier.

ParameterDescription
aKSegmentationLifetimeMultiplierSegmentation store multiplier

SetModemInitializationTimeout ( const TTimeIntervalMicroSeconds32 & )

voidSetModemInitializationTimeout(const TTimeIntervalMicroSeconds32 &aTimeout)[inline]

Sets the value of the modem initialisation timeout duration.

ParameterDescription
aTimeoutModem initialisation timeout duration

SetReassemblyLifetime ( const TTimeIntervalMinutes & )

voidSetReassemblyLifetime(const TTimeIntervalMinutes &aReassemblyLifetime)[inline]

Sets the value of the Reassembly store life time.

ParameterDescription
aReassemblyLifetimeReassembly store life time

SetSendTryLimit ( TInt )

voidSetSendTryLimit(TIntaLimit)[inline]

Sets the maximum number of attempts to send an SMS.

ParameterDescription
aLimitMaximum number of attempts to send a SMS

SetSendTryTimeout ( const TTimeIntervalMicroSeconds32 & )

voidSetSendTryTimeout(const TTimeIntervalMicroSeconds32 &aTimeout)[inline]

Sets the Send Try Timeout value.

ParameterDescription
aTimeoutTime-out value

SetTimeout ( const TTimeIntervalMicroSeconds32 & )

voidSetTimeout(const TTimeIntervalMicroSeconds32 &aTimeout)[inline]

Sets the time-out value.

ParameterDescription
aTimeoutTime-out value

Timeout ( )

const TTimeIntervalMicroSeconds32 &Timeout()const [inline]