Symbian^3 Product Developer Library >

TSmsSettings Class Reference

class TSmsSettings

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

Public Member Functions
TSmsSettings()
const TTimeIntervalMicroSeconds32 &BootTimerTimeout()
TBool DeletePDUsFromCombinedStores()
TBool DeletePDUsFromPhoneStores()
TBool DeletePDUsFromSIM()
IMPORT_C voidExternalizeL(RWriteStream &)
IMPORT_C voidInternalizeL(RReadStream &)
TInt KSegmentationLifetimeMultiplier()
const TTimeIntervalMicroSeconds32 &ModemInitializationTimeout()
const TTimeIntervalMinutes &ReassemblyLifetime()
TInt SendTryLimit()
const TTimeIntervalMicroSeconds32 &SendTryTimeout()
voidSetBootTimerTimeout(const TTimeIntervalMicroSeconds32 &)
voidSetDeletePDUsFromCombinedStores(TBool)
voidSetDeletePDUsFromPhoneStores(TBool)
voidSetDeletePDUsFromSIM(TBool)
voidSetKSegmentationLifetimeMultiplier(TInt)
voidSetModemInitializationTimeout(const TTimeIntervalMicroSeconds32 &)
voidSetReassemblyLifetime(const TTimeIntervalMinutes &)
voidSetSendTryLimit(TInt)
voidSetSendTryTimeout(const TTimeIntervalMicroSeconds32 &)
voidSetTimeout(const TTimeIntervalMicroSeconds32 &)
const TTimeIntervalMicroSeconds32 &Timeout()
Private Member Enumerations
enumanonymous { KDefaultTimeoutMicroSeconds32 = 60000000 }
enumanonymous { KDefaultSendTryLimit = 4 }
enumanonymous { KDefaultReassemblyLifetime = 2*1440 }
enumanonymous { KDefaultKSegmentationLifetimeMultiplier = 1200 }
enumanonymous { KDefaultModemInitializationTimeoutMicroSeconds32 = 30000000 }
enumanonymous { KDefaultSendTryTimeoutMicroSeconds32 = 60000000 }
enumanonymous { KDefaultBootTimerMicroSeconds32 = 60000000 }
enumTSmsSettingsFlags { ESmsFlagDeletePDUsFromSIM = 0x01, ESmsFlagDeletePDUsFromPhoneStores = 0x02, ESmsFlagDeletePDUsFromCombinedStores = 0x04 }
Private Attributes
TTimeIntervalMicroSeconds32 iBootTimerTimeout32
TInt iFlags
TInt iKSegmentationLifetimeMultiplier
TTimeIntervalMicroSeconds32 iModemInitializationTimeoutMicroSeconds32
TTimeIntervalMinutes iReassemblyLifetime
TInt iSendTryLimit
TTimeIntervalMicroSeconds32 iSendTryTimeoutMicroSeconds32
TTimeIntervalMicroSeconds32 iTimeoutMicroSeconds32

Constructor & Destructor Documentation

TSmsSettings()

IMPORT_CTSmsSettings()

Constructor.

Initialises the settings with default values.

capability
None

Member Functions Documentation

BootTimerTimeout()

const TTimeIntervalMicroSeconds32 &BootTimerTimeout()[inline]

Gets the Boot Timer Timeout value

DeletePDUsFromCombinedStores()

TBool DeletePDUsFromCombinedStores()const [inline]

Gets whether 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.

DeletePDUsFromSIM()

TBool DeletePDUsFromSIM()const [inline]

Gets whether 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

Parameters

RWriteStream & aStreamStream to write to

InternalizeL(RReadStream &)

IMPORT_C voidInternalizeL(RReadStream &aStream)

Internalises the object.

Sets the SMS sttings from the stream store.

capability
None

Parameters

RReadStream & aStreamStream to read from

KSegmentationLifetimeMultiplier()

TInt KSegmentationLifetimeMultiplier()const [inline]

Gets the value of the segmentation store multiplier.

ModemInitializationTimeout()

const TTimeIntervalMicroSeconds32 &ModemInitializationTimeout()const [inline]

Gets the value of the modem initialisation timeout duration.

ReassemblyLifetime()

const TTimeIntervalMinutes &ReassemblyLifetime()const [inline]

Gets the value of the Reassembly store life time.

SendTryLimit()

TInt SendTryLimit()const [inline]

Gets the maximum number of attempts to send an SMS.

SendTryTimeout()

const TTimeIntervalMicroSeconds32 &SendTryTimeout()const [inline]

Gets the Send Try Timeout value

SetBootTimerTimeout(const TTimeIntervalMicroSeconds32 &)

voidSetBootTimerTimeout(const TTimeIntervalMicroSeconds32 &aTimeout)[inline]

Sets the Boot Timer Timeout value

Parameters

const TTimeIntervalMicroSeconds32 & aTimeoutTime-out value

SetDeletePDUsFromCombinedStores(TBool)

voidSetDeletePDUsFromCombinedStores(TBoolaDelete)[inline]

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

Parameters

TBool 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.

Parameters

TBool 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.

Parameters

TBool aDeleteTrue if the PDU can be deleted from the SIM

SetKSegmentationLifetimeMultiplier(TInt)

voidSetKSegmentationLifetimeMultiplier(TIntaKSegmentationLifetimeMultiplier)[inline]

Sets the value of the segmentation store multiplier.

Parameters

TInt aKSegmentationLifetimeMultiplierSegmentation store multiplier

SetModemInitializationTimeout(const TTimeIntervalMicroSeconds32 &)

voidSetModemInitializationTimeout(const TTimeIntervalMicroSeconds32 &aTimeout)[inline]

Sets the value of the modem initialisation timeout duration.

Parameters

const TTimeIntervalMicroSeconds32 & aTimeoutModem initialisation timeout duration

SetReassemblyLifetime(const TTimeIntervalMinutes &)

voidSetReassemblyLifetime(const TTimeIntervalMinutes &aReassemblyLifetime)[inline]

Sets the value of the Reassembly store life time.

Parameters

const TTimeIntervalMinutes & aReassemblyLifetimeReassembly store life time

SetSendTryLimit(TInt)

voidSetSendTryLimit(TIntaLimit)[inline]

Sets the maximum number of attempts to send an SMS.

Parameters

TInt aLimitMaximum number of attempts to send a SMS

SetSendTryTimeout(const TTimeIntervalMicroSeconds32 &)

voidSetSendTryTimeout(const TTimeIntervalMicroSeconds32 &aTimeout)[inline]

Sets the Send Try Timeout value.

Parameters

const TTimeIntervalMicroSeconds32 & aTimeoutTime-out value

SetTimeout(const TTimeIntervalMicroSeconds32 &)

voidSetTimeout(const TTimeIntervalMicroSeconds32 &aTimeout)[inline]

Sets the time-out value.

Parameters

const TTimeIntervalMicroSeconds32 & aTimeoutTime-out value

Timeout()

const TTimeIntervalMicroSeconds32 &Timeout()const [inline]

Member Enumerations Documentation

Enum anonymous

Enumerators

KDefaultTimeoutMicroSeconds32 = 60000000

Enum anonymous

Enumerators

KDefaultSendTryLimit = 4

Enum anonymous

Enumerators

KDefaultReassemblyLifetime = 2*1440

Enum anonymous

Enumerators

KDefaultKSegmentationLifetimeMultiplier = 1200

Enum anonymous

Enumerators

KDefaultModemInitializationTimeoutMicroSeconds32 = 30000000

Enum anonymous

Enumerators

KDefaultSendTryTimeoutMicroSeconds32 = 60000000

Enum anonymous

Enumerators

KDefaultBootTimerMicroSeconds32 = 60000000

Enum TSmsSettingsFlags

Enumerators

ESmsFlagDeletePDUsFromSIM = 0x01
ESmsFlagDeletePDUsFromPhoneStores = 0x02
ESmsFlagDeletePDUsFromCombinedStores = 0x04

Member Data Documentation

TTimeIntervalMicroSeconds32 iBootTimerTimeout32

TTimeIntervalMicroSeconds32 iBootTimerTimeout32[private]

TInt iFlags

TInt iFlags[private]

TInt iKSegmentationLifetimeMultiplier

TInt iKSegmentationLifetimeMultiplier[private]

TTimeIntervalMicroSeconds32 iModemInitializationTimeoutMicroSeconds32

TTimeIntervalMicroSeconds32 iModemInitializationTimeoutMicroSeconds32[private]

TTimeIntervalMinutes iReassemblyLifetime

TTimeIntervalMinutes iReassemblyLifetime[private]

TInt iSendTryLimit

TInt iSendTryLimit[private]

Number of attempts for sending a PDU. 7.0

TTimeIntervalMicroSeconds32 iSendTryTimeoutMicroSeconds32

TTimeIntervalMicroSeconds32 iSendTryTimeoutMicroSeconds32[private]

TTimeIntervalMicroSeconds32 iTimeoutMicroSeconds32

TTimeIntervalMicroSeconds32 iTimeoutMicroSeconds32[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.