Collapse all Symbian^3 Product Developer Library

CAgentBase Class Reference

class CAgentBase : public CNifAgentBase

Base class for agents that access commdb and use overrides

since v9.5. Use MCPRs/CPRs/SCPRs instead of agents.

Inherits from

CAgentBase
- CNifAgentBase
  - CBase

Public Member Functions
	~CAgentBase()
IMPORT_C void	Authenticate(TDes &, TDes &)
IMPORT_C void	CancelAuthenticate()
IMPORT_C void	CancelReconnect()
IMPORT_C void	CancelRequestNotificationOfServiceChange(MAgentSessionNotify *)
IMPORT_C TConnectionSettings &	ConnectionSettingsL()
IMPORT_C TBool	IsActive()
IMPORT_C void	MDPOAuthenticateComplete(TInt)
IMPORT_C CStoreableOverrideSettings *	OverridesL()
IMPORT_C void	Reconnect()
IMPORT_C void	ReconnectComplete(TInt)
IMPORT_C void	RequestNotificationOfServiceChangeL(MAgentSessionNotify *)
IMPORT_C void	SelectComplete(const TDesC &)
IMPORT_C void	SelectComplete(TInt)
IMPORT_C void	ServiceChangeNotification(TUint32, const TDesC &)
IMPORT_C void	SetConnectionSettingsL(const TConnectionSettings &)
IMPORT_C void	SetOverridesL(CStoreableOverrideSettings *)

Protected Member Functions
	CAgentBase()
IMPORT_C void	ConstructL()
IMPORT_C TInt	DoCheckReadCapability(const TDesC &, const RMessagePtr2 *)
IMPORT_C TInt	DoCheckWriteCapability(const TDesC &, const RMessagePtr2 *)
IMPORT_C TInt	DoReadBool(const TDesC &, TBool &, const RMessagePtr2 *)
IMPORT_C TInt	DoReadDes(const TDesC &, TDes8 &, const RMessagePtr2 *)
IMPORT_C TInt	DoReadDes(const TDesC &, TDes16 &, const RMessagePtr2 *)
IMPORT_C TInt	DoReadInt(const TDesC &, TUint32 &, const RMessagePtr2 *)
IMPORT_C HBufC *	DoReadLongDesLC(const TDesC &, const RMessagePtr2 *)
IMPORT_C TInt	DoWriteBool(const TDesC &, TBool, const RMessagePtr2 *)
IMPORT_C TInt	DoWriteDes(const TDesC &, const TDesC8 &, const RMessagePtr2 *)
IMPORT_C TInt	DoWriteDes(const TDesC &, const TDesC16 &, const RMessagePtr2 *)
IMPORT_C TInt	DoWriteInt(const TDesC &, TUint32, const RMessagePtr2 *)

Private Member Functions
TInt	AuthenticateCb(TAny *)
CDialogProcessor *	DialogProcessor()

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()
	CNifAgentBase::CNifAgentBase()
	CNifAgentBase::CancelConnect()
	CNifAgentBase::CheckReadCapability(const TDesC &,const RMessagePtr2 *)
	CNifAgentBase::CheckWriteCapability(const TDesC &,const RMessagePtr2 *)
	CNifAgentBase::Connect(TAgentConnectType)
	CNifAgentBase::Connect(TAgentConnectType,CStoreableOverrideSettings *)
	CNifAgentBase::Control(TUint,TUint,TDes8 &)
	CNifAgentBase::Control(TUint,TUint,TDes8 &,const RProcess &)
	CNifAgentBase::Disconnect(TInt)
	CNifAgentBase::GetExcessData(TDes8 &)
	CNifAgentBase::GetLastError(TInt &)
	CNifAgentBase::IncomingConnectionReceived()
	CNifAgentBase::Info(TNifAgentInfo &)const
	CNifAgentBase::IsReconnect()const
	CNifAgentBase::Notification(TNifToAgentEventType,TAny *)
	CNifAgentBase::ReadBool(const TDesC &,TBool &)
	CNifAgentBase::ReadBool(const TDesC &,TBool &,const RMessagePtr2 *)
	CNifAgentBase::ReadDes(const TDesC &,TDes16 &)
	CNifAgentBase::ReadDes(const TDesC &,TDes16 &,const RMessagePtr2 *)
	CNifAgentBase::ReadDes(const TDesC &,TDes8 &)
	CNifAgentBase::ReadDes(const TDesC &,TDes8 &,const RMessagePtr2 *)
	CNifAgentBase::ReadInt(const TDesC &,TUint32 &)
	CNifAgentBase::ReadInt(const TDesC &,TUint32 &,const RMessagePtr2 *)
	CNifAgentBase::ReadLongDesLC(const TDesC &)
	CNifAgentBase::ReadLongDesLC(const TDesC &,const RMessagePtr2 *)
	CNifAgentBase::WriteBool(const TDesC &,TBool)
	CNifAgentBase::WriteBool(const TDesC &,TBool,const RMessagePtr2 *)
	CNifAgentBase::WriteDes(const TDesC &,const TDesC16 &)
	CNifAgentBase::WriteDes(const TDesC &,const TDesC16 &,const RMessagePtr2 *)
	CNifAgentBase::WriteDes(const TDesC &,const TDesC8 &)
	CNifAgentBase::WriteDes(const TDesC &,const TDesC8 &,const RMessagePtr2 *)
	CNifAgentBase::WriteInt(const TDesC &,TUint32)
	CNifAgentBase::WriteInt(const TDesC &,TUint32,const RMessagePtr2 *)

Protected Attributes
CAsyncCallBack *	iAuthenticateCallback
TInt	iAuthenticateError
CCommsDbAccess *	iDatabase
CDialogProcessor *	iDlgPrc
CStoreableOverrideSettings *	iOverrides
RPointerArray< MAgentSessionNotify >	iServiceChangeNotification
TConnectionSettings	iSettings

Inherited Attributes
	CNifAgentBase::iNotify

Constructor & Destructor Documentation

CAgentBase()

IMPORT_C

CAgentBase

(

)

[protected]

~CAgentBase()

IMPORT_C

~CAgentBase

(

)

[virtual]

Member Functions Documentation

Authenticate(TDes &, TDes &)

IMPORT_C void	Authenticate	(	TDes &	aUsername,
			TDes &	aPassword
		)	[virtual]

Parameters

TDes & aUsername
TDes & aPassword

AuthenticateCb(TAny *)

TInt

AuthenticateCb

(

TAny *

aThisPtr

)

[private, static]

Parameters

TAny * aThisPtr

CancelAuthenticate()

IMPORT_C void

CancelAuthenticate

(

)

[virtual]

CancelReconnect()

IMPORT_C void

CancelReconnect

(

)

[virtual]

CancelRequestNotificationOfServiceChange(MAgentSessionNotify *)

IMPORT_C void

CancelRequestNotificationOfServiceChange

(

MAgentSessionNotify *

aSession

)

[virtual]

Parameters

MAgentSessionNotify * aSession

ConnectionSettingsL()

IMPORT_C TConnectionSettings &

ConnectionSettingsL

(

)

[virtual]

ConstructL()

IMPORT_C void

ConstructL

(

)

[protected]

DialogProcessor()

CDialogProcessor *

DialogProcessor

(

)

[private, inline]

DoCheckReadCapability(const TDesC &, const RMessagePtr2 *)

IMPORT_C TInt	DoCheckReadCapability	(	const TDesC &	aField,
			const RMessagePtr2 *	aMessage
		)	[protected, virtual]

Check that a client has the required capabilties to read a field

Parameters

const TDesC & aField	the name of the field to read
const RMessagePtr2 * aMessage	Message containing the capabilities of the client

DoCheckWriteCapability(const TDesC &, const RMessagePtr2 *)

IMPORT_C TInt	DoCheckWriteCapability	(	const TDesC &	aField,
			const RMessagePtr2 *	aMessage
		)	[protected, virtual]

Check that a client has the required capabilties to write a field

Parameters

const TDesC & aField	the name of the field to write
const RMessagePtr2 * aMessage	Message containing the capabilities of the client

DoReadBool(const TDesC &, TBool &, const RMessagePtr2 *)

IMPORT_C TInt	DoReadBool	(	const TDesC &	aField,
			TBool &	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, virtual]

Read an boolean field from the connection settings provider

Parameters

const TDesC & aField	The name of the field to read
TBool & aValue	On return, contains the value of the field read
const RMessagePtr2 * aMessage

DoReadDes(const TDesC &, TDes8 &, const RMessagePtr2 *)

IMPORT_C TInt	DoReadDes	(	const TDesC &	aField,
			TDes8 &	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, virtual]

Read a 8-bit descriptor field from the connection settings provider

Parameters

const TDesC & aField	The name of the field to read
TDes8 & aValue	On return, contains the value of the field read
const RMessagePtr2 * aMessage

DoReadDes(const TDesC &, TDes16 &, const RMessagePtr2 *)

IMPORT_C TInt	DoReadDes	(	const TDesC &	aField,
			TDes16 &	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, virtual]

Write an 8-bit descriptor field to the connection settings provider

Parameters

const TDesC & aField	The name of the field to which to write
TDes16 & aValue	The value to be written to the field
const RMessagePtr2 * aMessage

DoReadInt(const TDesC &, TUint32 &, const RMessagePtr2 *)

IMPORT_C TInt	DoReadInt	(	const TDesC &	aField,
			TUint32 &	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, virtual]

Read an integer field from the connection settings provider

Parameters

const TDesC & aField	The name of the field to read
TUint32 & aValue	On return, contains the value of the field read
const RMessagePtr2 * aMessage

DoReadLongDesLC(const TDesC &, const RMessagePtr2 *)

IMPORT_C HBufC *	DoReadLongDesLC	(	const TDesC &	aField,
			const RMessagePtr2 *	aMessage
		)	[protected, virtual]

Read a 16-bit descriptor field of unknown size from the connection settings provider

Since: v7.0s

Parameters

const TDesC & aField	The name of the field to read
const RMessagePtr2 * aMessage

DoWriteBool(const TDesC &, TBool, const RMessagePtr2 *)

IMPORT_C TInt	DoWriteBool	(	const TDesC &	aField,
			TBool	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, virtual]

Write an boolean field to the connection settings provider

Parameters

const TDesC & aField	The name of the field to which to write
TBool aValue	The value to be written to the field
const RMessagePtr2 * aMessage

DoWriteDes(const TDesC &, const TDesC8 &, const RMessagePtr2 *)

IMPORT_C TInt	DoWriteDes	(	const TDesC &	aField,
			const TDesC8 &	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, virtual]

Read a 16-bit descriptor field from the connection settings provider

Parameters

const TDesC & aField	The name of the field to read
const TDesC8 & aValue	On return, contains the value of the field read
const RMessagePtr2 * aMessage

DoWriteDes(const TDesC &, const TDesC16 &, const RMessagePtr2 *)

IMPORT_C TInt	DoWriteDes	(	const TDesC &	aField,
			const TDesC16 &	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, virtual]

Write an 16-bit descriptor field to the connection settings provider

Parameters

const TDesC & aField	The name of the field to which to write
const TDesC16 & aValue	The value to be written to the field
const RMessagePtr2 * aMessage

DoWriteInt(const TDesC &, TUint32, const RMessagePtr2 *)

IMPORT_C TInt	DoWriteInt	(	const TDesC &	aField,
			TUint32	aValue,
			const RMessagePtr2 *	aMessage
		)	[protected, virtual]

Write an integer field to the connection settings provider

Parameters

const TDesC & aField	The name of the field to which to write
TUint32 aValue	The value to be written to the field
const RMessagePtr2 * aMessage

IsActive()

IMPORT_C TBool

IsActive

(

)

const [virtual]

MDPOAuthenticateComplete(TInt)

IMPORT_C void

MDPOAuthenticateComplete

(

TInt

aError

)

[virtual]

Parameters

TInt aError

OverridesL()

IMPORT_C CStoreableOverrideSettings *

OverridesL

(

)

[virtual]

Reconnect()

IMPORT_C void

Reconnect

(

)

[virtual]

ReconnectComplete(TInt)

IMPORT_C void

ReconnectComplete

(

TInt

aError

)

[virtual]

Parameters

TInt aError

RequestNotificationOfServiceChangeL(MAgentSessionNotify *)

IMPORT_C void

RequestNotificationOfServiceChangeL

(

MAgentSessionNotify *

aSession

)

[virtual]

Parameters

MAgentSessionNotify * aSession

SelectComplete(const TDesC &)

IMPORT_C void

SelectComplete

(

const TDesC &

aName

)

[virtual]

Parameters

const TDesC & aName

SelectComplete(TInt)

IMPORT_C void

SelectComplete

(

TInt

aError

)

[virtual]

Parameters

TInt aError

ServiceChangeNotification(TUint32, const TDesC &)

IMPORT_C void	ServiceChangeNotification	(	TUint32	aId,
			const TDesC &	aType
		)	[virtual]

Parameters

TUint32 aId
const TDesC & aType

SetConnectionSettingsL(const TConnectionSettings &)

IMPORT_C void

SetConnectionSettingsL

(

const TConnectionSettings &

aSettings

)

[virtual]

Parameters

const TConnectionSettings & aSettings

SetOverridesL(CStoreableOverrideSettings *)

IMPORT_C void

SetOverridesL

(

CStoreableOverrideSettings *

aOverrideSettings

)

[virtual]

Parameters

CStoreableOverrideSettings * aOverrideSettings

Member Data Documentation

CAsyncCallBack * iAuthenticateCallback

CAsyncCallBack *

iAuthenticateCallback

[protected]

TInt iAuthenticateError

TInt

iAuthenticateError

[protected]

CCommsDbAccess * iDatabase

CCommsDbAccess *

iDatabase

[protected]

CDialogProcessor * iDlgPrc

CDialogProcessor *

iDlgPrc

[protected]

CStoreableOverrideSettings * iOverrides

CStoreableOverrideSettings *

iOverrides

[protected]

RPointerArray< MAgentSessionNotify > iServiceChangeNotification

RPointerArray< MAgentSessionNotify >

iServiceChangeNotification

[protected]

TConnectionSettings iSettings

TConnectionSettings

iSettings

[protected]