Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: MsvSendErrorAction.h
Link against: schsend.lib

This item is not part of the S60 3rd Edition SDK for Symbian OS, Feature Pack 2.

Class TMsvSendErrorAction

class TMsvSendErrorAction;

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.

Members

Defined in TMsvSendErrorAction:
MaxRetries(), Reset(), SetMaxRetries(), TMsvSendErrorAction(), iAction, iError, iRetries, iRetrySpacing


Construction and destruction


TMsvSendErrorAction()

IMPORT_C TMsvSendErrorAction();

Description

Default constructor.

[Top]


Member functions


Reset()

IMPORT_C void Reset();

Description

Sets all member data to default values.


SetMaxRetries()

IMPORT_C void SetMaxRetries(const TInt16 aMaxRetries);

Description

Sets the maximum number of retries.

Parameters

const TInt16 aMaxRetries

Maximum number of retries.

Panic codes

ScheduleSend-DLL

21 The maximum number of retries is negative.


MaxRetries()

IMPORT_C TInt16 MaxRetries() const;

Description

Gets the maximum number of retries.

Return value

TInt16

Maximum number of retries

[Top]


Member data


iError

TInt iError;

Description

The error.


iAction

TMsvSendAction iAction;

Description

The action to take if this error occurs.


iRetries

TMsvSendRetries iRetries;

Description

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

TMsvSendRetrySpacing iRetrySpacing;

Description

Retry behaviour.

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