TMsvSendErrorAction Class Reference

#include <mw/msvsenderroraction.h>

Link against: schsend.lib

class TMsvSendErrorAction
Public Attributes
TMsvSendActioniAction
TInt iError
TMsvSendRetriesiRetries
TMsvSendRetrySpacingiRetrySpacing
Public Member Functions
TMsvSendErrorAction()
IMPORT_C TInt16MaxRetries()
IMPORT_C voidReset()
IMPORT_C voidSetMaxRetries(const TInt16)

Detailed Description

Encapsulates the action to take for a particular error.

An error may occur when the Server MTM is attempting to send a message or messages. If the Server MTM supports scheduling, then, depending on the error or conditions, the Server MTM may want to re-schedule the message on the Task Scheduler to send at a later time. CMsvScheduleSend::ReScheduleL() (in combination with CMsvSendErrorActions) uses the TMsvSendErrorAction to determine whether to re-schedule the message.

Member Attribute Documentation

iAction

TMsvSendActioniAction

The action to take if this error occurs.

iError

TInt iError

The error.

iRetries

TMsvSendRetriesiRetries

The number of attempts to make at sending a message if this error occurs.

If iRetries equals ESendRetriesInfinite, then sending will be attempted until successful (or the user intervenes). This member is ignored if iAction equals ESendActionFail.

iRetrySpacing

TMsvSendRetrySpacingiRetrySpacing

Retry behaviour.

This member is used by CMsvSendErrorActions to determine when to resend the message. This member is ignored if iAction equals ESendActionFail.

Constructor & Destructor Documentation

TMsvSendErrorAction ( )

IMPORT_CTMsvSendErrorAction()

Default constructor.

Member Function Documentation

MaxRetries ( )

IMPORT_C TInt16MaxRetries()const

Gets the maximum number of retries.

Return Value
Maximum number of retries

Reset ( )

IMPORT_C voidReset()

Sets all member data to default values.

SetMaxRetries ( const TInt16 )

IMPORT_C voidSetMaxRetries(const TInt16aMaxRetries)

Sets the maximum number of retries.

Parameters
aMaxRetriesMaximum number of retries.
Panic Codes
ScheduleSend-DLL21 The maximum number of retries is negative.