<!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/memp_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('memp__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="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">memp_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="mem_8h_source.html">net/mem.h</a>></code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for memp_priv.h:</div>
<div class="dyncontent">
<div class="center"><img src="memp__priv_8h__incl.png" border="0" usemap="#C_1_2Dev_2git_2UbixOS_2sys_2include_2net_2priv_2memp__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="memp__priv_8h__dep__incl.png" border="0" usemap="#C_1_2Dev_2git_2UbixOS_2sys_2include_2net_2priv_2memp__priv_8hdep" alt=""/></div>
</div>
</div>
<p><a href="memp__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="structmemp.html">memp</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="structmemp__desc.html">memp_desc</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:aabec8ab3418486aed704fb8bb933da42"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="memp__priv_8h.html#aabec8ab3418486aed704fb8bb933da42">DECLARE_LWIP_MEMPOOL_DESC</a>(desc)</td></tr>
<tr class="separator:aabec8ab3418486aed704fb8bb933da42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9373cb7cc6e658a60cec6ca57173a72d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="memp__priv_8h.html#a9373cb7cc6e658a60cec6ca57173a72d">LWIP_MEMPOOL_DECLARE_STATS_INSTANCE</a>(<a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>)</td></tr>
<tr class="separator:a9373cb7cc6e658a60cec6ca57173a72d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46723c1d1d900d5f23e5bde91d22d8be"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="memp__priv_8h.html#a46723c1d1d900d5f23e5bde91d22d8be">LWIP_MEMPOOL_DECLARE_STATS_REFERENCE</a>(<a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a>)</td></tr>
<tr class="separator:a46723c1d1d900d5f23e5bde91d22d8be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12e0cfbac9c8263e5a1fb319b92338e7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="memp__priv_8h.html#a12e0cfbac9c8263e5a1fb319b92338e7">MEMP_ALIGN_SIZE</a>(x)   (<a class="el" href="group__compiler__abstraction.html#gaef204be511fd32f681b55abc08e9ae18">LWIP_MEM_ALIGN_SIZE</a>(x))</td></tr>
<tr class="separator:a12e0cfbac9c8263e5a1fb319b92338e7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f8c378e0581aa2dc491cff52ae4fce2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="memp__priv_8h.html#a7f8c378e0581aa2dc491cff52ae4fce2">MEMP_SIZE</a>   0</td></tr>
<tr class="separator:a7f8c378e0581aa2dc491cff52ae4fce2"><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:a62f8c3c907743e34eee3cdac7fa1eaa5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="memp__priv_8h.html#a62f8c3c907743e34eee3cdac7fa1eaa5">memp_free_pool</a> (<a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> struct <a class="el" href="structmemp__desc.html">memp_desc</a> *desc, void *<a class="el" href="structmem.html">mem</a>)</td></tr>
<tr class="separator:a62f8c3c907743e34eee3cdac7fa1eaa5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6416303426d05526bed33f241fa6ecd7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="memp__priv_8h.html#a6416303426d05526bed33f241fa6ecd7">memp_init_pool</a> (<a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> struct <a class="el" href="structmemp__desc.html">memp_desc</a> *desc)</td></tr>
<tr class="separator:a6416303426d05526bed33f241fa6ecd7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a348c83ee972f1edf7296a1cdf1d75f22"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="memp__priv_8h.html#a348c83ee972f1edf7296a1cdf1d75f22">memp_malloc_pool</a> (<a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> struct <a class="el" href="structmemp__desc.html">memp_desc</a> *desc)</td></tr>
<tr class="separator:a348c83ee972f1edf7296a1cdf1d75f22"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>memory pools lwIP internal implementations (do not use in application code) </p>
<p class="definition">Definition in file <a class="el" href="memp__priv_8h_source.html">memp_priv.h</a>.</p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aabec8ab3418486aed704fb8bb933da42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aabec8ab3418486aed704fb8bb933da42">◆ </a></span>DECLARE_LWIP_MEMPOOL_DESC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DECLARE_LWIP_MEMPOOL_DESC</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">desc</td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memp__priv_8h_source.html#l00158">158</a> of file <a class="el" href="memp__priv_8h_source.html">memp_priv.h</a>.</p>
</div>
</div>
<a id="a9373cb7cc6e658a60cec6ca57173a72d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9373cb7cc6e658a60cec6ca57173a72d">◆ </a></span>LWIP_MEMPOOL_DECLARE_STATS_INSTANCE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LWIP_MEMPOOL_DECLARE_STATS_INSTANCE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memp__priv_8h_source.html#l00165">165</a> of file <a class="el" href="memp__priv_8h_source.html">memp_priv.h</a>.</p>
</div>
</div>
<a id="a46723c1d1d900d5f23e5bde91d22d8be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46723c1d1d900d5f23e5bde91d22d8be">◆ </a></span>LWIP_MEMPOOL_DECLARE_STATS_REFERENCE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define LWIP_MEMPOOL_DECLARE_STATS_REFERENCE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><a class="el" href="pci_8c.html#a8f8f80d37794cde9472343e4487ba3eb">name</a></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memp__priv_8h_source.html#l00166">166</a> of file <a class="el" href="memp__priv_8h_source.html">memp_priv.h</a>.</p>
</div>
</div>
<a id="a12e0cfbac9c8263e5a1fb319b92338e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12e0cfbac9c8263e5a1fb319b92338e7">◆ </a></span>MEMP_ALIGN_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MEMP_ALIGN_SIZE</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">x</td><td>)</td>
<td>   (<a class="el" href="group__compiler__abstraction.html#gaef204be511fd32f681b55abc08e9ae18">LWIP_MEM_ALIGN_SIZE</a>(x))</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memp__priv_8h_source.html#l00086">86</a> of file <a class="el" href="memp__priv_8h_source.html">memp_priv.h</a>.</p>
</div>
</div>
<a id="a7f8c378e0581aa2dc491cff52ae4fce2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f8c378e0581aa2dc491cff52ae4fce2">◆ </a></span>MEMP_SIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MEMP_SIZE   0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="memp__priv_8h_source.html#l00085">85</a> of file <a class="el" href="memp__priv_8h_source.html">memp_priv.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a62f8c3c907743e34eee3cdac7fa1eaa5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62f8c3c907743e34eee3cdac7fa1eaa5">◆ </a></span>memp_free_pool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void memp_free_pool </td>
<td>(</td>
<td class="paramtype"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> struct <a class="el" href="structmemp__desc.html">memp_desc</a> * </td>
<td class="paramname"><em>desc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>mem</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Put a custom pool element back into its pool.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">desc</td><td>the pool where to put mem </td></tr>
<tr><td class="paramname">mem</td><td>the memp element to free </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="memp_8c_source.html#l00452">452</a> of file <a class="el" href="memp_8c_source.html">memp.c</a>.</p>
<p class="reference">References <a class="el" href="debug_8h_source.html#l00116">LWIP_ASSERT</a>, and <a class="el" href="fat__string_8h_source.html#l00017">NULL</a>.</p>
</div>
</div>
<a id="a6416303426d05526bed33f241fa6ecd7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6416303426d05526bed33f241fa6ecd7">◆ </a></span>memp_init_pool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void memp_init_pool </td>
<td>(</td>
<td class="paramtype"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> struct <a class="el" href="structmemp__desc.html">memp_desc</a> * </td>
<td class="paramname"><em>desc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize custom memory pool. Related functions: memp_malloc_pool, memp_free_pool</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">desc</td><td>pool to initialize </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="memp_8c_source.html#l00230">230</a> of file <a class="el" href="memp_8c_source.html">memp.c</a>.</p>
<p class="reference">References <a class="el" href="memp__priv_8h_source.html#l00148">memp_desc::base</a>, <a class="el" href="arch_8h_source.html#l00236">LWIP_MEM_ALIGN</a>, <a class="el" href="arch_8h_source.html#l00315">LWIP_UNUSED_ARG</a>, <a class="el" href="lwipopts_8h_source.html#l00063">MEMP_OVERFLOW_CHECK</a>, <a class="el" href="memp__priv_8h_source.html#l00085">MEMP_SIZE</a>, <a class="el" href="memp__priv_8h_source.html#l00092">memp::next</a>, <a class="el" href="fat__string_8h_source.html#l00017">NULL</a>, <a class="el" href="memp__priv_8h_source.html#l00145">memp_desc::num</a>, <a class="el" href="memp__priv_8h_source.html#l00141">memp_desc::size</a>, and <a class="el" href="memp__priv_8h_source.html#l00151">memp_desc::tab</a>.</p>
<p class="reference">Referenced by <a class="el" href="memp_8c_source.html#l00271">memp_init()</a>.</p>
</div>
</div>
<a id="a348c83ee972f1edf7296a1cdf1d75f22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a348c83ee972f1edf7296a1cdf1d75f22">◆ </a></span>memp_malloc_pool()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* memp_malloc_pool </td>
<td>(</td>
<td class="paramtype"><a class="el" href="cdefs_8h.html#a2c212835823e3c54a8ab6d95c652660e">const</a> struct <a class="el" href="structmemp__desc.html">memp_desc</a> * </td>
<td class="paramname"><em>desc</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an element from a custom pool.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">desc</td><td>the pool to get an element from</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the allocated memory or a NULL pointer on error </dd></dl>
<p class="definition">Definition at line <a class="el" href="memp_8c_source.html#l00359">359</a> of file <a class="el" href="memp_8c_source.html">memp.c</a>.</p>
<p class="reference">References <a class="el" href="debug_8h_source.html#l00116">LWIP_ASSERT</a>, and <a class="el" href="fat__string_8h_source.html#l00017">NULL</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="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="memp__priv_8h.html">memp_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>
