Class CRegisteredMtmDll

class CRegisteredMtmDll : public CTimer;

Description

Allows an MTM object to access registry information about itself.

Derivation

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

• CActive - The core class of the active object abstraction.

• CTimer - Base class for a timer active object.

• CRegisteredMtmDll - Allows an MTM object to access registry information about itself.

Members

Defined in CRegisteredMtmDll:

• MtmDllInfo()constGets the full registration data for the MTM.
• MtmDllRefCount()constGets the number of MTM objects instantiated from the registry.
• MtmTypeUid()constGets the MTM type UID.
• RunL()Handles an active object's request completion event.
• TechnologyTypeUid()constGets the technology type UID.
• ~CRegisteredMtmDll()

Inherited from CActive:

• CActive(TInt)Constructs the active object with the specified priority.
• Cancel()Cancels the wait for completion of an outstanding request.
• Deque()Removes the active object from the active scheduler's list of active objects.
• EPriorityHighA priority higher than EPriorityUserInput.
• EPriorityIdleA low priority, useful for active objects representing background processing.
• EPriorityLowA priority higher than EPriorityIdle but lower than EPriorityStandard.
• EPriorityStandardMost active objects will have this priority.
• EPriorityUserInputA priority higher than EPriorityStandard; useful for active objects handling use...
• Extension_(TUint,TAny *&,TAny *)Extension function
• IsActive()constDetermines whether the active object has a request outstanding.
• IsAdded()constDetermines whether the active object has been added to the active scheduler's li...
• Priority()constGets the priority of the active object.
• RunError(TInt)Handles a leave occurring in the request completion event handler CActive::RunL(...
• SetActive()Indicates that the active object has issued a request and that it is now outstan...
• SetPriority(TInt)Sets the priority of the active object.
• TPriorityDefines standard priorities for active objects.
• iStatusThe request status associated with an asynchronous request.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from CTimer:

• After(TTimeIntervalMicroSeconds32)Requests an event after an interval.
• At(const TTime &)Requests an event at a given local time.
• AtUTC(const TTime &)Requests an event at a given UTC time.
• CTimer(TInt)Protected constructor with priority.
• ConstructL()Constructs a new asynchronous timer.
• DoCancel()Implements cancellation of an outstanding request.
• HighRes(TTimeIntervalMicroSeconds32)Requests an event after the specified interval to a resolution of 1ms. The "...
• Inactivity(TTimeIntervalSeconds)Requests an event if no activity occurs within the specified interval.
• Lock(TTimerLockSpec)Requests an event on a specified second fraction.

IMPORT_C ~CRegisteredMtmDll();

Description

inline TUid MtmTypeUid() const;

Description

Gets the MTM type UID.

Return value

TUid MTM type UID

inline TUid TechnologyTypeUid() const;

Description

Gets the technology type UID.

Return value

TUid UID that indicates the messaging technology that the MTM group implements

inline const CMtmDllInfo& MtmDllInfo() const;

Description

Gets the full registration data for the MTM.

Return value

const CMtmDllInfo & Object encapsulating full registration data for the MTM

inline TInt MtmDllRefCount() const;

Description

Gets the number of MTM objects instantiated from the registry.

Return value

TInt Number of current instances of the MTM

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 CRegisteredMtmDll::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)

CRegisteredMtmDll::RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls CActive::RunError(TInt) 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 CRegisteredMtmDll::RunL() or CActive::RunError(TInt) functions.

See also:

• CActiveScheduler::Start()Starts a new wait loop under the control of the current active scheduler.
• CActiveScheduler::Error(TInt)constHandles the result of a leave occurring in an active object’s RunL() function.
• CActiveScheduler::WaitForAnyRequest()Wait for an asynchronous request to complete.