a00144.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
  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&nbsp;Page</span></a></li>
  11. <li><a href="modules.html"><span>Modules</span></a></li>
  12. <li><a href="classes.html"><span>Data&nbsp;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>
  20. The uIP configuration functions are used for setting run-time parameters in uIP such as IP addresses.
  21. <p>
  22. <p>
  23. <table border="0" cellpadding="0" cellspacing="0">
  24. <tr><td></td></tr>
  25. <tr><td colspan="2"><br><h2>Defines</h2></td></tr>
  26. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#g12b467f314489259dd718228d0827a51">uip_sethostaddr</a>(addr)</td></tr>
  27. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the IP address of this host. <a href="#g12b467f314489259dd718228d0827a51"></a><br></td></tr>
  28. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#g20bc87e5c063c3f4b01547be6e5a0148">uip_gethostaddr</a>(addr)</td></tr>
  29. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the IP address of this host. <a href="#g20bc87e5c063c3f4b01547be6e5a0148"></a><br></td></tr>
  30. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#g41d37ea1e3bd24f7b51e9409aceaaa80">uip_setdraddr</a>(addr)</td></tr>
  31. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the default router's IP address. <a href="#g41d37ea1e3bd24f7b51e9409aceaaa80"></a><br></td></tr>
  32. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#geb79c914cf137e6d27fd7583e5a66679">uip_setnetmask</a>(addr)</td></tr>
  33. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the netmask. <a href="#geb79c914cf137e6d27fd7583e5a66679"></a><br></td></tr>
  34. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#gd8e8bc9bc0e2ea4a24a8a024fd3a7f7c">uip_getdraddr</a>(addr)</td></tr>
  35. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the default router's IP address. <a href="#gd8e8bc9bc0e2ea4a24a8a024fd3a7f7c"></a><br></td></tr>
  36. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#g5323320b7316647042016f17c4e881be">uip_getnetmask</a>(addr)</td></tr>
  37. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the netmask. <a href="#g5323320b7316647042016f17c4e881be"></a><br></td></tr>
  38. <tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00144.html#g30e827f33eacff55ecb4d8fb5a11d5d1">uip_setethaddr</a>(eaddr)</td></tr>
  39. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specifiy the Ethernet MAC address. <a href="#g30e827f33eacff55ecb4d8fb5a11d5d1"></a><br></td></tr>
  40. </table>
  41. <hr><h2>Define Documentation</h2>
  42. <a class="anchor" name="gd8e8bc9bc0e2ea4a24a8a024fd3a7f7c"></a><!-- doxytag: member="uip.h::uip_getdraddr" ref="gd8e8bc9bc0e2ea4a24a8a024fd3a7f7c" args="(addr)" --><p>
  43. <table class="mdTable" cellpadding="2" cellspacing="0">
  44. <tr>
  45. <td class="mdRow">
  46. <table cellpadding="0" cellspacing="0" border="0">
  47. <tr>
  48. <td class="md" nowrap valign="top">#define uip_getdraddr </td>
  49. <td class="md" valign="top">(&nbsp;</td>
  50. <td class="md" nowrap valign="top">addr&nbsp;</td>
  51. <td class="mdname1" valign="top" nowrap> </td>
  52. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  53. <td class="md" nowrap></td>
  54. </tr>
  55. </table>
  56. </td>
  57. </tr>
  58. </table>
  59. <table cellspacing="5" cellpadding="0" border="0">
  60. <tr>
  61. <td>
  62. &nbsp;
  63. </td>
  64. <td>
  65. <p>
  66. Get the default router's IP address.
  67. <p>
  68. <dl compact><dt><b>Parameters:</b></dt><dd>
  69. <table border="0" cellspacing="2" cellpadding="0">
  70. <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</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>
  71. </table>
  72. </dl>
  73. <p>
  74. Definition at line <a class="el" href="a00202.html#l00161">161</a> of file <a class="el" href="a00202.html">uip.h</a>. </td>
  75. </tr>
  76. </table>
  77. <a class="anchor" name="g20bc87e5c063c3f4b01547be6e5a0148"></a><!-- doxytag: member="uip.h::uip_gethostaddr" ref="g20bc87e5c063c3f4b01547be6e5a0148" args="(addr)" --><p>
  78. <table class="mdTable" cellpadding="2" cellspacing="0">
  79. <tr>
  80. <td class="mdRow">
  81. <table cellpadding="0" cellspacing="0" border="0">
  82. <tr>
  83. <td class="md" nowrap valign="top">#define uip_gethostaddr </td>
  84. <td class="md" valign="top">(&nbsp;</td>
  85. <td class="md" nowrap valign="top">addr&nbsp;</td>
  86. <td class="mdname1" valign="top" nowrap> </td>
  87. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  88. <td class="md" nowrap></td>
  89. </tr>
  90. </table>
  91. </td>
  92. </tr>
  93. </table>
  94. <table cellspacing="5" cellpadding="0" border="0">
  95. <tr>
  96. <td>
  97. &nbsp;
  98. </td>
  99. <td>
  100. <p>
  101. Get the IP address of this host.
  102. <p>
  103. The 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>
  104. Example: <div class="fragment"><pre class="fragment"> <a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> hostaddr;
  105. <a class="code" href="a00144.html#g20bc87e5c063c3f4b01547be6e5a0148">uip_gethostaddr</a>(&amp;hostaddr);
  106. </pre></div> <dl compact><dt><b>Parameters:</b></dt><dd>
  107. <table border="0" cellspacing="2" cellpadding="0">
  108. <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>A pointer to a uip_ipaddr_t variable that will be filled in with the currently configured IP address. </td></tr>
  109. </table>
  110. </dl>
  111. <p>
  112. Definition at line <a class="el" href="a00202.html#l00126">126</a> of file <a class="el" href="a00202.html">uip.h</a>. </td>
  113. </tr>
  114. </table>
  115. <a class="anchor" name="g5323320b7316647042016f17c4e881be"></a><!-- doxytag: member="uip.h::uip_getnetmask" ref="g5323320b7316647042016f17c4e881be" args="(addr)" --><p>
  116. <table class="mdTable" cellpadding="2" cellspacing="0">
  117. <tr>
  118. <td class="mdRow">
  119. <table cellpadding="0" cellspacing="0" border="0">
  120. <tr>
  121. <td class="md" nowrap valign="top">#define uip_getnetmask </td>
  122. <td class="md" valign="top">(&nbsp;</td>
  123. <td class="md" nowrap valign="top">addr&nbsp;</td>
  124. <td class="mdname1" valign="top" nowrap> </td>
  125. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  126. <td class="md" nowrap></td>
  127. </tr>
  128. </table>
  129. </td>
  130. </tr>
  131. </table>
  132. <table cellspacing="5" cellpadding="0" border="0">
  133. <tr>
  134. <td>
  135. &nbsp;
  136. </td>
  137. <td>
  138. <p>
  139. Get the netmask.
  140. <p>
  141. <dl compact><dt><b>Parameters:</b></dt><dd>
  142. <table border="0" cellspacing="2" cellpadding="0">
  143. <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>A pointer to a uip_ipaddr_t variable that will be filled in with the value of the netmask. </td></tr>
  144. </table>
  145. </dl>
  146. <p>
  147. Definition at line <a class="el" href="a00202.html#l00171">171</a> of file <a class="el" href="a00202.html">uip.h</a>. </td>
  148. </tr>
  149. </table>
  150. <a class="anchor" name="g41d37ea1e3bd24f7b51e9409aceaaa80"></a><!-- doxytag: member="uip.h::uip_setdraddr" ref="g41d37ea1e3bd24f7b51e9409aceaaa80" args="(addr)" --><p>
  151. <table class="mdTable" cellpadding="2" cellspacing="0">
  152. <tr>
  153. <td class="mdRow">
  154. <table cellpadding="0" cellspacing="0" border="0">
  155. <tr>
  156. <td class="md" nowrap valign="top">#define uip_setdraddr </td>
  157. <td class="md" valign="top">(&nbsp;</td>
  158. <td class="md" nowrap valign="top">addr&nbsp;</td>
  159. <td class="mdname1" valign="top" nowrap> </td>
  160. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  161. <td class="md" nowrap></td>
  162. </tr>
  163. </table>
  164. </td>
  165. </tr>
  166. </table>
  167. <table cellspacing="5" cellpadding="0" border="0">
  168. <tr>
  169. <td>
  170. &nbsp;
  171. </td>
  172. <td>
  173. <p>
  174. Set the default router's IP address.
  175. <p>
  176. <dl compact><dt><b>Parameters:</b></dt><dd>
  177. <table border="0" cellspacing="2" cellpadding="0">
  178. <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>A pointer to a uip_ipaddr_t variable containing the IP address of the default router.</td></tr>
  179. </table>
  180. </dl>
  181. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00148.html#g87f0b54ade0d159fba495089128a4932">uip_ipaddr()</a> </dd></dl>
  182. <p>
  183. Definition at line <a class="el" href="a00202.html#l00138">138</a> of file <a class="el" href="a00202.html">uip.h</a>. </td>
  184. </tr>
  185. </table>
  186. <a class="anchor" name="g30e827f33eacff55ecb4d8fb5a11d5d1"></a><!-- doxytag: member="uip_arp.h::uip_setethaddr" ref="g30e827f33eacff55ecb4d8fb5a11d5d1" args="(eaddr)" --><p>
  187. <table class="mdTable" cellpadding="2" cellspacing="0">
  188. <tr>
  189. <td class="mdRow">
  190. <table cellpadding="0" cellspacing="0" border="0">
  191. <tr>
  192. <td class="md" nowrap valign="top">#define uip_setethaddr </td>
  193. <td class="md" valign="top">(&nbsp;</td>
  194. <td class="md" nowrap valign="top">eaddr&nbsp;</td>
  195. <td class="mdname1" valign="top" nowrap> </td>
  196. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  197. <td class="md" nowrap></td>
  198. </tr>
  199. </table>
  200. </td>
  201. </tr>
  202. </table>
  203. <table cellspacing="5" cellpadding="0" border="0">
  204. <tr>
  205. <td>
  206. &nbsp;
  207. </td>
  208. <td>
  209. <p>
  210. Specifiy the Ethernet MAC address.
  211. <p>
  212. The 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>
  213. <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>
  214. <dl compact><dt><b>Parameters:</b></dt><dd>
  215. <table border="0" cellspacing="2" cellpadding="0">
  216. <tr><td valign="top"></td><td valign="top"><em>eaddr</em>&nbsp;</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>
  217. </table>
  218. </dl>
  219. <p>
  220. Definition at line <a class="el" href="a00205.html#l00134">134</a> of file <a class="el" href="a00205.html">uip_arp.h</a>. </td>
  221. </tr>
  222. </table>
  223. <a class="anchor" name="g12b467f314489259dd718228d0827a51"></a><!-- doxytag: member="uip.h::uip_sethostaddr" ref="g12b467f314489259dd718228d0827a51" args="(addr)" --><p>
  224. <table class="mdTable" cellpadding="2" cellspacing="0">
  225. <tr>
  226. <td class="mdRow">
  227. <table cellpadding="0" cellspacing="0" border="0">
  228. <tr>
  229. <td class="md" nowrap valign="top">#define uip_sethostaddr </td>
  230. <td class="md" valign="top">(&nbsp;</td>
  231. <td class="md" nowrap valign="top">addr&nbsp;</td>
  232. <td class="mdname1" valign="top" nowrap> </td>
  233. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  234. <td class="md" nowrap></td>
  235. </tr>
  236. </table>
  237. </td>
  238. </tr>
  239. </table>
  240. <table cellspacing="5" cellpadding="0" border="0">
  241. <tr>
  242. <td>
  243. &nbsp;
  244. </td>
  245. <td>
  246. <p>
  247. Set the IP address of this host.
  248. <p>
  249. The 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>
  250. Example: <div class="fragment"><pre class="fragment"> <a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> addr;
  251. <a class="code" href="a00148.html#g87f0b54ade0d159fba495089128a4932">uip_ipaddr</a>(&amp;addr, 192,168,1,2);
  252. <a class="code" href="a00144.html#g12b467f314489259dd718228d0827a51">uip_sethostaddr</a>(&amp;addr);
  253. </pre></div> <dl compact><dt><b>Parameters:</b></dt><dd>
  254. <table border="0" cellspacing="2" cellpadding="0">
  255. <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>A pointer to an IP address of type uip_ipaddr_t;</td></tr>
  256. </table>
  257. </dl>
  258. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00148.html#g87f0b54ade0d159fba495089128a4932">uip_ipaddr()</a> </dd></dl>
  259. <dl compact><dt><b>Examples: </b></dt><dd>
  260. <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>
  261. <p>
  262. Definition at line <a class="el" href="a00202.html#l00106">106</a> of file <a class="el" href="a00202.html">uip.h</a>. </td>
  263. </tr>
  264. </table>
  265. <a class="anchor" name="geb79c914cf137e6d27fd7583e5a66679"></a><!-- doxytag: member="uip.h::uip_setnetmask" ref="geb79c914cf137e6d27fd7583e5a66679" args="(addr)" --><p>
  266. <table class="mdTable" cellpadding="2" cellspacing="0">
  267. <tr>
  268. <td class="mdRow">
  269. <table cellpadding="0" cellspacing="0" border="0">
  270. <tr>
  271. <td class="md" nowrap valign="top">#define uip_setnetmask </td>
  272. <td class="md" valign="top">(&nbsp;</td>
  273. <td class="md" nowrap valign="top">addr&nbsp;</td>
  274. <td class="mdname1" valign="top" nowrap> </td>
  275. <td class="md" valign="top">&nbsp;)&nbsp;</td>
  276. <td class="md" nowrap></td>
  277. </tr>
  278. </table>
  279. </td>
  280. </tr>
  281. </table>
  282. <table cellspacing="5" cellpadding="0" border="0">
  283. <tr>
  284. <td>
  285. &nbsp;
  286. </td>
  287. <td>
  288. <p>
  289. Set the netmask.
  290. <p>
  291. <dl compact><dt><b>Parameters:</b></dt><dd>
  292. <table border="0" cellspacing="2" cellpadding="0">
  293. <tr><td valign="top"></td><td valign="top"><em>addr</em>&nbsp;</td><td>A pointer to a uip_ipaddr_t variable containing the IP address of the netmask.</td></tr>
  294. </table>
  295. </dl>
  296. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a00148.html#g87f0b54ade0d159fba495089128a4932">uip_ipaddr()</a> </dd></dl>
  297. <p>
  298. Definition at line <a class="el" href="a00202.html#l00150">150</a> of file <a class="el" href="a00202.html">uip.h</a>. </td>
  299. </tr>
  300. </table>
  301. <hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:02 2006 for uIP 1.0 by&nbsp;
  302. <a href="http://www.doxygen.org/index.html">
  303. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
  304. </body>
  305. </html>