Collapse all Symbian^3 Application Developer Library

RRsConfigurator Class Reference

class RRsConfigurator : public RSessionBase

The client interface to the Configurator server. Allows e.g. the Comms Provider Modules to Load the Comms Process with desired modules and bindings on demand.

Inherits from

RRsConfigurator
- RSessionBase
  - RHandleBase

Public Member Functions
	RRsConfigurator ()
IMPORT_C void	CancelLoadCpm (const CommsFW::TCFModuleName &)
IMPORT_C void	CancelUnloadCpm (const CommsFW::TCFModuleName &)
IMPORT_C TInt	Connect ()
IMPORT_C TInt	EnumerateModules (const TCFGroupName &, RootServer::TRSIter &, CommsFW::TCFModuleName &)
IMPORT_C TInt	GetModuleIniData (const CommsFW::TCFModuleName &, TDes8 &, TInt &)
IMPORT_C void	LoadCpm (const CommsFW::TCFModuleName &, TRequestStatus &)
IMPORT_C void	UnloadCpm (const CommsFW::TCFModuleName &, RootServer::TRSUnLoadType , TRequestStatus &)

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::Close()
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Inherited Attributes
	RHandleBase::iHandle

Constructor & Destructor Documentation

RRsConfigurator()

IMPORT_C

RRsConfigurator

(

)

Default Constructor

Member Functions Documentation

CancelLoadCpm(const CommsFW::TCFModuleName &)

IMPORT_C void

CancelLoadCpm

(

const CommsFW::TCFModuleName &

aName

)

Cancels asynchronous loading of a comms Provider Module. There is no guarantee the module loading is canceled. A best effort is made and the asynchronous request waiting for the module to load returns with KErrCanceled on success. TCFModuleName

capability: NetworkControl

Parameters

const CommsFW::TCFModuleName & aName

Name of module which is loading.

CancelUnloadCpm(const CommsFW::TCFModuleName &)

IMPORT_C void

CancelUnloadCpm

(

const CommsFW::TCFModuleName &

aName

)

Cancel asynchronous unloading of a comms Provider Module. There is no guarantee the module unloading is canceled. A best effort is made and the asynchronous request waiting for the module to load returns KErrCanceled on success. TCFModuleName

capability: NetworkControl PowerMgmt

Parameters

const CommsFW::TCFModuleName & aName

Name of module which is unloading.

Connect()

IMPORT_C TInt

Connect

(

)

Use this function to open a session to the Configurator Server, which is used to load the modules on demand. Default number of message slots is defined in KDefaultMessageSlots. As with any server, the connection should be closed after use. RHandleBase provides the necessary Close() function, which should be called when the server session is no longer required.

capability: NetworkControl

EnumerateModules(const TCFGroupName &, RootServer::TRSIter &, CommsFW::TCFModuleName &)

IMPORT_C TInt	EnumerateModules	(	const TCFGroupName &	aGroupName,
			RootServer::TRSIter &	aPosition,
			CommsFW::TCFModuleName &	aModuleName
		)

Through repeated calls returns the list of module names that are associated with provided group name. TCFModuleName TCFGroupName

capability: NetworkControl

Parameters

const TCFGroupName & aGroupName	for which the module names have to be retrieved
RootServer::TRSIter & aPosition	Position in enumeration.
CommsFW::TCFModuleName & aModuleName

GetModuleIniData(const CommsFW::TCFModuleName &, TDes8 &, TInt &)

IMPORT_C TInt	GetModuleIniData	(	const CommsFW::TCFModuleName &	aModuleName,
			TDes8 &	aIniData,
			TInt &	aRequiredIniDataSize
		)

Gets you the module [inidata] section, which contains information specific to CPM

capability: NetworkControl

Parameters

const CommsFW::TCFModuleName & aModuleName
TDes8 & aIniData	contains inidata on return.
TInt & aRequiredIniDataSize	contains actual size of the inidata on return.Using this the caller may resize the buffer and use the method again in case of KErrOverflow.

LoadCpm(const CommsFW::TCFModuleName &, TRequestStatus &)

IMPORT_C void	LoadCpm	(	const CommsFW::TCFModuleName &	aName,
			TRequestStatus &	aStatus
		)

Launch a new Comms Provider Module on demand The name of the new CPM instance must be unique and must be used in any further communication concerning this CPM instance, such as binding. TCFModuleName

capability: NetworkControl

Parameters

const CommsFW::TCFModuleName & aName	Name of module to load.
TRequestStatus & aStatus

UnloadCpm(const CommsFW::TCFModuleName &, RootServer::TRSUnLoadType, TRequestStatus &)

IMPORT_C void	UnloadCpm	(	const CommsFW::TCFModuleName &	aName,
			RootServer::TRSUnLoadType	aType,
			TRequestStatus &	aStatus
		)

Unloads a Comms Provider Module. This interannly calls root server UnLoadCpm() method TCFModuleName TRSUnLoadType

capability: NetworkControl PowerMgmt

Parameters

const CommsFW::TCFModuleName & aName	Name of module to unload
RootServer::TRSUnLoadType aType	unload type ( Graceful/Optional/ungraceful/immediate)
TRequestStatus & aStatus	The request status used to contain completion information for the function.