Class CMsvScheduleSettings

class CMsvScheduleSettings : public CBase;

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.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

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

Members

Defined in CMsvScheduleSettings:
EDefaultIntervalType, EDefaultLatency, EDefaultLongInterval, EDefaultPendingConditionsTimeout, EDefaultPriority, EDefaultShortInterval, EDefaultValidityPeriod, IntervalType(), Latency(), LongInterval(), NewL(), NewLC(), PendingConditionsTimeout(), Priority(), Reset(), SetIntervalType(), SetLatency(), SetLongInterval(), SetPendingConditionsTimeout(), SetPriority(), SetShortInterval(), SetValidityPeriod(), SetVariableIntervalsL(), ShortInterval(), ValidityPeriod(), VariableIntervals(), anonymous, ~CMsvScheduleSettings()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CMsvScheduleSettings *NewL();

Description

Allocates and creates a new CMsvScheduleSettings object.

Return value

CMsvScheduleSettings * New object

static IMPORT_C CMsvScheduleSettings *NewLC();

Description

Allocates and creates a new CMsvScheduleSettings object.

Return value

CMsvScheduleSettings * New object

IMPORT_C ~CMsvScheduleSettings();

Description

Destructor.

IMPORT_C void Reset();

Description

Resets the object.

This sets all data members to their default values.

IMPORT_C void SetPriority(const TInt aPriority);

Description

Sets the priority of the messages on the Task Scheduler.

Parameters

const TInt aPriority Priority value.

IMPORT_C TInt Priority() const;

Description

Gets the priority of the messages on the Task Scheduler.

Return value

TInt Priority value

IMPORT_C void SetValidityPeriod(const TTimeIntervalMinutes &aValidityPeriod);

Description

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

const TTimeIntervalMinutes &aValidityPeriod Validity period.

Panic codes

ScheduleSend-DLL 10 The validity period is invalid (negative or null).

IMPORT_C const TTimeIntervalMinutes &ValidityPeriod() const;

Description

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

Return value

const TTimeIntervalMinutes & Validity period

IMPORT_C void SetIntervalType(const TIntervalType aIntervalType);

Description

Sets the schedule interval type.

Parameters

const TIntervalType aIntervalType The schedule interval type.

IMPORT_C TIntervalType IntervalType() const;

Description

Gets the schedule interval type.

Return value

TIntervalType The schedule interval type

IMPORT_C void SetLongInterval(const TTimeIntervalSeconds &aInterval);

Description

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

const TTimeIntervalSeconds &aInterval Long interval value.

Panic codes

ScheduleSend-DLL 18 The long interval is out of range (negative or null).

IMPORT_C const TTimeIntervalSeconds &LongInterval() const;

Description

Gets the long retry interval value.

Return value

const TTimeIntervalSeconds & Long interval value

Panic codes

ScheduleSend-DLL 18 The long interval is out of range (negative or null).

IMPORT_C void SetShortInterval(const TTimeIntervalSeconds &aInterval);

Description

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

const TTimeIntervalSeconds &aInterval Short interval value.

Panic codes

ScheduleSend-DLL 19 The short interval is out of range (negative or null).

IMPORT_C const TTimeIntervalSeconds &ShortInterval() const;

Description

Gets the short retry interval value.

Return value

const TTimeIntervalSeconds & Short interval value

Panic codes

ScheduleSend-DLL 19 The short interval is out of range (negative or null).

IMPORT_C const CArrayFixFlat< TTimeIntervalSeconds > &VariableIntervals() const;

Description

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

const CArrayFixFlat< TTimeIntervalSeconds > & Variable retry intervals

IMPORT_C void SetVariableIntervalsL(const CArrayFixFlat< TTimeIntervalSeconds > &aIntervals);

Description

Sets variable retry intervals.

Parameters

const CArrayFixFlat< TTimeIntervalSeconds > &aIntervals Variable retry intervals.

Leave codes

One of the system wide error codes One of the intervals could not be appended to the array holding the variable intervals.

Panic codes

ScheduleSend-DLL 20 At least one of the intervals is out of range (negative or null).

IMPORT_C const TTimeIntervalMicroSeconds32 &Latency() const;

Description

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

const TTimeIntervalMicroSeconds32 & Minimum message sending latency

Panic codes

ScheduleSend-DLL 25 The latency is invalid (negative).

IMPORT_C void SetLatency(const TTimeIntervalMicroSeconds32 &aLatency);

Description

Sets the minimum message sending latency.

Parameters

const TTimeIntervalMicroSeconds32 &aLatency Minimum message sending latency.

Panic codes

ScheduleSend-DLL 25 The latency is invalid (negative).

IMPORT_C void SetPendingConditionsTimeout(const TTimeIntervalMinutes &aTimeout);

Description

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

const TTimeIntervalMinutes &aTimeout The timeout interval in minutes.

Panic codes

ScheduleSend-DLL 25 The timeout interval is invalid (negative).

IMPORT_C const TTimeIntervalMinutes &PendingConditionsTimeout() const;

Description

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

const TTimeIntervalMinutes & The timeout interval in minutes.

n/a

Description

Default scheduler settings values.

EDefaultPriority Default priority. EDefaultValidityPeriod Default validity period: 10080 Minutes in 1 week. EDefaultIntervalType Default interval type: EYearly EDefaultShortInterval Default short retry interval. EDefaultLongInterval Default long retry interval. EDefaultLatency Default latency. EDefaultPendingConditionsTimeout Default timeout. Zero minutes - no timeout.