Symbian^3 Application Developer Library >

TLbsHostSettingsSupl Class Reference

class TLbsHostSettingsSupl : public TLbsHostSettingsBase

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.

Inherits from

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 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()
Public Member Enumerations
enum TLbsConnectionType { ELbsConnectionTypeInvalid  = 0x00, ELbsConnectionTypeNap  = 0x01, ELbsConnectionTypeProxy  = 0x02 }
enum _TAuthModes { EAuthUnknown  = 0x00, EAuthNone  = 0x01, EAuthTls  = 0x02, EAuthAcaTls  = 0x04, EAuthPskTls  = 0x08 }
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
Inherited Attributes
TLbsHostSettingsClassTypeBase::iClassSize
TLbsHostSettingsClassTypeBase::iClassType

Constructor & Destructor Documentation

TLbsHostSettingsSupl()

IMPORT_C TLbsHostSettingsSupl ( )

Default constructor.

Member Functions 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

TAuthModes & 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

TAuthModes & 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

TInt & aConnectionId The id of connection point to use for SUPL.
TLbsConnectionType & 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

TDes8 & 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

TDes8 & 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

TInt & 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

TDes8 & 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

TBool & 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

TAuthModes 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

TAuthModes 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

const TInt aConnectionId The id of connection point to use for SUPL.
const TLbsConnectionType 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

const TDesC8 & 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

const TDesC8 & aName The name to use.

SetPortId(const TInt)

IMPORT_C void SetPortId ( const TInt aPortId )

Sets the port id of the SUPL server.

Parameters

const TInt 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

const TDesC8 & 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

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

Member Enumerations Documentation

Enum TLbsConnectionType

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

Enumerators

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.

Enumerators

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.

Member Type Definitions 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 Data Documentation

TAuthModes iAuthModesMOLR

TAuthModes iAuthModesMOLR [protected]

Supported authentication modes for terminal initiated location requests

TAuthModes iAuthModesMTLR

TAuthModes iAuthModesMTLR [protected]

Supported authentication modes for network initiated location requests

TInt iConnectionId

TInt iConnectionId [protected]

Network access point for these host settings

TLbsConnectionType iConnectionType

TLbsConnectionType iConnectionType [protected]

TLbsHostNameAddress iHostAddress

TLbsHostNameAddress iHostAddress [protected]

SUPL server host address for these settings

TLbsHostName iName

TLbsHostName iName [protected]

SUPL server host name

TInt iPortId

TInt iPortId [protected]

Port to use to connect to SUPL server

TLbsProviderId iProviderId

TLbsProviderId iProviderId [protected]

Provider of the host settings

TBool iReadOnly

TBool iReadOnly [protected]

Whether the host settings are read only

TUint8 iReserved

TUint8 iReserved [protected]

Reserved for future use

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.