Class CClientMtmRegistry

class CClientMtmRegistry : public CObserverRegistry;

Description

Accesses the Client-side MTM registry.

This registry holds details of the all the Client-side MTMs currently available on the system. Message client applications use this class to get a CBaseMtm-derived object by which to access Client-side MTM functionality.

Note that the base class CMtmDllRegistry provides functions for discovering what MTMs are present in the registry.

Derivation

• MMsvSessionObserver - Provides the interface for notification of events from a Message Server session.
• CMtmDllRegistry - No description.

• CObserverRegistry - Base class for client, UI and UI data MTM registries.

• CClientMtmRegistry - Accesses the Client-side MTM registry.

Members

Defined in CClientMtmRegistry:

• NewL(CMsvSession &,TTimeIntervalMicroSeconds32)Gets a CClientMtmRegistry object. The client should delete this object when it i...
• NewMtmL(TUid)Creates a Client-side MTM object for the specified MTM UID.
• ~CClientMtmRegistry()Destructor.

Inherited from CObserverRegistry:

• CObserverRegistry(CMsvSession &,TUid,TTimeIntervalMicroSeconds32)Constructor.
• ConstructL()Second-phase constructor.
• HandleSessionEventL(TMsvSessionEvent,TAny *,TAny *,TAny *)Implements the session observer interface to update the registry information whe...
• iIsAdded
• iMsvSession

Inherited from MMsvSessionObserver:

• EMsvCloseSessionThe client should immediately close the session with the Message Server.
• EMsvCorruptedIndexRebuildingThe Message Server has started to rebuild its index after it has been corrupted.
• EMsvCorruptedIndexRebuiltThe Message Server index had been corrupted and had to be rebuilt.
• EMsvEntriesChangedOne or more index entries have been changed.
• EMsvEntriesCreatedOne or more entries have been created.
• EMsvEntriesDeletedOne or more entries have been deleted.
• EMsvEntriesMovedOne or more entries have been moved.
• EMsvGeneralErrorSomething has happening in the server, but this client was unable to retrieve th...
• EMsvMediaAvailableThe disk containing the Message Store is available again.
• EMsvMediaChangedThe Message Server has automatically changed the index location to use the inter...
• EMsvMediaIncorrectAn incorrect disk is inserted.
• EMsvMediaUnavailableThe media (disk) containing the Message Server index has been removed.
• EMsvMtmGroupDeInstalledA MTM has been uninstalled.
• EMsvMtmGroupInstalledA new MTM has been installed.
• EMsvServerFailedToStartReceived after a client has used CMsvSession::OpenAsyncL(MMsvSessionObserver &am...
• EMsvServerReadyReceived after a client has used CMsvSession::OpenAsyncL(MMsvSessionObserver &am...
• EMsvServerTerminatedThe Message Server has been terminated.
• TMsvSessionEventSession event type.

Related Topics

 » Symbian OS v9.4 » Examples » Messaging example code » Imap4Example: An Email manager using IMAP4 and SMTP

• Imap4Example: An Email manager using IMAP4 and SMTP » Class summary

 » Symbian OS v9.4 » Examples » Messaging example code » Pop3Example: An Email manager using POP3 and SMTP

• Pop3Example: An Email manager using POP3 and SMTP » Class summary

IMPORT_C static CClientMtmRegistry* NewL(CMsvSession &aMsvSession, TTimeIntervalMicroSeconds32 aTimeoutMicroSeconds32=TTimeIntervalMicroSeconds32(30000000));

Description

Gets a CClientMtmRegistry object. The client should delete this object when it is no longer required.

The registry keeps a reference count of the number of instances of each MTM in use. When that reference count falls to zero, the DLL that provides the MTM is unloaded. However, this is not done immediately, but only after the time specified in aTimeoutMicroSeconds32. This increases efficiency in cases where the DLL is required again shortly.

Parameters

CMsvSession &aMsvSession The client's Message Server session TTimeIntervalMicroSeconds32 aTimeoutMicroSeconds32 Time to wait before unloading MTM DLLs

Return value

CClientMtmRegistry * A pointer to a newly allocated and initialised object

Leave codes

KErrNoMemory A memory allocation failed

IMPORT_C ~CClientMtmRegistry();

Description

Destructor.

IMPORT_C CBaseMtm* NewMtmL(TUid aMtmTypeUid);

Description

Creates a Client-side MTM object for the specified MTM UID.

The client should delete the returned object when it is no longer required.

Parameters

TUid aMtmTypeUid UID of MTM to obtain

Return value

CBaseMtm * Client-side MTM object for specified MTM

Leave codes

KErrNotFound aMtmTypeUid does not specify a registered MTM KErrNoMemory A memory allocation failed KErrBadLibraryEntryPoint Malformed MTM: a library entry point was not of the required type DLL loading error codes The DLL that provides the MTM cannot be loaded