Collapse all Symbian^3 Product Developer Library

CNATFWNatSettingsImpl Class Reference

class CNATFWNatSettingsImpl : public CBase

Implementation class for NAT FW Settings API.

Class uses Central Repository to retrieve settings values.

natfwnatsettings.lib

Since: S60 3.2

Inherits from

CNATFWNatSettingsImpl
- CBase

Public Member Functions
	~CNATFWNatSettingsImpl()
const CDesC8Array &	AvailableNatProtocols()
TBool	CrlfRefreshEnabled()
const TDesC8 &	Domain()
void	GetPortArea(TUint &, TUint &)
MNATFWIceSettings &	IceSettingsL()
CNATFWNatSettingsImpl *	NewL(const TDesC8 &)
CNATFWNatSettingsImpl *	NewLC(const TDesC8 &)
TInt	RefreshIntervalTcp()
TInt	RefreshIntervalUdp()
void	RetrieveIapSettingsL(TUint)
MNATFWStunSettings &	StunSettingsL()
MNATFWTurnSettings &	TurnSettingsL()
TBool	UseSharedSecret()

Private Member Functions
	CNATFWNatSettingsImpl()
void	ConstructL(const TDesC8 &)
void	ReadGeneralSettingsL()
void	ReadIapSettingsL(TUint32)

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()

Private Attributes
TBool	iCrlfRefreshEnabled
HBufC8 *	iDomain
TUint32	iDomainKey
CDesC8Array *	iEcomPlugInPriorityOrderArray
CNATFWIceSettings *	iIceSettings
TUint	iPortPoolEndPort
TUint	iPortPoolStartPort
TUint	iRefreshIntervalTcp
TUint	iRefreshIntervalUdp
CNATFWCenRepHandler *	iRepHandler
CNATFWStunSettings *	iStunSettings
CNATFWTurnSettings *	iTurnSettings
TBool	iUseSharedSecret

Constructor & Destructor Documentation

CNATFWNatSettingsImpl()

CNATFWNatSettingsImpl

(

)

[private]

Constructor

Since: S60 3.2

~CNATFWNatSettingsImpl()

~CNATFWNatSettingsImpl

(

)

[virtual]

Desctructor

Since: S60 3.2

Member Functions Documentation

AvailableNatProtocols()

const CDesC8Array &

AvailableNatProtocols

(

)

const

Returns available NAT protocols in priority order

Since: S60 3.2

ConstructL(const TDesC8 &)

void

ConstructL

(

const TDesC8 &

aDomain

)

[private]

Second phase Constructor

Since: S60 3.2

leave: KErrNoMemory if out of memory or system wide error code

Parameters

const TDesC8 & aDomain

reference to domain name descriptor

CrlfRefreshEnabled()

TBool

CrlfRefreshEnabled

(

)

const

Returns true if CRLF refresh is enabled.

Since: S60 3.2

Domain()

const TDesC8 &

Domain

(

)

const

Returns Domain name.

Since: S60 3.2

GetPortArea(TUint &, TUint &)

void	GetPortArea	(	TUint &	aStartPort,
			TUint &	aEndPort
		)	const

Returns port range for NAT FW via parameters.

Since: S60 3.2

Parameters

TUint & aStartPort	Start port of the port range
TUint & aEndPort	End port of the port range

IceSettingsL()

MNATFWIceSettings &

IceSettingsL

(

)

Returns interface through which ICE related settings can be queried. Also reads all Ice settings from Central Repository.

Since: S60 3.2

leave: System wide error code if CR fails

NewL(const TDesC8 &)

CNATFWNatSettingsImpl *

NewL

(

const TDesC8 &

aDomain

)

[static]

A two-phase constructor.

In initial phase domain name and internet acces point related settings values are read from Central Repository.

Since: S60 3.2

leave: KErrCorrupt if more than one identical domain names found at Central Repository

Parameters

const TDesC8 & aDomain

The STUN/TURN server domain name

NewLC(const TDesC8 &)

CNATFWNatSettingsImpl *

NewLC

(

const TDesC8 &

aDomain

)

[static]

A two-phase constructor. The instance is put to the cleanup stack.

In initial phase domain name and internet acces point related settings values are read from Central Repository.

Since: S60 3.2

leave: KErrCorrupt if more than one identical domain names found at Central repository

Parameters

const TDesC8 & aDomain

The STUN/TURN server domain name

ReadGeneralSettingsL()

void

ReadGeneralSettingsL

(

)

[private]

Method for reading general settings from the Central Repository. Leaves if memory allocation or Central Repository reading fails.

Since: S60 3.2

leave: KErrNoMemory if out of memory or system wide error code if CR errors

ReadIapSettingsL(TUint32)

void

ReadIapSettingsL

(

TUint32

aIapId

)

[private]

Method for reading internet accesspoint settings from the Central Repository.

Since: S60 3.2

leave: KErrCorrupt if more than one contents of IAP settings found with this IAP ID. System wide error code if CR fails.

Parameters

TUint32 aIapId

Internet accesspoint ID

RefreshIntervalTcp()

TInt

RefreshIntervalTcp

(

)

const

Returns refresh interval for TCP.

Since: S60 3.2

RefreshIntervalUdp()

TInt

RefreshIntervalUdp

(

)

const

Returns refresh interval for UDP.

Since: S60 3.2

RetrieveIapSettingsL(TUint)

void

RetrieveIapSettingsL

(

TUint

aIapId

)

Fetch Internet acces point settings from Central Repository by specific IAP ID. Old settings are replaced if new found.

Since: S60 3.2

leave: KErrCorrupt if more than one identical IAP ID values found at Central Repository or other system wide error code

Parameters

TUint aIapId

internet acces point ID

StunSettingsL()

MNATFWStunSettings &

StunSettingsL

(

)

Returns interface through which STUN related settings can be queried. Also reads all STUN settings from Central Repository.

Since: S60 3.2

leave: System wide error code if CR fails

TurnSettingsL()

MNATFWTurnSettings &

TurnSettingsL

(

)

Returns interface through which TURN related settings can be queried. Also reads all TURN settings from Central Repository.

Since: S60 3.2

leave: System wide error code if CR fails

UseSharedSecret()

TBool

UseSharedSecret

(

)

const

Returns true if shared secret is enabled.

Since: S60 3.2

Member Data Documentation

TBool iCrlfRefreshEnabled

TBool

iCrlfRefreshEnabled

[private]

CRLF Refresh Enabled

HBufC8 * iDomain

HBufC8 *

iDomain

[private]

Domain where lays the server Own.

TUint32 iDomainKey

TUint32

iDomainKey

[private]

DomainKey to the Central Repository contets value is in the field of the firs key mask bits defined in KUNSAFProtocolsFieldTypeMask

CDesC8Array * iEcomPlugInPriorityOrderArray

CDesC8Array *

iEcomPlugInPriorityOrderArray

[private]

Array of used NAT protocols and priority order Own.

CNATFWIceSettings * iIceSettings

CNATFWIceSettings *

iIceSettings

[private]

ICE software settings. Own.

TUint iPortPoolEndPort

TUint

iPortPoolEndPort

[private]

Ending port for the port range

TUint iPortPoolStartPort

TUint

iPortPoolStartPort

[private]

Starting port for the port range

TUint iRefreshIntervalTcp

TUint

iRefreshIntervalTcp

[private]

TCP Refresh Interval

TUint iRefreshIntervalUdp

TUint

iRefreshIntervalUdp

[private]

UDP RefreshI nterval

CNATFWCenRepHandler * iRepHandler

CNATFWCenRepHandler *

iRepHandler

[private]

The Central Repository handler Own.

CNATFWStunSettings * iStunSettings

CNATFWStunSettings *

iStunSettings

[private]

STUN software settings. Own.

CNATFWTurnSettings * iTurnSettings

CNATFWTurnSettings *

iTurnSettings

[private]

TURN software settings. Own.

TBool iUseSharedSecret

TBool

iUseSharedSecret

[private]

indicates the SharedSecret use