Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages   Examples  

OpenTCP configuration parameters


Detailed Description

A number of parameters in the files listed here, as well as defines mentioned here effect TCP/IP stacks' behaviour and/or runtime system requirements (mostly the amount of needed memory).

By modifying these and adjusting them to your applications' requirements, optimal application performance can be found for a given system constraints.


Files

file  config.h
 OpenTCP hardware configuration file.

file  datatypes.h
 OpenTCP definitions of datatypes of certain length.

file  debug.h
 OpenTCP file for debug options.


Defines

#define ARP_TSIZE   10
 ARP cache size (number of entries).

#define ARP_TIMEOUT   60
 ARP cache entry refresh period (in seconds).

#define ARP_RESEND   2
 ARP Request resend period (in seconds).

#define ARP_MAXRETRY   5
 Number of IP address resolving retires.

#define NETWORK_TX_BUFFER_SIZE   1024
 Transmit buffer size.

#define NO_OF_TCPSOCKETS   8
 Defines number of TCP sockets available.

#define NO_OF_UDPSOCKETS   4
 Defines number of UDP sockets available.

#define TCP_PORTS_END   1023
 Define reserved-ports space.

#define UDP_PORTS_END   1023
 Define reserved-ports space.

#define TCP_DEF_RETRIES   7
 Number of attempted TCP retransmissions before giving up.

#define TCP_DEF_KEEPALIVE   4
 Defines a number of seconds after which an empty ACK packet is sent.

#define TCP_DEF_RETRY_TOUT   4
 Default data-retransmission period (in seconds).

#define TCP_INIT_RETRY_TOUT   1
 Initial retransmission period (in seconds).

#define TCP_SYN_RETRY_TOUT   2
 Retranmission period for SYN packet.

#define TCP_DEF_TOUT   120
 Default idle timeout.

#define NUMTIMERS   55
 Number of timers available in the system.


Define Documentation

#define ARP_TSIZE   10
 

Change this number to change ARP cache size (number of cached ARP:IP address pairs).

Changing this values affects memory consumption as well as processing power needed to manage the ARP cache. If a device communicates with a limited number of hosts, this cache size may be smaller, thus reducing memory requirements. Small cache size may, however, reduce performance when communicating with more hosts than there are cache entries available.

Definition at line 91 of file arp.h.

#define ARP_TIMEOUT   60
 

Change this number to change refresh period of ARP cache entries.

Changing this values changes the amount of ARP refreshes performed and thus can change processing power used when refreshing the entries.

Definition at line 102 of file arp.h.

Referenced by arp_add(), arp_get_response(), arp_init(), and arp_manage().

#define ARP_RESEND   2
 

Change this number to determine how quickly will ARP module issue ARP requests.

Changing this values changes the amount time that will elapse before ARP module resends it's ARP request in case no response has been received. Change this number according to expected network latency and desired resolving speed.

Definition at line 117 of file arp.h.

Referenced by arp_find(), and arp_manage().

#define ARP_MAXRETRY   5
 

Change this number to change number of times ARP module will resend ARP requests before giving up (if no ARP reply is received).

Definition at line 126 of file arp.h.

Referenced by arp_add(), arp_find(), arp_get_response(), and arp_init().

#define NETWORK_TX_BUFFER_SIZE   1024
 

NETWORK_TX_BUFFER_SIZE defines the size of the network buffer used for data transmission by ICMP as well as TCP and UDP applications.

See net_buf documentation for more reference on the shared transmit buffer.

Definition at line 91 of file system.h.

Referenced by bootpc_run(), dhcpc_send_message(), get_host_by_name(), and process_icmp_in().

#define NO_OF_TCPSOCKETS   8
 

Change this number to change maximum number of TCP sockets available to the application.

Definition at line 81 of file tcp_ip.h.

#define NO_OF_UDPSOCKETS   4
 

Change this number to change maximum number of UDP sockets available to the application.

Definition at line 91 of file tcp_ip.h.

#define TCP_PORTS_END   1023
 

TCP socket numbers will only be assigned to be lower than this number.

Definition at line 100 of file tcp_ip.h.

Referenced by tcp_getfreeport().

#define UDP_PORTS_END   1023
 

UDP socket numbers will only be assigned to be lower than this number.

Definition at line 109 of file tcp_ip.h.

Referenced by udp_getfreeport().

#define TCP_DEF_RETRIES   7
 

This number defines how many times will TCP module try to retransmit the data before recognizing that connection was broken. Increase this value for high-latency, low-throughput networks with substantial packet loss.

Definition at line 160 of file tcp_ip.h.

Referenced by tcp_newstate().

#define TCP_DEF_KEEPALIVE   4
 

If for TCP_DEF_KEEPALIVE seconds nothing is received/sent over the TCP connection (this includes received empty TCP packets) an empty (keep-alive) TCP packet will be sent to check if the other side is still replying (and able to reply).

Definition at line 180 of file tcp_ip.h.

#define TCP_DEF_RETRY_TOUT   4
 

If data was not acknowledged during the time-frame defined by this value (in seconds) retransmission procedure will occur.

Definition at line 189 of file tcp_ip.h.

Referenced by tcp_newstate(), and tcp_poll().

#define TCP_INIT_RETRY_TOUT   1
 

Initial retransmission is made a little faster, which helps with connection establishment if ARP cache didn't contain remote IP address.

Definition at line 198 of file tcp_ip.h.

Referenced by tcp_newstate().

#define TCP_SYN_RETRY_TOUT   2
 

Controls SYN packet (segment) retransmit period.

Definition at line 206 of file tcp_ip.h.

Referenced by tcp_poll().

#define TCP_DEF_TOUT   120
 

This period defines idle timeout in seconds - this feature allows TCP/IP stack to close the TCP connection if no data has been exchanged over it during this period of time. This relates ONLY to data. Empty keep-alive TCP packets are not included.

Definition at line 225 of file tcp_ip.h.

Referenced by https_init(), pop3c_init(), and smtpc_init().

#define NUMTIMERS   55
 

Change this number to change the size of the timer pool.

Definition at line 77 of file timers.h.

Referenced by decrement_timers(), free_timer(), get_timer(), init_timer(), and timer_pool_init().


Generated on Sun Aug 3 20:33:01 2003 for OpenTCP by doxygen1.2.18