// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// tcpip_ini.h - INI File literals

//

#ifndef __TCPIP_INI_H__

#define __TCPIP_INI_H__

/**

* @file tcpip_ini.h

* @ingroup tcpip_ini_parameters

* Define TCPIP.INI configuration parameters

* @internalComponent

*/

/**

* @defgroup tcpip_ini_parameters	TCPIP.INI configuration parameters

*

* @{

*/

//

// INI File literals

// *****************

//

/** The name of the ini-file */

_LIT(TCPIP_INI_DATA,                "tcpip.ini");

/**

* @name	Start Section

*

* When the protocol stack is loaded into memory, it can automatically start

* a number of system daemons. The DNS resolver daemon (dnd.exe) is an example

* of such system damoens. When the stack is unloaded, any running daemons are

* automatically killed.

*

* Each daemon has its own section in the TCPIP.INI file. The daemons that

* should be started up are listed in the [start] section under the daemons

* key, separated by commas. Each daemon specific section contains the

* initialization parameters for the daemon. Currently, the only supported

* parameter key is filename, which specifies the location of the executable.

* For example:

@verbatim

[start]

daemons= dnd,httpserver

[dnd]

filename= z:\system\programs\dnd.exe

[httpserver]

filename= d:\system\programs\httpserver.exe

@endverbatim

* @{

*/

/** The section name <tt>[start]</tt> */

_LIT(TCPIP_INI_START,               "start");

/** The daemons list. <tt>daemons= dnd,kmd</tt> */

_LIT(TCPIP_INI_DAEMONS,             "daemons");

/** The filename daemon. <tt>[dnd]<br>filename= dnd.exe</tt> */

_LIT(TCPIP_INI_FILENAME,            "filename");

/** @} */

/**

* @name Network layer parameters

* @{

*/

/** The section name <tt>[ip]</tt> */

_LIT(TCPIP_INI_IP,                  "ip");		    // [ip]

/**

* Default TTL (time to live) value for IP packets.

*

* Default: #KTcpipIni_Maxttl

*/

_LIT(TCPIP_INI_MAXTTL,              "maxttl");	            // maxttl= 69

/**

* Default TTL for link local destinations.(IPv4 and IPv6).

* If negative, then default is same as <tt>maxttl</tt>.

*

* - Default: #KTcpipIni_LinkLocalttl

* - Range: [-1..255]

*/

_LIT(TCPIP_INI_LINKLOCALTTL,		"linklocalttl");

/**

* Maximum number of simultaneous dial attempts via NifMan.

*

* - Default: #KTcpipIni_Maxdials

* - Range: >= 0

* @deprecated Not used

* @since 7.0

*/

_LIT(TCPIP_INI_MAXDIALS,            "maxdials");

/**

* Packet forwarding.

* - Default: #KTcpipIni_Forward

* - Range: 0 = disabled, > 0 = enabled, and the number of cached flows to use.

*/

_LIT(TCPIP_INI_FORWARD,             "forward");

/**

* Enable IPv4 link-local configuration.

* When set, the stack will autoconfigure interface for IPv4 linklocal

* address space (<tt>169.254.0.0/16</tt>). This happens in addition to

* any other configuration if present unless option 3 is specified. Possible

* values and their meanings:

*

* Default: #KTcpipIni_Ipv4Linklocal

*

* Valid values:

* - 0= No IPv4 link-local addresses,

* - 1= Always use IPv4 link-local addresses,

* - 2= Only use IPv4 link-local addresses when no global address has been configured,

* - 3= Use link-local address if no IPv4 address is read from Nif or configuration daemon (e.g., DHCP).

*/

_LIT(TCPIP_INI_IPV4LINKLOCAL,       "ipv4linklocal");

/**

* Probe addresses without route from all links.

* If set to 1, destination addresses for which no route can be found,

* are probed with ND (ARP for IPv4) on all interfaces within scope.

* This setting is ignored if disabled if the source address is an IPv4

* link local or else the link local would not function except for

* neighbours with routes already discovered and cached.  This is

* necessary for compliance with the ZEROCONF RFC.

*

* - Default: #KTcpipIni_ProbeAddress

* - Range: 0=disabled, 1=enabled

*/

_LIT(TCPIP_INI_PROBEADDRESS,		"probeaddress");

/**

* No id defence.

*

* Normally the node tries to keep assigned ID reserved for this node,

* regardless of the prefix part. Enabling this option, disables this

* feature (and allows other hosts use my id with different prefixes).

*

* - Default: #KTcpipIni_NoDefendId

* - Range: 0 = disabled (defend id), 1 = enabled (do not defend id).

*/

_LIT(TCPIP_INI_NODEFENDID,			"nodefendid");

/**

* No interface error to attaced flows.

*

* This is the default value for new sockets (flows).

* The default can be changed by a socket option

* #KSoNoInterfaceError.

*

* - Default: #KTcpipIni_Noiferror

* - Range: 0= pass, 1= don't pass errors to flow

*/

_LIT(TCPIP_INI_NOIFERROR,			"noiferror");

/**	

* Max time to wait for route or interface.

*

* - Default: #KTcpipIni_Maxholdtime

* - Range: [0..maxint]

*/

_LIT(TCPIP_INI_MAXHOLDTIME,			"maxholdtime");

/**

* Shutdown delay.

* How long to wait until to kill daemons after last user (SAP/NIF) exits.

*

* - Default: #KTcpipIni_ShutdownDelay seconds.

* - Range: [0..maxint]

*/

_LIT(TCPIP_INI_SHUTDOWN_DELAY,		"shutdown_delay");

/**

* Keep interface up.

*

* This is the default value for new sockets (flows).

* The default can be changed by a socket option

* #KSoKeepInterfaceUp.

*

* When enabled (1), attaching the flow to the interface

* increments the flow count on the interface. This

* count is part of the process that controls how

* long idle interfaces are kept up.

*

* When disabled (0), the flow is not counted.

*

* - Default: #KTcpipIni_KeepInterfaceUp

* - Range: 0 = disabled, 1 = enabled

*/

_LIT(TCPIP_INI_KEEP_INTERFACE_UP,	"keepinterfaceup");

/**

* Max Fragment assemblies.

*

* Max number of simultaneous incomplete fragment assembly (currently per

* protocol version: IPv4 and IPv6). This is a safeguard against denial of

* service (DOS) attacks. Prevents overusing the heap space for the

* assembly control blocks.

*

* - Default: #KTcpipIni_FragCount

* - Range: [0..maxint]

*/

_LIT(TCPIP_INI_FRAG_COUNT,			"frag_count");

/**

* Max Fragment buffering.

*

* Total amount buffer space that can be allocated (RMBufs) for incomplete

* assemblies (per protocol version). This is a safeguard against denial of

* service (DOS) attacks. Prevents overusing the RMBuf pool for the

* packet content.

*

* - Default: #KTcpipIni_FragTotal (bytes)

* - Range: [0..maxint]

*/

_LIT(TCPIP_INI_FRAG_TOTAL,			"frag_total");

/**

* Destination cache.

* - Default: 0 (disabled)

* - Range: 0 = disabled,

*          1 = enabled / one entry per address,

*          2 = enabled / one entry per network

*

* @see MDestinationCache for more information.

*/

_LIT(TCPIP_INI_DSTCACHE,			"dstcache");

/**

* Lifetime of dest. cache entry.

*

* - Default: 600 (secs)

*/

_LIT(TCPIP_INI_DST_LIFETIME,		"dst_lifetime");

/**

* Max total size of dest. cache.

*

* - Default: 2048 (bytes)

*/

_LIT(TCPIP_INI_DST_MAXSIZE,			"dst_maxsize");

/**

* Max transmitted ICMP errors or echo replies within ca. 8 second timeslot.

*

* - Default #KTcpipIni_IcmpLimit

*/

_LIT(TCPIP_INI_ICMP_LIMIT,			"icmp_limit");

/**

* Route Information option.

*

* The type code for RouteInformation has not been defined by the

* IANA. This option allows enabling the option by specifying some

* non-zero type, which identifies the option in Router Avertisement

* message. (Experimental)

*

* - Default: 0 (not enabled)

*/

_LIT(TCPIP_INI_RA_OPT_ROUTE,		"ra_opt_route");

/**

* Recursive DNS Server Option (RDNSS)

*

* The type code for RouteInformation has not been defined by the

* IANA. This option allows enabling the option by specifying some

* non-zero type, which identifies the option in Router Avertisement

* message. (Experimental)

*

* - Default: 0 (not enabled)

*/

_LIT(TCPIP_INI_RA_OPT_RDNSS,		"ra_opt_rdnss");

/** @} */

/**

* @name TCP Parameters

* @{

*/

/** The section name <tt>[tcp]</tt> */

_LIT(TCPIP_INI_TCP,                 "tcp");

/**

* TCP maximum segment size.

* Upper limit is bounded by the network interface MTU.

*

* - Default: tcp_mss= 65535

* - Range: [0..65535]

*/

_LIT(TCPIP_INI_TCP_MSS,             "tcp_mss");

/**

* TCP receive buffer size.

* - Default: tcp_recv_buf= 8192

* - Range: [1024..65535]

*/

_LIT(TCPIP_INI_TCP_RECV_BUF,        "tcp_recv_buf");

#ifdef SYMBIAN_ADAPTIVE_TCP_RECEIVE_WINDOW

/**

* TCP receive maximum window size.

* - Default: tcp_recv_max_buf= 262144

* - Range: [131070-1073741823]

*/

_LIT(TCPIP_INI_TCP_RECV_MAX_WND,        "tcp_recv_max_wnd");

#endif //SYMBIAN_ADAPTIVE_TCP_RECEIVE_WINDOW

/**

* TCP send buffer size.

* - Default: tcp_send_buf= 8192

* - Range: [1024..65535]

*/

_LIT(TCPIP_INI_TCP_SEND_BUF,        "tcp_send_buf");

/**

* Minimum retransmission timeout (ms).

* - Default: tcp_min_rto= 1000

* - Range: 1000 ms

*/

_LIT(TCPIP_INI_TCP_MIN_RTO,         "tcp_min_rto");

/**

* Maximum retransmission timeout (ms).

* - Default: tcp_max_rto= 60000

* - Range: 60000 ms

*/

_LIT(TCPIP_INI_TCP_MAX_RTO,         "tcp_max_rto");

/**

* Initial retransmission timeout (ms).

* - Default: tcp_initial_rto= 3000

* - Range: [0..]

*/

_LIT(TCPIP_INI_TCP_INITIAL_RTO,     "tcp_initial_rto");

/**

* SRTT smoothing.

*

* alpha = 1 /  tcp_srtt_smooth, as defined in RFC2988.

* - Default: tcp_srtt_smooth= 8

* - Range: [0..]

*/

_LIT(TCPIP_INI_TCP_SRTT_SMOOTH,     "tcp_srtt_smooth");

/**

* MDEV smoothing.

* beta = 1 /  tcp_rttvar_smooth, as defined in RFC2988.

* - Default: tcp_rttvar_smooth= 4

* - Range: [0..]

*/

_LIT(TCPIP_INI_TCP_RTTVAR_SMOOTH,   "tcp_rttvar_smooth");

/**

* G value in RTO calculation (RFC2988).

* Constant representing clock granularity.

* - Default: machine specific.

* - Range: [0..]

*/

_LIT(TCPIP_INI_TCP_RTO_G,           "tcp_rto_g");

/**

* K value in RTO calculation (RFC2988).

* K constant, RTO = SRTT + max(K * RTTVAR, G)  (RFC2988)

* - Default: tcp_rto_k= 4

* - Range: [0..]

*/

_LIT(TCPIP_INI_TCP_RTO_K,           "tcp_rto_k");

/**

* Maximum retransmit burst size

* - Default: tcp_max_burst= 2

* - Range: [1..]

*/

_LIT(TCPIP_INI_TCP_MAX_BURST,       "tcp_max_burst");

/**

* Delayed acknowledgement delay time (ms).

* - Default: tcp_ack_delay= 200

* - Range: [0..]

*/

_LIT(TCPIP_INI_TCP_ACK_DELAY,       "tcp_ack_delay");

/**

* Number of retransmissions per connect() attempt.

* - Default: tcp_syn_retries= 5

* - Range: [0..]

*/

_LIT(TCPIP_INI_TCP_SYN_RETRIES,     "tcp_syn_retries");

/**

* Number of retransmissions before black hole diagnostics.

* Maximum retries before MTU reduction.

* - Default: tcp_retries1= 3

* - Range: [0..]

*/

_LIT(TCPIP_INI_TCP_RETRIES1,        "tcp_retries1");

/**

* Maximum number of retransmissions.

* - Default: tcp_retries2= 12

* - Range: [0..]

*/

_LIT(TCPIP_INI_TCP_RETRIES2,        "tcp_retries2");

/**

* MSL2 timeout (ms).

* TIME-WAIT & FIN-WAIT timeout.

* - Default: tcp_msl2= 60000

* - Range: [0..]

*/

_LIT(TCPIP_INI_TCP_MSL2,            "tcp_msl2");

/**

* Large initial window (RFC2414).

* Set initial cwnd according to RFC2414

* - Default: .tcp_rfc2414= 1

* - Range: 1=enable, 0=disable.

*/

_LIT(TCPIP_INI_TCP_RFC2414,         "tcp_rfc2414");

/**

* Initial congestion window size (segments) when RFC2414 is disabled.

* - Default: tcp_initial_cwnd= 2

* - Range: [1..]

*/

_LIT(TCPIP_INI_TCP_INITIAL_CWND,    "tcp_initial_cwnd");

/**

* TCP timestamps (RFC1323).

* - Default: tcp_timestamps= 1

* - Range: 1=enable, 0=disable

*/

_LIT(TCPIP_INI_TCP_TIMESTAMPS,      "tcp_timestamps");

/**

* Enable selective acknowledgements (RFC2018).

* - Default: tcp_sack= 1

* - Range: 1=enable, 0=disable

*/

_LIT(TCPIP_INI_TCP_SACK,            "tcp_sack");

/**

* Apply TIME-WAIT state also to local connections.

* - Default: tcp_local_timewait= 0

* - Range: 1=enable, 0=disable

*/

_LIT(TCPIP_INI_TCP_LOCAL_TIMEWAIT,  "tcp_local_timewait");

/**

* Typical degree of packet reordering in the network.

* - Default: tcp_reordering= 3

* - Range: [0..]

*/

_LIT(TCPIP_INI_TCP_REORDERING,      "tcp_reordering");

/**

* Variant of the nagle algorithm.

* - Default: tcp_strict_nagle= 0

* - Range: 0 = modern, 1 = strict

*/

_LIT(TCPIP_INI_TCP_STRICT_NAGLE,    "tcp_strict_nagle");

/**

* Limited transmit window size in segments (RFC3042).

* - Default: tcp_ltx_window= 2

* - Range: 0=disable, [1..]

*/

_LIT(TCPIP_INI_TCP_LTX_WINDOW,      "tcp_ltx_window");

/**

* Zero window probe style.

* - Default: tcp_probe_style= 0

* - Range:

*		- 0 = probe with a single byte (standard)

*		- 1 = probe with a full segment (BSD)

*		- 2 = probe with an out-of-window acknowledgement (experimental)

*/

_LIT(TCPIP_INI_TCP_PROBE_STYLE,     "tcp_probe_style");

/**

* Acknowledge pushed segments immediately.

*

* - Default: ?

* - Range: ?

*/

_LIT(TCPIP_INI_TCP_PUSH_ACK,        "tcp_push_ack");

/**

* F-RTO, also disables timestamp spike detection.

*

* If enabled, the TCP sender tries to probe with new previously

* unsent data segments after an RTO whether the RTO was spurious.

* If the RTO is detected spurious, the sender continues by sending

* new data instead of retransmitting.

* - Default: tcp_frto= 0

* - Range: 1 = enable, 0 = disable

*/

_LIT(TCPIP_INI_TCP_FRTO,	    "tcp_frto");

/**

* Send DSACKs for out-of-order segments.

* If enabled, send DSACKs in acknowledgements when receiving

* duplicate segments (RFC 2883). The data sender behaviour is

* not modified.

* - Default: tcp_dsack= 1

* - Range: 1 = enable, 0 = disable

*/

_LIT(TCPIP_INI_TCP_DSACK,	    "tcp_dsack");

/**

* Interval between keepalive probes.

* Delay for sending a TCP Keep-Alive probe after the connection

* has become idle (seconds). This is also the interval between

* succesful, replied keepalive probes.

* - Default: tcp_keepalive_intv= 7200 (= 2h)

* - Range: [0..]

*/

_LIT(TCPIP_INI_TCP_KEEPALIVE_INTV,  "tcp_keepalive_intv");

/**

* Number of unreplied probes before quitting.

* Number of unreplied TCP Keep-Alive probes to send

* before the sender gives up and terminates the connection.

* - Default: tcp_num_keepalives= 8

* - Range: [1..]

*/

_LIT(TCPIP_INI_TCP_NUM_KEEPALIVES,  "tcp_num_keepalives");

/**

* Interval between keepalive rexmits 

* Interval between consecutive retransmissions of a Keep-Alive

* probe if there has been no response from the other end (seconds).

* - Default: tcp_keepalive_rxmt= 75

* - Range: [0..1800]

*/

_LIT(TCPIP_INI_TCP_KEEPALIVE_RXMT,  "tcp_keepalive_rxmt");

/**

* Number of FIN retransmissions before socket is excluded from route flow count.

* After the FIN persistency limit is exceeded, link layer and TCP/IP stack is given permission

* to go down if no one else uses them.

* Value 0 means that socket is included in the interface flow count until it is really closed,

* i.e. in TIME_WAIT state.

* - Default: tcp_fin_persistency= 2

* - Range: [0..tcp_retries2]

*/

_LIT(TCPIP_INI_TCP_FIN_PERSISTENCY, "tcp_fin_persistency");

/**

Determines how to set congestion control parameters after spurious RTO.

1 = Eifel response (revert ssthresh and cwnd).

2 = Half congestion window and ssthresh.

3 = Set cwnd to 1 but revert ssthresh (Early versions of DCLOR).

- Default: tcp_spurious_rto_response= 1

- Range: [1..3]

*/

_LIT(TCPIP_INI_TCP_SPURIOUS_RTO_RESPONSE, "tcp_spurious_rto_response");

/**

* ECN.

* Toggles Explicit Congestion Notification [RFC3168] on and off.

* Two alternatives of ECN are available: when parameter value is 1

* the host uses ECN capable bit ECT(1).  When value is 2, the host