#include <mw/msvschedulesettings.h>
Link against: schsend.lib
class CMsvScheduleSettings : public CBase |
Public Member Enumerations | |
---|---|
enum | anonymous { EDefaultPriority, EDefaultValidityPeriod, EDefaultIntervalType, EDefaultShortInterval, ..., EDefaultPendingConditionsTimeout } |
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.
Default scheduler settings values.
Enumerator | Value | Description |
---|---|---|
EDefaultPriority | 27 |
Default priority. |
EDefaultValidityPeriod | 10080 |
Default validity period: 10080 Minutes in 1 week. |
EDefaultIntervalType | 3 |
Default interval type: EYearly |
EDefaultShortInterval | 5 |
Default short retry interval. |
EDefaultLongInterval | 120 |
Default long retry interval. |
EDefaultLatency | 1500000 |
Default latency. |
EDefaultPendingConditionsTimeout | 0 |
Default timeout. Zero minutes - no timeout. |
IMPORT_C TIntervalType | IntervalType | ( | ) | const |
Gets the schedule interval type.
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.
Panic Codes | |
---|---|
ScheduleSend-DLL | 25 The latency is invalid (negative). |
IMPORT_C const TTimeIntervalSeconds & | LongInterval | ( | ) | const |
Gets the long retry interval value.
Panic Codes | |
---|---|
ScheduleSend-DLL | 18 The long interval is out of range (negative or null). |
IMPORT_C CMsvScheduleSettings * | NewL | ( | ) | [static] |
Allocates and creates a new CMsvScheduleSettings object.
IMPORT_C CMsvScheduleSettings * | NewLC | ( | ) | [static] |
Allocates and creates a new CMsvScheduleSettings object.
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.
IMPORT_C TInt | Priority | ( | ) | const |
Gets the priority of the messages on the Task Scheduler.
IMPORT_C void | Reset | ( | ) |
Resets the object.
This sets all data members to their default values.
IMPORT_C void | SetIntervalType | ( | const TIntervalType | aIntervalType | ) |
Sets the schedule interval type.
Parameters | |
---|---|
aIntervalType | The schedule interval type. |
IMPORT_C void | SetLatency | ( | const TTimeIntervalMicroSeconds32 & | aLatency | ) |
Sets the minimum message sending latency.
Parameters | |
---|---|
aLatency | Minimum message sending latency. |
Panic Codes | |
---|---|
ScheduleSend-DLL | 25 The latency is invalid (negative). |
IMPORT_C void | SetLongInterval | ( | 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 | |
---|---|
aInterval | Long interval value. |
Panic Codes | |
---|---|
ScheduleSend-DLL | 18 The long interval is out of range (negative or null). |
IMPORT_C void | SetPendingConditionsTimeout | ( | 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 | |
---|---|
aTimeout | The timeout interval in minutes. |
Panic Codes | |
---|---|
ScheduleSend-DLL | 25 The timeout interval is invalid (negative). |
IMPORT_C void | SetPriority | ( | const TInt | aPriority | ) |
Sets the priority of the messages on the Task Scheduler.
Parameters | |
---|---|
aPriority | Priority value. |
IMPORT_C void | SetShortInterval | ( | 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 | |
---|---|
aInterval | Short interval value. |
Panic Codes | |
---|---|
ScheduleSend-DLL | 19 The short interval is out of range (negative or null). |
IMPORT_C void | SetValidityPeriod | ( | 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 | |
---|---|
aValidityPeriod | Validity period. |
Panic Codes | |
---|---|
ScheduleSend-DLL | 10 The validity period is invalid (negative or null). |
IMPORT_C void | SetVariableIntervalsL | ( | const CArrayFixFlat< TTimeIntervalSeconds > & | aIntervals | ) |
Sets variable retry intervals.
Parameters | |
---|---|
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 TTimeIntervalSeconds & | ShortInterval | ( | ) | const |
Gets the short retry interval value.
Panic Codes | |
---|---|
ScheduleSend-DLL | 19 The short interval is out of range (negative or null). |
IMPORT_C const TTimeIntervalMinutes & | ValidityPeriod | ( | ) | const |
Gets the time period for which the messages are valid on the Task Scheduler.
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.