Collapse all Symbian^3 Application Developer Library

CSuplSettingsInternal Class Reference

class CSuplSettingsInternal : public CSuplSettings

This class is used for accessing SUPL settings. The SUPL settings contains information such about server properties which includes following:

Server address in string format. This is an HSLP address used for SUPL connection. Protocol version in mmnn format where mm indicates minor version nn is major version The Internet Access Point Name refers to the access point which is used to access the HSLP over the internet. This can have maximum size of 100 characters. Manufacturer name of server indicates the server manufacturer. Time stamp when last used. Time stamp when last tried. Network info when the server was last used Network info when the server was last used sucessfully Information on whether server supports emergency support or not Information on whether server supports TLS or not Information on whether server supports PSK-TLS or not Information on whether server enabled or not Information on whether this server entry needs to be deleted when SIM changes Information on whether server can be used in the home network or not Information on whether this server entry can be edited or not SUPL Usage indicates whether user should be notified before using SUPL. Fallback indicates whether fallback is allowed or not if SUPL session fails with default server.

When changing SUPL settings, client has to explicitly lock the SUPL settings and unlock the SUPL settings immediately after the changes are made. Locking is required to avoid multiple clients changing SUPL settings at the same time. Only after unlock of SUPL settings, changes are committed to SUPL settings storage.

This is part of epos_suplsettings.lib

Since: S60 9.1TB

Inherits from

CSuplSettingsInternal
- CSuplSettings
  - CBase

Public Member Functions
	~CSuplSettingsInternal ()
IMPORT_C TInt	DeleteAllSessionRecords ()
IMPORT_C TInt	DeleteSessionRecord ( TInt64 )
IMPORT_C TInt	GetDefaultSlpId ( TInt64 &)
IMPORT_C TInt	GetEmergencySupportFlag (const TInt64 , TBool &)
IMPORT_C TInt	GetFallBackTimerValue ( TInt &)
IMPORT_C TInt	GetLastTriedTime (const TInt64 , TTime &)
IMPORT_C TInt	GetLastUseTime (const TInt64 , TTime &)
IMPORT_C TInt	GetManufacturerName (const TInt64 , TDes &)
IMPORT_C TInt	GetNetInfoLastSucess (const TInt64 , CSuplSettingsInternal::TSuplSettingsNetworkType &, TInt &, TInt &, TInt &, TInt &)
IMPORT_C TInt	GetNetInfoLastUse (const TInt64 , CSuplSettingsInternal::TSuplSettingsNetworkType &, TInt &, TInt &, TInt &, TInt &)
IMPORT_C TInt	GetPskTlsFlag (const TInt64 , TBool &)
IMPORT_C TInt	GetServerExtensionParams ( TInt64 , CServerExtensionParams *)
IMPORT_C TInt	GetTlsFlag (const TInt64 , TBool &)
IMPORT_C TInt	GetVersion (const TInt64 , TInt &, TInt &)
IMPORT_C TInt	InsertSessionRecord (const CTriggerParams *)
IMPORT_C CSuplSettingsInternal *	NewL ()
IMPORT_C CSuplSettingsInternal *	NewLC ()
IMPORT_C TInt	RemoveOnSimChange ()
IMPORT_C TInt	SetEmergencySupportFlag (const TInt64 , const TBool )
IMPORT_C TInt	SetFallBackTimerValue (const TInt )
IMPORT_C TInt	SetLastTriedTime (const TInt64 , const TTime )
IMPORT_C TInt	SetLastUseTime (const TInt64 , const TTime )
IMPORT_C TInt	SetManufacturerName (const TInt64 , const TDesC &)
IMPORT_C TInt	SetNetInfoLastSucess (const TInt64 , const CSuplSettingsInternal::TSuplSettingsNetworkType , const TInt , const TInt , const TInt , const TInt )
IMPORT_C TInt	SetNetInfoLastUse (const TInt64 , const CSuplSettingsInternal::TSuplSettingsNetworkType , const TInt , const TInt , const TInt , const TInt )
IMPORT_C TInt	SetOutstandingTriggers ( TInt64 , TUint64 )
IMPORT_C TInt	SetPskTlsSupportFlag (const TInt64 , const TBool )
IMPORT_C TInt	SetServerExtensionParams ( TInt64 , CServerExtensionParams *)
IMPORT_C TInt	SetTlsSupportFlag (const TInt64 , const TBool )
IMPORT_C TInt	SetTopPriority (const TInt64 )
IMPORT_C TInt	SetVersion (const TInt64 , const TInt , const TInt )

Private Member Functions
	CSuplSettingsInternal ()
	CSuplSettingsInternal (const CSuplSettingsInternal &)
void	ConstructL ()
CSuplSettingsInternal &	operator= (const CSuplSettingsInternal &)

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()
	CSuplSettings::AddNewServer(const CServerParams *,TInt64 &)
	CSuplSettings::CSuplSettings()
	CSuplSettings::CancelInitialize()
	CSuplSettings::CancelTriggerSession(TInt64)
	CSuplSettings::ChangePriority(TInt64,TInt,TBool)
	CSuplSettings::GenerateHslpAddressFromImsi(TDes &)
	CSuplSettings::GetAllSlp(RPointerArray< CServerParams > &)const
	CSuplSettings::GetAllSlp(RPointerArray< CServerParams > &,TRequestStatus &)const
	CSuplSettings::GetDefaultIAPName(TDes &)
	CSuplSettings::GetDefaultServer(CServerParams *)const
	CSuplSettings::GetEditableFlag(const TInt64,TBool &)const
	CSuplSettings::GetFallBack(TBool &)const
	CSuplSettings::GetIapName(const TInt64,TDes &)const
	CSuplSettings::GetImsi(TDes &)
	CSuplSettings::GetServerAddress(TInt64,TDes &)const
	CSuplSettings::GetServerEnabledFlag(const TInt64,TBool &)const
	CSuplSettings::GetSimChangeRemoveFlag(const TInt64,TBool &)const
	CSuplSettings::GetSlpInfoAddress(const TDesC &,CServerParams *)const
	CSuplSettings::GetSlpInfoFromId(const TInt64,CServerParams *)const
	CSuplSettings::GetSuplUsage(TSuplSettingsUsage &)const
	CSuplSettings::GetTriggerParams(RPointerArray< CTriggerParams > &)const
	CSuplSettings::GetTriggerParams(TInt64,CTriggerParams *&)const
	CSuplSettings::GetUsageInHomwNwFlag(const TInt64,TBool &)const
	CSuplSettings::Initialize(TRequestStatus &)
	CSuplSettings::IsImsiChanged(TBool &)
	CSuplSettings::IsSlpExists(const TDesC &)
	CSuplSettings::IsSlpExists(const TInt64)
	CSuplSettings::RemoveObserver()
	CSuplSettings::RemoveServer(const TInt64)
	CSuplSettings::RemoveSessionObserver()
	CSuplSettings::SetAllParameter(const CServerParams *)
	CSuplSettings::SetDefaultServer(const CServerParams *)
	CSuplSettings::SetEditableFlag(const TInt64,const TBool)const
	CSuplSettings::SetFallBack(TBool)
	CSuplSettings::SetIapName(const TInt64,const TDesC &)
	CSuplSettings::SetNotificationStatus(TInt64,TBool)
	CSuplSettings::SetObserverL(MSuplSettingsObserver &)
	CSuplSettings::SetServerAddress(const TInt64,const TDesC &)
	CSuplSettings::SetServerEnabledFlag(const TInt64,const TBool)
	CSuplSettings::SetSessionObserverL(MSuplSessionObserver &)
	CSuplSettings::SetSimChangeRemoveFlag(const TInt64,const TBool)
	CSuplSettings::SetSuplUsage(TSuplSettingsUsage)
	CSuplSettings::SetUsageInHomwNwFlag(const TInt64,const TBool)
	CSuplSettings::SlpCount(TInt &)
	CSuplSettings::~CSuplSettings()

Public Member Enumerations
enum	TServerParam { EServerAddress = 0, EProtocolVersion , EEmergencySupport , ETlsEnabled , EPskTlsUsed , EIap , EServerEnabled , EManufacturer , ESimChangeRemove , EUsageInHomeNw , ETimeLastUse , ETimeLastTried , ENetInfoLastUse , ENetInfoLastSucess , EEditable }
enum	TSessionParam { ETriggerNotificationStatus = 0, EOutstandingTriggers = 1 }
enum	TSuplSettingsNetworkType { EGsmNetwork = 0, EWcdmaNetwork }

Inherited Enumerations
	CSuplSettings:TSuplSettingsUsage

Inherited Attributes
	CSuplSettings::iLocked
	CSuplSettings::iSessionNotifier
	CSuplSettings::iSettingsDBChangeNotifier
	CSuplSettings::iSettingsEngine
	CSuplSettings::iSettingsNotifier
	CSuplSettings::iStatus

Constructor & Destructor Documentation

CSuplSettingsInternal()

CSuplSettingsInternal

(

)

[private]

C++ default constructor.

Since: S60 3.1

CSuplSettingsInternal(const CSuplSettingsInternal &)

CSuplSettingsInternal

(

const CSuplSettingsInternal &

)

[private]

Parameters

const CSuplSettingsInternal &

~CSuplSettingsInternal()

IMPORT_C

~CSuplSettingsInternal

(

)

Destructor.

Since: S60 3.1

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

By default EPOC constructor is private.

Since: S60 3.1

DeleteAllSessionRecords()

IMPORT_C TInt

DeleteAllSessionRecords

(

)

This method is used to delete all session records from session table

Since: S60 5.2

DeleteSessionRecord(TInt64)

IMPORT_C TInt

DeleteSessionRecord

(

TInt64

aSessionId

)

This method is used to delete a session record corresponding to the given session ID

Since: S60 5.2

Parameters

TInt64 aSessionId

GetDefaultSlpId(TInt64 &)

IMPORT_C TInt

GetDefaultSlpId

(

TInt64 &

aSlpId

)

const

This method is used to retrieve default SLP identification.

Since: S60 9.1TB

Parameters

TInt64 & aSlpId

GetEmergencySupportFlag(const TInt64, TBool &)

IMPORT_C TInt	GetEmergencySupportFlag	(	const TInt64	aSlpId,
			TBool &	aEmergencySupportFlag
		)	const

This method is used to retrieve parameter which indicates whether server supports emergency service or not.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
TBool & aEmergencySupportFlag

GetFallBackTimerValue(TInt &)

IMPORT_C TInt

GetFallBackTimerValue

(

TInt &

aTimerValue

)

This Method is used to Set the fallback timer value into the SUPL Settings

Since: S60 9.1 TB

Parameters

TInt & aTimerValue

GetLastTriedTime(const TInt64, TTime &)

IMPORT_C TInt	GetLastTriedTime	(	const TInt64	aSlpId,
			TTime &	aTime
		)	const

This method is used to retrieve timestamp when the HSLP was used tried last time.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
TTime & aTime

GetLastUseTime(const TInt64, TTime &)

IMPORT_C TInt	GetLastUseTime	(	const TInt64	aSlpId,
			TTime &	aTime
		)	const

This method is used to retrieve timestamp when the SLP was used last time.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
TTime & aTime

GetManufacturerName(const TInt64, TDes &)

IMPORT_C TInt	GetManufacturerName	(	const TInt64	aSlpId,
			TDes &	aManufacturerName
		)	const

This method is used to retrieve manufacturer name in server parameters. Manufacturer name refers to the service provider who is providing SUPL service. It is client's responsibility to allocate memory to aManufacturer parameter before invoking this method.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
TDes & aManufacturerName

GetNetInfoLastSucess(const TInt64, CSuplSettingsInternal::TSuplSettingsNetworkType &, TInt &, TInt &, TInt &, TInt &)

IMPORT_C TInt	GetNetInfoLastSucess	(	const TInt64	aSlpId,
			CSuplSettingsInternal::TSuplSettingsNetworkType &	aNetType,
			TInt &	aMcc,
			TInt &	aMnc,
			TInt &	aCid,
			TInt &	aLac
		)	const

This method is used to retrieve network information when the SUPL session was last done sucessfully.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
CSuplSettingsInternal::TSuplSettingsNetworkType & aNetType
TInt & aMcc
TInt & aMnc
TInt & aCid
TInt & aLac

GetNetInfoLastUse(const TInt64, CSuplSettingsInternal::TSuplSettingsNetworkType &, TInt &, TInt &, TInt &, TInt &)

IMPORT_C TInt	GetNetInfoLastUse	(	const TInt64	aSlpId,
			CSuplSettingsInternal::TSuplSettingsNetworkType &	aNetType,
			TInt &	aMcc,
			TInt &	aMnc,
			TInt &	aCid,
			TInt &	aLac
		)	const

This method is used to retrieve network information when the SUPL session was last done. The SUPL session could be sucessful one or failed one.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
CSuplSettingsInternal::TSuplSettingsNetworkType & aNetType
TInt & aMcc
TInt & aMnc
TInt & aCid
TInt & aLac

GetPskTlsFlag(const TInt64, TBool &)

IMPORT_C TInt	GetPskTlsFlag	(	const TInt64	aSlpId,
			TBool &	aPskTlsFlag
		)	const

This method is used to retrieve parameter which indicates whether server supports PSK-TLS or not.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
TBool & aPskTlsFlag

GetServerExtensionParams(TInt64, CServerExtensionParams *)

IMPORT_C TInt	GetServerExtensionParams	(	TInt64	aSlpId,
			CServerExtensionParams *	aServerExtnParams
		)	const

This method is used to retrieve extended parameters of given server

Since: S60 5.2

Parameters

TInt64 aSlpId
CServerExtensionParams * aServerExtnParams

GetTlsFlag(const TInt64, TBool &)

IMPORT_C TInt	GetTlsFlag	(	const TInt64	aSlpId,
			TBool &	aTlsFlag
		)	const

This method is used to retrieve parameter which indicates whether server supports TLS or not.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
TBool & aTlsFlag

GetVersion(const TInt64, TInt &, TInt &)

IMPORT_C TInt	GetVersion	(	const TInt64	aSlpId,
			TInt &	aMajor,
			TInt &	aMinor
		)	const

This method is used to retrieve protocol version supported by SUPL server. The protocol version consists of two parts : Major version and Minor version.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
TInt & aMajor
TInt & aMinor

InsertSessionRecord(const CTriggerParams *)

IMPORT_C TInt

InsertSessionRecord

(

const CTriggerParams *

aSessionParamValues

)

This method is used to insert Active session record into the SUPL session DB

Since: S60 5.2

Parameters

const CTriggerParams * aSessionParamValues

NewL()

IMPORT_C CSuplSettingsInternal *

NewL

(

)

[static]

Two-phased constructor.

Since: S60 3.1

NewLC()

IMPORT_C CSuplSettingsInternal *

NewLC

(

)

[static]

Two-phased constructor.

Since: S60 9.1TB

RemoveOnSimChange()

IMPORT_C TInt

RemoveOnSimChange

(

)

This method is used to delete all servers which have the Sim Change Remove Flag set

Since: S60 9.1TB

SetEmergencySupportFlag(const TInt64, const TBool)

IMPORT_C TInt	SetEmergencySupportFlag	(	const TInt64	aSlpId,
			const TBool	aEmergencySupportFlag
		)

This method is used to change parameter which indicates whether server supports emergency service or not.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
const TBool aEmergencySupportFlag

SetFallBackTimerValue(const TInt)

IMPORT_C TInt

SetFallBackTimerValue

(

const TInt

aTimerValue

)

This Method is used to Get the fallback timer value from the SUPL Settings

Since: S60 9.1 TB

Parameters

const TInt aTimerValue

SetLastTriedTime(const TInt64, const TTime)

IMPORT_C TInt	SetLastTriedTime	(	const TInt64	aSlpId,
			const TTime	aTime
		)

This method is used to change timestamp when the HSLP was used tried last time.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
const TTime aTime

SetLastUseTime(const TInt64, const TTime)

IMPORT_C TInt	SetLastUseTime	(	const TInt64	aSlpId,
			const TTime	aTime
		)

This method is used to change timestamp when the HSLP was used last time.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
const TTime aTime

SetManufacturerName(const TInt64, const TDesC &)

IMPORT_C TInt	SetManufacturerName	(	const TInt64	aSlpId,
			const TDesC &	aManufacturer
		)

This method is used to change manufacturer in server parameters. Manufacturer name refers to the service provider who is providing SUPL service.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
const TDesC & aManufacturer

SetNetInfoLastSucess(const TInt64, const CSuplSettingsInternal::TSuplSettingsNetworkType, const TInt, const TInt, const TInt, const TInt)

IMPORT_C TInt	SetNetInfoLastSucess	(	const TInt64	aSlpId,
			const CSuplSettingsInternal::TSuplSettingsNetworkType	aNetType,
			const TInt	aMcc,
			const TInt	aMnc,
			const TInt	aCid,
			const TInt	aLac = 0
		)

This method is used to change network information when the SUPL session was last done sucessfully.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
const CSuplSettingsInternal::TSuplSettingsNetworkType aNetType
const TInt aMcc
const TInt aMnc
const TInt aCid
const TInt aLac = 0

SetNetInfoLastUse(const TInt64, const CSuplSettingsInternal::TSuplSettingsNetworkType, const TInt, const TInt, const TInt, const TInt)

IMPORT_C TInt	SetNetInfoLastUse	(	const TInt64	aSlpId,
			const CSuplSettingsInternal::TSuplSettingsNetworkType	aNetType,
			const TInt	aMcc,
			const TInt	aMnc,
			const TInt	aCid,
			const TInt	aLac = 0
		)

This method is used to change network information when the SUPL session was last done. The SUPL session could be sucessful one or failed one.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
const CSuplSettingsInternal::TSuplSettingsNetworkType aNetType
const TInt aMcc
const TInt aMnc
const TInt aCid
const TInt aLac = 0

SetOutstandingTriggers(TInt64, TUint64)

IMPORT_C TInt	SetOutstandingTriggers	(	TInt64	aSessionId,
			TUint64	aOutstandingTriggers
		)

This method is used to set outstanding triggers attribute for a given session

Since: S60 5.2

Parameters

TInt64 aSessionId
TUint64 aOutstandingTriggers

SetPskTlsSupportFlag(const TInt64, const TBool)

IMPORT_C TInt	SetPskTlsSupportFlag	(	const TInt64	aSlpId,
			const TBool	aPskTlsSupportFlag
		)

This method is used to change parameter which indicates whether server supports PSK-TLS or not.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
const TBool aPskTlsSupportFlag

SetServerExtensionParams(TInt64, CServerExtensionParams *)

IMPORT_C TInt	SetServerExtensionParams	(	TInt64	aSlpId,
			CServerExtensionParams *	aServerExtnParams
		)

This method is used to set extended parameters of a given server.

Since: S60 5.2

Parameters

TInt64 aSlpId
CServerExtensionParams * aServerExtnParams

SetTlsSupportFlag(const TInt64, const TBool)

IMPORT_C TInt	SetTlsSupportFlag	(	const TInt64	aSlpId,
			const TBool	aTlsSupportFlag
		)

This method is used to change parameter which indicates whether server supports TLS or not.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
const TBool aTlsSupportFlag

SetTopPriority(const TInt64)

IMPORT_C TInt

SetTopPriority

(

const TInt64

aSlpId

)

This method is used to set one server entry as default in SUPL settings.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId

SetVersion(const TInt64, const TInt, const TInt)

IMPORT_C TInt	SetVersion	(	const TInt64	aSlpId,
			const TInt	aMajor,
			const TInt	aMinor
		)

This method is used to change protocol version supported by SUPL server. The protocol version consists of two parts : Major version and Minor version.

Since: S60 9.1TB

Parameters

const TInt64 aSlpId
const TInt aMajor
const TInt aMinor

operator=(const CSuplSettingsInternal &)

CSuplSettingsInternal &

operator=

(

const CSuplSettingsInternal &

)

[private]

Parameters

const CSuplSettingsInternal &

Member Enumerations Documentation

Enum TServerParam

Enumeration to indicate which parameter of server needs to be changed. This is one of the parameters for Set() method. Client has to select one of the values from this enumeration when changing SUPL settings. For example, if UI application is changing SUPL settings, it should select EUserInterface. Client can get information about particular parameter from SUPL settings using Get() method with this enumeration.

Enumerators

EServerAddress = 0	Indicates SUPL server address parameter in server parameters
EProtocolVersion	Indicates protocol version parameter in server parameters
EEmergencySupport	Indicates emergency support parameter in server parameters
ETlsEnabled	Indicates TLS parameter in server parameters
EPskTlsUsed	Indicates PSK-TLS parameter in server parameters
EIap	Indicates IAP parameter in server parameters
EServerEnabled	Indicates server enabled parameter in server parameters
EManufacturer	Indicates manufacturer parameter in server parameters
ESimChangeRemove	Indicates SIM change remove parameter in server parameters
EUsageInHomeNw	Indicates usage in home network parameter in server parameters
ETimeLastUse	Indicates time stamp when used last time parameter in server parameters
ETimeLastTried	Indicates time stamp when used tried parameter in server parameters
ENetInfoLastUse	Indicates network information when used last time parameter in server parameters
ENetInfoLastSucess	Indicates network information when last succeeded parameter in server parameters
EEditable	Indicates editable parameter in server parameters

Enum TSessionParam

Enumeration to indicate which parameter of active session needs to be changed.

Enumerators

ETriggerNotificationStatus = 0	Indicates Trigger notification status parameter
EOutstandingTriggers = 1	Indicates number of outstanding triggers parameter

Enum TSuplSettingsNetworkType

Enumeration to indicate which type of network used. This is one of the parameters for SetNetInfoLastUse() and SetNetInfoLastSucess() methods. Client has to select one of the values from this enumeration when changing network info in server settings.

Since: S60 9.1TB

Enumerators

EGsmNetwork = 0	Indicates that network is GSM network
EWcdmaNetwork	Indicates that network is WCDMA network