CMsvScheduleSend Class Reference

#include <mw/msvschedulesend.h>

Link against: schsend.lib

class CMsvScheduleSend : public CBase

Inherits from

CMsvScheduleSend

Protected Attributes
CMsvSysAgentActions *	iAgentActions
CMsvSendErrorActions *	iErrorActions
CMsvOffPeakTimes *	iOffPeakTimes
TMsvSchedulePackage	iPackage
TBool	iRegistered
CMsvScheduledEntries *	iSchEntries
CArrayFixFlat< TScheduleEntryInfo2 > *	iSchEntryInfo
CArrayFixFlat< TTaskInfo > *	iSchTaskInfo
RScheduler	iScheduler
CMsvServerEntry &	iServerEntry
CMsvScheduleSettings *	iSettings

Public Member Functions
	~CMsvScheduleSend()
CMsvSysAgentActions &	AgentActions()
IMPORT_C void	CheckScheduleL(const CMsvEntrySelection &)
IMPORT_C void	ConnectAndRegisterL(RScheduler &, const CMsvScheduleSettings &)
IMPORT_C void	CreateScheduleL(RScheduler &, const CMsvScheduleSettings &, const TTime &, const TTimeIntervalMinutes &, TSchedulerItemRef &)
IMPORT_C void	CreateScheduleL(RScheduler &, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTime &, TSchedulerItemRef &)
IMPORT_C void	DeleteScheduleL(const CMsvEntrySelection &)
IMPORT_C void	FindScheduleL(RScheduler &, const TTime &, TSchedulerItemRef &)
IMPORT_C void	FindScheduleL(RScheduler &, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTime &, TSchedulerItemRef &)
IMPORT_C void	LoadScheduleSettingsL(CRepository &)
CMsvOffPeakTimes &	OffPeakTimes()
IMPORT_C void	ReScheduleL(const CMsvEntrySelection &, const TMsvSchedulePackage &, const TMsvSendErrorAction *)
IMPORT_C void	RoundUpToMinute(TTime &)
IMPORT_C void	ScheduleEntryL(RScheduler &, const TSchedulerItemRef &, const TMsvSchedulePackage &, TTaskInfo &)
IMPORT_C void	ScheduleL(const CMsvEntrySelection &, const TMsvSchedulePackage &)
CMsvScheduleSettings &	ScheduleSettings()
CMsvSendErrorActions &	SendErrorActions()
IMPORT_C void	SendingCompleteL(TMsvEntry &, const TBool)
IMPORT_C void	SendingCompleteL(const CMsvEntrySelection &)
IMPORT_C void	UpdateEntryAfterSchedule(const TSchedulerItemRef &, const TTaskInfo &, const TTime &, TInt, TMsvEntry &, TMsvEntryScheduleData &)

Protected Member Functions
	CMsvScheduleSend(CMsvServerEntry &)
virtual IMPORT_C void	ConstructL()
pure virtual CMsvScheduledEntry *	GetMessageL(const TMsvId)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Provides a Server MTM's interface to the Task Scheduler for messaging scheduling.

Server MTM's must provide a derived class that implements GetMessageL() to provide a factory for MTM-specific scheduling CMsvScheduledEntry-based objects.

Member Attribute Documentation

iAgentActions

CMsvSysAgentActions *

iAgentActions

[protected]

The System Agent conditions that must be satisfied before a sending attempt.

iErrorActions

CMsvSendErrorActions *

iErrorActions

[protected]

The Server MTM specific actions to take when particular errors occur during message sending.

iOffPeakTimes

CMsvOffPeakTimes *

iOffPeakTimes

[protected]

The Server MTM specific off peak time periods.

iPackage

TMsvSchedulePackage

iPackage

[protected]

Scheduling options.

iRegistered

TBool

iRegistered

[protected]

Indicates if this has been registered with the Task Scheduler.

Initially set to EFalse.

iSchEntries

CMsvScheduledEntries *

iSchEntries

[protected]

Array of message schedule data.

iSchEntryInfo

CArrayFixFlat< TScheduleEntryInfo2 > *

iSchEntryInfo

[protected]

Array of schedule entry data.

iSchTaskInfo

CArrayFixFlat< TTaskInfo > *

iSchTaskInfo

[protected]

Array of schedule task data.

iScheduler

RScheduler

iScheduler

[protected]

Provides an interface to the Task Scheduler.

iServerEntry

CMsvServerEntry &

iServerEntry

[protected]

The CMsvServerEntry of the server MTM.

iSettings

CMsvScheduleSettings *

iSettings

[protected]

The Server MTM specific scheduled message sending settings.

Constructor & Destructor Documentation

CMsvScheduleSend ( CMsvServerEntry & )

IMPORT_C

CMsvScheduleSend

(

CMsvServerEntry &

aServerEntry

)

[protected]

Constructor.

Parameter	Description
aServerEntry	The CMsvServerEntry of the server MTM of which this CMsvScheduleSend object is a member.

~CMsvScheduleSend ( )

IMPORT_C

~CMsvScheduleSend

(

)

Destructor.

Member Function Documentation

AgentActions ( )

CMsvSysAgentActions &

AgentActions

(

)

const [inline]

Gets System Agent conditions that must be satisfied before a sending attempt.

Returns: System Agent conditions

CheckScheduleL ( const CMsvEntrySelection & )

IMPORT_C void

CheckScheduleL

(

const CMsvEntrySelection &

aSelection

)

Verifies that the schedule information stored in specified messages is the same as that on the task scheduler.

panic: ScheduleSend-DLL 0 The array of message IDs is empty. Debug build only.

Parameter	Description
aSelection	Array of message IDs that need to be checked against the task scheduler.

ConnectAndRegisterL ( RScheduler &, const CMsvScheduleSettings & )

IMPORT_C void	ConnectAndRegisterL	(	RScheduler &	aScheduler,
			const CMsvScheduleSettings &	aSettings
		)	[static]

Connects to and registers with the task scheduler.

leave: Any error code RScheduler::Connect() returned an error.

leave: Any error code RFs::Connect() returned an error.

leave: KErrPathNotFound The .EXE file to be called by the Task Scheduler when messages are due to be sent cannot be found. The filename is part of the schedule settings.

leave: Any error code RScheduler::Register() returned an error.

Parameter	Description
aScheduler	Handle to the scheduler to connect to.
aSettings	Schedule settings.

ConstructL ( )

IMPORT_C void

ConstructL

(

)

[protected, virtual]

Second phase constructor.

This constructor creates instances of the following classes: CMsvScheduleSettings, CMsvOffPeakTimes, CMsvSendErrorActions, CMsvSysAgentActions and CMsvScheduledEntries.

CreateScheduleL ( RScheduler &, const CMsvScheduleSettings &, const TTime &, const TTimeIntervalMinutes &, TSchedulerItemRef & )

IMPORT_C void	CreateScheduleL	(	RScheduler &	aScheduler,
			const CMsvScheduleSettings &	aSettings,
			const TTime &	aStartTime,
			const TTimeIntervalMinutes &	aValidityPeriod,
			TSchedulerItemRef &	aRef
		)	[static]

Creates a new schedule on the task scheduler with which each message can be associated.

The schedule is triggered by a start time being reached.

Parameter	Description
aScheduler	Handle to scheduler to update.
aSettings	Scheduler settings.
aStartTime	Schedule start time.
aValidityPeriod	Schedule validity period.
aRef	On return, the new schedule.

CreateScheduleL ( RScheduler &, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTime &, TSchedulerItemRef & )

IMPORT_C void	CreateScheduleL	(	RScheduler &	aScheduler,
			const CArrayFixFlat< TTaskSchedulerCondition > &	aConditions,
			const TTime &	aTimeout,
			TSchedulerItemRef &	aRef
		)	[static]

Creates a new schedule on the task scheduler with which each message can be associated.

The schedule is triggered by either a set of conditions being met or a timeout being reached.

See also: RScheduler::CreatePersistentSchedule TSysAgentCondition

Parameter	Description
aScheduler	Handle to scheduler to update.
aConditions	The set of System Agent conditions that are required to be met to trigger the schedule.
aTimeout	The timeout value for the schedule.
aRef	On return, the new schedule.

DeleteScheduleL ( const CMsvEntrySelection & )

IMPORT_C void

DeleteScheduleL

(

const CMsvEntrySelection &

aSelection

)

Delete the schedules for the specified messages from the task scheduler.

The messages themselves are not deleted.

leave: Any error code Unable to connect and register with the scheduler.

leave: Any error code but KErrLocked and KErrNotFound The method overloading CMsvScheduledEntry::GetMessageL() left with an error, i.e. the scheduling info of one of the messages from the selection could not be retrieved from the message server.

leave: Any error code Unable to reset the previous scheduling info for a message.

Parameter	Description
aSelection	Array of message IDs that need to be deleted from the task scheduler.

FindScheduleL ( RScheduler &, const TTime &, TSchedulerItemRef & )

IMPORT_C void	FindScheduleL	(	RScheduler &	aScheduler,
			const TTime &	aStartTime,
			TSchedulerItemRef &	aRef
		)	[static]

Searches the scheduler for an existing schedule item with a schedule time that matches with time supplied.

Parameter	Description
aScheduler	Handle to the scheduler.
aStartTime	Schedule start time.
aRef	On return, the schedule item.

FindScheduleL ( RScheduler &, const CArrayFixFlat< TTaskSchedulerCondition > &, const TTime &, TSchedulerItemRef & )

IMPORT_C void	FindScheduleL	(	RScheduler &	aScheduler,
			const CArrayFixFlat< TTaskSchedulerCondition > &	aConditions,
			const TTime &	aTimeout,
			TSchedulerItemRef &	aRef
		)	[static]

Searches the scheduler for an existing conditions schedule item with a set of pending conditions and timeout value that matches with those supplied.

Parameter	Description
aScheduler	Handle to the scheduler.
aConditions	The set of System Agent conditions that are required to be met to trigger the schedule.
aTimeout	The timeout value for the schedule.
aRef	On return, the schedule item.

GetMessageL ( const TMsvId )

CMsvScheduledEntry *

GetMessageL

(

const TMsvId

aId

)

const [protected, pure virtual]

Gets the schedule data and recipients of a message.

Recipient information is MTM-specific, so the server MTM must provide a derived class that implements CMsvScheduledEntry, and return objects of that type from this function.

Parameter	Description
aId	The message ID.

Returns: The message's schedule data.

LoadScheduleSettingsL ( CRepository & )

IMPORT_C void

LoadScheduleSettingsL

(

CRepository &

aRepository

)

Loads schedule settings from CenRep

Parameter	Description
aRepository	CenRep repository to load settings from

OffPeakTimes ( )

CMsvOffPeakTimes &

OffPeakTimes

(

)

const [inline]

Gets off-peak times settings.

Returns: Off-peak times settings

ReScheduleL ( const CMsvEntrySelection &, const TMsvSchedulePackage &, const TMsvSendErrorAction * )

IMPORT_C void	ReScheduleL	(	const CMsvEntrySelection &	aSelection,
			const TMsvSchedulePackage &	aPackage,
			const TMsvSendErrorAction *	aErrorAction = NULL
		)

Determines when the messages should be re-scheduled on the task scheduler, then schedules the messages at the new time(s).

Messages that are successfully re-scheduled are updated. The pending conditions flag indicates whether the message has been schedule for a set of conditions being met (or a timeout occuring) or scheduled for a specified time/date.

NOTE - conditions scheduling is only supoprted from 8.1 onwards.

In the case of time-scheduling, the date field is the scheduled time/date. In the case of conditions-scheduling, the date field reflects the timeout value.

There are several cases when messages are not re-scheduled. If all recipients have been sent to - in this case the message's sending state set to KMsvSendStateSent. If, more commonly, the message's maximum number of re-tries has been exceeded or the error action was ESendActionFail then the message is not changed.

panic: ScheduleSend-DLL 0 The array of message IDs is empty. Debug build only.

Parameter	Description
aSelection	Array of message IDs that need to be re-scheduled. This array cannot be empty. All the messages identified must belong to the same MTM. It is not a precondition that each message has already been scheduled on the task scheduler.
aPackage	Scheduling options.
aErrorAction	The specific action to take with the messages. If this argument is omitted, then ReScheduleL() uses the iError member of each TMsvEntry to find the related TMsvSendErrorAction in iErrorActions.

RoundUpToMinute ( TTime & )

IMPORT_C void

RoundUpToMinute

(

TTime &

aTime

)

[static]

Utility function that rounds a specified time up to the nearest minute.

Parameter	Description
aTime	On return, the passed value rounded up to the nearest minute.

ScheduleEntryL ( RScheduler &, const TSchedulerItemRef &, const TMsvSchedulePackage &, TTaskInfo & )

IMPORT_C void	ScheduleEntryL	(	RScheduler &	aScheduler,
			const TSchedulerItemRef &	aRef,
			const TMsvSchedulePackage &	aPackage,
			TTaskInfo &	aInfo
		)	[static]

Adds an entry to an existing schedule.

Parameter	Description
aScheduler	Scheduler to access.
aRef	Id of the schedule.
aPackage	Scheduler settings.
aInfo	Information about the entry to be added to the schedule.

ScheduleL ( const CMsvEntrySelection &, const TMsvSchedulePackage & )

IMPORT_C void	ScheduleL	(	const CMsvEntrySelection &	aSelection,
			const TMsvSchedulePackage &	aPackage
		)

Schedules messages on the task scheduler.

Messages that are successfully scheduled have their sending state set to KMsvSendStateScheduled.

leave: Any error code but KErrLocked and KErrNotFound The method overloading CMsvScheduledEntry::GetMessageL() left with an error, i.e. the scheduling info of one of the messages from the selection could not be retrieved from the message server.

leave: Any error code Unable to reset the previous scheduling info for a message.

panic: ScheduleSend-DLL 0 The array of message IDs is empty. Debug build only.

panic: ScheduleSend-DLL 1 At least one of the selected messages is scheduled for a different time as the others. Debug build only.

panic: ScheduleSend-DLL 2 At least one of the selected messages does not belong to the same MTM. Debug build only.

panic: ScheduleSend-DLL 3 At least one of the selected messages does not have the same off-peak settings as the others. Debug build only.

Parameter	Description
aSelection	Array of message IDs that need to be scheduled. This array cannot be empty. All the messages identified in the selection must belong to the same MTM; be scheduled for the same time; have the same setting for their OffPeak() flag; have the scheduled time stored in the iDate member of their corresponding TMsvEntry.
aPackage	Scheduling options

ScheduleSettings ( )

CMsvScheduleSettings &

ScheduleSettings

(

)

const [inline]

Gets scheduler settings.

Returns: Scheduler settings

SendErrorActions ( )

CMsvSendErrorActions &

SendErrorActions

(

)

const [inline]

Gets action-on-sending-error settings.

Returns: Action-on-sending-error settings

SendingCompleteL ( TMsvEntry &, const TBool )

IMPORT_C void	SendingCompleteL	(	TMsvEntry &	aEntry,
			const TBool	aChangeEntry = EFalse
		)

Tells the scheduler that sending is complete.

This function must be called when a message that had previously been scheduled is either sent or has failed. This function:

1. Deletes the TMsvEntryScheduleData associated with the message

2. Sets the Scheduled flag to EFalse

3. If required, calls ChangeEntry() on the message server entry

Note: SendingCompleteL() does not change the sending state of each message, nor delete each message from the task scheduler.

panic: ScheduleSend-DLL 24 The server entry is not set to the correct entry. Debug build only.

Parameter	Description
aEntry	The message which was either successfully sent or which failed (all the attempts) to send. It is not a precondition that the message has already been scheduled on the task scheduler.
aChangeEntry	If aChangeEntry is ETrue then SendingCompleteL() will call CMsvServerEntry::ChangeEntry() to update the message on the message server.

SendingCompleteL ( const CMsvEntrySelection & )

IMPORT_C void

SendingCompleteL

(

const CMsvEntrySelection &

aSelection

)

Tells the scheduler that sending is complete.

This method sets the messages's scheduled flag to false, resets the schedule data associated with each message and the number of retries for each recipient and stores the data and recipients in a stream associated with the TMsvEntry.

Parameter	Description
aSelection	Messages that were either successfully sent or which failed all the attempts to send.

UpdateEntryAfterSchedule ( const TSchedulerItemRef &, const TTaskInfo &, const TTime &, TInt, TMsvEntry &, TMsvEntryScheduleData & )

IMPORT_C void	UpdateEntryAfterSchedule	(	const TSchedulerItemRef &	aRef,
			const TTaskInfo &	aInfo,
			const TTime &	aTime,
			TInt	aFinalState,
			TMsvEntry &	aEntry,
			TMsvEntryScheduleData &	aData
		)	[static]

Utility function that updates message index entry fields to reflect the message's scheduling.

Parameter	Description
aRef	Scheduler item.
aInfo	Scheduler task information.
aTime	Schedule start time.
aFinalState	Sending state flag.
aEntry	On return, updated index entry.
aData	On return, populated messaging scheduling data.