CApDataHandler Class Reference

~CApDataHandler ( )

IMPORT_C

~CApDataHandler

(

)

[virtual]

Destructor.

Member Function Documentation

AccessPointDataL ( TUint32, CApAccessPointItem & )

IMPORT_C void	AccessPointDataL	(	TUint32	aUid,
			CApAccessPointItem &	aApItem
		)

Reads up one access point's data from the database. Expects that CApDataHandler has been created and the database had been opened. In case of error, function leaves with error code. Error conditions:

Insufficient memory,
AP does not exists,
Server connection failure.

Parameter	Description
aUid	The Uid of the access point to be read
aApItem	A reference to a CApAccessPointItem to hold the data.

Returns: no return value.

ApSpeed2EtelL ( CApAccessPointItem * )

void

ApSpeed2EtelL

(

CApAccessPointItem *

aItem

)

[protected]

Converts setted AP speed from TApCallSpeed to commsdb values

Returns: no return value

CommsDbSpeedL ( CApAccessPointItem & )

TUint32

CommsDbSpeedL

(

aApItem

)

[protected]

Returns the commsdb speed for the passed item

Parameter	Description
aApItem	An access point item

Returns: The speed of the passed item.

ConstructL ( CCommsDatabase & )

IMPORT_C void

ConstructL

(

CCommsDatabase &

aDb

)

[protected]

Second-phase constructor.

CreateCopyFromL ( TUint32 )

IMPORT_C TUint32

CreateCopyFromL

(

aBaseId

)

Creates a copy of a previously existing access point. Expects that CApDataHandler has been created and the database had been opened. In case of error, no access point will be created. Error conditions:

Insufficient memory
Server connection failure.
Lock already present by other task.
Access point does not exist.
Attempting to create new in protected tables will results in KErrAccessDenied

Parameter	Description
aBaseId	The UID of the existing access point to copy from.

Returns: The Uid of the newly constructed and saved access point.

CreateFromDataL ( CApAccessPointItem & )

IMPORT_C TUint32

CreateFromDataL

(

aApItem

)

Create a new access point from supplied data Expects that CApDataHandler has been created and the database had been opened. The name of the AP will be corrected to be unique if necessary and returned in the passed aApItem. In case of error, no access point will be created and the passed one will remain intact. Error conditions:

Insufficient memory
Server connection failure.
Lock already present by other task.
Attempting to create new in protected tables will result in KErrAccessDenied

Parameter	Description
aApItem	Reference to a CApAccessPointItem holding the data

Returns: The UID of the newly created and saved access point.

CreateLanBearerIfNeededL ( )

TUint32

CreateLanBearerIfNeededL

(

)

[protected]

Creates a new record in the LANBearer table if there is none for WLAN

Returns: The UID of the LANBEarer record.

CreateNetworkL ( CApNetworkItem & )

IMPORT_C void

CreateNetworkL

(

CApNetworkItem &

aNetwork

)

Creates a network group from the data. Expects that CApDataHandler has been created and the database had been opened. In case of error, network group will not be created. Error conditions:

Insufficient memory,
Server connection failure.
Lock already present by other task.
network group does not exist.
Attempting to remove read-only records will result in KErrAccessDenied

Parameter	Description
aNetwork	The network item to create/write into db.

Returns: no return value.

DefaultL ( TBool )

IMPORT_C TUint32

DefaultL

(

TBool

aIsWap

)

const

Reads the UID of the default access point. Expects that CApDataHandler has been created and the database had been opened. In case of error, leaves with CommsDb or system error codes. Error conditions:

Insufficient memory;
Server connection failure;
Lock already present;
Access point does not exists.

Returns: The UID of the default access point.

DefaultL ( TBool, TBool & )

IMPORT_C TUint32	DefaultL	(	TBool	aIsWap,
			TBool &	aReadOnly
		)	const

Insufficient memory;
Server connection failure;
Lock already present;
Access point does not exists.

Parameter	Description
aReadOnly	A TBool passed by reference to hold whether the the default access point record is read-only or not.

Returns: The UID of the default access point.

DoAccessPointDataL ( TUint32, CApAccessPointItem & )

void	DoAccessPointDataL	(	TUint32	aUid,
			CApAccessPointItem &	aApItem
		)	[protected]

Reads up one access point's data from the database. Expects that CApDataHandler has been created and the database had been opened. In case of error, function leaves with error code. Error conditions:

Insufficient memory,
AP does not exists,
Server connection failure.

Parameter	Description
aUid	The Uid of the access point to be read
aApItem	A reference to a CApAccessPointItem to hold the data.

Returns: no return value.

DoGetDefaultL ( TBool, TBool * )

TUint32	DoGetDefaultL	(	TBool	aIsWap,
			TBool *	aReadOnly
		)	const [protected]

Insufficient memory;
Server connection failure;
Lock already present;
Access point does not exists.

Returns: The UID of the default access point.

DoRemoveAPL ( TUint32 )

void

DoRemoveAPL

(

aUid

)

[protected]

Removes the given access point from the database. Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed. Error conditions:

Insufficient memory,
Server connection failure.
Lock already present by other task.
Access point does not exist.
Attempting to remove read-only records will result in KErrAccessDenied

Parameter	Description
aUid	The UID of the access point to remove.

Returns: no return value.

DoSetAsDefaultL ( TUint32, TCommsDbIspType )

void	DoSetAsDefaultL	(	TUint32	aUid,
			TCommsDbIspType	aIntendedType
		)	[protected]

Sets the default access point. Expects that CApDataHandler has been created and the database had been opened. In case of error, leaves with CommsDb or system error codes. Error conditions:

Insufficient memory;
Server connection failure;
Lock already present;
Access point does not exists.
Given Access Point is not of the desired type.

Parameter	Description
aUid	The UID of the access point to be set as default.
aIntendedType	The default type ( IAP, WAP, Both).

DoSetPreferredIfDbIapTypeL ( TUint32, TCommDbConnectionDirection, TUint32, TCommDbDialogPref, TUint32, TBool )

void	DoSetPreferredIfDbIapTypeL	(	TUint32	aRank,
			TCommDbConnectionDirection	aDirection,
			TUint32	aBearers,
			TCommDbDialogPref	aPrompt,
			TUint32	aIAP,
			TBool	aOverwrite
		)	[protected]

Sets the access point preference. Can be used only if the database type is IAP. Expects that CApDataHandler has been created and the database had been opened. In case of error, leaves with CommsDb or system error codes. Error conditions:

Insufficient memory;
Server connection failure;
Lock already present; Can also leave with KErrAlreadyExists (if aOverWrite is EFalse ).

Parameter	Description
aRank	The ranking of the connection preference.
aBearers	The bearer set beeing valid for this connection preference
aPrompt	Enum value indicating whether or not the user should be prompted or warned on connection
aIAP	The identifier of the preferred IAP for this connection.
aOverwrite	Boolean value indicating that if a same record present, overwrite it or not.

DoSetPreferredIfDbIspTypeL ( TUint32, TCommDbConnectionDirection, TUint32, TCommDbDialogPref, TUint32, TUint32, const TDesC &, TBool )

void	DoSetPreferredIfDbIspTypeL	(	TUint32	aRank,
			TCommDbConnectionDirection	aDirection,
			TUint32	aBearers,
			TCommDbDialogPref	aPrompt,
			TUint32	aISP,
			TUint32	aChargeCard,
			const TDesC &	aServiceType,
			TBool	aOverwrite
		)	[protected]

Sets the access point preference. Can be used only if the database type is ISP. Expects that CApDataHandler has been created and the database had been opened. In case of error, leaves with CommsDb or system error codes. Error conditions:

Insufficient memory;
Server connection failure;
Lock already present; Can also leave with KErrAlreadyExists (if aOverWrite is EFalse ).

Parameter	Description
aRank	The ranking of the connection preference.
aBearers	The bearer set beeing valid for this connection preference
aPrompt	Enum value indicating whether or not the user should be prompted or warned on connection
aISP	The identifier of the preferred ISP for this connection.
aChargeCard	Identifier of the preferred chargecard for this connection.
aServiceType	The type of the service.
aOverwrite	Boolean value indicating that if a same record present, overwrite it or not.

DoUpdateAccessPointDataL ( CApAccessPointItem &, TBool, TBool & )

TUint32	DoUpdateAccessPointDataL	(	CApAccessPointItem &	aApItem,
			TBool	aIsNew,
			TBool &	aNameChanged
		)	[protected]

Writes the data to the database. In case of error, leaves with CommDb error codes.

Parameter	Description
aApItem	Reference to a CApAccessPointItem which holds the data
aIsNew	A Boolean indicating whether it is a new record or it is an update operation.

Returns: No return value.

EtelSpeed2ApL ( CApAccessPointItem & )

void

EtelSpeed2ApL

(

aItem

)

[protected]

Converts commsdb speed values to TApCallSpeed

Returns: no return value

GetLocationIdL ( )

TUint32

GetLocationIdL

(

)

[protected]

Gets the location record ID

Returns: The UID of the location.

GetModemBearerIDL ( CApAccessPointItem & )

TUint32

GetModemBearerIDL

(

aApItem

)

[protected]

Gets the modem record ID

Returns: The UID of the modem record.

GetPreferredIfDbIapTypeL ( TUint32, TCommDbConnectionDirection, TUint32 &, TUint32 &, TUint32 & )

IMPORT_C void	GetPreferredIfDbIapTypeL	(	TUint32	aRank,
			TCommDbConnectionDirection	aDirection,
			TUint32 &	aBearers,
			TUint32 &	aPrompt,
			TUint32 &	aIAP
		)

Gets the access point preference. Can be used only if the database type is IAP. Expects that CApDataHandler has been created and the database had been opened. In case of error, leaves with CommsDb or system error codes. Error conditions:

Insufficient memory;
Server connection failure;
Lock already present; Deprecated

Parameter	Description
aRank	The ranking of the desired connection preference.
aBearers	The bearer set beeing valid for this connection preference
aPrompt	Enum value indicating whether or not the user should be prompted or warned on connection
aIAP	The identifier of the preferred IAP for this connection preference.

GetPreferredIfDbIspTypeL ( TUint32, TCommDbConnectionDirection, TUint32 &, TUint32 &, TUint32 &, TUint32 & )

IMPORT_C const TDesC &	GetPreferredIfDbIspTypeL	(	TUint32	aRank,
			TCommDbConnectionDirection	aDirection,
			TUint32 &	aBearers,
			TUint32 &	aPrompt,
			TUint32 &	aISP,
			TUint32 &	aChargeCard
		)

Gets the access point preference. Can be used only if the database type is ISP. Expects that CApDataHandler has been created and the database had been opened. In case of error, leaves with CommsDb or system error codes. Error conditions:

Insufficient memory;
Server connection failure;
Lock already present; Deprecated

Parameter	Description
aRank	The ranking of the desired connection preference.
aBearers	The bearer set beeing valid for this connection preference
aPrompt	Enum value indicating whether or not the user should be prompted or warned on connection
aISP	The identifier of the preferred ISP for this connection preference.
aChargeCard	Identifier of the preferred chargecard for this connection preference.

Returns: The type of the service.

HandleBearerChangeIfNeededL ( CApAccessPointItem & )

TBool

HandleBearerChangeIfNeededL

(

aApItem

)

[protected]

Handles the bearer change related things (deleting old links, inserting new ones if needed in the database). Expects that CApDataHandler has been created and the database had been opened. In case of error, access point data will not be changed.

Parameter	Description
aApItem	A reference to a CApAccessPointItem holding the CHANGED data.

Returns: Boolean indicating whether bearer has changed or not.

NewLC ( CCommsDatabase & )

IMPORT_C CApDataHandler *

NewLC

(

CCommsDatabase &

aDb

)

[static]

Two-phased constructor. Leaves on failure, places instance on cleanup stack. Deprecated

Parameter	Description
aDb	a reference to a CCommsDataBase object.

Returns: The constructed CApDataHandler.

ProtocolL ( CApAccessPointItem & )

TUint32

ProtocolL

(

aApItem

)

[protected]

Returns the protocol for the passed item

Parameter	Description
aApItem	An access point item

Returns: The protocol of the passed item.

ReadDialInOutDataL ( TUint32, CApAccessPointItem & )

void	ReadDialInOutDataL	(	TUint32	aIspId,
			CApAccessPointItem &	aApItem
		)	[protected]

Reads the DialIn/Out ISP data from the database. In case of error, leaves with CommDb error codes.

Parameter	Description
aIspId	The UID of the record in the Dialup table to read the data from.
aApItem	A reference to a CApAccessPointItem to hold the data

Returns: No return value.

ReadGprsDataL ( TUint32, CApAccessPointItem & )

void	ReadGprsDataL	(	TUint32	aIspId,
			CApAccessPointItem &	aApItem
		)	[protected]

Reads the GPRS data from the database. In case of error, leaves with CommDb error codes.

Parameter	Description
aIspId	The UID of the record in the GPRS table to read the data from.
aApItem	A reference to a CApAccessPointItem to hold the data

Returns: No return value.

ReadIapDataL ( TUint32, CApAccessPointItem & )

void	ReadIapDataL	(	TUint32	aIapId,
			CApAccessPointItem &	aApItem
		)	[protected]

Reads the IAP part of the data from the database. In case of error, leaves with CommDb error codes.

Parameter	Description
aIapId	The UID of the record in the IAP table to read the data.
aApItem	A reference to a CApAccessPointItem to hold the data

Returns: No return value.

ReadIspDataL ( TUint32, CApAccessPointItem & )

void	ReadIspDataL	(	TUint32	aIspId,
			CApAccessPointItem &	aApItem
		)	[protected]

Reads the ISP part of the data from the database. In case of error, leaves with CommDb error codes.

Parameter	Description
aIspId	The UID of the record in the ISP table to read the data.
aApItem	A reference to a CApAccessPointItem to hold the data

Returns: No return value.

ReadLanDataL ( TUint32, CApAccessPointItem & )

void	ReadLanDataL	(	TUint32	aIspId,
			CApAccessPointItem &	aApItem
		)	[protected]

Reads the LAN data from the database. In case of error, leaves with CommDb error codes.

Parameter	Description
aIspId	The UID of the record in the LAN table to read the data from.
aApItem	A reference to a CApAccessPointItem to hold the data

Returns: No return value.

ReadModemBearerNameL ( CApAccessPointItem & )

void

ReadModemBearerNameL

(

aApItem

)

[protected]

Reads up the name of the LAN/Modem bearer record

ReadNetworkDataL ( CApAccessPointItem & )

void

ReadNetworkDataL

(

aApItem

)

[protected]

Reads up the network data of an access point

Parameter	Description
aApItem	A CApAccessPointItem passed by reference holding the current access point data.

ReadNetworkL ( TUint32, CApNetworkItem & )

IMPORT_C void	ReadNetworkL	(	TUint32	aUid,
			CApNetworkItem &	aNetwork
		)

Reads up a network Network is identified by passed uid

ReadNetworkPartL ( CApAccessPointItem & )

IMPORT_C void

ReadNetworkPartL

(

aItem

)

Reads up a network part of the access point Network is identified by the iNetworkId of the passed access point

ReadProxyDataL ( CApAccessPointItem & )

void

ReadProxyDataL

(

aApItem

)

[protected]

Reads up the proxy data of an access point

Parameter	Description
aApItem	A CApAccessPointItem passed by reference holding the current access point data.

ReadServiceIp6L ( CCommsDbTableView &, CApAccessPointItem & )

void	ReadServiceIp6L	(	CCommsDbTableView &	ispt,
			CApAccessPointItem &	aApItem
		)	[protected]

Reads up CSD/GPRS IPv6 parts of an access point. Leaves if it is not persent in the database

ReadServiceL ( CCommsDbTableView &, CApAccessPointItem & )

void	ReadServiceL	(	CCommsDbTableView &	ispt,
			CApAccessPointItem &	aApItem
		)	[protected]

Reads up common IP & PPP SERVICE data parts of an access point. Leaves if it is not persent in the database

ReadVpnInfoL ( TUint32, CApAccessPointItem & )

void	ReadVpnInfoL	(	TUint32	aIspId,
			CApAccessPointItem &	aApItem
		)	[protected]

Reads up the VPN bearer type info in case of a VPN access point In case of error, leaves with CommDb error codes.

Parameter	Description
aIspId	The UID of the record in the VPN table to read the data from.
aApItem	A reference to a CApAccessPointItem to hold the data

Returns: No return value.

ReadWapDataL ( TUint32, CApAccessPointItem & )

void	ReadWapDataL	(	TUint32	aWapId,
			CApAccessPointItem &	aApItem
		)	[protected]

Reads the WAP part of the data from the database. In case of error, leaves with CommDb error codes.

Parameter	Description
aWapId	The UID of the Access Point to read the data from.
aApItem	A reference to a CApAccessPointItem to hold the data

Returns: No return value.

ReadWlanL ( CCommsDbTableView &, CApAccessPointItem & )

void	ReadWlanL	(	CCommsDbTableView &	lant,
			CApAccessPointItem &	aApItem
		)	[protected]

Gets the local variant value

Returns: A TInt stating the variant Reads up WLAN data parts of an access point. Leaves if it is not persent in the database

RemoveAPL ( TUint32 )

IMPORT_C void

RemoveAPL

(

aUid

)

Removes the given access point from the database. Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed. Error conditions:

Insufficient memory,
Server connection failure.
Lock already present by other task.
Access point does not exist.
Attempting to remove read-only records will result in KErrAccessDenied

Parameter	Description
aUid	The UID of the access point to remove.

Returns: no return value.

RemoveGprsL ( TUint32, TBool )

void	RemoveGprsL	(	TUint32	aUid,
			TBool	aOut
		)	[protected]

Removes the GPRS part of the access point from the database. Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameter	Description
aUid	The UID of the GPRS part of the access point to remove.

Returns: No return value.

RemoveIapL ( TUint32 )

void

RemoveIapL

(

aUid

)

[protected]

Removes the IAP part of the access point from the database. Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameter	Description
aUid	The UID of the IAP part of the access point to remove.

Returns: No return value.

RemoveIspL ( TUint32, TBool )

void	RemoveIspL	(	TUint32	aUid,
			TBool	aOut
		)	[protected]

Removes the ISP part of the access point from the database. Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameter	Description
aUid	The UID of the ISP part of the access point to remove.
aOut	TBool indicating whether Dial out or dial in ISP.

Returns: No return value.

RemoveLanL ( TUint32 )

void

RemoveLanL

(

aUid

)

[protected]

Removes the LAN part of the access point from the database. Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameter	Description
aUid	The UID of the LAN part of the access point to remove.

Returns: No return value.

RemoveNetworkDataL ( TUint32 )

void

RemoveNetworkDataL

(

aIspId

)

[protected]

Removes the network data

Parameter	Description
aIspId	The record ID to remove

RemoveNetworkL ( TUint32 )

IMPORT_C void

RemoveNetworkL

(

aUid

)

Removes the given network group from the database. Expects that CApDataHandler has been created and the database had been opened. In case of error, network group will not be removed. Error conditions:

Insufficient memory,
Server connection failure.
Lock already present by other task.
network group does not exist.
Attempting to remove read-only records will result in KErrAccessDenied

Parameter	Description
aUid	The UID of the network group to remove.

Returns: no return value.

RemoveProxyDataL ( HBufC *, TUint32 )

void	RemoveProxyDataL	(	HBufC *	aServiceType,
			TUint32	aIspId
		)	[protected]

Removes a proxy data

Parameter	Description
aServiceType	The service type to remove for
aIspId	The service record ID

RemoveWapApL ( TUint32 )

void

RemoveWapApL

(

aUid

)

[protected]

Removes the WAP_ACCESS_POINT table part of the access point from the database. Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameter	Description
aUid	The UID of the access point to remove.

Returns: No return value.

RemoveWapBearerApL ( TUint32 )

void

RemoveWapBearerApL

(

aUid

)

[protected]

Removes the WAP_BEARER table part of the access point from the database. Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameter	Description
aUid	The UID of the access point to remove.

Returns: No return value.

RemoveWlanL ( TUint32 )

void

RemoveWlanL

(

aUid

)

[protected]

Removes the WLAN part of the access point from the database. Expects that CApDataHandler has been created and the database had been opened. In case of error, access point will not be removed.

Parameter	Description
aUid	The UID of the LAN part of the access point to remove.

Returns: No return value.

SetAsDefaultL ( TUint32, TCommsDbIspType )

IMPORT_C void	SetAsDefaultL	(	TUint32	aUid,
			TCommsDbIspType	aIntendedType
		)

Sets the default access point. Expects that CApDataHandler has been created and the database had been opened. In case of error, leaves with CommsDb or system error codes. Error conditions:

Insufficient memory;
Server connection failure;
Lock already present;
Access point does not exists.
Given Access Point is not of the desired type.

Parameter	Description
aUid	The UID of the access point to be set as default.
aIntendedType	The default type ( IAP, WAP, Both).

SetDefaultIapIspL ( TUint32 )

void

SetDefaultIapIspL

(

aUid

)

[protected]

Sets the default IAP & ISP records in Global Settings. In case of error, leaves with CommDb error codes.

Returns: No return value.

SetPreferredIfDbIapTypeL ( TUint32, TCommDbConnectionDirection, TUint32, TCommDbDialogPref, TUint32, TBool )

IMPORT_C void	SetPreferredIfDbIapTypeL	(	TUint32	aRank,
			TCommDbConnectionDirection	aDirection,
			TUint32	aBearers,
			TCommDbDialogPref	aPrompt,
			TUint32	aIAP,
			TBool	aOverwrite
		)

Insufficient memory;
Server connection failure;
Lock already present; Can also leave with KErrAlreadyExists (if aOverWrite is EFalse ). Deprecated

Parameter	Description
aRank	The ranking of the connection preference.
aBearers	The bearer set being valid for this connection preference
aPrompt	Enum value indicating whether or not the user should be prompted or warned on connection
aIAP	The identifier of the preferred IAP for this connection.
aOverwrite	Boolean value indicating that if a same record present, overwrite it or not.

SetPreferredIfDbIspTypeL ( TUint32, TCommDbConnectionDirection, TUint32, TCommDbDialogPref, TUint32, TUint32, const TDesC &, TBool )

IMPORT_C void	SetPreferredIfDbIspTypeL	(	TUint32	aRank,
			TCommDbConnectionDirection	aDirection,
			TUint32	aBearers,
			TCommDbDialogPref	aPrompt,
			TUint32	aISP,
			TUint32	aChargeCard,
			const TDesC &	aServiceType,
			TBool	aOverwrite
		)

Insufficient memory;
Server connection failure;
Lock already present; Can also leave with KErrAlreadyExists (if aOverWrite is EFalse ). Deprecated

Parameter	Description
aRank	The ranking of the connection preference.
aBearers	The bearer set beeing valid for this connection preference
aPrompt	Enum value indicating whether or not the user should be prompted or warned on connection
aISP	The identifier of the preferred ISP for this connection.
aChargeCard	Identifier of the preferred chargecard for this connection.
aServiceType	The type of the service.
aOverwrite	Boolean value indicating that if a same record is present, overwrite it or not.

UpdateAccessPointDataL ( CApAccessPointItem &, TBool & )

IMPORT_C void	UpdateAccessPointDataL	(	CApAccessPointItem &	aApItem,
			TBool &	aNameChanged
		)

Updates data stored in an existing access point. Expects that CApDataHandler has been created and the database had been opened. In case of error, no data is stored. Error conditions:

Insufficient memory
Server connection failure
Lock already present by other task
Uid does not exists.
Attempting to update read-only records will result in KErrAccessDenied