Class CMsvCompletedOperation

class CMsvCompletedOperation : public CMsvOperation;

Description

Utility to create a messaging operation object for an operation that has already completed.

This utility is useful, for example, for writers of MTMs, where the API requires that an asynchronous operation is returned, but where in reality, the operation has performed synchronously. It allows the program to construct an operation object for which the operation is already completed, with the progress information and error code set.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CActive - The core class of the active object abstraction

• CMsvOperation - Defines an interface for use by objects which control asynchronous commands in the messaging system

• CMsvCompletedOperation - Utility to create a messaging operation object for an operation that has already completed

Members

Defined in CMsvCompletedOperation:
DoCancel(), FinalProgress(), NewL(), ProgressL(), RunL(), ~CMsvCompletedOperation()

Inherited from CActive:
Cancel(), Deque(), EPriorityHigh, EPriorityIdle, EPriorityLow, EPriorityStandard, EPriorityUserInput, IsActive(), IsAdded(), Priority(), RunError(), SetActive(), SetPriority(), TPriority, iStatus

Inherited from CBase:
Delete(), operator new()

Inherited from CMsvOperation:
Extension_(), Id(), Mtm(), Service(), SystemProgress(), iMsvSession, iMtm, iObserverRequestStatus, iService

static IMPORT_C CMsvCompletedOperation *NewL(CMsvSession &aMsvSession, TUid aMtm, const TDesC8 &aProgress, TMsvId aService, TRequestStatus &aObserverRequestStatus, TInt aErr=KErrNone);

Description

Allocates and constructs a new CMsvCompletedOperation object.

The new object is added to the active scheduler and its asynchronous request immediately set to complete.

Parameters

CMsvSession &aMsvSession Message Server session to use TUid aMtm The UID of the MTM associated with the operation. const TDesC8 &aProgress Operation progress information buffer. This is copied by the object. TMsvId aService The ID of the service that is associated with this operation. TRequestStatus &aObserverRequestStatus Request status of the operation observer. This observer is signalled that the operation is complete. TInt aErr Error code with which to complete the request. Use KErrNone to indicate that the operation completed successfully.

Return value

CMsvCompletedOperation * New CMsvOperationActiveSchedulerWait object

Leave codes

KErrNoMemory

IMPORT_C ~CMsvCompletedOperation();

Description

Destructor.

Any active request on the object is cancelled.

virtual const TDesC8 &ProgressL();

Description

Gets information on the progress of the operation.

For a CMsvCompletedOperation, the progress information returned by ProgressL() and FinalProgress() is the same, and is the progress information set in the NewL() function.

Return value

const TDesC8 & Descriptor holding progress information.

See also:

• CMsvOperation::ProgressL()

virtual const TDesC8 &FinalProgress();

Description

Gets information about a completed operation.

Return value

const TDesC8 & Descriptor holding progress information.

See also:

• CMsvOperation::FinalProgress()

private: virtual void DoCancel();

Description

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

private: virtual void RunL();

Description

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.