CMsvSendOperation Class Reference

class CMsvSendOperation : public CMsvOperation

Utility to create an operation containing a sending operation which may be used to retrieve a standard progress structure.

This class is intended to be derived from. The derived class must define the TranslateProgress() member function. This function is responsible for translating the native progress of the given mtm into the standard progress structure, CMsvSendOperation::TSendOperationProgress.

Inherits from

Nested Classes and Structures

Public Member Functions
~CMsvSendOperation()
IMPORT_C const TDesC8 &FinalProgress()
IMPORT_C const TDesC8 &ProgressL()
IMPORT_C voidStart(CMsvOperation *)
Protected Member Functions
CMsvSendOperation(CMsvSession &, TRequestStatus &)
Private Member Functions
voidComplete(TInt)
IMPORT_C voidDoCancel()
IMPORT_C voidRunL()
const TDesC8 &TranslateProgress(const TDesC8 &)
Inherited Functions
CActive::CActive(TInt)
CActive::Cancel()
CActive::Deque()
CActive::IsActive()const
CActive::IsAdded()const
CActive::Priority()const
CActive::RunError(TInt)
CActive::SetActive()
CActive::SetPriority(TInt)
CActive::~CActive()
CBase::CBase()
CBase::Delete(CBase *)
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()
CMsvOperation::CMsvOperation(CMsvSession &,TInt,TRequestStatus &)
CMsvOperation::Extension_(TUint,TAny *&,TAny *)
CMsvOperation::Id()const
CMsvOperation::Mtm()const
CMsvOperation::Service()const
CMsvOperation::SystemProgress(TMsvSystemProgress &)
CMsvOperation::~CMsvOperation()
Public Member Enumerations
enumTSendOperationState {
ESendStateInPreparation, ESendStateWaitingToSend, ESendStateConnecting, ESendStateSending, ESendStateDone, ESendStateFailed
}
Inherited Enumerations
CActive:TPriority
Protected Attributes
CMsvOperation *iOperation
TPckgBuf< TSendOperationProgress >iProgress
Inherited Attributes
CActive::iStatus
CMsvOperation::iMsvSession
CMsvOperation::iMtm
CMsvOperation::iObserverRequestStatus
CMsvOperation::iService

Constructor & Destructor Documentation

CMsvSendOperation(CMsvSession &, TRequestStatus &)

IMPORT_CCMsvSendOperation(CMsvSession &aMsvSession,
TRequestStatus &aObserverRequestStatus
)[protected]

Parameters

CMsvSession & aMsvSession
TRequestStatus & aObserverRequestStatus

~CMsvSendOperation()

IMPORT_C~CMsvSendOperation()[virtual]

Member Functions Documentation

Complete(TInt)

voidComplete(TIntanError)[private]

Parameters

TInt anError

DoCancel()

IMPORT_C voidDoCancel()[private, virtual]

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel().

CActive::Cancel

FinalProgress()

IMPORT_C const TDesC8 &FinalProgress()[virtual]

ProgressL()

IMPORT_C const TDesC8 &ProgressL()[virtual]

Gets information on the progress of the operation.

All operations on local entries share the same progress information format, which defined by TMsvLocalOperationProgress.

For MTM-specific operations, progress information can be extracted by calling CBaseUiMtm::GetProgress() or displayed by CBaseUiMtm::DisplayProgressSummary() on the appropriate User Interface MTM.

Requirements:

Derived classes should implement this function so that the client can check on the progress of the operation. The function should share an understanding of the format of the buffer with the implementations of CBaseUiMtm::GetProgress() and CBaseUiMtm::DisplayProgressSummary() in the User Interface MTM. The arguments of CBaseUiMtm::GetProgress() show some information that should be included where appropriate.

leave

KErrNotReady The operation has not yet been started: it has been queued for execution in the Message Server

Descriptor holding progress information. The maximum buffer size should be KMsvProgressBufferLength (defined in msvipc.h).

RunL()

IMPORT_C voidRunL()[private, virtual]

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's RunL() or RunError() functions.

CActiveScheduler::Start

CActiveScheduler::Error

CActiveScheduler::WaitForAnyRequest

TRAPD

Start(CMsvOperation *)

IMPORT_C voidStart(CMsvOperation *aOperation)

Parameters

CMsvOperation * aOperation

TranslateProgress(const TDesC8 &)

const TDesC8 &TranslateProgress(const TDesC8 &aProgress)[private, pure virtual]

Translates the progress from sending operation's progress into TSendOperationProgress.

This member function must be defined by derived classes. Must not leave. TSendOperationProgress

Descriptor holding progress information.

Parameters

const TDesC8 & aProgress

Member Enumerations Documentation

Enum TSendOperationState

Send progress state.

TSendOperationProgress

Enumerators

ESendStateInPreparation
ESendStateWaitingToSend
ESendStateConnecting
ESendStateSending
ESendStateDone
ESendStateFailed

Member Data Documentation

CMsvOperation * iOperation

CMsvOperation *iOperation[protected]

The sending operation.

Assigned when ConstructL is called

TPckgBuf< TSendOperationProgress > iProgress

TPckgBuf< TSendOperationProgress >iProgress[protected]

The progress that is associated with this operation.

The TranslateProgress defined by derived classes must populate and return this progress structure. TranslateProgress()

TSendOperationProgress