Collapse all Symbian^3 Application Developer Library

RConfigDaemon Class Reference

class RConfigDaemon : public RAsyncConnectBase

The RConfigDaemon class Implements the Symbian OS Configuration daemon Client API

Inherits from

RConfigDaemon
- RAsyncConnectBase
  - RSessionBase
    - RHandleBase

Public Member Functions
void	Cancel ( TRequestStatus &)
void	Cancel ( TUint , TRequestStatus &)
void	Configure (const TDes8 &, TRequestStatus &)
void	Deregister ( TInt , TDes8 *, TRequestStatus &)
void	Ioctl ( TUint , TUint , TRequestStatus &, TDes8 *)
void	LinkLayerDown ()
void	LinkLayerUp ()
void	ProgressNotification ( TDaemonProgressBuf &, TRequestStatus &)
TVersion	Version ()

Inherited Functions
	RAsyncConnectBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus &)
	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

Member Functions Documentation

Cancel(TRequestStatus &)

void

Cancel

(

TRequestStatus &

aStatus

)

Cancels current request asynchronously => just one request at the time could be issued see CNifConfigurationControl::StoreClientStatus functinon in NIFConfigurationControl.cpp

Parameters

TRequestStatus & aStatus

- active object iStatus to complete

Cancel(TUint, TRequestStatus &)

void	Cancel	(	TUint	aOpMask,
			TRequestStatus &	aStatus
		)

Cancels an asynchronous operation. The operation to be canceled is specified in the mask.

Parameters

TUint aOpMask	Specifies the operation to be canceled
TRequestStatus & aStatus	active object iStatus to complete

Configure(const TDes8 &, TRequestStatus &)

void	Configure	(	const TDes8 &	aInfo,
			TRequestStatus &	aStatus
		)

The RConfigDaemon::Connect method

Connect the Handle to the Server Must be called before all other methods except Version()

Parameters

const TDes8 & aInfo	The startup info for the connection
TRequestStatus & aStatus	The request status of the active object to be completed

Deregister(TInt, TDes8 *, TRequestStatus &)

void	Deregister	(	TInt	aCause,
			TDes8 *	aActionStatus,
			TRequestStatus &	aStatus
		)

Issues a deregistration request.

Parameters

TInt aCause	Specifies what caused the deregister call (idle timer or Stop call)
TDes8 * aActionStatus	Returns the action to be executed by Nifman (shut down the NIF and the agent or keep them up)
TRequestStatus & aStatus	Active object iStatus to complete

Ioctl(TUint, TUint, TRequestStatus &, TDes8 *)

void	Ioctl	(	TUint	aOptionLevel,
			TUint	aOptionName,
			TRequestStatus &	aStatus,
			TDes8 *	aDes = NULL
		)

Issues an asynchronous command. Various option's levels & names could be supported by the loaded daemon

Parameters

TUint aOptionLevel	- Control level
TUint aOptionName	- Name of control request
TRequestStatus & aStatus	- active object iStatus to complete
TDes8 * aDes = NULL

LinkLayerDown()

void

LinkLayerDown

(

)

Informs the daemon of the start of link layer renegotiation.

LinkLayerUp()

void

LinkLayerUp

(

)

Informs the daemon of the completion of link layer renegotiation.

ProgressNotification(TDaemonProgressBuf &, TRequestStatus &)

void	ProgressNotification	(	TDaemonProgressBuf &	aProgress,
			TRequestStatus &	aStatus
		)

Issues a progress notification request. This request will be completed when the daemon has something to report.

Parameters

TDaemonProgressBuf & aProgress	Returns the progress information
TRequestStatus & aStatus	Active object iStatus to complete

Version()

TVersion

Version

(

)

const

The RConfigDaemon::Version method

Extract the version of the API