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

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

voidConstructL(const TDesC8 &aDomain)[private]

Second phase Constructor

Parameters

const TDesC8 & aDomain

CrlfRefreshEnabled()

IMPORT_C TBoolCrlfRefreshEnabled()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 voidGetPortArea(TUint &aStartPort,
TUint &aEndPort
)const

Returns port range for NAT FW use.

Since
S60 3.2

Parameters

TUint & aStartPortStart port of the port range
TUint & aEndPortEnd 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 & aDomainThe 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 & aDomainThe STUN/TURN server domain name

RefreshIntervalTcp()

IMPORT_C TIntRefreshIntervalTcp()const

Returns refresh interval for TCP.

Since
S60 3.2

RefreshIntervalUdp()

IMPORT_C TIntRefreshIntervalUdp()const

Returns refresh interval for UDP.

Since
S60 3.2

RetrieveIapSettingsL(TUint)

IMPORT_C voidRetrieveIapSettingsL(TUintaIapId)

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 aIapIdThe 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 TBoolUseSharedSecret()const

Returns true if shared secret is enabled.

Since
S60 3.2

Member Data Documentation

CNATFWNatSettingsImpl * iSettingsImpl

CNATFWNatSettingsImpl *iSettingsImpl[private]

NAT Settings implementation own