| 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.
| Public Member Functions | |
|---|---|
| ~CMsvSendOperation() | |
| IMPORT_C const TDesC8 & | FinalProgress() |
| IMPORT_C const TDesC8 & | ProgressL() |
| IMPORT_C void | Start(CMsvOperation *) |
| Protected Member Functions | |
|---|---|
| CMsvSendOperation(CMsvSession &, TRequestStatus &) | |
| Private Member Functions | |
|---|---|
| void | Complete(TInt) |
| IMPORT_C void | DoCancel() |
| IMPORT_C void | RunL() |
| const TDesC8 & | TranslateProgress(const TDesC8 &) |
| Public Member Enumerations | |
|---|---|
| enum | TSendOperationState { 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 | |
| IMPORT_C | CMsvSendOperation | ( | CMsvSession & | aMsvSession, |
| TRequestStatus & | aObserverRequestStatus | |||
| ) | [protected] | |||
| CMsvSession & aMsvSession | |
| TRequestStatus & aObserverRequestStatus |
| IMPORT_C void | DoCancel | ( | ) | [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().
| 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).
| IMPORT_C void | RunL | ( | ) | [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::WaitForAnyRequest
TRAPD
| IMPORT_C void | Start | ( | CMsvOperation * | aOperation | ) |
| CMsvOperation * aOperation |
| 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.
| const TDesC8 & aProgress |
Send progress state.
| ESendStateInPreparation | |
| ESendStateWaitingToSend | |
| ESendStateConnecting | |
| ESendStateSending | |
| ESendStateDone | |
| ESendStateFailed |
| CMsvOperation * | iOperation | [protected] |
The sending operation.
Assigned when ConstructL is called
| 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()