| <!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" lang="en-US"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> |
| <meta name="generator" content="Doxygen 1.12.0"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>lwIP: src/include/lwip/memp.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> |
| <script type="text/javascript" src="clipboard.js"></script> |
| <link href="navtree.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="navtreedata.js"></script> |
| <script type="text/javascript" src="navtree.js"></script> |
| <script type="text/javascript" src="resize.js"></script> |
| <script type="text/javascript" src="cookie.js"></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 id="projectrow"> |
| <td id="projectalign"> |
| <div id="projectname">lwIP<span id="projectnumber"> 2.1.3</span> |
| </div> |
| <div id="projectbrief">Lightweight IP stack</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.12.0 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| var searchBox = new SearchBox("searchBox", "search/",'.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { codefold.init(0); }); |
| /* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search',true); |
| $(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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(function(){initNavTree('memp_8h.html',''); initResizable(true); }); |
| /* @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"> |
| <div id="MSearchResults"> |
| <div class="SRPage"> |
| <div id="SRIndex"> |
| <div id="SRResults"></div> |
| <div class="SRStatus" id="Loading">Loading...</div> |
| <div class="SRStatus" id="Searching">Searching...</div> |
| <div class="SRStatus" id="NoMatches">No Matches</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div class="header"> |
| <div class="summary"> |
| <a href="#define-members">Macros</a> | |
| <a href="#enum-members">Enumerations</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"><div class="title">memp.h File Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="textblock"><code>#include "<a class="el" href="opt_8h.html">lwip/opt.h</a>"</code><br /> |
| <code>#include "<a class="el" href="memp__std_8h.html">lwip/priv/memp_std.h</a>"</code><br /> |
| <code>#include "<a class="el" href="memp__priv_8h.html">lwip/priv/memp_priv.h</a>"</code><br /> |
| <code>#include "<a class="el" href="stats_8h.html">lwip/stats.h</a>"</code><br /> |
| </div><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a> |
| Macros</h2></td></tr> |
| <tr class="memitem:ga92fc8c29d0e2654f2a2ecc43b2b7fb13" id="r_ga92fc8c29d0e2654f2a2ecc43b2b7fb13"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mempool.html#ga92fc8c29d0e2654f2a2ecc43b2b7fb13">LWIP_MEMPOOL_PROTOTYPE</a>(name)</td></tr> |
| <tr class="separator:ga92fc8c29d0e2654f2a2ecc43b2b7fb13"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga5b1fb3ce7942432d87cc948b1c5ed6cb" id="r_ga5b1fb3ce7942432d87cc948b1c5ed6cb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mempool.html#ga5b1fb3ce7942432d87cc948b1c5ed6cb">LWIP_MEMPOOL_DECLARE</a>(name, num, size, desc)</td></tr> |
| <tr class="separator:ga5b1fb3ce7942432d87cc948b1c5ed6cb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga60b51c06d276f525b35d8b7abd4dcb41" id="r_ga60b51c06d276f525b35d8b7abd4dcb41"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mempool.html#ga60b51c06d276f525b35d8b7abd4dcb41">LWIP_MEMPOOL_INIT</a>(name)</td></tr> |
| <tr class="separator:ga60b51c06d276f525b35d8b7abd4dcb41"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga5e2498f6c17746c1fe7153de5f7f275a" id="r_ga5e2498f6c17746c1fe7153de5f7f275a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mempool.html#ga5e2498f6c17746c1fe7153de5f7f275a">LWIP_MEMPOOL_ALLOC</a>(name)</td></tr> |
| <tr class="separator:ga5e2498f6c17746c1fe7153de5f7f275a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaa43d114dd702fbd8f1db18474ea93a04" id="r_gaa43d114dd702fbd8f1db18474ea93a04"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__mempool.html#gaa43d114dd702fbd8f1db18474ea93a04">LWIP_MEMPOOL_FREE</a>(name, x)</td></tr> |
| <tr class="separator:gaa43d114dd702fbd8f1db18474ea93a04"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a> |
| Enumerations</h2></td></tr> |
| <tr class="memitem:a85a164b1f7764951cc685ea525114e57" id="r_a85a164b1f7764951cc685ea525114e57"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="#a85a164b1f7764951cc685ea525114e57">memp_t</a> </td></tr> |
| <tr class="separator:a85a164b1f7764951cc685ea525114e57"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:a9693e5b1ac2c6b9c0e7870522d45efa2" id="r_a9693e5b1ac2c6b9c0e7870522d45efa2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9693e5b1ac2c6b9c0e7870522d45efa2">memp_init</a> (void)</td></tr> |
| <tr class="separator:a9693e5b1ac2c6b9c0e7870522d45efa2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac49689457203bfb872adf5428f96a3e7" id="r_ac49689457203bfb872adf5428f96a3e7"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac49689457203bfb872adf5428f96a3e7">memp_malloc</a> (<a class="el" href="#a85a164b1f7764951cc685ea525114e57">memp_t</a> type)</td></tr> |
| <tr class="separator:ac49689457203bfb872adf5428f96a3e7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aecd94926b7c2a0e23ae195f4ae97581f" id="r_aecd94926b7c2a0e23ae195f4ae97581f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aecd94926b7c2a0e23ae195f4ae97581f">memp_free</a> (<a class="el" href="#a85a164b1f7764951cc685ea525114e57">memp_t</a> type, void *<a class="el" href="structmem.html">mem</a>)</td></tr> |
| <tr class="separator:aecd94926b7c2a0e23ae195f4ae97581f"><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 pool API</p> |
| <p>lwIP internal memory pools (do not use in application code) This file is deliberately included multiple times: once with empty definition of LWIP_MEMPOOL() to handle all includes and multiple times to build up various lists of mem pools. </p> |
| </div><h2 class="groupheader">Enumeration Type Documentation</h2> |
| <a id="a85a164b1f7764951cc685ea525114e57" name="a85a164b1f7764951cc685ea525114e57"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a85a164b1f7764951cc685ea525114e57">◆ </a></span>memp_t</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="#a85a164b1f7764951cc685ea525114e57">memp_t</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Create the list of all memory pools managed by memp. MEMP_MAX represents a NULL pool at the end </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="aecd94926b7c2a0e23ae195f4ae97581f" name="aecd94926b7c2a0e23ae195f4ae97581f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aecd94926b7c2a0e23ae195f4ae97581f">◆ </a></span>memp_free()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void memp_free </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="#a85a164b1f7764951cc685ea525114e57">memp_t</a></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>mem</em></span> )</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Put an element back into its pool.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">type</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> |
| |
| </div> |
| </div> |
| <a id="a9693e5b1ac2c6b9c0e7870522d45efa2" name="a9693e5b1ac2c6b9c0e7870522d45efa2"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9693e5b1ac2c6b9c0e7870522d45efa2">◆ </a></span>memp_init()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void memp_init </td> |
| <td>(</td> |
| <td class="paramtype">void</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Initializes lwIP built-in pools. Related functions: memp_malloc, memp_free</p> |
| <p>Carves out memp_memory into linked lists for each pool-type. </p> |
| |
| </div> |
| </div> |
| <a id="ac49689457203bfb872adf5428f96a3e7" name="ac49689457203bfb872adf5428f96a3e7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac49689457203bfb872adf5428f96a3e7">◆ </a></span>memp_malloc()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void * memp_malloc </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="#a85a164b1f7764951cc685ea525114e57">memp_t</a></td> <td class="paramname"><span class="paramname"><em>type</em></span></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Get an element from a specific pool.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">type</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> |
| |
| </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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b0856f6b0d80ccb263b2f415c91f9e17.html">include</a></li><li class="navelem"><a class="el" href="dir_4e6b3cf33a61b6caac9c8ac30c866f37.html">lwip</a></li><li class="navelem"><a class="el" href="memp_8h.html">memp.h</a></li> |
| <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li> |
| </ul> |
| </div> |
| </body> |
| </html> |