1060 lines
54 KiB
HTML
1060 lines
54 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>uIP 1.0: Configuration options for uIP</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.4.6 -->
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="classes.html"><span>Data Structures</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
</ul></div>
|
|
<h1>Configuration options for uIP</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
uIP is configured using the per-project configuration file <a class="el" href="a00140.html">uipopt.h</a>.
|
|
<p>
|
|
This file contains all compile-time options for uIP and should be tweaked to match each specific project. The uIP distribution contains a documented example "uipopt.h" that can be copied and modified for each project.<p>
|
|
<dl compact><dt><b>Note:</b></dt><dd>Most of the configuration options in the <a class="el" href="a00140.html">uipopt.h</a> should not be changed, but rather the per-project uip-conf.h file. </dd></dl>
|
|
|
|
<p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<tr><td colspan="2"><br><h2>Files</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="a00141.html">uip-conf.h</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">An example uIP configuration file. <br></td></tr>
|
|
|
|
<p>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="a00140.html">uipopt.h</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Configuration options for uIP. <br></td></tr>
|
|
|
|
<p>
|
|
<tr><td colspan="2"><br><h2>Project-specific configuration options</h2></td></tr>
|
|
<tr><td colspan="2">uIP has a number of configuration options that can be overridden for each project. These are kept in a project-specific uip-conf.h file and all configuration names have the prefix UIP_CONF. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3f6f1f6f98431f2d33ed30a30d2ccc35"></a><!-- doxytag: member="uipopt::UIP_CONF_MAX_CONNECTIONS" ref="g3f6f1f6f98431f2d33ed30a30d2ccc35" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g3f6f1f6f98431f2d33ed30a30d2ccc35">UIP_CONF_MAX_CONNECTIONS</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of TCP connections. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g974c9b4bbe6b07cc1d64ac4fad278030"></a><!-- doxytag: member="uipopt::UIP_CONF_MAX_LISTENPORTS" ref="g974c9b4bbe6b07cc1d64ac4fad278030" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g974c9b4bbe6b07cc1d64ac4fad278030">UIP_CONF_MAX_LISTENPORTS</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of listening TCP ports. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gcacc406c3bf7d0e00412e4c946252739"></a><!-- doxytag: member="uipopt::UIP_CONF_BUFFER_SIZE" ref="gcacc406c3bf7d0e00412e4c946252739" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#gcacc406c3bf7d0e00412e4c946252739">UIP_CONF_BUFFER_SIZE</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">uIP buffer size. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gca1240bba5dd57f8c7c27123c84a1f6d"></a><!-- doxytag: member="uipopt::UIP_CONF_BYTE_ORDER" ref="gca1240bba5dd57f8c7c27123c84a1f6d" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#gca1240bba5dd57f8c7c27123c84a1f6d">UIP_CONF_BYTE_ORDER</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">CPU byte order. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3001114ddadc1f2ada5cc9a780e866fc"></a><!-- doxytag: member="uipopt::UIP_CONF_LOGGING" ref="g3001114ddadc1f2ada5cc9a780e866fc" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g3001114ddadc1f2ada5cc9a780e866fc">UIP_CONF_LOGGING</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Logging on or off. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g763f12007aad8cc0e483bf50f8a8d9b4"></a><!-- doxytag: member="uipopt::UIP_CONF_UDP" ref="g763f12007aad8cc0e483bf50f8a8d9b4" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g763f12007aad8cc0e483bf50f8a8d9b4">UIP_CONF_UDP</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">UDP support on or off. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9dd44616d41cef74d3beb51d8be5ecec"></a><!-- doxytag: member="uipopt::UIP_CONF_UDP_CHECKSUMS" ref="g9dd44616d41cef74d3beb51d8be5ecec" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g9dd44616d41cef74d3beb51d8be5ecec">UIP_CONF_UDP_CHECKSUMS</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">UDP checksums on or off. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g529648ad3b0b327a43689b0f1779ff55"></a><!-- doxytag: member="uipopt::UIP_CONF_STATISTICS" ref="g529648ad3b0b327a43689b0f1779ff55" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g529648ad3b0b327a43689b0f1779ff55">UIP_CONF_STATISTICS</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">uIP statistics on or off <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">8 bit datatype <a href="#g4caecabca98b43919dd11be1c0d4cd8e"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">16 bit datatype <a href="#g77570ac4fcab86864fa1916e55676da2"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Statistics datatype. <a href="#g727459e5c4f777543c81ffffa3df3f0c"></a><br></td></tr>
|
|
<tr><td colspan="2"><br><h2>Static configuration options</h2></td></tr>
|
|
<tr><td colspan="2">These configuration options can be used for setting the IP address settings statically, but only if UIP_FIXEDADDR is set to 1. The configuration options for a specific node includes IP address, netmask and default router as well as the Ethernet address. The netmask, default router and Ethernet address are appliciable only if uIP should be run over Ethernet.<p>
|
|
All of these should be changed to suit your project. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g51195ea7cd5aa387a87f9d3b23905b62">UIP_FIXEDADDR</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines if uIP should use a fixed IP address or not. <a href="#g51195ea7cd5aa387a87f9d3b23905b62"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g9069474ea570fd78c481aa164317dbaf">UIP_PINGADDRCONF</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ping IP address asignment. <a href="#g9069474ea570fd78c481aa164317dbaf"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#ge0f8cbeca9731af2171ffd37e79de893">UIP_FIXEDETHADDR</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specifies if the uIP ARP module should be compiled with a fixed Ethernet MAC address or not. <a href="#ge0f8cbeca9731af2171ffd37e79de893"></a><br></td></tr>
|
|
<tr><td colspan="2"><br><h2>IP configuration options</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#gb61381673de27f31848c5396bf0b338e">UIP_TTL</a> 64</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The IP TTL (time to live) of IP packets sent by uIP. <a href="#gb61381673de27f31848c5396bf0b338e"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#gf963fdea2b75d27ef31e92d1d01359ee">UIP_REASSEMBLY</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Turn on support for IP packet reassembly. <a href="#gf963fdea2b75d27ef31e92d1d01359ee"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc3882366feda1cb759ccbfe98327a7db"></a><!-- doxytag: member="uipopt::UIP_REASS_MAXAGE" ref="gc3882366feda1cb759ccbfe98327a7db" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#gc3882366feda1cb759ccbfe98327a7db">UIP_REASS_MAXAGE</a> 40</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The maximum time an IP fragment should wait in the reassembly buffer before it is dropped. <br></td></tr>
|
|
<tr><td colspan="2"><br><h2>UDP configuration options</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdcf372ff9748996f7c05e9822a615384"></a><!-- doxytag: member="uipopt::UIP_UDP" ref="gdcf372ff9748996f7c05e9822a615384" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#gdcf372ff9748996f7c05e9822a615384">UIP_UDP</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Toggles wether UDP support should be compiled in or not. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g92f3344ec8ca46893163399c89fafed5">UIP_UDP_CHECKSUMS</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Toggles if UDP checksums should be used or not. <a href="#g92f3344ec8ca46893163399c89fafed5"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g196379ceb1219a99f4495e41ccc9bbfb"></a><!-- doxytag: member="uipopt::UIP_UDP_CONNS" ref="g196379ceb1219a99f4495e41ccc9bbfb" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g196379ceb1219a99f4495e41ccc9bbfb">UIP_UDP_CONNS</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The maximum amount of concurrent UDP connections. <br></td></tr>
|
|
<tr><td colspan="2"><br><h2>TCP configuration options</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#gac0de06236b02659460445de30776e00">UIP_ACTIVE_OPEN</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines if support for opening connections from uIP should be compiled in. <a href="#gac0de06236b02659460445de30776e00"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#gf5fe83be78b78b9e7d9e7f1e34ab1cc5">UIP_CONNS</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of simultaneously open TCP connections. <a href="#gf5fe83be78b78b9e7d9e7f1e34ab1cc5"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g8f4ebd8ef6c0ea665ed351d87fec09fd">UIP_LISTENPORTS</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of simultaneously listening TCP ports. <a href="#g8f4ebd8ef6c0ea665ed351d87fec09fd"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g51c1cd531ff0afb81620151f2248cd21">UIP_URGDATA</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines if support for TCP urgent data notification should be compiled in. <a href="#g51c1cd531ff0afb81620151f2248cd21"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g15de27b044603284f68db05a378235a7">UIP_RTO</a> 3</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The initial retransmission timeout counted in timer pulses. <a href="#g15de27b044603284f68db05a378235a7"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g67cf1e0d2324c93f332c1f020c0fe8b3">UIP_MAXRTX</a> 8</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of times a segment should be retransmitted before the connection should be aborted. <a href="#g67cf1e0d2324c93f332c1f020c0fe8b3"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g24aa5bc36939cc9a0833e1df01478a7e">UIP_MAXSYNRTX</a> 5</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of times a SYN segment should be retransmitted before a connection request should be deemed to have been unsuccessful. <a href="#g24aa5bc36939cc9a0833e1df01478a7e"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g4910467b83a639f06739c82cd362037e">UIP_TCP_MSS</a> (UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The TCP maximum segment size. <a href="#g4910467b83a639f06739c82cd362037e"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g5b9dba2123705bce1ce95c3deca0bdad">UIP_RECEIVE_WINDOW</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The size of the advertised receiver's window. <a href="#g5b9dba2123705bce1ce95c3deca0bdad"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g2bc3b489923793759526a3181eb667fa">UIP_TIME_WAIT_TIMEOUT</a> 120</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">How long a connection should stay in the TIME_WAIT state. <a href="#g2bc3b489923793759526a3181eb667fa"></a><br></td></tr>
|
|
<tr><td colspan="2"><br><h2>ARP configuration options</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#gb1455b27c06532a399cf06d2c1d6d08d">UIP_ARPTAB_SIZE</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The size of the ARP table. <a href="#gb1455b27c06532a399cf06d2c1d6d08d"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g3090117ef3ff5775b77cb1960e442d07">UIP_ARP_MAXAGE</a> 120</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The maxium age of ARP table entries measured in 10ths of seconds. <a href="#g3090117ef3ff5775b77cb1960e442d07"></a><br></td></tr>
|
|
<tr><td colspan="2"><br><h2>General configuration options</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g3589822ecb9d9c4145209756396b8a6b">UIP_BUFSIZE</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The size of the uIP packet buffer. <a href="#g3589822ecb9d9c4145209756396b8a6b"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g5726142fec34f35fb9ea19e5a45975c6">UIP_STATISTICS</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines if statistics support should be compiled in. <a href="#g5726142fec34f35fb9ea19e5a45975c6"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g21664b7441cfa37d280228d23316d609">UIP_LOGGING</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines if logging of certain events should be compiled in. <a href="#g21664b7441cfa37d280228d23316d609"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g156dd2891a57035e4afdc4c2bc0b0ebf">UIP_BROADCAST</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Broadcast support. <a href="#g156dd2891a57035e4afdc4c2bc0b0ebf"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#ge6f4a2453dbd8bc60e6a82774552366a">UIP_LLH_LEN</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The link level header length. <a href="#ge6f4a2453dbd8bc60e6a82774552366a"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#gb58e1ceb7cb73ca2bcd73146b6c1b4e7">uip_log</a> (char *msg)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print out a uIP log message. <a href="#gb58e1ceb7cb73ca2bcd73146b6c1b4e7"></a><br></td></tr>
|
|
<tr><td colspan="2"><br><h2>CPU architecture configuration</h2></td></tr>
|
|
<tr><td colspan="2">The CPU architecture configuration is where the endianess of the CPU on which uIP is to be run is specified. Most CPUs today are little endian, and the most notable exception are the Motorolas which are big endian. The BYTE_ORDER macro should be changed to reflect the CPU architecture on which uIP is to be run. <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g285a80366aed9428f64282b8d13c918b">UIP_BYTE_ORDER</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The byte order of the CPU architecture on which uIP is to be run. <a href="#g285a80366aed9428f64282b8d13c918b"></a><br></td></tr>
|
|
<tr><td colspan="2"><br><h2>Appication specific configurations</h2></td></tr>
|
|
<tr><td colspan="2">An uIP application is implemented using a single application function that is called by uIP whenever a TCP/IP event occurs. The name of this function must be registered with uIP at compile time using the UIP_APPCALL definition.<p>
|
|
uIP applications can store the application state within the <a class="el" href="a00088.html">uip_conn</a> structure by specifying the type of the application structure by typedef:ing the type uip_tcp_appstate_t and uip_udp_appstate_t.<p>
|
|
The file containing the definitions must be included in the <a class="el" href="a00140.html">uipopt.h</a> file.<p>
|
|
The following example illustrates how this can look. <div class="fragment"><pre class="fragment"><span class="keywordtype">void</span> <a class="code" href="a00164.html#g648ddfb2dde2cc55034e4e0ea41cb6d1">httpd_appcall</a>(<span class="keywordtype">void</span>);
|
|
<span class="preprocessor">#define UIP_APPCALL httpd_appcall</span>
|
|
<span class="preprocessor"></span>
|
|
<span class="keyword">struct </span><a class="code" href="a00080.html">httpd_state</a> {
|
|
<a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00080.html#94fcc9f5c47f419040d849ce58beae35">state</a>;
|
|
<a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00080.html#6df929b448ea98bc44d41f5e96237bda">count</a>;
|
|
<span class="keywordtype">char</span> *dataptr;
|
|
<span class="keywordtype">char</span> *script;
|
|
};
|
|
<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00080.html">httpd_state</a> <a class="code" href="a00153.html#g69646a81a922033c5281445a71f8ffed">uip_tcp_appstate_t</a>
|
|
</pre></div> <br><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g41aa744caa46913b3b3aedb2a4e78546"></a><!-- doxytag: member="uipopt::UIP_APPCALL" ref="g41aa744caa46913b3b3aedb2a4e78546" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g41aa744caa46913b3b3aedb2a4e78546">UIP_APPCALL</a> smtp_appcall</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the application function that uIP should call in response to TCP/IP events. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a00085.html">smtp_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g69646a81a922033c5281445a71f8ffed">uip_tcp_appstate_t</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The type of the application state that is to be stored in the <a class="el" href="a00088.html">uip_conn</a> structure. <a href="#g69646a81a922033c5281445a71f8ffed"></a><br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#ga92afb113e122f860392bfbd385f842e">uip_udp_appstate_t</a></td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The type of the application state that is to be stored in the <a class="el" href="a00088.html">uip_conn</a> structure. <a href="#ga92afb113e122f860392bfbd385f842e"></a><br></td></tr>
|
|
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gb6e04358481bd2057524fb874cfa472b"></a><!-- doxytag: member="uipopt::UIP_LITTLE_ENDIAN" ref="gb6e04358481bd2057524fb874cfa472b" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#gb6e04358481bd2057524fb874cfa472b">UIP_LITTLE_ENDIAN</a> 3412</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6836f92f3692f3a4429eb599db40cbae"></a><!-- doxytag: member="uipopt::UIP_BIG_ENDIAN" ref="g6836f92f3692f3a4429eb599db40cbae" args="" -->
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00153.html#g6836f92f3692f3a4429eb599db40cbae">UIP_BIG_ENDIAN</a> 1234</td></tr>
|
|
|
|
</table>
|
|
<hr><h2>Define Documentation</h2>
|
|
<a class="anchor" name="gac0de06236b02659460445de30776e00"></a><!-- doxytag: member="uipopt.h::UIP_ACTIVE_OPEN" ref="gac0de06236b02659460445de30776e00" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_ACTIVE_OPEN </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Determines if support for opening connections from uIP should be compiled in.
|
|
<p>
|
|
If the applications that are running on top of uIP for this project do not need to open outgoing TCP connections, this configration option can be turned off to reduce the code size of uIP.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00233">233</a> of file <a class="el" href="a00206.html">uipopt.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g3090117ef3ff5775b77cb1960e442d07"></a><!-- doxytag: member="uipopt.h::UIP_ARP_MAXAGE" ref="g3090117ef3ff5775b77cb1960e442d07" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_ARP_MAXAGE 120 </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The maxium age of ARP table entries measured in 10ths of seconds.
|
|
<p>
|
|
An UIP_ARP_MAXAGE of 120 corresponds to 20 minutes (BSD default).
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00358">358</a> of file <a class="el" href="a00206.html">uipopt.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="a00204.html#l00142">uip_arp_timer()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="gb1455b27c06532a399cf06d2c1d6d08d"></a><!-- doxytag: member="uipopt.h::UIP_ARPTAB_SIZE" ref="gb1455b27c06532a399cf06d2c1d6d08d" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_ARPTAB_SIZE </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The size of the ARP table.
|
|
<p>
|
|
This option should be set to a larger value if this uIP node will have many connections from the local network.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00349">349</a> of file <a class="el" href="a00206.html">uipopt.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="a00204.html#l00125">uip_arp_init()</a>, <a class="el" href="a00204.html#l00354">uip_arp_out()</a>, and <a class="el" href="a00204.html#l00142">uip_arp_timer()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g156dd2891a57035e4afdc4c2bc0b0ebf"></a><!-- doxytag: member="uipopt.h::UIP_BROADCAST" ref="g156dd2891a57035e4afdc4c2bc0b0ebf" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_BROADCAST </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Broadcast support.
|
|
<p>
|
|
This flag configures IP broadcast support. This is useful only together with UDP.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00423">423</a> of file <a class="el" href="a00206.html">uipopt.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g3589822ecb9d9c4145209756396b8a6b"></a><!-- doxytag: member="uipopt.h::UIP_BUFSIZE" ref="g3589822ecb9d9c4145209756396b8a6b" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_BUFSIZE </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The size of the uIP packet buffer.
|
|
<p>
|
|
The uIP packet buffer should not be smaller than 60 bytes, and does not need to be larger than 1500 bytes. Lower size results in lower TCP throughput, larger size results in higher TCP throughput.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00379">379</a> of file <a class="el" href="a00206.html">uipopt.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="a00199.html#l00049">uip_split_output()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g285a80366aed9428f64282b8d13c918b"></a><!-- doxytag: member="uipopt.h::UIP_BYTE_ORDER" ref="g285a80366aed9428f64282b8d13c918b" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_BYTE_ORDER </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The byte order of the CPU architecture on which uIP is to be run.
|
|
<p>
|
|
This option can be either BIG_ENDIAN (Motorola byte order) or LITTLE_ENDIAN (Intel byte order).
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00475">475</a> of file <a class="el" href="a00206.html">uipopt.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="gf5fe83be78b78b9e7d9e7f1e34ab1cc5"></a><!-- doxytag: member="uipopt.h::UIP_CONNS" ref="gf5fe83be78b78b9e7d9e7f1e34ab1cc5" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_CONNS </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The maximum number of simultaneously open TCP connections.
|
|
<p>
|
|
Since the TCP connections are statically allocated, turning this configuration knob down results in less RAM used. Each TCP connection requires approximatly 30 bytes of memory. <dl compact><dt><b>Examples: </b></dt><dd>
|
|
<a class="el" href="a00042.html#a79">example-mainloop-with-arp.c</a>, and <a class="el" href="a00043.html#a96">example-mainloop-without-arp.c</a>.</dl>
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00245">245</a> of file <a class="el" href="a00206.html">uipopt.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="a00201.html#l00407">uip_connect()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g51195ea7cd5aa387a87f9d3b23905b62"></a><!-- doxytag: member="uipopt.h::UIP_FIXEDADDR" ref="g51195ea7cd5aa387a87f9d3b23905b62" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_FIXEDADDR </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Determines if uIP should use a fixed IP address or not.
|
|
<p>
|
|
If uIP should use a fixed IP address, the settings are set in the <a class="el" href="a00140.html">uipopt.h</a> file. If not, the macros <a class="el" href="a00144.html#g12b467f314489259dd718228d0827a51">uip_sethostaddr()</a>, <a class="el" href="a00144.html#g41d37ea1e3bd24f7b51e9409aceaaa80">uip_setdraddr()</a> and <a class="el" href="a00144.html#geb79c914cf137e6d27fd7583e5a66679">uip_setnetmask()</a> should be used instead.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00097">97</a> of file <a class="el" href="a00206.html">uipopt.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="ge0f8cbeca9731af2171ffd37e79de893"></a><!-- doxytag: member="uipopt.h::UIP_FIXEDETHADDR" ref="ge0f8cbeca9731af2171ffd37e79de893" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_FIXEDETHADDR </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Specifies if the uIP ARP module should be compiled with a fixed Ethernet MAC address or not.
|
|
<p>
|
|
If this configuration option is 0, the macro <a class="el" href="a00144.html#g30e827f33eacff55ecb4d8fb5a11d5d1">uip_setethaddr()</a> can be used to specify the Ethernet address at run-time.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00127">127</a> of file <a class="el" href="a00206.html">uipopt.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g8f4ebd8ef6c0ea665ed351d87fec09fd"></a><!-- doxytag: member="uipopt.h::UIP_LISTENPORTS" ref="g8f4ebd8ef6c0ea665ed351d87fec09fd" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_LISTENPORTS </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The maximum number of simultaneously listening TCP ports.
|
|
<p>
|
|
Each listening TCP port requires 2 bytes of memory.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00259">259</a> of file <a class="el" href="a00206.html">uipopt.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="a00201.html#l00379">uip_init()</a>, <a class="el" href="a00201.html#l00529">uip_listen()</a>, and <a class="el" href="a00201.html#l00518">uip_unlisten()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="ge6f4a2453dbd8bc60e6a82774552366a"></a><!-- doxytag: member="uipopt.h::UIP_LLH_LEN" ref="ge6f4a2453dbd8bc60e6a82774552366a" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_LLH_LEN </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The link level header length.
|
|
<p>
|
|
This is the offset into the uip_buf where the IP header can be found. For Ethernet, this should be set to 14. For SLIP, this should be set to 0.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00448">448</a> of file <a class="el" href="a00206.html">uipopt.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="a00201.html#l00318">uip_ipchksum()</a>, <a class="el" href="a00201.html#l00682">uip_process()</a>, and <a class="el" href="a00199.html#l00049">uip_split_output()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g21664b7441cfa37d280228d23316d609"></a><!-- doxytag: member="uipopt.h::UIP_LOGGING" ref="g21664b7441cfa37d280228d23316d609" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_LOGGING </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Determines if logging of certain events should be compiled in.
|
|
<p>
|
|
This is useful mostly for debugging. The function <a class="el" href="a00153.html#gb58e1ceb7cb73ca2bcd73146b6c1b4e7">uip_log()</a> must be implemented to suit the architecture of the project, if logging is turned on.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00408">408</a> of file <a class="el" href="a00206.html">uipopt.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g67cf1e0d2324c93f332c1f020c0fe8b3"></a><!-- doxytag: member="uipopt.h::UIP_MAXRTX" ref="g67cf1e0d2324c93f332c1f020c0fe8b3" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_MAXRTX 8 </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The maximum number of times a segment should be retransmitted before the connection should be aborted.
|
|
<p>
|
|
This should not be changed.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00288">288</a> of file <a class="el" href="a00206.html">uipopt.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="a00201.html#l00682">uip_process()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g24aa5bc36939cc9a0833e1df01478a7e"></a><!-- doxytag: member="uipopt.h::UIP_MAXSYNRTX" ref="g24aa5bc36939cc9a0833e1df01478a7e" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_MAXSYNRTX 5 </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The maximum number of times a SYN segment should be retransmitted before a connection request should be deemed to have been unsuccessful.
|
|
<p>
|
|
This should not need to be changed.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00297">297</a> of file <a class="el" href="a00206.html">uipopt.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="a00201.html#l00682">uip_process()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g9069474ea570fd78c481aa164317dbaf"></a><!-- doxytag: member="uipopt.h::UIP_PINGADDRCONF" ref="g9069474ea570fd78c481aa164317dbaf" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_PINGADDRCONF </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Ping IP address asignment.
|
|
<p>
|
|
uIP uses a "ping" packets for setting its own IP address if this option is set. If so, uIP will start with an empty IP address and the destination IP address of the first incoming "ping" (ICMP echo) packet will be used for setting the hosts IP address.<p>
|
|
<dl compact><dt><b>Note:</b></dt><dd>This works only if UIP_FIXEDADDR is 0. </dd></dl>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00114">114</a> of file <a class="el" href="a00206.html">uipopt.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="gf963fdea2b75d27ef31e92d1d01359ee"></a><!-- doxytag: member="uipopt.h::UIP_REASSEMBLY" ref="gf963fdea2b75d27ef31e92d1d01359ee" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_REASSEMBLY </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Turn on support for IP packet reassembly.
|
|
<p>
|
|
uIP supports reassembly of fragmented IP packets. This features requires an additonal amount of RAM to hold the reassembly buffer and the reassembly code size is approximately 700 bytes. The reassembly buffer is of the same size as the uip_buf buffer (configured by UIP_BUFSIZE).<p>
|
|
<dl compact><dt><b>Note:</b></dt><dd>IP packet reassembly is not heavily tested. </dd></dl>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00156">156</a> of file <a class="el" href="a00206.html">uipopt.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g5b9dba2123705bce1ce95c3deca0bdad"></a><!-- doxytag: member="uipopt.h::UIP_RECEIVE_WINDOW" ref="g5b9dba2123705bce1ce95c3deca0bdad" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_RECEIVE_WINDOW </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The size of the advertised receiver's window.
|
|
<p>
|
|
Should be set low (i.e., to the size of the uip_buf buffer) is the application is slow to process incoming data, or high (32768 bytes) if the application processes data quickly.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00317">317</a> of file <a class="el" href="a00206.html">uipopt.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g15de27b044603284f68db05a378235a7"></a><!-- doxytag: member="uipopt.h::UIP_RTO" ref="g15de27b044603284f68db05a378235a7" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_RTO 3 </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The initial retransmission timeout counted in timer pulses.
|
|
<p>
|
|
This should not be changed.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00280">280</a> of file <a class="el" href="a00206.html">uipopt.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="a00201.html#l00682">uip_process()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g5726142fec34f35fb9ea19e5a45975c6"></a><!-- doxytag: member="uipopt.h::UIP_STATISTICS" ref="g5726142fec34f35fb9ea19e5a45975c6" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_STATISTICS </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Determines if statistics support should be compiled in.
|
|
<p>
|
|
The statistics is useful for debugging and to show the user.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00393">393</a> of file <a class="el" href="a00206.html">uipopt.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g4910467b83a639f06739c82cd362037e"></a><!-- doxytag: member="uipopt.h::UIP_TCP_MSS" ref="g4910467b83a639f06739c82cd362037e" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_TCP_MSS (UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN) </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The TCP maximum segment size.
|
|
<p>
|
|
This is should not be to set to more than UIP_BUFSIZE - UIP_LLH_LEN - UIP_TCPIP_HLEN.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00305">305</a> of file <a class="el" href="a00206.html">uipopt.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g2bc3b489923793759526a3181eb667fa"></a><!-- doxytag: member="uipopt.h::UIP_TIME_WAIT_TIMEOUT" ref="g2bc3b489923793759526a3181eb667fa" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_TIME_WAIT_TIMEOUT 120 </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
How long a connection should stay in the TIME_WAIT state.
|
|
<p>
|
|
This configiration option has no real implication, and it should be left untouched.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00328">328</a> of file <a class="el" href="a00206.html">uipopt.h</a>.
|
|
<p>
|
|
Referenced by <a class="el" href="a00201.html#l00682">uip_process()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="gb61381673de27f31848c5396bf0b338e"></a><!-- doxytag: member="uipopt.h::UIP_TTL" ref="gb61381673de27f31848c5396bf0b338e" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_TTL 64 </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The IP TTL (time to live) of IP packets sent by uIP.
|
|
<p>
|
|
This should normally not be changed.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00141">141</a> of file <a class="el" href="a00206.html">uipopt.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g92f3344ec8ca46893163399c89fafed5"></a><!-- doxytag: member="uipopt.h::UIP_UDP_CHECKSUMS" ref="g92f3344ec8ca46893163399c89fafed5" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_UDP_CHECKSUMS </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Toggles if UDP checksums should be used or not.
|
|
<p>
|
|
<dl compact><dt><b>Note:</b></dt><dd>Support for UDP checksums is currently not included in uIP, so this option has no function. </dd></dl>
|
|
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00195">195</a> of file <a class="el" href="a00206.html">uipopt.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g51c1cd531ff0afb81620151f2248cd21"></a><!-- doxytag: member="uipopt.h::UIP_URGDATA" ref="g51c1cd531ff0afb81620151f2248cd21" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define UIP_URGDATA </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Determines if support for TCP urgent data notification should be compiled in.
|
|
<p>
|
|
Urgent data (out-of-band data) is a rarely used TCP feature that very seldom would be required.
|
|
<p>
|
|
Definition at line <a class="el" href="a00206.html#l00273">273</a> of file <a class="el" href="a00206.html">uipopt.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Typedef Documentation</h2>
|
|
<a class="anchor" name="g77570ac4fcab86864fa1916e55676da2"></a><!-- doxytag: member="uip-conf.h::u16_t" ref="g77570ac4fcab86864fa1916e55676da2" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">typedef uint16_t <a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
16 bit datatype
|
|
<p>
|
|
This typedef defines the 16-bit type used throughout uIP. <dl compact><dt><b>Examples: </b></dt><dd>
|
|
<a class="el" href="a00048.html#a2">dhcpc.c</a>, <a class="el" href="a00049.html#a51">dhcpc.h</a>, <a class="el" href="a00046.html#a125">resolv.c</a>, <a class="el" href="a00047.html#a157">resolv.h</a>, <a class="el" href="a00038.html#a188">smtp.c</a>, <a class="el" href="a00039.html#a197">smtp.h</a>, <a class="el" href="a00044.html#a230">telnetd.c</a>, and <a class="el" href="a00050.html#a250">uip-conf.h</a>.</dl>
|
|
<p>
|
|
Definition at line <a class="el" href="a00207.html#l00076">76</a> of file <a class="el" href="a00207.html">uip-conf.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g4caecabca98b43919dd11be1c0d4cd8e"></a><!-- doxytag: member="uip-conf.h::u8_t" ref="g4caecabca98b43919dd11be1c0d4cd8e" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">typedef uint8_t <a class="el" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
8 bit datatype
|
|
<p>
|
|
This typedef defines the 8-bit type used throughout uIP. <dl compact><dt><b>Examples: </b></dt><dd>
|
|
<a class="el" href="a00048.html#a1">dhcpc.c</a>, <a class="el" href="a00049.html#a53">dhcpc.h</a>, <a class="el" href="a00046.html#a126">resolv.c</a>, <a class="el" href="a00039.html#a200">smtp.h</a>, <a class="el" href="a00044.html#a227">telnetd.c</a>, <a class="el" href="a00045.html#a245">telnetd.h</a>, and <a class="el" href="a00050.html#a249">uip-conf.h</a>.</dl>
|
|
<p>
|
|
Definition at line <a class="el" href="a00207.html#l00067">67</a> of file <a class="el" href="a00207.html">uip-conf.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g727459e5c4f777543c81ffffa3df3f0c"></a><!-- doxytag: member="uip-conf.h::uip_stats_t" ref="g727459e5c4f777543c81ffffa3df3f0c" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">typedef unsigned short <a class="el" href="a00153.html#g727459e5c4f777543c81ffffa3df3f0c">uip_stats_t</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Statistics datatype.
|
|
<p>
|
|
This typedef defines the dataype used for keeping statistics in uIP.
|
|
<p>
|
|
Definition at line <a class="el" href="a00207.html#l00086">86</a> of file <a class="el" href="a00207.html">uip-conf.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="g69646a81a922033c5281445a71f8ffed"></a><!-- doxytag: member="smtp.h::uip_tcp_appstate_t" ref="g69646a81a922033c5281445a71f8ffed" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">typedef <a class="el" href="a00085.html">uip_tcp_appstate_t</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The type of the application state that is to be stored in the <a class="el" href="a00088.html">uip_conn</a> structure.
|
|
<p>
|
|
This usually is typedef:ed to a struct holding application state information. <dl compact><dt><b>Examples: </b></dt><dd>
|
|
<a class="el" href="a00039.html#a205">smtp.h</a>, <a class="el" href="a00045.html#a248">telnetd.h</a>, and <a class="el" href="a00041.html#a317">webclient.h</a>.</dl>
|
|
<p>
|
|
Definition at line <a class="el" href="a00175.html#l00098">98</a> of file <a class="el" href="a00175.html">smtp.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="ga92afb113e122f860392bfbd385f842e"></a><!-- doxytag: member="resolv.h::uip_udp_appstate_t" ref="ga92afb113e122f860392bfbd385f842e" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">typedef <a class="el" href="a00153.html#ga92afb113e122f860392bfbd385f842e">uip_udp_appstate_t</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
The type of the application state that is to be stored in the <a class="el" href="a00088.html">uip_conn</a> structure.
|
|
<p>
|
|
This usually is typedef:ed to a struct holding application state information. <dl compact><dt><b>Examples: </b></dt><dd>
|
|
<a class="el" href="a00049.html#a59">dhcpc.h</a>.</dl>
|
|
<p>
|
|
Definition at line <a class="el" href="a00173.html#l00047">47</a> of file <a class="el" href="a00173.html">resolv.h</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Function Documentation</h2>
|
|
<a class="anchor" name="gb58e1ceb7cb73ca2bcd73146b6c1b4e7"></a><!-- doxytag: member="uipopt.h::uip_log" ref="gb58e1ceb7cb73ca2bcd73146b6c1b4e7" args="(char *msg)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void uip_log </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">char * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>msg</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
Print out a uIP log message.
|
|
<p>
|
|
This function must be implemented by the module that uses uIP, and is called by uIP whenever a log message is generated. </td>
|
|
</tr>
|
|
</table>
|
|
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:02 2006 for uIP 1.0 by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
|
|
</body>
|
|
</html>
|