<!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 V2: C:/Dev/git/UbixOS/sys/include/net/ip.h File Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 V2
 <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">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<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('',true,false,'search.php','Search');
$(document).ready(function() { init_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('ip_8h.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">ip.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="opt_8h_source.html">net/opt.h</a>"</code><br />
<code>#include "<a class="el" href="def_8h_source.html">net/def.h</a>"</code><br />
<code>#include "<a class="el" href="pbuf_8h_source.html">net/pbuf.h</a>"</code><br />
<code>#include "<a class="el" href="ip__addr_8h_source.html">net/ip_addr.h</a>"</code><br />
<code>#include "<a class="el" href="err_8h_source.html">net/err.h</a>"</code><br />
<code>#include "<a class="el" href="netif_8h_source.html">net/netif.h</a>"</code><br />
<code>#include "<a class="el" href="ip4_8h_source.html">net/ip4.h</a>"</code><br />
<code>#include "<a class="el" href="ip6_8h_source.html">net/ip6.h</a>"</code><br />
<code>#include "<a class="el" href="prot_2ip_8h_source.html">net/prot/ip.h</a>"</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for ip.h:</div>
<div class="dyncontent">
<div class="center"><img src="ip_8h__incl.png" border="0" usemap="#C_1_2Dev_2git_2UbixOS_2sys_2include_2net_2ip_8h" alt=""/></div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="ip_8h__dep__incl.png" border="0" usemap="#C_1_2Dev_2git_2UbixOS_2sys_2include_2net_2ip_8hdep" alt=""/></div>
</div>
</div>
<p><a href="ip_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structip__globals.html">ip_globals</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structip__pcb.html">ip_pcb</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:a9135977868017c3deeec86b525e13997"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#a9135977868017c3deeec86b525e13997">ip_current_dest_addr</a>()   (&ip_data.current_iphdr_dest)</td></tr>
<tr class="separator:a9135977868017c3deeec86b525e13997"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9135977868017c3deeec86b525e13997"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#a9135977868017c3deeec86b525e13997">ip_current_dest_addr</a>()   (&ip_data.current_iphdr_dest)</td></tr>
<tr class="separator:a9135977868017c3deeec86b525e13997"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ca15ea285a10982294378cd7b8e83e2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#a2ca15ea285a10982294378cd7b8e83e2">ip_current_header_tot_len</a>()   (ip_data.current_ip_header_tot_len)</td></tr>
<tr class="separator:a2ca15ea285a10982294378cd7b8e83e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae214afa9d3f1b26fc8d538436b8fa3c4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#ae214afa9d3f1b26fc8d538436b8fa3c4">ip_current_input_netif</a>()   (ip_data.current_input_netif)</td></tr>
<tr class="separator:ae214afa9d3f1b26fc8d538436b8fa3c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabecef3c7653a9767c79245c44fcab9f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#aabecef3c7653a9767c79245c44fcab9f">ip_current_netif</a>()   (ip_data.current_netif)</td></tr>
<tr class="separator:aabecef3c7653a9767c79245c44fcab9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e35b7692c228c98e738892f0a215647"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#a4e35b7692c228c98e738892f0a215647">ip_current_src_addr</a>()   (&ip_data.current_iphdr_src)</td></tr>
<tr class="separator:a4e35b7692c228c98e738892f0a215647"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e35b7692c228c98e738892f0a215647"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#a4e35b7692c228c98e738892f0a215647">ip_current_src_addr</a>()   (&ip_data.current_iphdr_src)</td></tr>
<tr class="separator:a4e35b7692c228c98e738892f0a215647"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26e077f52de4a97ff89c02415c084518"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#a26e077f52de4a97ff89c02415c084518">ip_get_option</a>(pcb, opt)   ((pcb)->so_options & (opt))</td></tr>
<tr class="separator:a26e077f52de4a97ff89c02415c084518"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8bdf4b5f674375e76cdd968826d80e53"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#a8bdf4b5f674375e76cdd968826d80e53">IP_PCB</a></td></tr>
<tr class="separator:a8bdf4b5f674375e76cdd968826d80e53"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19a7497f9c87e25b66382e1b92f56382"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#a19a7497f9c87e25b66382e1b92f56382">IP_PCB_ADDRHINT</a></td></tr>
<tr class="separator:a19a7497f9c87e25b66382e1b92f56382"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a441c63f00c4b0cb69fc34ca6b55307cc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#a441c63f00c4b0cb69fc34ca6b55307cc">ip_reset_option</a>(pcb, opt)   ((pcb)->so_options &= ~(opt))</td></tr>
<tr class="separator:a441c63f00c4b0cb69fc34ca6b55307cc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae392fc1ebc42a4b08f73d42c04089be9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#ae392fc1ebc42a4b08f73d42c04089be9">ip_route_get_local_ip</a>(src, dest, <a class="el" href="structnetif.html">netif</a>, ipaddr)</td></tr>
<tr class="separator:ae392fc1ebc42a4b08f73d42c04089be9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a13f48cf825c7f074dc05bea54e9d6a93"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#a13f48cf825c7f074dc05bea54e9d6a93">ip_set_option</a>(pcb, opt)   ((pcb)->so_options |= (opt))</td></tr>
<tr class="separator:a13f48cf825c7f074dc05bea54e9d6a93"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a355679dba1c0d8ef07ce3abcd28e3063"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#a355679dba1c0d8ef07ce3abcd28e3063">LWIP_IP_CHECK_PBUF_REF_COUNT_FOR_TX</a>(p)   <a class="el" href="debug_8h.html#a94ad086267808462beae2b38f91996ed">LWIP_ASSERT</a>("p->ref == 1", (p)->ref == 1)</td></tr>
<tr class="separator:a355679dba1c0d8ef07ce3abcd28e3063"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b7dff1859ced5f2be3fc3da231819d7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#a2b7dff1859ced5f2be3fc3da231819d7">LWIP_IP_HDRINCL</a>   <a class="el" href="include_2sys_2types_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a></td></tr>
<tr class="separator:a2b7dff1859ced5f2be3fc3da231819d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8c7ccdad2d7d3a264bd8cfc57140ca8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#ac8c7ccdad2d7d3a264bd8cfc57140ca8">SOF_BROADCAST</a>   0x20U /* permit to send and to receive broadcast messages (see <a class="el" href="group__lwip__opts__ipv4.html#ga0b2c993fd940f5774108298933310384">IP_SOF_BROADCAST</a> option) */</td></tr>
<tr class="separator:ac8c7ccdad2d7d3a264bd8cfc57140ca8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4bbdf8a2e757d758ec0e1c91b58893f"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#ae4bbdf8a2e757d758ec0e1c91b58893f">SOF_INHERITED</a>   (<a class="el" href="ip_8h.html#aa40b3366a7939ec3a60e9a7d239575e2">SOF_REUSEADDR</a>|<a class="el" href="ip_8h.html#a1f7f7efb095c77c06af5c5e8ba558d45">SOF_KEEPALIVE</a>)</td></tr>
<tr class="separator:ae4bbdf8a2e757d758ec0e1c91b58893f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f7f7efb095c77c06af5c5e8ba558d45"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#a1f7f7efb095c77c06af5c5e8ba558d45">SOF_KEEPALIVE</a>   0x08U /* keep connections alive */</td></tr>
<tr class="separator:a1f7f7efb095c77c06af5c5e8ba558d45"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa40b3366a7939ec3a60e9a7d239575e2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#aa40b3366a7939ec3a60e9a7d239575e2">SOF_REUSEADDR</a>   0x04U /* allow local address reuse */</td></tr>
<tr class="separator:aa40b3366a7939ec3a60e9a7d239575e2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ac944fb6564f181bc90bc7c2b8b00d94c"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structip__globals.html">ip_globals</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="ip_8h.html#ac944fb6564f181bc90bc7c2b8b00d94c">ip_data</a></td></tr>
<tr class="separator:ac944fb6564f181bc90bc7c2b8b00d94c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>IP API </p>
<p class="definition">Definition in file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a9135977868017c3deeec86b525e13997"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9135977868017c3deeec86b525e13997">◆ </a></span>ip_current_dest_addr <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_current_dest_addr</td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td>   (&ip_data.current_iphdr_dest)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Destination IP address of current_header</p>
<p>Union destination address of current_header </p>
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00212">212</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="a9135977868017c3deeec86b525e13997"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9135977868017c3deeec86b525e13997">◆ </a></span>ip_current_dest_addr <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_current_dest_addr</td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td>   (&ip_data.current_iphdr_dest)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Destination IP address of current_header</p>
<p>Union destination address of current_header </p>
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00212">212</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="a2ca15ea285a10982294378cd7b8e83e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ca15ea285a10982294378cd7b8e83e2">◆ </a></span>ip_current_header_tot_len</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_current_header_tot_len</td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td>   (ip_data.current_ip_header_tot_len)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Total header length of ip(6)_current_header() (i.e. after this, the UDP/TCP header starts) </p>
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00139">139</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="ae214afa9d3f1b26fc8d538436b8fa3c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae214afa9d3f1b26fc8d538436b8fa3c4">◆ </a></span>ip_current_input_netif</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_current_input_netif</td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td>   (ip_data.current_input_netif)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the interface that received the current packet. This function must only be called from a receive callback (udp_recv, raw_recv, tcp_accept). It will return NULL otherwise. </p>
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00137">137</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="aabecef3c7653a9767c79245c44fcab9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabecef3c7653a9767c79245c44fcab9f">◆ </a></span>ip_current_netif</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_current_netif</td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td>   (ip_data.current_netif)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the interface that accepted the current packet. This may or may not be the receiving netif, depending on your netif/network setup. This function must only be called from a receive callback (udp_recv, raw_recv, tcp_accept). It will return NULL otherwise. </p>
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00133">133</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="a4e35b7692c228c98e738892f0a215647"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e35b7692c228c98e738892f0a215647">◆ </a></span>ip_current_src_addr <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_current_src_addr</td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td>   (&ip_data.current_iphdr_src)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Source IP address of current_header</p>
<p>Union source address of current_header </p>
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00210">210</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="a4e35b7692c228c98e738892f0a215647"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e35b7692c228c98e738892f0a215647">◆ </a></span>ip_current_src_addr <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_current_src_addr</td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td>   (&ip_data.current_iphdr_src)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Source IP address of current_header</p>
<p>Union source address of current_header </p>
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00210">210</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="a26e077f52de4a97ff89c02415c084518"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26e077f52de4a97ff89c02415c084518">◆ </a></span>ip_get_option</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_get_option</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">pcb, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">opt </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   ((pcb)->so_options & (opt))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets an IP pcb option (SOF_* flags) </p>
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00215">215</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="a8bdf4b5f674375e76cdd968826d80e53"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8bdf4b5f674375e76cdd968826d80e53">◆ </a></span>IP_PCB</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define IP_PCB</td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="comment">/* ip addresses in network byte order */</span> \</div>
<div class="line"> ip_addr_t local_ip; \</div>
<div class="line"> ip_addr_t remote_ip; \</div>
<div class="line"> <span class="comment">/* Socket options */</span> \</div>
<div class="line"> u8_t so_options; \</div>
<div class="line"> <span class="comment">/* Type Of Service */</span> \</div>
<div class="line"> u8_t tos; \</div>
<div class="line"> <span class="comment">/* Time To Live */</span> \</div>
<div class="line"> u8_t ttl \</div>
<div class="line"> <span class="comment">/* link layer address resolution hint */</span> \</div>
<div class="line"> IP_PCB_ADDRHINT</div>
</div><!-- fragment --><p>This is the common part of all PCB types. It needs to be at the beginning of a PCB type definition. It is located here so that changes to this common part are made in one location instead of having to change all PCB structs. </p>
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00076">76</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="a19a7497f9c87e25b66382e1b92f56382"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19a7497f9c87e25b66382e1b92f56382">◆ </a></span>IP_PCB_ADDRHINT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define IP_PCB_ADDRHINT</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00069">69</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="a441c63f00c4b0cb69fc34ca6b55307cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a441c63f00c4b0cb69fc34ca6b55307cc">◆ </a></span>ip_reset_option</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_reset_option</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">pcb, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">opt </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   ((pcb)->so_options &= ~(opt))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Resets an IP pcb option (SOF_* flags) </p>
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00219">219</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="ae392fc1ebc42a4b08f73d42c04089be9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae392fc1ebc42a4b08f73d42c04089be9">◆ </a></span>ip_route_get_local_ip</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_route_get_local_ip</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">src, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">dest, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><a class="el" href="structnetif.html">netif</a>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">ipaddr </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"><span class="keywordflow">do</span> { \</div>
<div class="line"> (<a class="code" href="structnetif.html">netif</a>) = ip_route(src, dest); \</div>
<div class="line"> (ipaddr) = ip_netif_get_local_ip(<a class="code" href="structnetif.html">netif</a>, dest); \</div>
<div class="line">}<span class="keywordflow">while</span>(0)</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00308">308</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="a13f48cf825c7f074dc05bea54e9d6a93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13f48cf825c7f074dc05bea54e9d6a93">◆ </a></span>ip_set_option</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ip_set_option</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">pcb, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">opt </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   ((pcb)->so_options |= (opt))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets an IP pcb option (SOF_* flags) </p>
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00217">217</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="a355679dba1c0d8ef07ce3abcd28e3063"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a355679dba1c0d8ef07ce3abcd28e3063">◆ </a></span>LWIP_IP_CHECK_PBUF_REF_COUNT_FOR_TX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LWIP_IP_CHECK_PBUF_REF_COUNT_FOR_TX</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">p</td><td>)</td>
<td>   <a class="el" href="debug_8h.html#a94ad086267808462beae2b38f91996ed">LWIP_ASSERT</a>("p->ref == 1", (p)->ref == 1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>pbufs passed to IP must have a ref-count of 1 as their payload pointer gets altered as the packet is passed down the stack </p>
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00063">63</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="a2b7dff1859ced5f2be3fc3da231819d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b7dff1859ced5f2be3fc3da231819d7">◆ </a></span>LWIP_IP_HDRINCL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LWIP_IP_HDRINCL   <a class="el" href="include_2sys_2types_8h.html#a070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00058">58</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="ac8c7ccdad2d7d3a264bd8cfc57140ca8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8c7ccdad2d7d3a264bd8cfc57140ca8">◆ </a></span>SOF_BROADCAST</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SOF_BROADCAST   0x20U /* permit to send and to receive broadcast messages (see <a class="el" href="group__lwip__opts__ipv4.html#ga0b2c993fd940f5774108298933310384">IP_SOF_BROADCAST</a> option) */</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00099">99</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="ae4bbdf8a2e757d758ec0e1c91b58893f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4bbdf8a2e757d758ec0e1c91b58893f">◆ </a></span>SOF_INHERITED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SOF_INHERITED   (<a class="el" href="ip_8h.html#aa40b3366a7939ec3a60e9a7d239575e2">SOF_REUSEADDR</a>|<a class="el" href="ip_8h.html#a1f7f7efb095c77c06af5c5e8ba558d45">SOF_KEEPALIVE</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00102">102</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="a1f7f7efb095c77c06af5c5e8ba558d45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f7f7efb095c77c06af5c5e8ba558d45">◆ </a></span>SOF_KEEPALIVE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SOF_KEEPALIVE   0x08U /* keep connections alive */</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00098">98</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<a id="aa40b3366a7939ec3a60e9a7d239575e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa40b3366a7939ec3a60e9a7d239575e2">◆ </a></span>SOF_REUSEADDR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SOF_REUSEADDR   0x04U /* allow local address reuse */</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ip_8h_source.html#l00097">97</a> of file <a class="el" href="ip_8h_source.html">ip.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ac944fb6564f181bc90bc7c2b8b00d94c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac944fb6564f181bc90bc7c2b8b00d94c">◆ </a></span>ip_data</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structip__globals.html">ip_globals</a> ip_data</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="astructnetif_html"><div class="ttname"><a href="structnetif.html">netif</a></div><div class="ttdef"><b>Definition:</b> <a href="netif_8h_source.html#l00233">netif.h:233</a></div></div>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_e6bb53534ac0e427887cf7a94c0c004e.html">C:</a></li><li class="navelem"><a class="el" href="dir_d99d5d4662bf24521eef49da6a8cd34d.html">Dev</a></li><li class="navelem"><a class="el" href="dir_474a4b306371cf7e7f6fa12cb0b77df6.html">git</a></li><li class="navelem"><a class="el" href="dir_849109bbd106d461b128d63e5babcedf.html">UbixOS</a></li><li class="navelem"><a class="el" href="dir_6ec99f6d7d5182ba8913209ab70c9f18.html">sys</a></li><li class="navelem"><a class="el" href="dir_d1be8160e739b6eed1f7843efdbae1b3.html">include</a></li><li class="navelem"><a class="el" href="dir_8a452844cab5a537277ef786999bc939.html">net</a></li><li class="navelem"><a class="el" href="ip_8h.html">ip.h</a></li>
<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>
