TCP configuration options

Collaboration diagram for TCP configuration options:

Macros
#define	UIP_TCP
#define	UIP_ACTIVE_OPEN
#define	UIP_CONNS
#define	UIP_LISTENPORTS
#define	UIP_URGDATA
#define	UIP_RTO   3
#define	UIP_MAXRTX   8
#define	UIP_MAXSYNRTX   5
#define	UIP_TCP_MSS   (UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN)
#define	UIP_RECEIVE_WINDOW
#define	UIP_TIME_WAIT_TIMEOUT   120

Detailed Description

The name of the function that should be called when UDP datagrams arrive.

Macro Definition Documentation

#define UIP_TCP

Toggles whether TCP support should be compiled in or not.

Definition at line 396 of file uipopt.h.

#define UIP_ACTIVE_OPEN

Determines if support for opening connections from uIP should be compiled in.

If the applications that are running on top of uIP for this project do not need to open outgoing TCP connections, this configuration option can be turned off to reduce the code size of uIP.

Definition at line 410 of file uipopt.h.

#define UIP_CONNS

The maximum number of simultaneously open TCP connections.

Since the TCP connections are statically allocated, turning this configuration knob down results in less RAM used. Each TCP connection requires approximately 30 bytes of memory.

Definition at line 425 of file uipopt.h.

Referenced by tcpip_input(), tcpip_output(), uip_init(), and uip_process().

#define UIP_LISTENPORTS

The maximum number of simultaneously listening TCP ports.

Each listening TCP port requires 2 bytes of memory.

Definition at line 439 of file uipopt.h.

Referenced by tcpip_input(), tcpip_output(), uip_init(), uip_listen(), uip_process(), and uip_unlisten().

#define UIP_URGDATA

Determines if support for TCP urgent data notification should be compiled in.

Urgent data (out-of-band data) is a rarely used TCP feature that very seldom would be required.

Definition at line 453 of file uipopt.h.

#define UIP_RTO   3

The initial retransmission timeout counted in timer pulses.

This should not be changed.

Definition at line 460 of file uipopt.h.

Referenced by uip_init(), and uip_process().

#define UIP_MAXRTX   8

The maximum number of times a segment should be retransmitted before the connection should be aborted.

This should not be changed.

Definition at line 468 of file uipopt.h.

Referenced by uip_process().

#define UIP_MAXSYNRTX   5

The maximum number of times a SYN segment should be retransmitted before a connection request should be deemed to have been unsuccessful.

This should not need to be changed.

Definition at line 477 of file uipopt.h.

Referenced by uip_process().

#define UIP_TCP_MSS   (UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN)

The TCP maximum segment size.

This is should not be to set to more than UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN.

Definition at line 491 of file uipopt.h.

Referenced by uip_init(), and uip_process().

#define UIP_RECEIVE_WINDOW

The size of the advertised receiver's window.

Should be set low (i.e., to the size of the uip_buf buffer) if the application is slow to process incoming data, or high (32768 bytes) if the application processes data quickly.

Definition at line 504 of file uipopt.h.

Referenced by uip_process().

#define UIP_TIME_WAIT_TIMEOUT   120

How long a connection should stay in the TIME_WAIT state.

This can be reduced for faster entry into power saving modes.

Definition at line 515 of file uipopt.h.

Referenced by uip_process().