TMsvEntryScheduleData Class Reference

#include <mw/msventryscheduledata.h>

Link against: schsend.lib

class TMsvEntryScheduleData

Public Attributes
TSchedulerItemRef	iRef
TInt	iTaskId

Protected Attributes
TInt	iRetryCount
TInt16	iVersion

Public Member Functions
	TMsvEntryScheduleData()
IMPORT_C void	IncreaseRetries()
IMPORT_C TBool	IsReset()
IMPORT_C void	RemoveL(CMsvStore &)
IMPORT_C void	Reset()
IMPORT_C void	ResetRetries()
IMPORT_C void	RestoreL(CMsvStore &)
IMPORT_C TInt	Retries()
IMPORT_C void	StoreL(CMsvStore &)

Protected Member Functions
void	ExternalizeL(RWriteStream &)
void	InternalizeL(RReadStream &)

Detailed Description

Stores message-specific data related to scheduling.

The data is not required by the Client/UI side. This data is stored in a stream associated with the TMsvEntry.

Member Attribute Documentation

iRef

TSchedulerItemRef

iRef

The TSchedulerItemRef returned by the Task Scheduler when the schedule on which the message is scheduled is created.

iRetryCount

TInt

iRetryCount

[protected]

The number of retries that have been made to send this message.

iTaskId

TInt

iTaskId

The Task ID returned by the Task Scheduler when the message is scheduled.

iVersion

TInt16

iVersion

[protected]

Structure version.

Constructor & Destructor Documentation

TMsvEntryScheduleData ( )

IMPORT_C

TMsvEntryScheduleData

(

)

Default constructor.

Member Function Documentation

ExternalizeL ( RWriteStream & )

void

ExternalizeL

(

RWriteStream &

aWriteStream

)

const [protected]

Externalises the object to the specified stream.

Parameters
aWriteStream	Stream to write to.

IncreaseRetries ( )

IMPORT_C void

IncreaseRetries

(

)

Adds one to the value of the iRetryCount member.

InternalizeL ( RReadStream & )

void

InternalizeL

(

RReadStream &

aReadStream

)

[protected]

Internalises the object from the specified stream.

Parameters
aReadStream	Stream to read from.

IsReset ( )

IMPORT_C TBool

IsReset

(

)

const

Tests if all the members are set to their default value.

Return Value: True if all the members are set to their default value.

RemoveL ( CMsvStore & )

IMPORT_C void

RemoveL

(

CMsvStore &

aStore

)

const

Removes the object from a store.

Parameters
aStore	Store to remove from.

Leave Codes

Reset ( )

IMPORT_C void

Reset

(

)

Resets the object.

It sets all member data to zero.

ResetRetries ( )

IMPORT_C void

ResetRetries

(

)

Sets the iRetryCount member to zero.

RestoreL ( CMsvStore & )

IMPORT_C void

RestoreL

(

CMsvStore &

aStore

)

Restores the object from a store.

Parameters
aStore	Store to read from.

Retries ( )

IMPORT_C TInt

Retries

(

)

const

Gets how many retries have been made to send this message.

Return Value: Number of retries.

StoreL ( CMsvStore & )

IMPORT_C void

StoreL

(

CMsvStore &

aStore

)

const

Stores the object in a store.

This method leaves if the the object's data cannot be written to a RMsvWriteStream stream.

Parameters
aStore	Store to write to.