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 voidIncreaseRetries()
IMPORT_C TBoolIsReset()
IMPORT_C voidRemoveL(CMsvStore &)
IMPORT_C voidReset()
IMPORT_C voidResetRetries()
IMPORT_C voidRestoreL(CMsvStore &)
IMPORT_C TIntRetries()
IMPORT_C voidStoreL(CMsvStore &)
Protected Member Functions
voidExternalizeL(RWriteStream &)
voidInternalizeL(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

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_CTMsvEntryScheduleData()

Default constructor.

Member Function Documentation

ExternalizeL ( RWriteStream & )

voidExternalizeL(RWriteStream &aWriteStream)const [protected]

Externalises the object to the specified stream.

Parameters
aWriteStreamStream to write to.

IncreaseRetries ( )

IMPORT_C voidIncreaseRetries()

Adds one to the value of the iRetryCount member.

InternalizeL ( RReadStream & )

voidInternalizeL(RReadStream &aReadStream)[protected]

Internalises the object from the specified stream.

Parameters
aReadStreamStream to read from.

IsReset ( )

IMPORT_C TBoolIsReset()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 voidRemoveL(CMsvStore &aStore)const

Removes the object from a store.

Parameters
aStoreStore to remove from.
Leave Codes

Reset ( )

IMPORT_C voidReset()

Resets the object.

It sets all member data to zero.

ResetRetries ( )

IMPORT_C voidResetRetries()

Sets the iRetryCount member to zero.

RestoreL ( CMsvStore & )

IMPORT_C voidRestoreL(CMsvStore &aStore)

Restores the object from a store.

Parameters
aStoreStore to read from.

Retries ( )

IMPORT_C TIntRetries()const

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

Return Value
Number of retries.

StoreL ( CMsvStore & )

IMPORT_C voidStoreL(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
aStoreStore to write to.