Constructor. This is called by MTM implementers from the derived class constructor.

CMsvOperation-derived objects are not created by message client applications. The constructor uses the CMsvSession object to obtain a ID for the operation. This ID can be accessed by clients through Id().

aPriority is the priority used by the active object. Typically, this is EPriorityStandard.

aObserverRequestStatus is the asynchronous status object of an active object provided by the caller. The derived class is required to signal the caller through this when the operation completes. It is stored by the constructor in the iObserverRequestStatus member.

Destructor.

This base class function takes no action. Derived classes should implement a destructor to do the clean up tasks that they require. Minimally, they should call Cancel() to cancel any outstanding request.

The extension method provides a polymorphic behaviour to call the correct SystemProgress function.

Gets information about a completed operation.

Unlike ProgressL(), this is guaranteed to provide status information reflecting the outcome of a completed operation.

Requirements:

The default implementation of this function returns the result from ProgressL(). If the operation is active or ProgressL() leaves, a panic occurs.

A derived class should implement the function to meet the requirement to provide appropriate final status information. Typically, on active object completion, it will store progress information in a private member, and return that stored information from this function.

Gets the operation ID.

This ID is unique within a Message Server session. The ID allows the client to keep track of different operations.

Gets the UID of the MTM associated with the operation.

This UID can be used to determine the appropriate method of getting information from a progress descriptor.

The default implementation returns iMtm.

ProgressL()

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.

Gets the ID of the service that is associated with this operation.

If the operation is not associated with a service, the function returns KMsvLocalServiceIndexEntryId.

This call leads to calling SystemProgress() in the server to populate the TMsvSystemProgress structure.

Message Server session used by object. This is set by the constructor.

The UID of the MTM associated with the operation.

The appropriate value should be set by the derived class constructor.

Mtm()

Request status of the operation observer.

This is the aObserverRequestStatus passed in the constructor.

The ID of the service that is associated with this operation.

Usually, the derived class constructor will contain a suitable argument to allow the caller to set this.

Service()