<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.16"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>UbixOS: NETIF</title> <link href="../../tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="../../jquery.js"></script> <script type="text/javascript" src="../../dynsections.js"></script> <link href="../../navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="../../resize.js"></script> <script type="text/javascript" src="../../navtreedata.js"></script> <script type="text/javascript" src="../../navtree.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</script> <link href="../../doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">UbixOS  <span id="projectnumber">2.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.16 --> <script type="text/javascript" src="../../menudata.js"></script> <script type="text/javascript" src="../../menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('../../',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('df/def/group__lwip__opts__netif.html','../../');}); /* @license-end */ </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#groups">Modules</a> | <a href="#define-members">Macros</a> </div> <div class="headertitle"> <div class="title">NETIF<div class="ingroups"><a class="el" href="../../d9/de2/group__lwip__opts.html">Options (lwipopts.h)</a></div></div> </div> </div><!--header--> <div class="contents"> <div class="dynheader"> Collaboration diagram for NETIF:</div> <div class="dyncontent"> <div class="center"><img src="../../df/def/group__lwip__opts__netif.png" border="0" usemap="#df_2def_2group____lwip____opts____netif" alt=""/></div> <map name="df_2def_2group____lwip____opts____netif" id="df_2def_2group____lwip____opts____netif"> <area shape="rect" href="../../d9/de2/group__lwip__opts.html" title=" " alt="" coords="5,5,143,31"/> <area shape="rect" title=" " alt="" coords="191,5,249,31"/> <area shape="rect" href="../../d2/da2/group__lwip__opts__loop.html" title=" " alt="" coords="297,5,428,31"/> </map> </div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a> Modules</h2></td></tr> <tr class="memitem:d2/da2/group__lwip__opts__loop"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/da2/group__lwip__opts__loop.html">Loopback interface</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:gadd45fb65f2d0e6de5a0d14ff9e101b77"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/def/group__lwip__opts__netif.html#gadd45fb65f2d0e6de5a0d14ff9e101b77">LWIP_NETIF_API</a>   0</td></tr> <tr class="separator:gadd45fb65f2d0e6de5a0d14ff9e101b77"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaa714dbfa66822ec4c6111bdb8cf753c1"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/def/group__lwip__opts__netif.html#gaa714dbfa66822ec4c6111bdb8cf753c1">LWIP_NETIF_HOSTNAME</a>   0</td></tr> <tr class="separator:gaa714dbfa66822ec4c6111bdb8cf753c1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad1d5e878d94b56ba687cef69be936ad9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/def/group__lwip__opts__netif.html#gad1d5e878d94b56ba687cef69be936ad9">LWIP_NETIF_HWADDRHINT</a>   0</td></tr> <tr class="separator:gad1d5e878d94b56ba687cef69be936ad9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga1a446932dd927cc4136ba654c13bb97b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/def/group__lwip__opts__netif.html#ga1a446932dd927cc4136ba654c13bb97b">LWIP_NETIF_LINK_CALLBACK</a>   0</td></tr> <tr class="separator:ga1a446932dd927cc4136ba654c13bb97b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9c942c2e9655b06d4f73c630d30f60bf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/def/group__lwip__opts__netif.html#ga9c942c2e9655b06d4f73c630d30f60bf">LWIP_NETIF_REMOVE_CALLBACK</a>   0</td></tr> <tr class="separator:ga9c942c2e9655b06d4f73c630d30f60bf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaffb97d89516c38d3fcb9e44e5d707f36"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/def/group__lwip__opts__netif.html#gaffb97d89516c38d3fcb9e44e5d707f36">LWIP_NETIF_STATUS_CALLBACK</a>   0</td></tr> <tr class="separator:gaffb97d89516c38d3fcb9e44e5d707f36"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gabafb9f64a80e51b56c0abbcfc1f7e04e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/def/group__lwip__opts__netif.html#gabafb9f64a80e51b56c0abbcfc1f7e04e">LWIP_NETIF_TX_SINGLE_PBUF</a>   0</td></tr> <tr class="separator:gabafb9f64a80e51b56c0abbcfc1f7e04e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga94a35212616f9a9aae5c98741612b936"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="../../df/def/group__lwip__opts__netif.html#ga94a35212616f9a9aae5c98741612b936">LWIP_NUM_NETIF_CLIENT_DATA</a>   0</td></tr> <tr class="separator:ga94a35212616f9a9aae5c98741612b936"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <h2 class="groupheader">Macro Definition Documentation</h2> <a id="gadd45fb65f2d0e6de5a0d14ff9e101b77"></a> <h2 class="memtitle"><span class="permalink"><a href="#gadd45fb65f2d0e6de5a0d14ff9e101b77">◆ </a></span>LWIP_NETIF_API</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define LWIP_NETIF_API   0</td> </tr> </table> </div><div class="memdoc"> <p>LWIP_NETIF_API==1: Support netif api (in <a class="el" href="../../dd/dfb/netifapi_8c.html">netifapi.c</a>) </p> <p class="definition">Definition at line <a class="el" href="../../dc/dba/opt_8h_source.html#l01360">1360</a> of file <a class="el" href="../../dc/dba/opt_8h_source.html">opt.h</a>.</p> </div> </div> <a id="gaa714dbfa66822ec4c6111bdb8cf753c1"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaa714dbfa66822ec4c6111bdb8cf753c1">◆ </a></span>LWIP_NETIF_HOSTNAME</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define LWIP_NETIF_HOSTNAME   0</td> </tr> </table> </div><div class="memdoc"> <p>LWIP_NETIF_HOSTNAME==1: use DHCP_OPTION_HOSTNAME with netif's hostname field. </p> <p class="definition">Definition at line <a class="el" href="../../dc/dba/opt_8h_source.html#l01353">1353</a> of file <a class="el" href="../../dc/dba/opt_8h_source.html">opt.h</a>.</p> </div> </div> <a id="gad1d5e878d94b56ba687cef69be936ad9"></a> <h2 class="memtitle"><span class="permalink"><a href="#gad1d5e878d94b56ba687cef69be936ad9">◆ </a></span>LWIP_NETIF_HWADDRHINT</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define LWIP_NETIF_HWADDRHINT   0</td> </tr> </table> </div><div class="memdoc"> <p>LWIP_NETIF_HWADDRHINT==1: Cache link-layer-address hints (e.g. table indices) in struct netif. TCP and UDP can make use of this to prevent scanning the ARP table for every sent packet. While this is faster for big ARP tables or many concurrent connections, it might be counterproductive if you have a tiny ARP table or if there never are concurrent connections. </p> <p class="definition">Definition at line <a class="el" href="../../dc/dba/opt_8h_source.html#l01395">1395</a> of file <a class="el" href="../../dc/dba/opt_8h_source.html">opt.h</a>.</p> </div> </div> <a id="ga1a446932dd927cc4136ba654c13bb97b"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga1a446932dd927cc4136ba654c13bb97b">◆ </a></span>LWIP_NETIF_LINK_CALLBACK</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define LWIP_NETIF_LINK_CALLBACK   0</td> </tr> </table> </div><div class="memdoc"> <p>LWIP_NETIF_LINK_CALLBACK==1: Support a callback function from an interface whenever the link changes (i.e., link down) </p> <p class="definition">Definition at line <a class="el" href="../../dc/dba/opt_8h_source.html#l01376">1376</a> of file <a class="el" href="../../dc/dba/opt_8h_source.html">opt.h</a>.</p> </div> </div> <a id="ga9c942c2e9655b06d4f73c630d30f60bf"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga9c942c2e9655b06d4f73c630d30f60bf">◆ </a></span>LWIP_NETIF_REMOVE_CALLBACK</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define LWIP_NETIF_REMOVE_CALLBACK   0</td> </tr> </table> </div><div class="memdoc"> <p>LWIP_NETIF_REMOVE_CALLBACK==1: Support a callback function that is called when a netif has been removed </p> <p class="definition">Definition at line <a class="el" href="../../dc/dba/opt_8h_source.html#l01384">1384</a> of file <a class="el" href="../../dc/dba/opt_8h_source.html">opt.h</a>.</p> </div> </div> <a id="gaffb97d89516c38d3fcb9e44e5d707f36"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaffb97d89516c38d3fcb9e44e5d707f36">◆ </a></span>LWIP_NETIF_STATUS_CALLBACK</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define LWIP_NETIF_STATUS_CALLBACK   0</td> </tr> </table> </div><div class="memdoc"> <p>LWIP_NETIF_STATUS_CALLBACK==1: Support a callback function whenever an interface changes its up/down status (i.e., due to DHCP IP acquisition) </p> <p class="definition">Definition at line <a class="el" href="../../dc/dba/opt_8h_source.html#l01368">1368</a> of file <a class="el" href="../../dc/dba/opt_8h_source.html">opt.h</a>.</p> </div> </div> <a id="gabafb9f64a80e51b56c0abbcfc1f7e04e"></a> <h2 class="memtitle"><span class="permalink"><a href="#gabafb9f64a80e51b56c0abbcfc1f7e04e">◆ </a></span>LWIP_NETIF_TX_SINGLE_PBUF</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define LWIP_NETIF_TX_SINGLE_PBUF   0</td> </tr> </table> </div><div class="memdoc"> <p>LWIP_NETIF_TX_SINGLE_PBUF: if this is set to 1, lwIP tries to put all data to be sent into one single pbuf. This is for compatibility with DMA-enabled MACs that do not support scatter-gather. Beware that this might involve CPU-memcpy before transmitting that would not be needed without this flag! Use this only if you need to!</p> <dl class="todo"><dt><b><a class="el" href="../../dd/da0/todo.html#_todo000002">Todo:</a></b></dt><dd>: TCP and IP-frag do not work with this, yet: </dd></dl> <p class="definition">Definition at line <a class="el" href="../../dc/dba/opt_8h_source.html#l01408">1408</a> of file <a class="el" href="../../dc/dba/opt_8h_source.html">opt.h</a>.</p> </div> </div> <a id="ga94a35212616f9a9aae5c98741612b936"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga94a35212616f9a9aae5c98741612b936">◆ </a></span>LWIP_NUM_NETIF_CLIENT_DATA</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define LWIP_NUM_NETIF_CLIENT_DATA   0</td> </tr> </table> </div><div class="memdoc"> <p>LWIP_NUM_NETIF_CLIENT_DATA: Number of clients that may store data in client_data member array of struct netif. </p> <p class="definition">Definition at line <a class="el" href="../../dc/dba/opt_8h_source.html#l01416">1416</a> of file <a class="el" href="../../dc/dba/opt_8h_source.html">opt.h</a>.</p> </div> </div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.16 </li> </ul> </div> </body> </html>