CMsvScheduleSettings Class Reference

#include <mw/msvschedulesettings.h>

Link against: schsend.lib

class CMsvScheduleSettings : public CBase

Inherits from

  • CMsvScheduleSettings

Detailed Description

Stores the MTM-specific (general) settings for scheduling messages on the Task Scheduler.

These settings include the latency (minimum amount of time between now and when the message is scheduled for), the intervals (short, long or variable) to wait for before attempting to re-send the message and the timout value for messages pending conditions to be met.

The other MTM scheduling releated settings are stored in CMsvOffPeakTimes and CMsvSendErrorActions.

Member Enumeration Documentation

Enum anonymous

Default scheduler settings values.

EnumeratorValueDescription
EDefaultPriority27

Default priority.

EDefaultValidityPeriod10080

Default validity period: 10080 Minutes in 1 week.

EDefaultIntervalType3

Default interval type: EYearly

EDefaultShortInterval5

Default short retry interval.

EDefaultLongInterval120

Default long retry interval.

EDefaultLatency1500000

Default latency.

EDefaultPendingConditionsTimeout0

Default timeout. Zero minutes - no timeout.

Constructor & Destructor Documentation

~CMsvScheduleSettings ( )

IMPORT_C~CMsvScheduleSettings()

Destructor.

Member Function Documentation

IntervalType ( )

IMPORT_C TIntervalTypeIntervalType()const

Gets the schedule interval type.

Return Value
The schedule interval type

Latency ( )

IMPORT_C const TTimeIntervalMicroSeconds32 &Latency()const

Gets the minimum message sending latency.

This is the minimum amount of time from the current time that must elapse before the message is sent. This must be greater than or equal to zero.

If the client specifies that the message should be scheduled in the past, then CMsvScheduleSend will actually schedule the message in Latency() seconds from the current time.

Return Value
Minimum message sending latency
Panic Codes
ScheduleSend-DLL25 The latency is invalid (negative).

LongInterval ( )

IMPORT_C const TTimeIntervalSeconds &LongInterval()const

Gets the long retry interval value.

Return Value
Long interval value
Panic Codes
ScheduleSend-DLL18 The long interval is out of range (negative or null).

NewL ( )

IMPORT_C CMsvScheduleSettings *NewL()[static]

Allocates and creates a new CMsvScheduleSettings object.

Return Value
New object

NewLC ( )

IMPORT_C CMsvScheduleSettings *NewLC()[static]

Allocates and creates a new CMsvScheduleSettings object.

Return Value
New object

PendingConditionsTimeout ( )

IMPORT_C const TTimeIntervalMinutes &PendingConditionsTimeout()const

Gets the timeout interval when re-scheduling messages for pending conditions to be met.

A value of zero indicates that there is no timeout when pending conditions to be met. The default value is zero.

Return Value
The timeout interval in minutes.

Priority ( )

IMPORT_C TIntPriority()const

Gets the priority of the messages on the Task Scheduler.

Return Value
Priority value

Reset ( )

IMPORT_C voidReset()

Resets the object.

This sets all data members to their default values.

SetIntervalType ( const TIntervalType )

IMPORT_C voidSetIntervalType(const TIntervalTypeaIntervalType)

Sets the schedule interval type.

Parameters
aIntervalTypeThe schedule interval type.

SetLatency ( const TTimeIntervalMicroSeconds32 & )

IMPORT_C voidSetLatency(const TTimeIntervalMicroSeconds32 &aLatency)

Sets the minimum message sending latency.

Parameters
aLatencyMinimum message sending latency.
Panic Codes
ScheduleSend-DLL25 The latency is invalid (negative).

SetLongInterval ( const TTimeIntervalSeconds & )

IMPORT_C voidSetLongInterval(const TTimeIntervalSeconds &aInterval)

Sets the long retry interval value.

This is used by CMsvScheduleSend to determine when to next send the message, if the TMsvSendErrorAction::iAction equals ESendActionRetryLater and TMsvSendErrorAction::iRetrySpacing equals ESendRetriesFixed.

Parameters
aIntervalLong interval value.
Panic Codes
ScheduleSend-DLL18 The long interval is out of range (negative or null).

SetPendingConditionsTimeout ( const TTimeIntervalMinutes & )

IMPORT_C voidSetPendingConditionsTimeout(const TTimeIntervalMinutes &aTimeout)

Sets the timeout interval when re-scheduling messages for pending conditions to be met.

A value of zero indicates that there is no timeout when pending conditions to be met. The default value is zero.

Parameters
aTimeoutThe timeout interval in minutes.
Panic Codes
ScheduleSend-DLL25 The timeout interval is invalid (negative).

SetPriority ( const TInt )

IMPORT_C voidSetPriority(const TIntaPriority)

Sets the priority of the messages on the Task Scheduler.

Parameters
aPriorityPriority value.

SetShortInterval ( const TTimeIntervalSeconds & )

IMPORT_C voidSetShortInterval(const TTimeIntervalSeconds &aInterval)

Sets the short retry interval value.

This is used by CMsvScheduleSend to determine when to next send the message, if the TMsvSendErrorAction::iAction equals ESendActionRetryImmediately.

Parameters
aIntervalShort interval value.
Panic Codes
ScheduleSend-DLL19 The short interval is out of range (negative or null).

SetValidityPeriod ( const TTimeIntervalMinutes & )

IMPORT_C voidSetValidityPeriod(const TTimeIntervalMinutes &aValidityPeriod)

Sets the time period for which the messages are valid on the Task Scheduler.

This is ignored if a message has to be sent off-peak.

Parameters
aValidityPeriodValidity period.
Panic Codes
ScheduleSend-DLL10 The validity period is invalid (negative or null).

SetVariableIntervalsL ( const CArrayFixFlat< TTimeIntervalSeconds > & )

IMPORT_C voidSetVariableIntervalsL(const CArrayFixFlat< TTimeIntervalSeconds > &aIntervals)

Sets variable retry intervals.

Parameters
aIntervalsVariable retry intervals.
Leave Codes
Oneof the system wide error codes One of the intervals could not be appended to the array holding the variable intervals.
Panic Codes
ScheduleSend-DLL20 At least one of the intervals is out of range (negative or null).

ShortInterval ( )

IMPORT_C const TTimeIntervalSeconds &ShortInterval()const

Gets the short retry interval value.

Return Value
Short interval value
Panic Codes
ScheduleSend-DLL19 The short interval is out of range (negative or null).

ValidityPeriod ( )

IMPORT_C const TTimeIntervalMinutes &ValidityPeriod()const

Gets the time period for which the messages are valid on the Task Scheduler.

Return Value
Validity period

VariableIntervals ( )

IMPORT_C const CArrayFixFlat< TTimeIntervalSeconds > &VariableIntervals()const

Gets variable retry intervals.

This is used by CMsvScheduleSend to determine when to next send the message. It is only used if TMsvSendErrorAction::iAction equals ESendActionRetryLater and TMsvSendErrorAction::iRetrySpacing equals ESendRetrySpacingVariable.

Return Value
Variable retry intervals