CApAccessPointItem Class Reference
class CApAccessPointItem : public CBase |
CApAccessPointItem is used to exchange data between engine and client. It holds the information for an access point including WAP, IAP, ISP (if present & applies). This class uses the same approach as CommDB to read and write data: it has functions for each data type implemented. To read or write the data, we have to know the data type and the enum name of the 'column'. The column values has the names of the database columns with the 'EAp' prefix. The reason for this (not using the database column descriptors) is performance. It is much faster to compare enum values than literals.
Constructor & Destructor Documentation
CApAccessPointItem()
IMPORT_C | CApAccessPointItem | ( | ) | [protected] |
~CApAccessPointItem()
IMPORT_C | ~CApAccessPointItem | ( | ) | [virtual] |
Member Functions Documentation
BearerTypeL()
This function returns the bearer type for the current access point
CompareCdma(const CApAccessPointItem &)
Compares the Cdma part of THIS and the passed aItem.
CompareGprs(const CApAccessPointItem &)
Compares the Gprs part of THIS and the passed aItem.
CompareIap(const CApAccessPointItem &)
Compares the IAP part of THIS and the passed aItem.
CompareIsp(const CApAccessPointItem &)
Compares the IsP part of THIS and the passed aItem.
CompareProxy(const CApAccessPointItem &)
CompareWap(const CApAccessPointItem &)
Compares the WAP part of THIS and the passed aItem. Does not compares IAP ID
CompareWlan(const CApAccessPointItem &)
Compares the Wlan part of THIS and the passed aItem.
ConnectionName()
IMPORT_C const TDesC & | ConnectionName | ( | ) | const |
This function returns the name of the connection Ownership is not passed.
ConstructL()
IMPORT_C void | ConstructL | ( | ) | [protected] |
Second-phase constructor.
CopyFromL(const CApAccessPointItem &)
Copies the data from another CApAccessPointItem. Substitute for the "assignment operator". It requires allocation thus can leave. Wap Access Point Uid is not copied.
DoCompareApL(const CApAccessPointItem &)
Compares THIS and the passed aItem.
GetCleanIpAddressLC(const TDesC &)
HBufC * | GetCleanIpAddressLC | ( | const TDesC & | aValue | ) | [private] |
Removes leading 0s from the passed IP address.
Parameters
const TDesC & aValue | A descriptor holding the IP address to remove leading 0s from |
GetPlainPhoneNumberLC(const TDesC &)
HBufC * | GetPlainPhoneNumberLC | ( | const TDesC & | aNumber | ) | [private] |
Removes invalid chars e.g. space, () from the passed phone number. (valid are 0,1,2,..9,p,w,+,*,#) Strips pre- and postfixes, prefix separator is#, postfix separators are p, w or +
HasProxy()
TBool
| HasProxy | ( | ) | const [private] |
Returns whether the Ap has proxy data or not.
HasSameIspAndBearerL(CApAccessPointItem &)
This function compares this and the passed CApAccessPointItem whether they have the same ISP and bearer Returns true if the APs have the same phone number
IsReadOnly()
IMPORT_C TBool | IsReadOnly | ( | ) | const |
This function returns whether the access point is read-only or not.
IsSamePhoneNumberL(CApAccessPointItem &)
Compares the 'default phone number' (ISP dial-in number) of this and the passed CApAccessPointItem
IsSupported(TApMember)
Check if aColumn is supported.
Parameters
TApMember aColumn | Enum value indicating the column to check. |
IsVpnAp()
Returnes whether the given access point is a VPN ap or not.
IsWlan()
Returns whether this item has WLAN or not
LeaveIfUnsupportedL(TApMember)
void | LeaveIfUnsupportedL | ( | TApMember | aColumn | ) | [private] |
Leave with KErrNotSupported if aColumn is not supported.
Parameters
TApMember aColumn | Enum value indicating the column to check. |
LimitIp6DNSL()
void | LimitIp6DNSL | ( | ) | [private] |
Limit the Ip6 DNS address In case of CSD, HSCSD, only Well-known and User defined is supported, so if the bearer is changed from something else to these bearer types, the possible 'Dynamic' should be replaced with Well-known
LimitSpeedL()
void | LimitSpeedL | ( | ) | [private] |
Limits the speed after changing e.g. bearer type
NewLC()
Two-phased constructor. Leaves on failure, places instance on cleanup stack. Instance is initialised to default values. The created instance is suitable for passing to CApDataHandler's functions, contains all necessary information.
ReAllocL(HBufC *&, const TDesC16 &)
Reallocates a passed 16-bit descriptor. Passed descriptor is deleted, new one is AllocL-ed Passed descriptor MUST NOT BE on the CleanupStack
Parameters
HBufC *& aDes | The descriptor to hold the value |
const TDesC16 & aValue | The value to pass to the aDes descriptor. |
ReAllocL(HBufC8 *&, const TDesC8 &)
Reallocates a passed 8-bit descriptor. Passed descriptor is deleted, new one is AllocL-ed Passed descriptor MUST NOT BE on the CleanupStack
Parameters
HBufC8 *& aDes | The descriptor to hold the value |
const TDesC8 & aValue | The value to pass to the aDes descriptor. |
ReadBool(const TApMember, TBool &)
This function reads up a boolean value from the specified column. If the specified column does not exist (that is, not part of the database structure), it will Panic in debug builds and it will return KErrInvalidColumn in release builds without Panicking. Panic is used in debug builds because it indicates a programming error. In release, it 'notifies' the caller about the error through the return value but enables system to continue operation.
Parameters
const TApMember aColumn | Enum value indicating the column to read. |
TBool & aValue | A reference to a boolean to hold the value |
ReadConstLongTextL(const TApMember)
This function reads up a long text value from the specified column. The ownership is not passed to the caller. It means that the caller should not delete the received value. If the caller must take the ownership for any reason, must make a copy and use that and delete the copy when no longer needed.
Parameters
const TApMember aColumn | Enum value indicating the column to read. |
ReadLongTextL(const TApMember)
NOTE: This function is deprecated. Use ReadConstLongTextL! This function reads up a long text value from the specified column. The ownership is not passed to the caller. It means that the caller should not delete the received value. If the caller must take the ownership for any reason, must make a copy and use that and delete the copy when no longer needed.
Parameters
const TApMember aColumn | Enum value indicating the column to read. |
ReadTextL(const TApMember, TDes8 &)
This function reads up an 8-bit text value from the specified column.
Parameters
const TApMember aColumn | Enum value indicating the column to read. |
TDes8 & aValue | Reference to an 8-bit descriptor to hold the value |
ReadTextL(const TApMember, TDes16 &)
This function reads up a 16-bit text value from the specified column.
Parameters
const TApMember aColumn | Enum value indicating the column to read. |
TDes16 & aValue | Reference to a 16-bit descriptor to hold the value |
ReadTextLengthL(const TApMember)
This function reads the length of the text in the specified column.
Parameters
const TApMember aColumn | Enum value indicating the column to read. |
ReadUint(const TApMember, TUint32 &)
This function reads up a TUint32 value from the specified column. In case the given value was not written to the database, it will return KErrValueUnspecified. If the specified column does not exist (that is, not part of the database structure), it will Panic in debug builds and it will return KErrInvalidColumn in release builds without Panicking. Panic is used in debug builds because it indicates a programming error. In release, it 'notifies' the caller about the error through the return value but enables system to continue operation.
Parameters
const TApMember aColumn | Enum value indicating the column to read. |
TUint32 & aValue | A reference to a TUint32 to hold the value |
RemoveInvalidCharsLC(const TDesC16 &)
HBufC * | RemoveInvalidCharsLC | ( | const TDesC16 & | aInText | ) | [private] |
Removes invalid chars from the passed text Invalid chars are: TAB
RemoveInvalidCharsLC(const TDesC8 &)
HBufC8 * | RemoveInvalidCharsLC | ( | const TDesC8 & | aInText | ) | [private] |
Removes invalid chars from the passed text Invalid chars are: TAB
RemoveInvalidPhoneCharsLC(const TDesC16 &)
HBufC * | RemoveInvalidPhoneCharsLC | ( | const TDesC16 & | aInText | ) | [private] |
Removes invalid chars from the passed phone number
SanityCheckOk()
IMPORT_C TBool | SanityCheckOk | ( | ) | |
This function checks the integrity of the CApAccessPointItem. Currently checks: IF WAP_IP_BEARER, WAP_ISP_TYPE conforms to IAP_SERVICE_TYPE
SetBearerTypeL(TApBearerType)
This function sets the bearer type for the current access point
Parameters
TApBearerType aBearer | TApBearerType enum indicating the desired bearer type. |
SetDns6IpFromServer()
void | SetDns6IpFromServer | ( | ) | [private] |
Sets iExt->iIpv6GetDNSIPFromServer according the currently valid iExt->iIpv6PrimaryDNS & iExt->iIpv6SecondaryDNS values. Called internally, after every setting of the above two values
SetDnsIpFromServer()
void | SetDnsIpFromServer | ( | ) | [private] |
Sets iGetDNSIPFromServer according the currently valid iPrimaryDNS & iSecondaryDNS values. Called internally, after every setting of the above two values
SetIfNetworksL()
void | SetIfNetworksL | ( | ) | [private] |
Sets the IfNetworks value according to the bearer type and the IPv6 support availability. The required values are: IPv4: GPRS/CDMA, pdptype ipv4 "ip", CSD "ip" HSCSD "ip" IPv6: GPRS/CDMA, pdptype ipv4 "ip", GPRS/CDMA, pdptype ipv6 "ip6", CSD "ip,ip6" HSCSD "ip,ip6"
SetIpFromServer()
void | SetIpFromServer | ( | ) | [private] |
Sets iIspIPAddrFromServer according the currently valid iIspIPAddr value. Called internally, after every setting of iIspIPAddr values
SetNamesL(const TDesC16 &)
IMPORT_C void | SetNamesL | ( | const TDesC16 & | aValue | ) | |
This function writes a 16-bit text value to the 'name' fields of the access point. This includes: WAP_ACCESS_POINT, IAP, Dial/in/out/Gprs In/Out table's COMM_DB_NAME fields. These fields are (by TApMember): EApWapAccessPointName, EApIapName, EApIspName. It is useful if we need to use same names.
Parameters
const TDesC16 & aValue | A const reference to a 16-bit text descriptor to the value. |
SetProxyFlag()
void | SetProxyFlag | ( | ) | [private] |
SetVpnAp(TBool)
void | SetVpnAp | ( | TBool | aIsVpn | ) | |
Sets the current access point as VPN or as normal AP. Internal use only!
Parameters
TBool aIsVpn | a TBool specifiyng that the current AP is VPN or not. |
Specified(TApMember)
Returns whether a given member is specified (after reading it from the DB) or not.
Parameters
TApMember aMember | The member we would like to knopw if it is specified or not. |
Specify(TApMember, TBool)
Sets a given member as specified or not
SpecifyAll(TBool)
void | SpecifyAll | ( | TBool | aOn | ) | [private] |
Sets all member as specified or not
Parameters
TBool aOn | The value to set |
SpecifyCDMA(TBool)
void | SpecifyCDMA | ( | TBool | aOn | ) | [private] |
Sets all CDMA member as specified or not
Parameters
TBool aOn | The value to set |
SpecifyGPRS(TBool)
void | SpecifyGPRS | ( | TBool | aOn | ) | [private] |
Sets all GPRS member as specified or not
Parameters
TBool aOn | The value to set |
SpecifyIAP(TBool)
void | SpecifyIAP | ( | TBool | aOn | ) | [private] |
Sets all IAP member as specified or not
Parameters
TBool aOn | The value to set |
SpecifyISP(TBool)
void | SpecifyISP | ( | TBool | aOn | ) | [private] |
Sets all ISP member as specified or not
Parameters
TBool aOn | The value to set |
SpecifyIpBearer(TBool)
void | SpecifyIpBearer | ( | TBool | aOn | ) | [private] |
Sets all IP bearer member as specified or not
Parameters
TBool aOn | The value to set |
SpecifyWLAN(TBool)
void | SpecifyWLAN | ( | TBool | aOn | ) | [private] |
Sets all WLAN member as specified or not
Parameters
TBool aOn | The value to set |
SpecifyWap(TBool)
void | SpecifyWap | ( | TBool | aOn | ) | [private] |
Sets all WAP member as specified or not
Parameters
TBool aOn | The value to set |
WapBearer()
IMPORT_C const TDesC & | WapBearer | ( | ) | const |
This function returns the current WAP bearer for the access point Ownership is not passed.
WapUid()
This function returns the ID of the access point
WriteBool(const TApMember, const TBool &)
This function writes a boolean value to the specified column. If the specified column does not exist (that is, not part of the database structure), it will Panic in debug builds and it will return KErrInvalidColumn in release builds without Panicking. Panic is used in debug builds because it indicates a programming error. In release, it 'notifies' the caller about the error through the return value but enables system to continue operation.
Parameters
const TApMember aColumn | Enum value indicating the column to write. |
const TBool & aValue | A const reference to a boolean value |
WriteLongTextL(const TApMember, const TDesC &)
This function writes a long text value to the specified column. If the specified column does not exist (that is, not part of the database structure), it will Panic in debug builds and it will return KErrInvalidColumn in release builds without Panicking. Panic is used in debug builds because it indicates a programming error. In release, it 'notifies' the caller about the error through the return value but enables system to continue operation. This function can Leave if the copying of the text does not succeed.
Parameters
const TApMember aColumn | Enum value indicating the column to write. |
const TDesC & aValue | Reference to a 16-bit text descriptor to the value |
WriteTextL(const TApMember, const TDesC8 &)
This function writes an 8-bit text value to the specified column. If the specified column does not exist (that is, not part of the database structure), it will Panic in debug builds and it will return KErrInvalidColumn in release builds without Panicking. Panic is used in debug builds because it indicates a programming error. In release, it 'notifies' the caller about the error through the return value but enables system to continue operation. This function can Leave if the copying of the text does not succeed. Possible leave codes are the system leave codes.
Parameters
const TApMember aColumn | Enum value indicating the column to write. |
const TDesC8 & aValue | Reference to an 8-bit text descriptor to the value |
WriteTextL(const TApMember, const TDesC16 &)
This function writes a 16-bit text value to the specified column. If the specified column does not exist (that is, not part of the database structure), it will Panic in debug builds and it will return KErrInvalidColumn in release builds without Panicking. Panic is used in debug builds because it indicates a programming error. In release, it 'notifies' the caller about the error through the return value but enables system to continue operation. This function can Leave if the copying of the text does not succeed.
Parameters
const TApMember aColumn | Enum value indicating the column to write. |
const TDesC16 & aValue | Reference to a 16-bit text descriptor to the value |
WriteUint(const TApMember, const TUint32 &)
This function writes a TUint32 value to the specified column. If the specified column does not exist (that is, not part of the database structure), it will Panic in debug builds and it will return KErrInvalidColumn in release builds without Panicking. Panic is used in debug builds because it indicates a programming error. In release, it 'notifies' the caller about the error through the return value but enables system to continue operation.
Parameters
const TApMember aColumn | Enum value indicating the column to write. |
const TUint32 & aValue | A const reference to a TUint32 value |
operator!=(const CApAccessPointItem &)
Inequality operator. Wap Access Point Uid is not counted.
operator==(const CApAccessPointItem &)
Equality operator. Wap Access Point Uid is not counted.
Member Data Documentation
TBool
iApHasProxySettings
TBool
| iApHasProxySettings | [private] |
TUint32
iApIapBearerService
TUint32
| iApIapBearerService | [private] |
HBufC * iApProxyExceptions
HBufC * | iApProxyExceptions | [private] |
TUint32
iApProxyPortNumber
TUint32
| iApProxyPortNumber | [private] |
HBufC * iApProxyProtocolName
HBufC * | iApProxyProtocolName | [private] |
HBufC * iApProxyServerAddress
HBufC * | iApProxyServerAddress | [private] |
TBool
iApProxyUseProxy
TBool
| iApProxyUseProxy | [private] |
TApCallType
iBearerCallTypeIsdn
TCallbackAction
iCallBackTypeIsServerNum
TBool
iDisplayTerminalWindow
TBool
| iDisplayTerminalWindow | [private] |
TBool
iEnablePPPCompression
TBool
| iEnablePPPCompression | [private] |
TBool
iGetDNSIPFromServer
TBool
| iGetDNSIPFromServer | [private] |
HBufC * iGprsAccessPointName
HBufC * | iGprsAccessPointName | [private] |
TUint32
iGprsMinMeanThroughput
TUint32
| iGprsMinMeanThroughput | [private] |
TUint32
iGprsMinPeakThroughput
TUint32
| iGprsMinPeakThroughput | [private] |
TUint32
iGprsMinPrecedence
TUint32
| iGprsMinPrecedence | [private] |
TUint32
iGprsMinReliability
TUint32
| iGprsMinReliability | [private] |
HBufC * iGprsPdpAddress
HBufC * | iGprsPdpAddress | [private] |
TUint32
iGprsReqMeanPeakThroughput
TUint32
| iGprsReqMeanPeakThroughput | [private] |
TUint32
iGprsReqPeakThroughput
TUint32
| iGprsReqPeakThroughput | [private] |
TUint32
iGprsReqPrecedence
TUint32
| iGprsReqPrecedence | [private] |
TUint32
iGprsReqReliability
TUint32
| iGprsReqReliability | [private] |
TBool
iGprsUseAnonymAccess
TBool
| iGprsUseAnonymAccess | [private] |
HBufC * iIapServiceType
HBufC * | iIapServiceType | [private] |
TUint32
iIsConnectionTypeContinuous
TUint32
| iIsConnectionTypeContinuous | [private] |
TBool
iIsPasswordAuthenticationSecure
TBool
| iIsPasswordAuthenticationSecure | [private] |
TBool
iIsReadOnly
TBool
| iIsReadOnly | [private] |
TBool
iIsWTLSSecurityOn
TBool
| iIsWTLSSecurityOn | [private] |
TInt
iIspBearerCE
TInt
| iIspBearerCE | [private] |
TInt
iIspBearerName
TInt
| iIspBearerName | [private] |
TUint32
iIspCallbackTimeOut
TUint32
| iIspCallbackTimeOut | [private] |
TUint32
iIspChannelCoding
HBufC * iIspDefaultTelNumber
HBufC * | iIspDefaultTelNumber | [private] |
HBufC * iIspDescription
HBufC * | iIspDescription | [private] |
TBool
iIspDialResolution
TBool
| iIspDialResolution | [private] |
TBool
iIspEnableLCPExtensions
TBool
| iIspEnableLCPExtensions | [private] |
TBool
iIspEnableSwCompression
TBool
| iIspEnableSwCompression | [private] |
HBufC * iIspGateway
HBufC * | iIspGateway | [private] |
HBufC * iIspIPAddr
HBufC * | iIspIPAddr | [private] |
TBool
iIspIPAddrFromServer
TBool
| iIspIPAddrFromServer | [private] |
HBufC * iIspIPNetMask
HBufC * | iIspIPNetMask | [private] |
HBufC * iIspIfAuthName
HBufC * | iIspIfAuthName | [private] |
HBufC * iIspIfAuthPass
HBufC * | iIspIfAuthPass | [private] |
TUint32
iIspIfAuthRetries
HBufC8 * iIspIfCallbackInfo
HBufC8 * | iIspIfCallbackInfo | [private] |
HBufC * iIspIfName
HBufC * | iIspIfName | [private] |
HBufC * iIspIfNetworks
HBufC * | iIspIfNetworks | [private] |
HBufC * iIspIfParams
HBufC * | iIspIfParams | [private] |
TBool
iIspIfPromptForAuth
TBool
| iIspIfPromptForAuth | [private] |
HBufC8 * iIspInitString
HBufC8 * | iIspInitString | [private] |
TUint32
iIspMaximumTimeSlots
TUint32
| iIspMaximumTimeSlots | [private] |
TUint32
iIspRequestedTimeSlots
TUint32
| iIspRequestedTimeSlots | [private] |
HBufC * iLoginScript
HBufC * | iLoginScript | [private] |
TApCallSpeed
iMaxConnSpeed
HBufC * iNetworkName
HBufC * | iNetworkName | [private] |
HBufC * iPassword
HBufC * | iPassword | [private] |
HBufC * iPrimaryDNS
HBufC * | iPrimaryDNS | [private] |
TBool
iPromptPassword
TBool
| iPromptPassword | [private] |
HBufC * iSecondaryDNS
HBufC * | iSecondaryDNS | [private] |
CArrayFixFlat< TBool > * iSpecified
HBufC * iStartingPage
HBufC * | iStartingPage | [private] |
TBool
iUseCallBack
TBool
| iUseCallBack | [private] |
TBool
iUseLoginScript
TBool
| iUseLoginScript | [private] |
HBufC * iUserName
HBufC * | iUserName | [private] |
HBufC * iWapAccessPointName
HBufC * | iWapAccessPointName | [private] |
HBufC * iWapBearer
HBufC * | iWapBearer | [private] |
HBufC * iWapGatewayAddress
HBufC * | iWapGatewayAddress | [private] |
HBufC * iWapProxyLoginName
HBufC * | iWapProxyLoginName | [private] |
HBufC * iWapProxyLoginPass
HBufC * | iWapProxyLoginPass | [private] |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.