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

Public Member Functions
~CAgentBase()
IMPORT_C voidAuthenticate(TDes &, TDes &)
IMPORT_C voidCancelAuthenticate()
IMPORT_C voidCancelReconnect()
IMPORT_C voidCancelRequestNotificationOfServiceChange(MAgentSessionNotify *)
IMPORT_C TConnectionSettings &ConnectionSettingsL()
IMPORT_C TBoolIsActive()
IMPORT_C voidMDPOAuthenticateComplete(TInt)
IMPORT_C CStoreableOverrideSettings *OverridesL()
IMPORT_C voidReconnect()
IMPORT_C voidReconnectComplete(TInt)
IMPORT_C voidRequestNotificationOfServiceChangeL(MAgentSessionNotify *)
IMPORT_C voidSelectComplete(const TDesC &)
IMPORT_C voidSelectComplete(TInt)
IMPORT_C voidServiceChangeNotification(TUint32, const TDesC &)
IMPORT_C voidSetConnectionSettingsL(const TConnectionSettings &)
IMPORT_C voidSetOverridesL(CStoreableOverrideSettings *)
Protected Member Functions
CAgentBase()
IMPORT_C voidConstructL()
IMPORT_C TIntDoCheckReadCapability(const TDesC &, const RMessagePtr2 *)
IMPORT_C TIntDoCheckWriteCapability(const TDesC &, const RMessagePtr2 *)
IMPORT_C TIntDoReadBool(const TDesC &, TBool &, const RMessagePtr2 *)
IMPORT_C TIntDoReadDes(const TDesC &, TDes8 &, const RMessagePtr2 *)
IMPORT_C TIntDoReadDes(const TDesC &, TDes16 &, const RMessagePtr2 *)
IMPORT_C TIntDoReadInt(const TDesC &, TUint32 &, const RMessagePtr2 *)
IMPORT_C HBufC *DoReadLongDesLC(const TDesC &, const RMessagePtr2 *)
IMPORT_C TIntDoWriteBool(const TDesC &, TBool, const RMessagePtr2 *)
IMPORT_C TIntDoWriteDes(const TDesC &, const TDesC8 &, const RMessagePtr2 *)
IMPORT_C TIntDoWriteDes(const TDesC &, const TDesC16 &, const RMessagePtr2 *)
IMPORT_C TIntDoWriteInt(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_CCAgentBase()[protected]

~CAgentBase()

IMPORT_C~CAgentBase()[virtual]

Member Functions Documentation

Authenticate(TDes &, TDes &)

IMPORT_C voidAuthenticate(TDes &aUsername,
TDes &aPassword
)[virtual]

Parameters

TDes & aUsername
TDes & aPassword

AuthenticateCb(TAny *)

TInt AuthenticateCb(TAny *aThisPtr)[private, static]

Parameters

TAny * aThisPtr

CancelAuthenticate()

IMPORT_C voidCancelAuthenticate()[virtual]

CancelReconnect()

IMPORT_C voidCancelReconnect()[virtual]

CancelRequestNotificationOfServiceChange(MAgentSessionNotify *)

IMPORT_C voidCancelRequestNotificationOfServiceChange(MAgentSessionNotify *aSession)[virtual]

Parameters

MAgentSessionNotify * aSession

ConnectionSettingsL()

IMPORT_C TConnectionSettings &ConnectionSettingsL()[virtual]

ConstructL()

IMPORT_C voidConstructL()[protected]

DialogProcessor()

CDialogProcessor *DialogProcessor()[private, inline]

DoCheckReadCapability(const TDesC &, const RMessagePtr2 *)

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

Check that a client has the required capabilties to read a field KErrNone, if the client has the required capabilites, otherwise one of the standard Symbian OS error codes

Parameters

const TDesC & aFieldthe name of the field to read
const RMessagePtr2 * aMessageMessage containing the capabilities of the client

DoCheckWriteCapability(const TDesC &, const RMessagePtr2 *)

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

Check that a client has the required capabilties to write a field KErrNone, if the client has the required capabilites, otherwise one of the standard Symbian OS error codes

Parameters

const TDesC & aFieldthe name of the field to write
const RMessagePtr2 * aMessageMessage containing the capabilities of the client

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

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

Read an boolean field from the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes

Parameters

const TDesC & aFieldThe name of the field to read
TBool & aValueOn return, contains the value of the field read
const RMessagePtr2 * aMessage

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

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

Read a 8-bit descriptor field from the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes

Parameters

const TDesC & aFieldThe name of the field to read
TDes8 & aValueOn return, contains the value of the field read
const RMessagePtr2 * aMessage

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

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

Write an 8-bit descriptor field to the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes

Parameters

const TDesC & aFieldThe name of the field to which to write
TDes16 & aValueThe value to be written to the field
const RMessagePtr2 * aMessage

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

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

Read an integer field from the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes

Parameters

const TDesC & aFieldThe name of the field to read
TUint32 & aValueOn 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 The value of the field read

v7.0s

Parameters

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

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

IMPORT_C TIntDoWriteBool(const TDesC &aField,
TBoolaValue,
const RMessagePtr2 *aMessage
)[protected, virtual]

Write an boolean field to the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes

Parameters

const TDesC & aFieldThe name of the field to which to write
TBool aValueThe value to be written to the field
const RMessagePtr2 * aMessage

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

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

Read a 16-bit descriptor field from the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes

Parameters

const TDesC & aFieldThe name of the field to read
const TDesC8 & aValueOn return, contains the value of the field read
const RMessagePtr2 * aMessage

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

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

Write an 16-bit descriptor field to the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes

Parameters

const TDesC & aFieldThe name of the field to which to write
const TDesC16 & aValueThe value to be written to the field
const RMessagePtr2 * aMessage

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

IMPORT_C TIntDoWriteInt(const TDesC &aField,
TUint32aValue,
const RMessagePtr2 *aMessage
)[protected, virtual]

Write an integer field to the connection settings provider KErrNone, if successful; otherwise one of the standard Symbian OS error codes

Parameters

const TDesC & aFieldThe name of the field to which to write
TUint32 aValueThe value to be written to the field
const RMessagePtr2 * aMessage

IsActive()

IMPORT_C TBoolIsActive()const [virtual]

MDPOAuthenticateComplete(TInt)

IMPORT_C voidMDPOAuthenticateComplete(TIntaError)[virtual]

Parameters

TInt aError

OverridesL()

IMPORT_C CStoreableOverrideSettings *OverridesL()[virtual]

Reconnect()

IMPORT_C voidReconnect()[virtual]

ReconnectComplete(TInt)

IMPORT_C voidReconnectComplete(TIntaError)[virtual]

Parameters

TInt aError

RequestNotificationOfServiceChangeL(MAgentSessionNotify *)

IMPORT_C voidRequestNotificationOfServiceChangeL(MAgentSessionNotify *aSession)[virtual]

Parameters

MAgentSessionNotify * aSession

SelectComplete(const TDesC &)

IMPORT_C voidSelectComplete(const TDesC &aName)[virtual]

Parameters

const TDesC & aName

SelectComplete(TInt)

IMPORT_C voidSelectComplete(TIntaError)[virtual]

Parameters

TInt aError

ServiceChangeNotification(TUint32, const TDesC &)

IMPORT_C voidServiceChangeNotification(TUint32aId,
const TDesC &aType
)[virtual]

Parameters

TUint32 aId
const TDesC & aType

SetConnectionSettingsL(const TConnectionSettings &)

IMPORT_C voidSetConnectionSettingsL(const TConnectionSettings &aSettings)[virtual]

Parameters

const TConnectionSettings & aSettings

SetOverridesL(CStoreableOverrideSettings *)

IMPORT_C voidSetOverridesL(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]