TLbsHostSettingsSupl Class Reference

#include <lbs/lbshostsettingsclasstypes.h>

Link against: lbshostsettings.lib

class TLbsHostSettingsSupl : public TLbsHostSettingsBase

Inherits from

TLbsHostSettingsSupl
- TLbsHostSettingsBase
  - TLbsHostSettingsClassTypeBase

Public Member Type Definitions
typedef	TUint32 TAuthModes

Protected Attributes
TAuthModes	iAuthModesMOLR
TAuthModes	iAuthModesMTLR
TInt	iConnectionId
TLbsConnectionType	iConnectionType
TLbsHostNameAddress	iHostAddress
TLbsHostName	iName
TInt	iPortId
TLbsProviderId	iProviderId
TBool	iReadOnly
TUint8	iReserved

Public Member Enumerations
enum	TLbsConnectionType { ELbsConnectionTypeInvalid, ELbsConnectionTypeNap, ELbsConnectionTypeProxy }
enum	_TAuthModes { EAuthUnknown, EAuthNone, EAuthTls, EAuthAcaTls, EAuthPskTls }

Public Member Functions
	TLbsHostSettingsSupl()
IMPORT_C void	GetAuthModesMOLR(TAuthModes &)
IMPORT_C void	GetAuthModesMTLR(TAuthModes &)
IMPORT_C void	GetConnectionPoint(TInt &, TLbsConnectionType &)
IMPORT_C void	GetHostNameAddress(TDes8 &)
IMPORT_C void	GetName(TDes8 &)
IMPORT_C void	GetPortId(TInt &)
IMPORT_C void	GetProviderId(TDes8 &)
IMPORT_C void	GetReadOnly(TBool &)
IMPORT_C void	SetAuthModesMOLR(TAuthModes)
IMPORT_C void	SetAuthModesMTLR(TAuthModes)
IMPORT_C void	SetConnectionPoint(const TInt, const TLbsConnectionType)
IMPORT_C void	SetHostNameAddress(const TDesC8 &)
IMPORT_C void	SetName(const TDesC8 &)
IMPORT_C void	SetPortId(const TInt)
IMPORT_C void	SetProviderId(const TDesC8 &)
IMPORT_C void	SetReadOnly(const TBool)

Inherited Attributes
	TLbsHostSettingsClassTypeBase::iClassSize
	TLbsHostSettingsClassTypeBase::iClassType

Inherited Functions
	TLbsHostSettingsBase::CreatorId()const
	TLbsHostSettingsBase::HostSettingsId()const
	TLbsHostSettingsBase::LastModified()const
	TLbsHostSettingsBase::SetCreatorId(TLbsHostCreatorId)
	TLbsHostSettingsBase::SetHostSettingsId(TLbsHostSettingsId &)
	TLbsHostSettingsBase::SetLastModifiedL(const TDesC &)
	TLbsHostSettingsBase::TLbsHostSettingsBase()
	TLbsHostSettingsBase::UpdateLastModified()
	TLbsHostSettingsClassTypeBase::ClassSize()const
	TLbsHostSettingsClassTypeBase::ClassType()const
	TLbsHostSettingsClassTypeBase::TLbsHostSettingsClassTypeBase()

Detailed Description

Abstraction of a SUPL account

The class has available data members to store the address, connection type as well as connection id associated with an account. Getters/seters are also provided to retrieve/set the connection type and id associated with an account, the operator identifier, the name and address of the Home SUPL server.

Member Type Definition Documentation

Typedef TAuthModes

typedef TUint32

TAuthModes

Defined type for maintaining Binary Compatibility of the _TAuthModes enumeration. Used to specify a bitmask of allowed authentication mechanisms.

Member Attribute Documentation

iAuthModesMOLR

TAuthModes

iAuthModesMOLR

[protected]

Supported authentication modes for terminal initiated location requests

iAuthModesMTLR

TAuthModes

iAuthModesMTLR

[protected]

Supported authentication modes for network initiated location requests

iConnectionId

TInt

iConnectionId

[protected]

Network access point for these host settings

iConnectionType

TLbsConnectionType

iConnectionType

[protected]

iHostAddress

TLbsHostNameAddress

iHostAddress

[protected]

SUPL server host address for these settings

iName

TLbsHostName

iName

[protected]

SUPL server host name

iPortId

TInt

iPortId

[protected]

Port to use to connect to SUPL server

iProviderId

TLbsProviderId

iProviderId

[protected]

Provider of the host settings

iReadOnly

TBool

iReadOnly

[protected]

Whether the host settings are read only

iReserved

TUint8

iReserved

[protected]

Reserved for future use

Member Enumeration Documentation

Enum TLbsConnectionType

Type of connection point to use for the connection to the SUPL server. Other connection types are expected in the future.

Enumerator	Value	Description
ELbsConnectionTypeInvalid	0x00	Connection type is invalid
ELbsConnectionTypeNap	0x01	Network access point
ELbsConnectionTypeProxy	0x02	Proxy connection type

Enum _TAuthModes

SUPL authentication mechanisms.

To simplify interactions with a user, a UI (Control Panel) application may offer only the following combinations:

EAuthNone & EAuthTls & EAuthAcaTls & EAuthPskTls
EAuthTls & EAuthAcaTls & EAuthPskTls
EAuthAcaTls & EAuthPskTls
EAuthPskTls

and translate them as No, Low, Medium and High Security when interacting with a user. It is the responsibility of a SUPL Server to use the highest security level supported by both the Server and the SUPL Protocol Module.

Note that the enumeration may be extended in the future by adding more values. To maintain compatibility any unrecognized values must be handled as EAuthUnknown.

Enumerator	Value	Description
EAuthUnknown	0x00	Unknown/undefined value
EAuthNone	0x01	No authentication allowed.
EAuthTls	0x02	TLS authentication allowed.
EAuthAcaTls	0x04	TLS + Alternative Client authentication allowed.
EAuthPskTls	0x08	PSK-TLS authentication allowed.

Constructor & Destructor Documentation

TLbsHostSettingsSupl ( )

IMPORT_C

TLbsHostSettingsSupl

(

)

Default constructor.

Member Function Documentation

GetAuthModesMOLR ( TAuthModes & )

IMPORT_C void

GetAuthModesMOLR

(

TAuthModes &

aAuthModes

)

const

Get the authentication modes that this SUPL host setting can use for MO-LRs (terminal initiated location requests).

Parameters
aAuthModes	On return it contains the authentication modes associated with this SUPL host setting.

GetAuthModesMTLR ( TAuthModes & )

IMPORT_C void

GetAuthModesMTLR

(

TAuthModes &

aAuthModes

)

const

Get the authentication modes that this SUPL host setting can use for MT-LRs (network initiated location requests).

Parameters
aAuthModes	On return it contains the authentication modes associated with this SUPL host setting.

GetConnectionPoint ( TInt &, TLbsConnectionType & )

IMPORT_C void	GetConnectionPoint	(	TInt &	aConnectionId,
			TLbsConnectionType &	aConnectionType
		)	const

Retrieves the connection details of the SUPL account. Note that connection point types may be added in the future, code using this API should support graceful handling of unexpected connection types.

Parameters
aConnectionId	The id of connection point to use for SUPL.
aConnectionType	The type of connection point that the id refers to.

GetHostNameAddress ( TDes8 & )

IMPORT_C void

GetHostNameAddress

(

TDes8 &

aHostAddress

)

const

Gets the host address of this SUPL host setting entry.

Parameters
aHostAddress	On return it contains the host address.

GetName ( TDes8 & )

IMPORT_C void

GetName

(

TDes8 &

aName

)

const

Retrieves the host name of the SUPL server

Parameters
aName	On return, contains the name of the SUPL server.

GetPortId ( TInt & )

IMPORT_C void

GetPortId

(

TInt &

aPortId

)

const

Retrieves the port id of the SUPL server.

Parameters
aPortId	On return, contains the port id.

GetProviderId ( TDes8 & )

IMPORT_C void

GetProviderId

(

TDes8 &

aProviderId

)

const

Retrieves the identifier for the location service provider

Parameters
aProviderId	On return, contains the identifier.

GetReadOnly ( TBool & )

IMPORT_C void

GetReadOnly

(

TBool &

aReadOnly

)

const

Retrieves the read only status of the SUPL account.

Parameters
aReadOnly	If the account is read only ETrue, else EFalse.

SetAuthModesMOLR ( TAuthModes )

IMPORT_C void

SetAuthModesMOLR

(

TAuthModes

aAuthModes

)

Set the authentication modes that this SUPL host setting can use for MO-LRs (terminal initiated location requests).

Parameters
aAuthModes	The authentication modes associated with this SUPL host setting.

SetAuthModesMTLR ( TAuthModes )

IMPORT_C void

SetAuthModesMTLR

(

TAuthModes

aAuthModes

)

Set the authentication modes that this SUPL host setting can use for MT-LRs (network initiated location requests).

Parameters
aAuthModes	The authentication modes associated with this SUPL host setting.

SetConnectionPoint ( const TInt, const TLbsConnectionType )

IMPORT_C void	SetConnectionPoint	(	const TInt	aConnectionId,
			const TLbsConnectionType	aConnectionType
		)

Sets the connection details of the SUPL account. Note that connection point types may be added in the future, code using this API should support graceful handling of unexpected connection types.

Parameters
aConnectionId	The id of connection point to use for SUPL.
aConnectionType	The type of connection point that the id refers to.

SetHostNameAddress ( const TDesC8 & )

IMPORT_C void

SetHostNameAddress

(

const TDesC8 &

aHostAddress

)

Sets the host address of this SUPL host setting

Parameters
aHostAddress	The host address to be set for this SUPL host setting entry.

SetName ( const TDesC8 & )

IMPORT_C void

SetName

(

const TDesC8 &

aName

)

Sets the host name of the SUPL server

Parameters
aName	The name to use.

SetPortId ( const TInt )

IMPORT_C void

SetPortId

(

const TInt

aPortId

)

Sets the port id of the SUPL server.

Parameters
aPortId	The port id to use.

SetProviderId ( const TDesC8 & )

IMPORT_C void

SetProviderId

(

const TDesC8 &

aProviderId

)

Sets the the identifier for the location service provider

Parameters
aProviderId	The identifier to use.

SetReadOnly ( const TBool )

IMPORT_C void

SetReadOnly

(

const TBool

aReadOnly

)

Sets the read only status of the SUPL account.

Parameters
aReadOnly	If the account should be read only ETrue, else EFalse.