<!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/priv/tcpip_priv.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('tcpip__priv_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="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">tcpip_priv.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="tcpip_8h_source.html">net/tcpip.h</a>"</code><br />
<code>#include "<a class="el" href="sys_8h_source.html">net/sys.h</a>"</code><br />
<code>#include "<a class="el" href="timeouts_8h_source.html">net/timeouts.h</a>"</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for tcpip_priv.h:</div>
<div class="dyncontent">
<div class="center"><img src="tcpip__priv_8h__incl.png" border="0" usemap="#C_1_2Dev_2git_2UbixOS_2sys_2include_2net_2priv_2tcpip__priv_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="tcpip__priv_8h__dep__incl.png" border="0" usemap="#C_1_2Dev_2git_2UbixOS_2sys_2include_2net_2priv_2tcpip__priv_8hdep" alt=""/></div>
</div>
</div>
<p><a href="tcpip__priv_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="structtcpip__api__call__data.html">tcpip_api_call_data</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="structtcpip__msg.html">tcpip_msg</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:a4b2322aa0c1906f84f16acf359f06a92"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#a4b2322aa0c1906f84f16acf359f06a92">API_EXPR_DEREF</a>(expr)   (*(expr))</td></tr>
<tr class="separator:a4b2322aa0c1906f84f16acf359f06a92"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f3c3ae0938b5510978cbd31560a5797"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#a1f3c3ae0938b5510978cbd31560a5797">API_EXPR_REF</a>(expr)   expr</td></tr>
<tr class="separator:a1f3c3ae0938b5510978cbd31560a5797"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91e803b3c3f0ab89b20d7a85e3e92624"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#a91e803b3c3f0ab89b20d7a85e3e92624">API_EXPR_REF_SEM</a>(expr)   <a class="el" href="tcpip__priv_8h.html#a1f3c3ae0938b5510978cbd31560a5797">API_EXPR_REF</a>(expr)</td></tr>
<tr class="separator:a91e803b3c3f0ab89b20d7a85e3e92624"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad299ce8f259fb9f1f6c5c5a812f1bc58"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#ad299ce8f259fb9f1f6c5c5a812f1bc58">API_MSG_M_DEF</a>(m)   *m</td></tr>
<tr class="separator:ad299ce8f259fb9f1f6c5c5a812f1bc58"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a9d654eb42f26b409d1386d162f1e31"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#a3a9d654eb42f26b409d1386d162f1e31">API_MSG_M_DEF_C</a>(t, m)   <a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> t * m</td></tr>
<tr class="separator:a3a9d654eb42f26b409d1386d162f1e31"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ff9b936b16d91844c0e32424e97f493"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#a8ff9b936b16d91844c0e32424e97f493">API_VAR_ALLOC</a>(type, pool, <a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>, errorval)</td></tr>
<tr class="separator:a8ff9b936b16d91844c0e32424e97f493"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b826b1ea2ee54ebb94ab354578a1ffe"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#a0b826b1ea2ee54ebb94ab354578a1ffe">API_VAR_ALLOC_POOL</a>(type, pool, <a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>, errorval)</td></tr>
<tr class="separator:a0b826b1ea2ee54ebb94ab354578a1ffe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab5d4a4fa91c4c144bedabf593a68b4dd"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#ab5d4a4fa91c4c144bedabf593a68b4dd">API_VAR_DECLARE</a>(type, <a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>)   type <a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a></td></tr>
<tr class="separator:ab5d4a4fa91c4c144bedabf593a68b4dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a30caebb5334f52d49ac938a507094094"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#a30caebb5334f52d49ac938a507094094">API_VAR_FREE</a>(pool, <a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>)</td></tr>
<tr class="separator:a30caebb5334f52d49ac938a507094094"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a803c2dd81f7e69515115b78759be0d76"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#a803c2dd81f7e69515115b78759be0d76">API_VAR_FREE_POOL</a>(pool, <a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>)</td></tr>
<tr class="separator:a803c2dd81f7e69515115b78759be0d76"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3518256af0d1a422755a899b13c2b563"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#a3518256af0d1a422755a899b13c2b563">API_VAR_REF</a>(<a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>)   <a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a></td></tr>
<tr class="separator:a3518256af0d1a422755a899b13c2b563"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aa7ecde8c8d8012fe5c498f7ee58f9458"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#aa7ecde8c8d8012fe5c498f7ee58f9458">tcpip_api_call_fn</a>) (struct <a class="el" href="structtcpip__api__call__data.html">tcpip_api_call_data</a> *call)</td></tr>
<tr class="separator:aa7ecde8c8d8012fe5c498f7ee58f9458"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a1e0cb5032a61055e3f4a3426ed548937"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#a1e0cb5032a61055e3f4a3426ed548937">tcpip_msg_type</a> { <br />
  <a class="el" href="tcpip__priv_8h.html#a1e0cb5032a61055e3f4a3426ed548937a8665d0f2f1498c366e90d67a1e4c7f80">TCPIP_MSG_API</a>,
<a class="el" href="tcpip__priv_8h.html#a1e0cb5032a61055e3f4a3426ed548937ae68ceceeb8f3bfda0dfdb824dfd0aa8a">TCPIP_MSG_API_CALL</a>,
<a class="el" href="tcpip__priv_8h.html#a1e0cb5032a61055e3f4a3426ed548937a64972ba60577a99b44f088e0b5150c8a">TCPIP_MSG_INPKT</a>,
<a class="el" href="tcpip__priv_8h.html#a1e0cb5032a61055e3f4a3426ed548937a3915e837fa47d5b65cc17d47a0790662">TCPIP_MSG_CALLBACK</a>,
<br />
  <a class="el" href="tcpip__priv_8h.html#a1e0cb5032a61055e3f4a3426ed548937a17160cdc581db556a47a57cd4efb3b78">TCPIP_MSG_CALLBACK_STATIC</a>
<br />
}</td></tr>
<tr class="separator:a1e0cb5032a61055e3f4a3426ed548937"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a3d42b0c46607f91aedcc7745ed466b08"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#a3d42b0c46607f91aedcc7745ed466b08">tcpip_api_call</a> (<a class="el" href="tcpip__priv_8h.html#aa7ecde8c8d8012fe5c498f7ee58f9458">tcpip_api_call_fn</a> fn, struct <a class="el" href="structtcpip__api__call__data.html">tcpip_api_call_data</a> *call)</td></tr>
<tr class="separator:a3d42b0c46607f91aedcc7745ed466b08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12bdf37eddcd72c4178e3ea7d370395d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="tcpip__priv_8h.html#a12bdf37eddcd72c4178e3ea7d370395d">tcpip_send_msg_wait_sem</a> (<a class="el" href="tcpip_8h.html#a35203296bb838f3b493839ffc6e7285d">tcpip_callback_fn</a> fn, void *apimsg, <a class="el" href="sem_8h.html#a900e36da93bb688c29fc8148f2f44e04">sys_sem_t</a> *sem)</td></tr>
<tr class="separator:a12bdf37eddcd72c4178e3ea7d370395d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>TCPIP API internal implementations (do not use in application code) </p>
<p class="definition">Definition in file <a class="el" href="tcpip__priv_8h_source.html">tcpip_priv.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a4b2322aa0c1906f84f16acf359f06a92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b2322aa0c1906f84f16acf359f06a92">◆ </a></span>API_EXPR_DEREF</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define API_EXPR_DEREF</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">expr</td><td>)</td>
<td>   (*(expr))</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tcpip__priv_8h_source.html#l00090">90</a> of file <a class="el" href="tcpip__priv_8h_source.html">tcpip_priv.h</a>.</p>
</div>
</div>
<a id="a1f3c3ae0938b5510978cbd31560a5797"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f3c3ae0938b5510978cbd31560a5797">◆ </a></span>API_EXPR_REF</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define API_EXPR_REF</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">expr</td><td>)</td>
<td>   expr</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tcpip__priv_8h_source.html#l00088">88</a> of file <a class="el" href="tcpip__priv_8h_source.html">tcpip_priv.h</a>.</p>
</div>
</div>
<a id="a91e803b3c3f0ab89b20d7a85e3e92624"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91e803b3c3f0ab89b20d7a85e3e92624">◆ </a></span>API_EXPR_REF_SEM</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define API_EXPR_REF_SEM</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">expr</td><td>)</td>
<td>   <a class="el" href="tcpip__priv_8h.html#a1f3c3ae0938b5510978cbd31560a5797">API_EXPR_REF</a>(expr)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tcpip__priv_8h_source.html#l00089">89</a> of file <a class="el" href="tcpip__priv_8h_source.html">tcpip_priv.h</a>.</p>
</div>
</div>
<a id="ad299ce8f259fb9f1f6c5c5a812f1bc58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad299ce8f259fb9f1f6c5c5a812f1bc58">◆ </a></span>API_MSG_M_DEF</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define API_MSG_M_DEF</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">m</td><td>)</td>
<td>   *m</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tcpip__priv_8h_source.html#l00091">91</a> of file <a class="el" href="tcpip__priv_8h_source.html">tcpip_priv.h</a>.</p>
</div>
</div>
<a id="a3a9d654eb42f26b409d1386d162f1e31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a9d654eb42f26b409d1386d162f1e31">◆ </a></span>API_MSG_M_DEF_C</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define API_MSG_M_DEF_C</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">t, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">m </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> t * m</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tcpip__priv_8h_source.html#l00092">92</a> of file <a class="el" href="tcpip__priv_8h_source.html">tcpip_priv.h</a>.</p>
</div>
</div>
<a id="a8ff9b936b16d91844c0e32424e97f493"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ff9b936b16d91844c0e32424e97f493">◆ </a></span>API_VAR_ALLOC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define API_VAR_ALLOC</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">type, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">pool, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">errorval </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tcpip__priv_8h_source.html#l00084">84</a> of file <a class="el" href="tcpip__priv_8h_source.html">tcpip_priv.h</a>.</p>
</div>
</div>
<a id="a0b826b1ea2ee54ebb94ab354578a1ffe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b826b1ea2ee54ebb94ab354578a1ffe">◆ </a></span>API_VAR_ALLOC_POOL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define API_VAR_ALLOC_POOL</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">type, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">pool, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">errorval </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tcpip__priv_8h_source.html#l00085">85</a> of file <a class="el" href="tcpip__priv_8h_source.html">tcpip_priv.h</a>.</p>
</div>
</div>
<a id="ab5d4a4fa91c4c144bedabf593a68b4dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5d4a4fa91c4c144bedabf593a68b4dd">◆ </a></span>API_VAR_DECLARE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define API_VAR_DECLARE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">type, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   type <a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tcpip__priv_8h_source.html#l00083">83</a> of file <a class="el" href="tcpip__priv_8h_source.html">tcpip_priv.h</a>.</p>
</div>
</div>
<a id="a30caebb5334f52d49ac938a507094094"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30caebb5334f52d49ac938a507094094">◆ </a></span>API_VAR_FREE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define API_VAR_FREE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">pool, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tcpip__priv_8h_source.html#l00086">86</a> of file <a class="el" href="tcpip__priv_8h_source.html">tcpip_priv.h</a>.</p>
</div>
</div>
<a id="a803c2dd81f7e69515115b78759be0d76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a803c2dd81f7e69515115b78759be0d76">◆ </a></span>API_VAR_FREE_POOL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define API_VAR_FREE_POOL</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">pool, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tcpip__priv_8h_source.html#l00087">87</a> of file <a class="el" href="tcpip__priv_8h_source.html">tcpip_priv.h</a>.</p>
</div>
</div>
<a id="a3518256af0d1a422755a899b13c2b563"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3518256af0d1a422755a899b13c2b563">◆ </a></span>API_VAR_REF</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define API_VAR_REF</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a></td><td>)</td>
<td>   <a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tcpip__priv_8h_source.html#l00082">82</a> of file <a class="el" href="tcpip__priv_8h_source.html">tcpip_priv.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="aa7ecde8c8d8012fe5c498f7ee58f9458"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7ecde8c8d8012fe5c498f7ee58f9458">◆ </a></span>tcpip_api_call_fn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>(* tcpip_api_call_fn) (struct <a class="el" href="structtcpip__api__call__data.html">tcpip_api_call_data</a> *call)</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="tcpip__priv_8h_source.html#l00108">108</a> of file <a class="el" href="tcpip__priv_8h_source.html">tcpip_priv.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a1e0cb5032a61055e3f4a3426ed548937"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e0cb5032a61055e3f4a3426ed548937">◆ </a></span>tcpip_msg_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="tcpip__priv_8h.html#a1e0cb5032a61055e3f4a3426ed548937">tcpip_msg_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a1e0cb5032a61055e3f4a3426ed548937a8665d0f2f1498c366e90d67a1e4c7f80"></a>TCPIP_MSG_API </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a1e0cb5032a61055e3f4a3426ed548937ae68ceceeb8f3bfda0dfdb824dfd0aa8a"></a>TCPIP_MSG_API_CALL </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a1e0cb5032a61055e3f4a3426ed548937a64972ba60577a99b44f088e0b5150c8a"></a>TCPIP_MSG_INPKT </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a1e0cb5032a61055e3f4a3426ed548937a3915e837fa47d5b65cc17d47a0790662"></a>TCPIP_MSG_CALLBACK </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a1e0cb5032a61055e3f4a3426ed548937a17160cdc581db556a47a57cd4efb3b78"></a>TCPIP_MSG_CALLBACK_STATIC </td><td class="fielddoc"></td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="tcpip__priv_8h_source.html#l00111">111</a> of file <a class="el" href="tcpip__priv_8h_source.html">tcpip_priv.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a3d42b0c46607f91aedcc7745ed466b08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3d42b0c46607f91aedcc7745ed466b08">◆ </a></span>tcpip_api_call()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> tcpip_api_call </td>
<td>(</td>
<td class="paramtype"><a class="el" href="tcpip__priv_8h.html#aa7ecde8c8d8012fe5c498f7ee58f9458">tcpip_api_call_fn</a> </td>
<td class="paramname"><em>fn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structtcpip__api__call__data.html">tcpip_api_call_data</a> * </td>
<td class="paramname"><em>call</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Synchronously calls function in TCPIP thread and waits for its completion. It is recommended to use LWIP_TCPIP_CORE_LOCKING (preferred) or LWIP_NETCONN_SEM_PER_THREAD. If not, a semaphore is created and destroyed on every call which is usually an expensive/slow operation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fn</td><td>Function to call </td></tr>
<tr><td class="paramname">call</td><td>Call parameters </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Return value from tcpip_api_call_fn </dd></dl>
<p class="definition">Definition at line <a class="el" href="tcpip_8c_source.html#l00356">356</a> of file <a class="el" href="tcpip_8c_source.html">tcpip.c</a>.</p>
<p class="reference">References <a class="el" href="err_8h_source.html#l00063">ERR_OK</a>, <a class="el" href="tcpip_8h_source.html#l00060">LOCK_TCPIP_CORE</a>, <a class="el" href="debug_8h_source.html#l00116">LWIP_ASSERT</a>, <a class="el" href="tcpip__priv_8h_source.html#l00128">tcpip_msg::msg</a>, <a class="el" href="tcpip__priv_8h_source.html#l00102">tcpip_api_call_data::sem</a>, <a class="el" href="sys_8h_source.html#l00271">sys_mbox_valid_val</a>, <a class="el" href="sys__arch_8c_source.html#l00052">sys_sem_new()</a>, <a class="el" href="tcpip_8c_source.html#l00048">TCPIP_MSG_VAR_DECLARE</a>, and <a class="el" href="tcpip_8h_source.html#l00061">UNLOCK_TCPIP_CORE</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="tcpip__priv_8h_a3d42b0c46607f91aedcc7745ed466b08_cgraph.png" border="0" usemap="#tcpip__priv_8h_a3d42b0c46607f91aedcc7745ed466b08_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="a12bdf37eddcd72c4178e3ea7d370395d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12bdf37eddcd72c4178e3ea7d370395d">◆ </a></span>tcpip_send_msg_wait_sem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> tcpip_send_msg_wait_sem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="tcpip_8h.html#a35203296bb838f3b493839ffc6e7285d">tcpip_callback_fn</a> </td>
<td class="paramname"><em>fn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>apimsg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sem_8h.html#a900e36da93bb688c29fc8148f2f44e04">sys_sem_t</a> * </td>
<td class="paramname"><em>sem</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sends a message to TCPIP thread to call a function. Caller thread blocks on on a provided semaphore, which ist NOT automatically signalled by TCPIP thread, this has to be done by the user. It is recommended to use LWIP_TCPIP_CORE_LOCKING since this is the way with least runtime overhead.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fn</td><td>function to be called from TCPIP thread </td></tr>
<tr><td class="paramname">apimsg</td><td>argument to API function </td></tr>
<tr><td class="paramname">sem</td><td>semaphore to wait on </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>ERR_OK if the function was called, another err_t if not </dd></dl>
<p class="definition">Definition at line <a class="el" href="tcpip_8c_source.html#l00322">322</a> of file <a class="el" href="tcpip_8c_source.html">tcpip.c</a>.</p>
<p class="reference">References <a class="el" href="err_8h_source.html#l00063">ERR_OK</a>, <a class="el" href="tcpip_8h_source.html#l00060">LOCK_TCPIP_CORE</a>, <a class="el" href="debug_8h_source.html#l00116">LWIP_ASSERT</a>, <a class="el" href="arch_8h_source.html#l00315">LWIP_UNUSED_ARG</a>, <a class="el" href="tcpip__priv_8h_source.html#l00128">tcpip_msg::msg</a>, <a class="el" href="tcpip__priv_8h_source.html#l00133">tcpip_msg::sem</a>, <a class="el" href="sys_8h_source.html#l00271">sys_mbox_valid_val</a>, <a class="el" href="sys__arch_8c_source.html#l00132">sys_sem_valid()</a>, <a class="el" href="tcpip_8c_source.html#l00048">TCPIP_MSG_VAR_DECLARE</a>, and <a class="el" href="tcpip_8h_source.html#l00061">UNLOCK_TCPIP_CORE</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="tcpip__priv_8h_a12bdf37eddcd72c4178e3ea7d370395d_cgraph.png" border="0" usemap="#tcpip__priv_8h_a12bdf37eddcd72c4178e3ea7d370395d_cgraph" alt=""/></div>
</div>
</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="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="dir_860402f1cbc34f52a46bdb76ccd99d75.html">priv</a></li><li class="navelem"><a class="el" href="tcpip__priv_8h.html">tcpip_priv.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>
