📄 group__opentcp__config.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>OpenTCP configuration parameters</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.2.18 --><center><a class="qindex" href="main.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindex" href="examples.html">Examples</a> </center><hr><h1>OpenTCP configuration parameters</h1><hr><a name="_details"></a><h2>Detailed Description</h2>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).<p>By modifying these and adjusting them to your applications' requirements, optimal application performance can be found for a given system constraints. <table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>Files</h2></td></tr><tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="config_8h.html">config.h</a></td></tr><tr><td> </td><td><font size=-1><em>OpenTCP hardware configuration file.</em></font><br><br></td></tr><p><tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="datatypes_8h.html">datatypes.h</a></td></tr><tr><td> </td><td><font size=-1><em>OpenTCP definitions of datatypes of certain length.</em></font><br><br></td></tr><p><tr><td nowrap align=right valign=top>file </td><td valign=bottom><a class="el" href="debug_8h.html">debug.h</a></td></tr><tr><td> </td><td><font size=-1><em>OpenTCP file for debug options.</em></font><br><br></td></tr><p><tr><td colspan=2><br><h2>Defines</h2></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a0">ARP_TSIZE</a> 10</td></tr><tr><td> </td><td><font size=-1><em>ARP cache size (number of entries).</em> <a href="#a0"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a1">ARP_TIMEOUT</a> 60</td></tr><tr><td> </td><td><font size=-1><em>ARP cache entry refresh period (in seconds).</em> <a href="#a1"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a2">ARP_RESEND</a> 2</td></tr><tr><td> </td><td><font size=-1><em>ARP Request resend period (in seconds).</em> <a href="#a2"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a3">ARP_MAXRETRY</a> 5</td></tr><tr><td> </td><td><font size=-1><em>Number of IP address resolving retires.</em> <a href="#a3"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a4">NETWORK_TX_BUFFER_SIZE</a> 1024</td></tr><tr><td> </td><td><font size=-1><em>Transmit buffer size.</em> <a href="#a4"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a5">NO_OF_TCPSOCKETS</a> 8</td></tr><tr><td> </td><td><font size=-1><em>Defines number of TCP sockets available.</em> <a href="#a5"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a6">NO_OF_UDPSOCKETS</a> 4</td></tr><tr><td> </td><td><font size=-1><em>Defines number of UDP sockets available.</em> <a href="#a6"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a7">TCP_PORTS_END</a> 1023</td></tr><tr><td> </td><td><font size=-1><em>Define reserved-ports space.</em> <a href="#a7"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a8">UDP_PORTS_END</a> 1023</td></tr><tr><td> </td><td><font size=-1><em>Define reserved-ports space.</em> <a href="#a8"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a9">TCP_DEF_RETRIES</a> 7</td></tr><tr><td> </td><td><font size=-1><em>Number of attempted TCP retransmissions before giving up.</em> <a href="#a9"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a10">TCP_DEF_KEEPALIVE</a> 4</td></tr><tr><td> </td><td><font size=-1><em>Defines a number of seconds after which an empty ACK packet is sent.</em> <a href="#a10"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a11">TCP_DEF_RETRY_TOUT</a> 4</td></tr><tr><td> </td><td><font size=-1><em>Default data-retransmission period (in seconds).</em> <a href="#a11"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a12">TCP_INIT_RETRY_TOUT</a> 1</td></tr><tr><td> </td><td><font size=-1><em>Initial retransmission period (in seconds).</em> <a href="#a12"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a13">TCP_SYN_RETRY_TOUT</a> 2</td></tr><tr><td> </td><td><font size=-1><em>Retranmission period for SYN packet.</em> <a href="#a13"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a14">TCP_DEF_TOUT</a> 120</td></tr><tr><td> </td><td><font size=-1><em>Default idle timeout.</em> <a href="#a14"></a><em></em></font><br><br></td></tr><tr><td nowrap align=right valign=top>#define </td><td valign=bottom><a class="el" href="group__opentcp__config.html#a15">NUMTIMERS</a> 55</td></tr><tr><td> </td><td><font size=-1><em>Number of timers available in the system.</em> <a href="#a15"></a><em></em></font><br><br></td></tr></table><hr><h2>Define Documentation</h2><a name="a0" doxytag="arp.h::ARP_TSIZE"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define ARP_TSIZE 10 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Change this number to change ARP cache size (number of cached ARP:IP address pairs).<p>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. <p>Definition at line <a class="el" href="arp_8h-source.html#l00091">91</a> of file <a class="el" href="arp_8h-source.html">arp.h</a>. </td> </tr></table><a name="a1" doxytag="arp.h::ARP_TIMEOUT"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define ARP_TIMEOUT 60 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Change this number to change refresh period of ARP cache entries.<p>Changing this values changes the amount of ARP refreshes performed and thus can change processing power used when refreshing the entries. <p>Definition at line <a class="el" href="arp_8h-source.html#l00102">102</a> of file <a class="el" href="arp_8h-source.html">arp.h</a>.<p>Referenced by <a class="el" href="arp_8c-source.html#l00552">arp_add()</a>, <a class="el" href="arp_8c-source.html#l00307">arp_get_response()</a>, <a class="el" href="arp_8c-source.html#l00910">arp_init()</a>, and <a class="el" href="arp_8c-source.html#l00785">arp_manage()</a>. </td> </tr></table><a name="a2" doxytag="arp.h::ARP_RESEND"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define ARP_RESEND 2 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Change this number to determine how quickly will ARP module issue ARP requests.<p>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. <p>Definition at line <a class="el" href="arp_8h-source.html#l00117">117</a> of file <a class="el" href="arp_8h-source.html">arp.h</a>.<p>Referenced by <a class="el" href="arp_8c-source.html#l00639">arp_find()</a>, and <a class="el" href="arp_8c-source.html#l00785">arp_manage()</a>. </td> </tr></table><a name="a3" doxytag="arp.h::ARP_MAXRETRY"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define ARP_MAXRETRY 5 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Change this number to change number of times ARP module will resend ARP requests before giving up (if no ARP reply is received). <p>Definition at line <a class="el" href="arp_8h-source.html#l00126">126</a> of file <a class="el" href="arp_8h-source.html">arp.h</a>.<p>Referenced by <a class="el" href="arp_8c-source.html#l00552">arp_add()</a>, <a class="el" href="arp_8c-source.html#l00639">arp_find()</a>, <a class="el" href="arp_8c-source.html#l00307">arp_get_response()</a>, and <a class="el" href="arp_8c-source.html#l00910">arp_init()</a>. </td> </tr></table><a name="a4" doxytag="system.h::NETWORK_TX_BUFFER_SIZE"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define NETWORK_TX_BUFFER_SIZE 1024 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>NETWORK_TX_BUFFER_SIZE defines the size of the network buffer used for data transmission by ICMP as well as TCP and UDP applications.<p>See net_buf documentation for more reference on the shared transmit buffer. <p>Definition at line <a class="el" href="system_8h-source.html#l00091">91</a> of file <a class="el" href="system_8h-source.html">system.h</a>.<p>Referenced by <a class="el" href="bootp_8c-source.html#l00183">bootpc_run()</a>, <a class="el" href="dhcpc_8c-source.html#l00389">dhcpc_send_message()</a>, <a class="el" href="dns_8c-source.html#l00445">get_host_by_name()</a>, and <a class="el" href="icmp_8c-source.html#l00097">process_icmp_in()</a>. </td> </tr></table><a name="a5" doxytag="tcp_ip.h::NO_OF_TCPSOCKETS"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define NO_OF_TCPSOCKETS 8 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Change this number to change maximum number of TCP sockets available to the application. <p>Definition at line <a class="el" href="tcp__ip_8h-source.html#l00081">81</a> of file <a class="el" href="tcp__ip_8h-source.html">tcp_ip.h</a>. </td> </tr></table><a name="a6" doxytag="tcp_ip.h::NO_OF_UDPSOCKETS"></a><p><table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> #define NO_OF_UDPSOCKETS 4 </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Change this number to change maximum number of UDP sockets available to the application. <p>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -