Collapse all Symbian^3 Application Developer Library

CNATFWNatSettingsApi Class Reference

class CNATFWNatSettingsApi : public CBase

API class to retrieve NAT FW Settings.

Class uses Central Repository to retrieve settings values.

natfwnatsettings.lib

Since: S60 3.2

Inherits from

CNATFWNatSettingsApi
- CBase

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

Private Member Functions
	CNATFWNatSettingsApi ()
void	ConstructL (const TDesC8 &)

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
CNATFWNatSettingsImpl *	iSettingsImpl

Constructor & Destructor Documentation

CNATFWNatSettingsApi()

CNATFWNatSettingsApi

(

)

[private]

Constructor

~CNATFWNatSettingsApi()

~CNATFWNatSettingsApi

(

)

[virtual]

Desctructor

Since: S60 3.2

Member Functions Documentation

AvailableNatProtocols()

IMPORT_C 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

Parameters

const TDesC8 & aDomain

CrlfRefreshEnabled()

IMPORT_C TBool

CrlfRefreshEnabled

(

)

const

Returns true if CRLF refresh is enabled.

Since: S60 3.2

Domain()

IMPORT_C const TDesC8 &

Domain

(

)

const

Returns Domain name

Since: S60 3.2

GetPortArea(TUint &, TUint &)

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

Returns port range for NAT FW use.

Since: S60 3.2

Parameters

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

IceSettingsL()

IMPORT_C MNATFWIceSettings &

IceSettingsL

(

)

const

Returns interface through which ICE related settings can be queried. Also reads all ICE settings from Central Repository. Ownership is not transferred.

Since: S60 3.2

leave: System wide error code if CR fails

NewL(const TDesC8 &)

IMPORT_C CNATFWNatSettingsApi *

NewL

(

const TDesC8 &

aDomain

)

[static]

A two-phase constructor.

In initial phase domain name 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 &)

IMPORT_C CNATFWNatSettingsApi *

NewLC

(

const TDesC8 &

aDomain

)

[static]

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

In initial phase domain name 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

RefreshIntervalTcp()

IMPORT_C TInt

RefreshIntervalTcp

(

)

const

Returns refresh interval for TCP.

Since: S60 3.2

RefreshIntervalUdp()

IMPORT_C TInt

RefreshIntervalUdp

(

)

const

Returns refresh interval for UDP.

Since: S60 3.2

RetrieveIapSettingsL(TUint)

IMPORT_C void

RetrieveIapSettingsL

(

TUint

aIapId

)

Fetch Internet acces point settings from Central Repository for specific IAP ID. Replaces domain specific UDP And TCP refresh interval and retransmission timeout settings if new ones found.

Since: S60 3.2

leave: KErrCorrupt if more than one identical IAP ID values found or system wide error code in other CR errors

Parameters

TUint aIapId

The Internet acces point ID

StunSettingsL()

IMPORT_C MNATFWStunSettings &

StunSettingsL

(

)

const

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

Since: S60 3.2

leave: System wide error code if CR fails

TurnSettingsL()

IMPORT_C MNATFWTurnSettings &

TurnSettingsL

(

)

const

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

Since: S60 3.2

leave: System wide error code if CR fails

UseSharedSecret()

IMPORT_C TBool

UseSharedSecret

(

)

const

Returns true if shared secret is enabled.

Since: S60 3.2

Member Data Documentation

CNATFWNatSettingsImpl * iSettingsImpl

CNATFWNatSettingsImpl *

iSettingsImpl

[private]

NAT Settings implementation own