1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3<title>uIP 1.0: uIP configuration functions</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5<link href="tabs.css" rel="stylesheet" type="text/css"> 6</head><body> 7<!-- Generated by Doxygen 1.4.6 --> 8<div class="tabs"> 9 <ul> 10 <li><a href="main.html"><span>Main Page</span></a></li> 11 <li><a href="modules.html"><span>Modules</span></a></li> 12 <li><a href="classes.html"><span>Data Structures</span></a></li> 13 <li><a href="files.html"><span>Files</span></a></li> 14 <li><a href="examples.html"><span>Examples</span></a></li> 15 </ul></div> 16<h1>uIP configuration functions<br> 17<small> 18[<a class="el" href="a00150.html">The uIP TCP/IP stack</a>]</small> 19</h1><hr><a name="_details"></a><h2>Detailed Description</h2> 20The uIP configuration functions are used for setting run-time parameters in uIP such as IP addresses. 21<p> 22 23<p> 24<table border="0" cellpadding="0" cellspacing="0"> 25<tr><td></td></tr> 26<tr><td colspan="2"><br><h2>Defines</h2></td></tr> 27<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#g12b467f314489259dd718228d0827a51">uip_sethostaddr</a>(addr)</td></tr> 28 29<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the IP address of this host. <a href="#g12b467f314489259dd718228d0827a51"></a><br></td></tr> 30<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#g20bc87e5c063c3f4b01547be6e5a0148">uip_gethostaddr</a>(addr)</td></tr> 31 32<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the IP address of this host. <a href="#g20bc87e5c063c3f4b01547be6e5a0148"></a><br></td></tr> 33<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#g41d37ea1e3bd24f7b51e9409aceaaa80">uip_setdraddr</a>(addr)</td></tr> 34 35<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the default router's IP address. <a href="#g41d37ea1e3bd24f7b51e9409aceaaa80"></a><br></td></tr> 36<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#geb79c914cf137e6d27fd7583e5a66679">uip_setnetmask</a>(addr)</td></tr> 37 38<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the netmask. <a href="#geb79c914cf137e6d27fd7583e5a66679"></a><br></td></tr> 39<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#gd8e8bc9bc0e2ea4a24a8a024fd3a7f7c">uip_getdraddr</a>(addr)</td></tr> 40 41<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the default router's IP address. <a href="#gd8e8bc9bc0e2ea4a24a8a024fd3a7f7c"></a><br></td></tr> 42<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#g5323320b7316647042016f17c4e881be">uip_getnetmask</a>(addr)</td></tr> 43 44<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the netmask. <a href="#g5323320b7316647042016f17c4e881be"></a><br></td></tr> 45<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#g30e827f33eacff55ecb4d8fb5a11d5d1">uip_setethaddr</a>(eaddr)</td></tr> 46 47<tr><td class="mdescLeft"> </td><td class="mdescRight">Specifiy the Ethernet MAC address. <a href="#g30e827f33eacff55ecb4d8fb5a11d5d1"></a><br></td></tr> 48</table> 49<hr><h2>Define Documentation</h2> 50<a class="anchor" name="gd8e8bc9bc0e2ea4a24a8a024fd3a7f7c"></a><!-- doxytag: member="uip.h::uip_getdraddr" ref="gd8e8bc9bc0e2ea4a24a8a024fd3a7f7c" args="(addr)" --><p> 51<table class="mdTable" cellpadding="2" cellspacing="0"> 52 <tr> 53 <td class="mdRow"> 54 <table cellpadding="0" cellspacing="0" border="0"> 55 <tr> 56 <td class="md" nowrap valign="top">#define uip_getdraddr </td> 57 <td class="md" valign="top">( </td> 58 <td class="md" nowrap valign="top">addr </td> 59 <td class="mdname1" valign="top" nowrap> </td> 60 <td class="md" valign="top"> ) </td> 61 <td class="md" nowrap></td> 62 </tr> 63 </table> 64 </td> 65 </tr> 66</table> 67<table cellspacing="5" cellpadding="0" border="0"> 68 <tr> 69 <td> 70 71 </td> 72 <td> 73 74<p> 75Get the default router's IP address. 76<p> 77<dl compact><dt><b>Parameters:</b></dt><dd> 78 <table border="0" cellspacing="2" cellpadding="0"> 79 <tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>A pointer to a uip_ipaddr_t variable that will be filled in with the IP address of the default router. </td></tr> 80 </table> 81</dl> 82 83<p> 84Definition at line <a class="el" href="a00202.html#l00161">161</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 85 </tr> 86</table> 87<a class="anchor" name="g20bc87e5c063c3f4b01547be6e5a0148"></a><!-- doxytag: member="uip.h::uip_gethostaddr" ref="g20bc87e5c063c3f4b01547be6e5a0148" args="(addr)" --><p> 88<table class="mdTable" cellpadding="2" cellspacing="0"> 89 <tr> 90 <td class="mdRow"> 91 <table cellpadding="0" cellspacing="0" border="0"> 92 <tr> 93 <td class="md" nowrap valign="top">#define uip_gethostaddr </td> 94 <td class="md" valign="top">( </td> 95 <td class="md" nowrap valign="top">addr </td> 96 <td class="mdname1" valign="top" nowrap> </td> 97 <td class="md" valign="top"> ) </td> 98 <td class="md" nowrap></td> 99 </tr> 100 </table> 101 </td> 102 </tr> 103</table> 104<table cellspacing="5" cellpadding="0" border="0"> 105 <tr> 106 <td> 107 108 </td> 109 <td> 110 111<p> 112Get the IP address of this host. 113<p> 114The IP address is represented as a 4-byte array where the first octet of the IP address is put in the first member of the 4-byte array.<p> 115Example: <div class="fragment"><pre class="fragment"> <a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> hostaddr; 116 117 <a class="code" href="a00144.html#g20bc87e5c063c3f4b01547be6e5a0148">uip_gethostaddr</a>(&hostaddr); 118</pre></div> <dl compact><dt><b>Parameters:</b></dt><dd> 119 <table border="0" cellspacing="2" cellpadding="0"> 120 <tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>A pointer to a uip_ipaddr_t variable that will be filled in with the currently configured IP address. </td></tr> 121 </table> 122</dl> 123 124<p> 125Definition at line <a class="el" href="a00202.html#l00126">126</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 126 </tr> 127</table> 128<a class="anchor" name="g5323320b7316647042016f17c4e881be"></a><!-- doxytag: member="uip.h::uip_getnetmask" ref="g5323320b7316647042016f17c4e881be" args="(addr)" --><p> 129<table class="mdTable" cellpadding="2" cellspacing="0"> 130 <tr> 131 <td class="mdRow"> 132 <table cellpadding="0" cellspacing="0" border="0"> 133 <tr> 134 <td class="md" nowrap valign="top">#define uip_getnetmask </td> 135 <td class="md" valign="top">( </td> 136 <td class="md" nowrap valign="top">addr </td> 137 <td class="mdname1" valign="top" nowrap> </td> 138 <td class="md" valign="top"> ) </td> 139 <td class="md" nowrap></td> 140 </tr> 141 </table> 142 </td> 143 </tr> 144</table> 145<table cellspacing="5" cellpadding="0" border="0"> 146 <tr> 147 <td> 148 149 </td> 150 <td> 151 152<p> 153Get the netmask. 154<p> 155<dl compact><dt><b>Parameters:</b></dt><dd> 156 <table border="0" cellspacing="2" cellpadding="0"> 157 <tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>A pointer to a uip_ipaddr_t variable that will be filled in with the value of the netmask. </td></tr> 158 </table> 159</dl> 160 161<p> 162Definition at line <a class="el" href="a00202.html#l00171">171</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 163 </tr> 164</table> 165<a class="anchor" name="g41d37ea1e3bd24f7b51e9409aceaaa80"></a><!-- doxytag: member="uip.h::uip_setdraddr" ref="g41d37ea1e3bd24f7b51e9409aceaaa80" args="(addr)" --><p> 166<table class="mdTable" cellpadding="2" cellspacing="0"> 167 <tr> 168 <td class="mdRow"> 169 <table cellpadding="0" cellspacing="0" border="0"> 170 <tr> 171 <td class="md" nowrap valign="top">#define uip_setdraddr </td> 172 <td class="md" valign="top">( </td> 173 <td class="md" nowrap valign="top">addr </td> 174 <td class="mdname1" valign="top" nowrap> </td> 175 <td class="md" valign="top"> ) </td> 176 <td class="md" nowrap></td> 177 </tr> 178 </table> 179 </td> 180 </tr> 181</table> 182<table cellspacing="5" cellpadding="0" border="0"> 183 <tr> 184 <td> 185 186 </td> 187 <td> 188 189<p> 190Set the default router's IP address. 191<p> 192<dl compact><dt><b>Parameters:</b></dt><dd> 193 <table border="0" cellspacing="2" cellpadding="0"> 194 <tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>A pointer to a uip_ipaddr_t variable containing the IP address of the default router.</td></tr> 195 </table> 196</dl> 197<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00148.html#g87f0b54ade0d159fba495089128a4932">uip_ipaddr()</a> </dd></dl> 198 199<p> 200Definition at line <a class="el" href="a00202.html#l00138">138</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 201 </tr> 202</table> 203<a class="anchor" name="g30e827f33eacff55ecb4d8fb5a11d5d1"></a><!-- doxytag: member="uip_arp.h::uip_setethaddr" ref="g30e827f33eacff55ecb4d8fb5a11d5d1" args="(eaddr)" --><p> 204<table class="mdTable" cellpadding="2" cellspacing="0"> 205 <tr> 206 <td class="mdRow"> 207 <table cellpadding="0" cellspacing="0" border="0"> 208 <tr> 209 <td class="md" nowrap valign="top">#define uip_setethaddr </td> 210 <td class="md" valign="top">( </td> 211 <td class="md" nowrap valign="top">eaddr </td> 212 <td class="mdname1" valign="top" nowrap> </td> 213 <td class="md" valign="top"> ) </td> 214 <td class="md" nowrap></td> 215 </tr> 216 </table> 217 </td> 218 </tr> 219</table> 220<table cellspacing="5" cellpadding="0" border="0"> 221 <tr> 222 <td> 223 224 </td> 225 <td> 226 227<p> 228Specifiy the Ethernet MAC address. 229<p> 230The ARP code needs to know the MAC address of the Ethernet card in order to be able to respond to ARP queries and to generate working Ethernet headers.<p> 231<dl compact><dt><b>Note:</b></dt><dd>This macro only specifies the Ethernet MAC address to the ARP code. It cannot be used to change the MAC address of the Ethernet card.</dd></dl> 232<dl compact><dt><b>Parameters:</b></dt><dd> 233 <table border="0" cellspacing="2" cellpadding="0"> 234 <tr><td valign="top"></td><td valign="top"><em>eaddr</em> </td><td>A pointer to a struct <a class="el" href="a00089.html">uip_eth_addr</a> containing the Ethernet MAC address of the Ethernet card. </td></tr> 235 </table> 236</dl> 237 238<p> 239Definition at line <a class="el" href="a00205.html#l00134">134</a> of file <a class="el" href="a00205.html">uip_arp.h</a>. </td> 240 </tr> 241</table> 242<a class="anchor" name="g12b467f314489259dd718228d0827a51"></a><!-- doxytag: member="uip.h::uip_sethostaddr" ref="g12b467f314489259dd718228d0827a51" args="(addr)" --><p> 243<table class="mdTable" cellpadding="2" cellspacing="0"> 244 <tr> 245 <td class="mdRow"> 246 <table cellpadding="0" cellspacing="0" border="0"> 247 <tr> 248 <td class="md" nowrap valign="top">#define uip_sethostaddr </td> 249 <td class="md" valign="top">( </td> 250 <td class="md" nowrap valign="top">addr </td> 251 <td class="mdname1" valign="top" nowrap> </td> 252 <td class="md" valign="top"> ) </td> 253 <td class="md" nowrap></td> 254 </tr> 255 </table> 256 </td> 257 </tr> 258</table> 259<table cellspacing="5" cellpadding="0" border="0"> 260 <tr> 261 <td> 262 263 </td> 264 <td> 265 266<p> 267Set the IP address of this host. 268<p> 269The IP address is represented as a 4-byte array where the first octet of the IP address is put in the first member of the 4-byte array.<p> 270Example: <div class="fragment"><pre class="fragment"> <a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> addr; 271 272 <a class="code" href="a00148.html#g87f0b54ade0d159fba495089128a4932">uip_ipaddr</a>(&addr, 192,168,1,2); 273 <a class="code" href="a00144.html#g12b467f314489259dd718228d0827a51">uip_sethostaddr</a>(&addr); 274</pre></div> <dl compact><dt><b>Parameters:</b></dt><dd> 275 <table border="0" cellspacing="2" cellpadding="0"> 276 <tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>A pointer to an IP address of type uip_ipaddr_t;</td></tr> 277 </table> 278</dl> 279<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00148.html#g87f0b54ade0d159fba495089128a4932">uip_ipaddr()</a> </dd></dl> 280<dl compact><dt><b>Examples: </b></dt><dd> 281<a class="el" href="a00048.html#a42">dhcpc.c</a>, <a class="el" href="a00042.html#a66">example-mainloop-with-arp.c</a>, and <a class="el" href="a00043.html#a90">example-mainloop-without-arp.c</a>.</dl> 282<p> 283Definition at line <a class="el" href="a00202.html#l00106">106</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 284 </tr> 285</table> 286<a class="anchor" name="geb79c914cf137e6d27fd7583e5a66679"></a><!-- doxytag: member="uip.h::uip_setnetmask" ref="geb79c914cf137e6d27fd7583e5a66679" args="(addr)" --><p> 287<table class="mdTable" cellpadding="2" cellspacing="0"> 288 <tr> 289 <td class="mdRow"> 290 <table cellpadding="0" cellspacing="0" border="0"> 291 <tr> 292 <td class="md" nowrap valign="top">#define uip_setnetmask </td> 293 <td class="md" valign="top">( </td> 294 <td class="md" nowrap valign="top">addr </td> 295 <td class="mdname1" valign="top" nowrap> </td> 296 <td class="md" valign="top"> ) </td> 297 <td class="md" nowrap></td> 298 </tr> 299 </table> 300 </td> 301 </tr> 302</table> 303<table cellspacing="5" cellpadding="0" border="0"> 304 <tr> 305 <td> 306 307 </td> 308 <td> 309 310<p> 311Set the netmask. 312<p> 313<dl compact><dt><b>Parameters:</b></dt><dd> 314 <table border="0" cellspacing="2" cellpadding="0"> 315 <tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>A pointer to a uip_ipaddr_t variable containing the IP address of the netmask.</td></tr> 316 </table> 317</dl> 318<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00148.html#g87f0b54ade0d159fba495089128a4932">uip_ipaddr()</a> </dd></dl> 319 320<p> 321Definition at line <a class="el" href="a00202.html#l00150">150</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 322 </tr> 323</table> 324<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:02 2006 for uIP 1.0 by 325<a href="http://www.doxygen.org/index.html"> 326<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> 327</body> 328</html> 329
