Collapse all Symbian^3 Product Developer Library

CCmPluginBase Class Reference

class CCmPluginBase : public CBase

This class wraps the CCmPluginBaseEng class and is used instead of that in the framework and the 'R' classes. This way the CCmPluginBaseEng class could remain in the object pool after the CCmPluginBase object is deleted.

cmmanager.lib

Since: S60 v3.2

Inherits from

CCmPluginBase
- CBase

Public Member Functions
	CCmPluginBase(CCmPluginBaseEng *)
	~CCmPluginBase()
TBool	CanHandleIapIdL(TUint32)
TBool	CanHandleIapIdL(CommsDat::CCDIAPRecord *)
IMPORT_C void	CheckDNSServerAddressL(TBool, CommsDat::CMDBField< TDesC > &, CommsDat::CMDBField< TDesC > &, CommsDat::CMDBField< TBool > &)
IMPORT_C CCmManagerImpl &	CmMgr()
CCmManagerImpl *	Cmmgr()
IMPORT_C const TCmAttribConvTable *	ConvTableItem(TUint32)
IMPORT_C CCmPluginBase *	CreateCopyL()
CCmPluginBase *	CreateInstanceL(TCmPluginInitParam &)
IMPORT_C void	CreateNewL()
void	DecrementRefCounter()
IMPORT_C TBool	DeleteL(TBool, TBool)
IMPORT_C CCmDestinationImpl *	Destination()
IMPORT_C TBool	FeatureSupported(TInt)
void	FilterPossibleParentsL(RArray< TUint32 > &)
IMPORT_C void	GetAdditionalUids(RArray< TUint32 > &)
IMPORT_C TBool	GetBoolAttributeL(const TUint32)
IMPORT_C TUint32	GetIntAttributeL(const TUint32)
TInt	GetRefCounter()
IMPORT_C HBufC8 *	GetString8AttributeL(const TUint32)
IMPORT_C HBufC *	GetStringAttributeL(const TUint32)
IMPORT_C CommsDat::TMDBElementId	IAPRecordElementId()
void	IncrementRefCounter()
TBool	InitializeWithUiL(TBool)
IMPORT_C TBool	IsLinkedToIap(TUint32)
IMPORT_C TBool	IsLinkedToSnap(TUint32)
IMPORT_C TBool	IsProtected()
IMPORT_C void	LoadL(TUint32)
IMPORT_C TInt	NumOfConnMethodReferencesL()
IMPORT_C CCmDestinationImpl *	ParentDestination()
IMPORT_C CCmPluginBaseEng *	Plugin()
void	ReLoadL()
IMPORT_C void	RestoreAttributeL(const TUint32)
TInt	RunSettingsL()
IMPORT_C CommsDat::CMDBSession &	Session()
IMPORT_C void	SetBoolAttributeL(const TUint32, TBool)
IMPORT_C void	SetDNSServerAddressL(TUint32, const TDesC &, TUint32, const TDesC &, TUint32, TBool)
IMPORT_C void	SetIntAttributeL(const TUint32, TUint32)
void	SetPlugin(CCmPluginBaseEng *)
TBool	SetProxyServerNameL(const TDesC &)
IMPORT_C void	SetString8AttributeL(const TUint32, const TDesC8 &)
IMPORT_C void	SetStringAttributeL(const TUint32, const TDesC16 &)
IMPORT_C void	UpdateL()

Protected Member Functions
IMPORT_C void	AddCommonConversionTableL(const TCmCommonAttrConvArrayItem *)
IMPORT_C void	AddConverstionTableL(CommsDat::CCDRecordBase *, TBool , const TCmAttribConvTable *)
IMPORT_C void	AddResourceFileL(const TDesC &)
void	AdditionalReset()
IMPORT_C HBufC *	AllocReadL(TInt)
void	BearerRecordIdLC(HBufC *&, TUint32 &)
IMPORT_C TBool	CheckIfAlreadyConnected()
IMPORT_C void	CheckIfNameModifiedL(CommsDat::CCDRecordBase *)
void	CommitTransactionL(TInt)
IMPORT_C void	ConstructL()
void	CopyAdditionalDataL(CCmPluginBaseEng &)
void	CreateAdditionalRecordsL()
void	CreateNewServiceRecordL()
void	DeleteAdditionalRecordsL()
IMPORT_C TInt	GlobalBearerPriority(const TDesC &)
IMPORT_C TInt	GlobalUiBearerPriority(const TDesC &)
void	LoadAdditionalRecordsL()
IMPORT_C void	LoadServiceSettingL()
void	OpenTransactionLC()
void	PrepareToCopyDataL(CCmPluginBaseEng &)
void	PrepareToDeleteRecordsL()
IMPORT_C void	PrepareToLoadRecordsL()
IMPORT_C void	PrepareToUpdateRecordsL()
IMPORT_C void	RemoveCommonConversionTable(const TCmCommonAttrConvArrayItem *)
IMPORT_C void	RemoveConversionTable(const TCmAttribConvTable *)
IMPORT_C void	RemoveResourceFile(const TDesC &)
IMPORT_C void	Reset()
void	ServiceRecordIdLC(HBufC *&, TUint32 &)
void	UpdateAdditionalRecordsL()
IMPORT_C void	UpdateServiceRecordL()

Private Member Functions
TUint32	CheckForCommonAttribute(const TUint32)
TUint32	CommonAttribute(const TUint32)
void	CopyAttributes(CommsDat::CCDRecordBase , CommsDat::CCDRecordBase )
void	DoLoadL(TUint32)
void	EnableChargeCardL(TBool)
void	EnableLocationL(TBool)
void	EnableProxyL(TBool)
TValidationFunctionL	FindFieldL(TUint32, TCMFieldTypes, CommsDat::CMDBElement *&)
CCDIAPMetadataRecord *	FindSeamlessnessRecordL()
CommsDat::CCDWAPIPBearerRecord *	FindWAPRecordL()
TUint32	GetLocationIdL()
void	LoadChargeCardSettingL(TUint32)
void	LoadIAPRecordL(TUint32)
void	LoadLocationSettingL()
void	LoadNetworkSettingL()
void	LoadProxySettingL()
void	LoadSeamlessnessRecordL()
void	LoadWapRecordL()
CCDIAPMetadataRecord *	NewSeamlessnessRecordL(TBool)
void	NewWapRecordL()
void	SetAttribute(CommsDat::CCDRecordBase *, TUint32, TBool)
void	UpdateChargeCardRecordL()
void	UpdateConnPrefSettingL()
void	UpdateIAPRecordL()
void	UpdateLocationRecordL()
void	UpdateNetworkRecordL()
void	UpdateProxyRecordL()
void	UpdateSeamlessnessRecordL()
void	UpdateWapRecordL()

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()

Private Attributes
CCmPluginBaseEng *	iPlugin

Constructor & Destructor Documentation

CCmPluginBase(CCmPluginBaseEng *)

IMPORT_C

CCmPluginBase

(

CCmPluginBaseEng *

plugin

)

Constructor

Parameters

CCmPluginBaseEng * plugin

~CCmPluginBase()

IMPORT_C

~CCmPluginBase

(

)

Destructor.

Member Functions Documentation

AddCommonConversionTableL(const TCmCommonAttrConvArrayItem *)

IMPORT_C void

AddCommonConversionTableL

(

const TCmCommonAttrConvArrayItem *

aConvTable

)

[protected]

Parameters

const TCmCommonAttrConvArrayItem * aConvTable

AddConverstionTableL(CommsDat::CCDRecordBase **, TBool , const TCmAttribConvTable )

IMPORT_C void	AddConverstionTableL	(	CommsDat::CCDRecordBase **	aRecord,
			TBool *	aEnabled,
			const TCmAttribConvTable *	aConvTable
		)	[protected]

Parameters

CommsDat::CCDRecordBase ** aRecord
TBool * aEnabled
const TCmAttribConvTable * aConvTable

AddResourceFileL(const TDesC &)

IMPORT_C void

AddResourceFileL

(

const TDesC &

aName

)

[protected]

Add file name to the resource file array. Open it and/or increment reference count.

Parameters

const TDesC & aName

resource file name

AdditionalReset()

void

AdditionalReset

(

)

[protected]

Plug-in implementation can make its on cleanup in this function. Always called from LoadL() and should be called from plugin's destructor.

AllocReadL(TInt)

IMPORT_C HBufC *

AllocReadL

(

TInt

aResourceId

)

const [protected]

Read string from resource file. Resource file has to be opened prior this by calling AddResourceFileL().

Parameters

TInt aResourceId

BearerRecordIdLC(HBufC *&, TUint32 &)

void	BearerRecordIdLC	(	HBufC *&	aBearerName,
			TUint32 &	aRecordId
		)	[protected]

Return the bearer table name and record id of this connection in the bearer table.

Parameters

HBufC *& aBearerName
TUint32 & aRecordId

CanHandleIapIdL(TUint32)

TBool

CanHandleIapIdL

(

TUint32

aIapId

)

const

Checks if the plug-in can handle the given AP.

Parameters

TUint32 aIapId

IAPId of the AP to be checked

CanHandleIapIdL(CommsDat::CCDIAPRecord *)

TBool

CanHandleIapIdL

(

CommsDat::CCDIAPRecord *

aIapRecord

)

const

Checks if the plug-in can handle the given AP.

Parameters

CommsDat::CCDIAPRecord * aIapRecord

IAP record to be checked

CheckDNSServerAddressL(TBool, CommsDat::CMDBField< TDesC > &, CommsDat::CMDBField< TDesC > &, CommsDat::CMDBField< TBool > &)

IMPORT_C void	CheckDNSServerAddressL	(	TBool	aIPv6,
			CommsDat::CMDBField< TDesC > &	aDNS1,
			CommsDat::CMDBField< TDesC > &	aDNS2,
			CommsDat::CMDBField< TBool > &	aDNSFromServer
		)

Plugins can check DNS setting with this function. Suggested to be called from PrepareToUpdateRecordsL(). It checked the DNS server addresses, moves secord into first if first is dynamic, and update DNSFromServer field according to address values.

Parameters

TBool aIPv6	passed DNS server address are in IPv6 form
CommsDat::CMDBField< TDesC > & aDNS1	secord DNS server address
CommsDat::CMDBField< TDesC > & aDNS2
CommsDat::CMDBField< TBool > & aDNSFromServer	DNS address from server flag

CheckForCommonAttribute(const TUint32)

TUint32

CheckForCommonAttribute

(

const TUint32

aAttribute

)

const [private]

Search for common attribute and convert it to plugin specific one.

Parameters

const TUint32 aAttribute

common attribute id

CheckIfAlreadyConnected()

IMPORT_C TBool

CheckIfAlreadyConnected

(

)

const [protected]

Check if there's connection established with this connection method (IAP id).

CheckIfNameModifiedL(CommsDat::CCDRecordBase *)

IMPORT_C void

CheckIfNameModifiedL

(

CommsDat::CCDRecordBase *

aRecord

)

const [protected]

Checks if the ECmName attribute was set since the last update. If so, name is updated in passed record

Parameters

CommsDat::CCDRecordBase * aRecord

record to be checked against iIapRecord

CmMgr()

IMPORT_C CCmManagerImpl &

CmMgr

(

)

const

Returns a pointer to the cmmanager

Cmmgr()

CCmManagerImpl *

Cmmgr

(

)

Returns pointer to the CmManager object

CommitTransactionL(TInt)

void

CommitTransactionL

(

TInt

aError

)

[protected]

Commit transaction.

Parameters

TInt aError

- error id

CommonAttribute(const TUint32)

TUint32

CommonAttribute

(

const TUint32

aAttribute

)

const [private]

Returns the common attribute for the bearer specific attribute. Panics if there is no matching common attribute.

Parameters

const TUint32 aAttribute

bearer specific attribute

ConstructL()

IMPORT_C void

ConstructL

(

)

[protected]

Second phase constructor

ConvTableItem(TUint32)

IMPORT_C const TCmAttribConvTable *

ConvTableItem

(

TUint32

aAttribute

)

Return the coversion table item of the attribute

Parameters

TUint32 aAttribute

attribute of which conversion item is requested

CopyAdditionalDataL(CCmPluginBaseEng &)

void

CopyAdditionalDataL

(

CCmPluginBaseEng &

aDestInst

)

const [protected]

Copy data of the connection method that is not added to the conversion table. (e.g. bearer specific flags)

Parameters

CCmPluginBaseEng & aDestInst

copy attributes into this plugin instance

CopyAttributes(CommsDat::CCDRecordBase , CommsDat::CCDRecordBase )

void	CopyAttributes	(	CommsDat::CCDRecordBase *	aSrcRecord,
			CommsDat::CCDRecordBase *	aDstRecord
		)	[private]

Copy the attributes of the source record to the destination.

Parameters

CommsDat::CCDRecordBase * aSrcRecord	record of which attributes are copied
CommsDat::CCDRecordBase * aDstRecord

CreateAdditionalRecordsL()

void

CreateAdditionalRecordsL

(

)

[protected]

Plugin can create and initialize its bearer specific record(s) here. Do NOT store them in CommsDat yet.

CreateCopyL()

IMPORT_C CCmPluginBase *

CreateCopyL

(

)

const

Create a copy of the connection method:

CreateInstanceL()
CreateNewL()
PrepareToCopyDataL()
Copies data:
- name
- bearer type
- records added to the convertion table
Calls CopyAdditionalDataL().

CreateInstanceL(TCmPluginInitParam &)

CCmPluginBase *

CreateInstanceL

(

TCmPluginInitParam &

aInitParam

)

Create a new instance of the given bearer type plugin. Used from framework to avoid using slow ECom framework.

Parameters

TCmPluginInitParam & aInitParam

initialization data

CreateNewL()

IMPORT_C void

CreateNewL

(

)

Create a new connection method in memory. Call UpdateL() to store it in CommsDat. No transaction operation is performed.

Creates new WAP, IAP, Network records
CreateNewServiceRecordL()
CreateAdditionalRecordsL()
Loads default AP name from resource (R_CMMANAGERENG_DEFAULT_AP_NAME)

CreateNewServiceRecordL()

void

CreateNewServiceRecordL

(

)

[protected]

Plugin has to create and initialize its bearer specific object that points to the service record here. Pointer has to be stored in iServiceRecord data member. Do NOT store service record in CommsDat yet.

DecrementRefCounter()

void

DecrementRefCounter

(

)

Increments the reference counter. Used by the object pool.

DeleteAdditionalRecordsL()

void

DeleteAdditionalRecordsL

(

)

[protected]

Plugin can delete additional, bearer specific record with this function. Called from DeleteL().

DeleteL(TBool, TBool)

IMPORT_C TBool	DeleteL	(	TBool	aForced,
			TBool	aOneRefAllowed = ETrue
		)

Parameters

TBool aForced
TBool aOneRefAllowed = ETrue

Destination()

IMPORT_C CCmDestinationImpl *

Destination

(

)

const

Returns the CCmDestinationImpl* if this is an embedded destination CM. Otherwise returns NULL.

DoLoadL(TUint32)

void

DoLoadL

(

TUint32

aIapId

)

[private]

Parameters

TUint32 aIapId

EnableChargeCardL(TBool)

void

EnableChargeCardL

(

TBool

aEnable

)

[private]

Parameters

TBool aEnable

EnableLocationL(TBool)

void

EnableLocationL

(

TBool

aEnable

)

[private]

Parameters

TBool aEnable

EnableProxyL(TBool)

void

EnableProxyL

(

TBool

aEnable

)

[private]

Parameters

TBool aEnable

FeatureSupported(TInt)

IMPORT_C TBool

FeatureSupported

(

TInt

aFeature

)

[static]

Calls FeatureManager::FeatureSupported directly.

Since: 3.2

Parameters

TInt aFeature

feature ID

FilterPossibleParentsL(RArray< TUint32 > &)

void

FilterPossibleParentsL

(

RArray< TUint32 > &

aDests

)

Scans aDests for destinations that may be valid parents for this plugin and removes those that may not.

Parameters

RArray< TUint32 > & aDests

The array of destination IDs to be filtered.

FindFieldL(TUint32, TCMFieldTypes, CommsDat::CMDBElement *&)

TValidationFunctionL	FindFieldL	(	TUint32	aAttribute,
			TCMFieldTypes	aType,
			CommsDat::CMDBElement *&	aElement
		)	const [private]

Find field element associated with the passed attribute.

Parameters

TUint32 aAttribute	aatribute to find type of the attribute (e.g. bool, int or string)
TCMFieldTypes aType
CommsDat::CMDBElement *& aElement

FindSeamlessnessRecordL()

CCDIAPMetadataRecord *

FindSeamlessnessRecordL

(

)

[private]

FindWAPRecordL()

CommsDat::CCDWAPIPBearerRecord *

FindWAPRecordL

(

)

[private]

GetAdditionalUids(RArray< TUint32 > &)

IMPORT_C void

GetAdditionalUids

(

RArray< TUint32 > &

aIapIds

)

Appends uids of connection methods - which were also created during connection method creation - to the array given as parameter

Parameters

RArray< TUint32 > & aIapIds

the array the additonal cm uids are appended to

GetBoolAttributeL(const TUint32)

IMPORT_C TBool

GetBoolAttributeL

(

const TUint32

aAttribute

)

const

Gets the value for a TBool attribute.

Parameters

const TUint32 aAttribute

Identifies the attribute to be retrived.

GetIntAttributeL(const TUint32)

IMPORT_C TUint32

GetIntAttributeL

(

const TUint32

aAttribute

)

const

Gets the value for a TInt attribute.

Parameters

const TUint32 aAttribute

Identifies the attribute to be retrived.

GetLocationIdL()

TUint32

GetLocationIdL

(

)

const [private]

Return Location id

GetRefCounter()

TInt

GetRefCounter

(

)

Returns the reference counter. Used by the object pool.

GetString8AttributeL(const TUint32)

IMPORT_C HBufC8 *

GetString8AttributeL

(

const TUint32

aAttribute

)

const

Gets the value for a String8 attribute.

Parameters

const TUint32 aAttribute

Identifies the attribute to be retrived.

GetStringAttributeL(const TUint32)

IMPORT_C HBufC *

GetStringAttributeL

(

const TUint32

aAttribute

)

const

Gets the value for a String16 attribute.

Parameters

const TUint32 aAttribute

Identifies the attribute to be retrived.

GlobalBearerPriority(const TDesC &)

IMPORT_C TInt

GlobalBearerPriority

(

const TDesC &

aServiceType

)

const [protected]

Returns the global priority of the passed bearer type

Parameters

const TDesC & aServiceType

bearer type of which priority is requested

GlobalUiBearerPriority(const TDesC &)

IMPORT_C TInt

GlobalUiBearerPriority

(

const TDesC &

aServiceType

)

const [protected]

Returns the global UI priority of the passed bearer type

Parameters

const TDesC & aServiceType

bearer type of which priority is requested

IAPRecordElementId()

IMPORT_C CommsDat::TMDBElementId

IAPRecordElementId

(

)

const

IncrementRefCounter()

void

IncrementRefCounter

(

)

Increments the reference counter. Used by the object pool.

InitializeWithUiL(TBool)

TBool

InitializeWithUiL

(

TBool

aManuallyConfigure

)

Called on a newly created connection method to initialize it properly with user interaction (e.g. APN setting for a packet data-, WEP-key setting for a WLAN connection method, etc.). Note: each plug-in should set its name (i.e. ECmName) in this function call.

Since: S60 3.2

Parameters

TBool aManuallyConfigure

let's the plugin know if a plugin should be configured manually or automatically

IsLinkedToIap(TUint32)

IMPORT_C TBool

IsLinkedToIap

(

TUint32

aIapId

)

Function should be overriden by bearer type plugins. Returns if the passed IAP id is linked to that connection method.

Parameters

TUint32 aIapId

IAP id to be checked

IsLinkedToSnap(TUint32)

IMPORT_C TBool

IsLinkedToSnap

(

TUint32

aSnapId

)

Function should be overriden by bearer type plugins. Returns if the passed SNAP id is linked to that connection method.

Parameters

TUint32 aSnapId

SNAP id to be checked

IsProtected()

IMPORT_C TBool

IsProtected

(

)

const

LoadAdditionalRecordsL()

void

LoadAdditionalRecordsL

(

)

[protected]

Inherited class can load any additional records after CCmPluginBaseEng finished.

LoadChargeCardSettingL(TUint32)

void

LoadChargeCardSettingL

(

TUint32

aChargeCardId

)

[private]

Parameters

TUint32 aChargeCardId

LoadIAPRecordL(TUint32)

void

LoadIAPRecordL

(

TUint32

aIapId

)

[private]

Parameters

TUint32 aIapId

LoadL(TUint32)

IMPORT_C void

LoadL

(

TUint32

aIapId

)

Performs the basic loading of records related to this connection method:

OpenTransactionLC();
PrepareToLoadRecordsL()
LoadIAPRecordL();
- load IAP
- load WAP (AP & IP Bearer)
- load proxy
- load charge card
- load network
- load location
LoadServiceSettingL();
LoadAdditionalRecordsL();

Parameters

TUint32 aIapId

LoadLocationSettingL()

void

LoadLocationSettingL

(

)

[private]

LoadNetworkSettingL()

void

LoadNetworkSettingL

(

)

[private]

LoadProxySettingL()

void

LoadProxySettingL

(

)

[private]

LoadSeamlessnessRecordL()

void

LoadSeamlessnessRecordL

(

)

[private]

LoadServiceSettingL()

IMPORT_C void

LoadServiceSettingL

(

)

[protected]

Load service record. Default implementation can create only factory supported record instances.

LoadWapRecordL()

void

LoadWapRecordL

(

)

[private]

NewSeamlessnessRecordL(TBool)

CCDIAPMetadataRecord *

NewSeamlessnessRecordL

(

TBool

aSetDef

)

[private]

Create a new metadata record.

Parameters

TBool aSetDef

ETrue if setting default seamlessness valud is needed

NewWapRecordL()

void

NewWapRecordL

(

)

[private]

No WAP record found in load process, but client wants to set start page.

NumOfConnMethodReferencesL()

IMPORT_C TInt

NumOfConnMethodReferencesL

(

)

OpenTransactionLC()

void

OpenTransactionLC

(

)

[protected]

Open transaction

ParentDestination()

IMPORT_C CCmDestinationImpl *

ParentDestination

(

)

const

Return the parent destination of this connection method.

Plugin()

IMPORT_C CCmPluginBaseEng *

Plugin

(

)

const

PrepareToCopyDataL(CCmPluginBaseEng &)

void

PrepareToCopyDataL

(

CCmPluginBaseEng &

aDestInst

)

const [protected]

Called from CreateCopyL(). Plugin can prepare for copying every records added to the conversion tables.

Parameters

CCmPluginBaseEng & aDestInst

copy attributes into this plugin instance

PrepareToDeleteRecordsL()

void

PrepareToDeleteRecordsL

(

)

[protected]

Plugin can prepare to delete the connection method with this function. Called from DeleteL() before any record would be deleted. Do NOT delete any record here.

PrepareToLoadRecordsL()

IMPORT_C void

PrepareToLoadRecordsL

(

)

[protected]

Inherited class can make some preraration before CCmPluginBaseEng would start loading records from tables.

PrepareToUpdateRecordsL()

IMPORT_C void

PrepareToUpdateRecordsL

(

)

[protected]

Check if connection method data is valid, before it would be persisted to commsdat. If invalid data found, set its attribute id in iInvalidAttribute. Base class implementation must be called from overridden one.

ReLoadL()

void

ReLoadL

(

)

Reloads CM

RemoveCommonConversionTable(const TCmCommonAttrConvArrayItem *)

IMPORT_C void

RemoveCommonConversionTable

(

const TCmCommonAttrConvArrayItem *

aConvTable

)

[protected]

Parameters

const TCmCommonAttrConvArrayItem * aConvTable

RemoveConversionTable(const TCmAttribConvTable *)

IMPORT_C void

RemoveConversionTable

(

const TCmAttribConvTable *

aConvTable

)

[protected]

Parameters

const TCmAttribConvTable * aConvTable

RemoveResourceFile(const TDesC &)

IMPORT_C void

RemoveResourceFile

(

const TDesC &

aName

)

[protected]

Remove file name from the resource file name array. Close the resource file and/or decrement the reference count.

Parameters

const TDesC & aName

resource file name

Reset()

IMPORT_C void

Reset

(

)

[protected]

Make a reset on this class.

RestoreAttributeL(const TUint32)

IMPORT_C void

RestoreAttributeL

(

const TUint32

aAttribute

)

Restore the original value of the attribute from commsdat field. Base implementation can be used only with attributes stored directly in commsdat.

Parameters

const TUint32 aAttribute

attribute to be restored

RunSettingsL()

TInt

RunSettingsL

(

)

Launches the settings dialog of the plugin

Since: S60 3.2

ServiceRecordIdLC(HBufC *&, TUint32 &)

void	ServiceRecordIdLC	(	HBufC *&	aServiceName,
			TUint32 &	aRecordId
		)	[protected]

Return the service table name and record id of this connection in the service table.

Parameters

HBufC *& aServiceName
TUint32 & aRecordId

Session()

IMPORT_C CommsDat::CMDBSession &

Session

(

)

const

SetAttribute(CommsDat::CCDRecordBase *, TUint32, TBool)

void	SetAttribute	(	CommsDat::CCDRecordBase *	aRecord,
			TUint32	aAttribute,
			TBool	aSet
		)	[private]

Set attribute flag on the given record

Parameters

CommsDat::CCDRecordBase * aRecord	record to be set
TUint32 aAttribute	e.g. ECDHidden
TBool aSet	ETrue to set, EFalse to clear

SetBoolAttributeL(const TUint32, TBool)

IMPORT_C void	SetBoolAttributeL	(	const TUint32	aAttribute,
			TBool	aValue
		)

Sets the value for a TBool attribute.

Parameters

const TUint32 aAttribute	Identifies the attribute to be set.
TBool aValue	The value to be set.

SetDNSServerAddressL(TUint32, const TDesC &, TUint32, const TDesC &, TUint32, TBool)

IMPORT_C void	SetDNSServerAddressL	(	TUint32	aSrv1Attr,
			const TDesC &	aSrv1,
			TUint32	aSrv2Attr,
			const TDesC &	aSrv2,
			TUint32	aAddrFromSrvAttr,
			TBool	aIPv6
		)

Function to set up DNS addresses and DNS address from server flag. Can be used with both IPv4 and IPv6 attribute. Passed bearer specific attributes must be defined in common conversion table.

Parameters

TUint32 aSrv1Attr	first DNS server address attribute
const TDesC & aSrv1	DNS first DNS server address
TUint32 aSrv2Attr	second DNS server address
const TDesC & aSrv2	DNS second DNS server address attribute
TUint32 aAddrFromSrvAttr	DNS address from server flag attribute
TBool aIPv6	ETrue if passed addresses are in IPv6 form

SetIntAttributeL(const TUint32, TUint32)

IMPORT_C void	SetIntAttributeL	(	const TUint32	aAttribute,
			TUint32	aValue
		)

Sets the value for a TInt attribute.

Parameters

const TUint32 aAttribute	Identifies the attribute to be set.
TUint32 aValue	The value to be set.

SetPlugin(CCmPluginBaseEng *)

void

SetPlugin

(

CCmPluginBaseEng *

aPlugin

)

Parameters

CCmPluginBaseEng * aPlugin

SetProxyServerNameL(const TDesC &)

TBool

SetProxyServerNameL

(

const TDesC &

aProxyServer

)

Parameters

const TDesC & aProxyServer

SetString8AttributeL(const TUint32, const TDesC8 &)

IMPORT_C void	SetString8AttributeL	(	const TUint32	aAttribute,
			const TDesC8 &	aValue
		)

Sets the value for a String8 attribute.

Parameters

const TUint32 aAttribute	Identifies the attribute to be set.
const TDesC8 & aValue	The value to be set.

SetStringAttributeL(const TUint32, const TDesC16 &)

IMPORT_C void	SetStringAttributeL	(	const TUint32	aAttribute,
			const TDesC16 &	aValue
		)

Sets the value for a String16 attribute.

Parameters

const TUint32 aAttribute	Identifies the attribute to be set.
const TDesC16 & aValue	The value to be set.

UpdateAdditionalRecordsL()

void

UpdateAdditionalRecordsL

(

)

[protected]

Inherited class can update its additional records here.

UpdateChargeCardRecordL()

void

UpdateChargeCardRecordL

(

)

[private]

UpdateConnPrefSettingL()

void

UpdateConnPrefSettingL

(

)

[private]

UpdateIAPRecordL()

void

UpdateIAPRecordL

(

)

[private]

UpdateL()

IMPORT_C void

UpdateL

(

)

Update or if this is a new CM, creates CM in CommsDat.

UpdateLocationRecordL()

void

UpdateLocationRecordL

(

)

[private]

UpdateNetworkRecordL()

void

UpdateNetworkRecordL

(

)

[private]

UpdateProxyRecordL()

void

UpdateProxyRecordL

(

)

[private]

UpdateSeamlessnessRecordL()

void

UpdateSeamlessnessRecordL

(

)

[private]

UpdateServiceRecordL()

IMPORT_C void

UpdateServiceRecordL

(

)

[protected]

Update service record.

UpdateWapRecordL()

void

UpdateWapRecordL

(

)

[private]

Member Data Documentation

CCmPluginBaseEng * iPlugin

CCmPluginBaseEng *

iPlugin

[private]

CCmPluginBase Class Reference

Inherits from

Constructor & Destructor Documentation

CCmPluginBase(CCmPluginBaseEng *)

Parameters

~CCmPluginBase()

Member Functions Documentation

AddCommonConversionTableL(const TCmCommonAttrConvArrayItem *)

Parameters

AddConverstionTableL(CommsDat::CCDRecordBase **, TBool *, const TCmAttribConvTable *)

Parameters

AddResourceFileL(const TDesC &)

Parameters

AdditionalReset()

AllocReadL(TInt)

Parameters

BearerRecordIdLC(HBufC *&, TUint32 &)

Parameters

CanHandleIapIdL(TUint32)

Parameters

CanHandleIapIdL(CommsDat::CCDIAPRecord *)

Parameters

CheckDNSServerAddressL(TBool, CommsDat::CMDBField< TDesC > &, CommsDat::CMDBField< TDesC > &, CommsDat::CMDBField< TBool > &)

Parameters

CheckForCommonAttribute(const TUint32)

Parameters

CheckIfAlreadyConnected()

CheckIfNameModifiedL(CommsDat::CCDRecordBase *)

Parameters

CmMgr()

Cmmgr()

CommitTransactionL(TInt)

Parameters

CommonAttribute(const TUint32)

Parameters

ConstructL()

ConvTableItem(TUint32)

Parameters

CopyAdditionalDataL(CCmPluginBaseEng &)

Parameters

CopyAttributes(CommsDat::CCDRecordBase *, CommsDat::CCDRecordBase *)

Parameters

CreateAdditionalRecordsL()

CreateCopyL()

CreateInstanceL(TCmPluginInitParam &)

Parameters

CreateNewL()

CreateNewServiceRecordL()

DecrementRefCounter()

DeleteAdditionalRecordsL()

DeleteL(TBool, TBool)

Parameters

Destination()

DoLoadL(TUint32)

Parameters

EnableChargeCardL(TBool)

Parameters

EnableLocationL(TBool)

Parameters

EnableProxyL(TBool)

Parameters

FeatureSupported(TInt)

Parameters

FilterPossibleParentsL(RArray< TUint32 > &)

Parameters

FindFieldL(TUint32, TCMFieldTypes, CommsDat::CMDBElement *&)

Parameters

FindSeamlessnessRecordL()

FindWAPRecordL()

GetAdditionalUids(RArray< TUint32 > &)

Parameters

GetBoolAttributeL(const TUint32)

Parameters

GetIntAttributeL(const TUint32)

Parameters

GetLocationIdL()

GetRefCounter()

GetString8AttributeL(const TUint32)

Parameters

GetStringAttributeL(const TUint32)

AddConverstionTableL(CommsDat::CCDRecordBase **, TBool , const TCmAttribConvTable )

CopyAttributes(CommsDat::CCDRecordBase , CommsDat::CCDRecordBase )