Class TSmsSettings

class TSmsSettings;

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

Members

Defined in TSmsSettings:
BootTimerTimeout(), DeletePDUsFromCombinedStores(), DeletePDUsFromPhoneStores(), DeletePDUsFromSIM(), ExternalizeL(), InternalizeL(), KSegmentationLifetimeMultiplier(), ModemInitializationTimeout(), ReassemblyLifetime(), SendTryLimit(), SendTryTimeout(), SetBootTimerTimeout(), SetDeletePDUsFromCombinedStores(), SetDeletePDUsFromPhoneStores(), SetDeletePDUsFromSIM(), SetKSegmentationLifetimeMultiplier(), SetModemInitializationTimeout(), SetReassemblyLifetime(), SetSendTryLimit(), SetSendTryTimeout(), SetTimeout(), TSmsSettings(), Timeout()

Capability:

Illegal

IMPORT_C TSmsSettings();

Description

Constructor.

Initialises the settings with default values.

inline const TTimeIntervalMicroSeconds32 &Timeout() const;

Description

Gets the time-out value.

Return value

const TTimeIntervalMicroSeconds32 & Time-out value

inline void SetTimeout(const TTimeIntervalMicroSeconds32 &aTimeout);

Description

Sets the time-out value.

Parameters

const TTimeIntervalMicroSeconds32 &aTimeout Time-out value

inline TInt SendTryLimit() const;

Description

Gets the maximum number of attempts to send an SMS.

Return value

TInt Maximum number of attempts to send a SMS

inline void SetSendTryLimit(TInt aLimit);

Description

Sets the maximum number of attempts to send an SMS.

Parameters

TInt aLimit Maximum number of attempts to send a SMS

inline TBool DeletePDUsFromSIM() const;

Description

Gets whether the PDU can be deleted from the SIM.

Return value

TBool True if the PDU can be deleted from the SIM

inline void SetDeletePDUsFromSIM(TBool aDelete);

Description

Sets whether the PDU can be deleted from the SIM.

Parameters

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

inline TBool DeletePDUsFromPhoneStores() const;

Description

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

Return value

TBool True if the PDU can be deleted from the phone store

inline void SetDeletePDUsFromPhoneStores(TBool aDelete);

Description

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

Parameters

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

inline TBool DeletePDUsFromCombinedStores() const;

Description

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

Return value

TBool True if the PDU can be deleted from the combined store

inline void SetDeletePDUsFromCombinedStores(TBool aDelete);

Description

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

Parameters

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

inline const TTimeIntervalMinutes &ReassemblyLifetime() const;

Description

Gets the value of the Reassembly store life time.

Return value

const TTimeIntervalMinutes & Reassembly store life time

inline void SetReassemblyLifetime(const TTimeIntervalMinutes &aReassemblyLifetime);

Description

Sets the value of the Reassembly store life time.

Parameters

const TTimeIntervalMinutes &aReassemblyLifetime Reassembly store life time

inline TInt KSegmentationLifetimeMultiplier() const;

Description

Gets the value of the segmentation store multiplier.

Return value

TInt Segmentation store multiplier

inline void SetKSegmentationLifetimeMultiplier(TInt aKSegmentationLifetimeMultiplier);

Description

Sets the value of the segmentation store multiplier.

Parameters

TInt aKSegmentationLifetimeMultiplier Segmentation store multiplier

inline const TTimeIntervalMicroSeconds32 &ModemInitializationTimeout() const;

Description

Gets the value of the modem initialisation timeout duration.

Return value

const TTimeIntervalMicroSeconds32 & Modem initialisation timeout duration

inline void SetModemInitializationTimeout(const TTimeIntervalMicroSeconds32 &aTimeout);

Description

Sets the value of the modem initialisation timeout duration.

Parameters

const TTimeIntervalMicroSeconds32 &aTimeout Modem initialisation timeout duration

inline const TTimeIntervalMicroSeconds32 &SendTryTimeout() const;

Description

Gets the Send Try Timeout value

Return value

const TTimeIntervalMicroSeconds32 & Time-out value

inline void SetSendTryTimeout(const TTimeIntervalMicroSeconds32 &aTimeout);

Description

Sets the Send Try Timeout value.

Parameters

const TTimeIntervalMicroSeconds32 &aTimeout Time-out value

inline const TTimeIntervalMicroSeconds32 &BootTimerTimeout();

Description

Gets the Boot Timer Timeout value

Return value

const TTimeIntervalMicroSeconds32 & Boot Timer Time-out value

inline void SetBootTimerTimeout(const TTimeIntervalMicroSeconds32 &aTimeout);

Description

Sets the Boot Timer Timeout value

Parameters

const TTimeIntervalMicroSeconds32 &aTimeout Time-out value

Capability:

Illegal

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises the object.

Sets the SMS sttings from the stream store.

Parameters

RReadStream &aStream Stream to read from

Capability:

Illegal

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises the object.

Gets the SMS sttings from the stream store.

Parameters

RWriteStream &aStream Stream to write to