Collapse all Symbian^3 Application Developer Library

CClientMtmRegistry Class Reference

class CClientMtmRegistry : public CObserverRegistry

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.

Inherits from

CClientMtmRegistry
- CObserverRegistry
  - CMtmDllRegistry
    - CBase

Public Member Functions
	~CClientMtmRegistry ()
IMPORT_C CClientMtmRegistry *	NewL ( CMsvSession &, TTimeIntervalMicroSeconds32 )
IMPORT_C CBaseMtm *	NewMtmL ( TUid )

Protected Member Functions
	CClientMtmRegistry ( CMsvSession &, TTimeIntervalMicroSeconds32 )
void	ConstructL ()

Private Member Functions
CBaseMtm *	DoNewMtmL (const RLibrary &, CRegisteredMtmDll &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CMtmDllRegistry::AddRegisteredMtmDll(TUid,TUid,const CMtmDllInfo &,MRegisteredMtmDllObserver &)
	CMtmDllRegistry::CMtmDllRegistry(RFs &,TUid,TTimeIntervalMicroSeconds32)
	CMtmDllRegistry::IsInUse()const
	CMtmDllRegistry::IsInUse(TUid)const
	CMtmDllRegistry::IsPresent(TUid)const
	CMtmDllRegistry::MtmTypeUid(TInt)const
	CMtmDllRegistry::MtmTypeUidToIndex(TUid)const
	CMtmDllRegistry::NumRegisteredMtmDlls()const
	CMtmDllRegistry::RegisteredMtmDllInfo(TUid)const
	CMtmDllRegistry::RemoveAllRegisteredMtmDlls()
	CMtmDllRegistry::RemoveRegisteredMtmDll(TUid)
	CMtmDllRegistry::TechnologyTypeUid(TUid)const
	CMtmDllRegistry::~CMtmDllRegistry()
	CObserverRegistry::CObserverRegistry(CMsvSession &,TUid,TTimeIntervalMicroSeconds32)
	CObserverRegistry::HandleSessionEventL(TMsvSessionEvent,TAny ,TAny ,TAny *)
	CObserverRegistry::~CObserverRegistry()

Inherited Attributes
	CMtmDllRegistry::iFs
	CMtmDllRegistry::iMtmDllTypeUid
	CMtmDllRegistry::iRegisteredMtmDllArray
	CMtmDllRegistry::iTimeoutMicroSeconds32
	CObserverRegistry::iIsAdded
	CObserverRegistry::iMsvSession

Constructor & Destructor Documentation

CClientMtmRegistry(CMsvSession &, TTimeIntervalMicroSeconds32)

CClientMtmRegistry	(	CMsvSession &	aMsvSession,
		TTimeIntervalMicroSeconds32	aTimeoutMicroSeconds32
	)	[protected]

Parameters

CMsvSession & aMsvSession
TTimeIntervalMicroSeconds32 aTimeoutMicroSeconds32

~CClientMtmRegistry()

IMPORT_C

~CClientMtmRegistry

(

)

Destructor.

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[protected]

Second-phase constructor.

DoNewMtmL(const RLibrary &, CRegisteredMtmDll &)

CBaseMtm *	DoNewMtmL	(	const RLibrary &	aLib,
			CRegisteredMtmDll &	aReg
		)	const [private]

Parameters

const RLibrary & aLib
CRegisteredMtmDll & aReg

NewL(CMsvSession &, TTimeIntervalMicroSeconds32)

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

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.

leave: KErrNoMemory A memory allocation failed

Parameters

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

NewMtmL(TUid)

IMPORT_C CBaseMtm *

NewMtmL

(

TUid

aMtmTypeUid

)

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

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

leave: KErrNotFound aMtmTypeUid does not specify a registered MTM

leave: KErrNoMemory A memory allocation failed

leave: KErrBadLibraryEntryPoint Malformed MTM: a library entry point was not of the required type

leave: DLL loading error codes The DLL that provides the MTM cannot be loaded

Parameters

TUid aMtmTypeUid

UID of MTM to obtain