| <!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: PBUF</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('group__lwip__opts__pbuf.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> </div> |
| <div class="headertitle"><div class="title">PBUF<div class="ingroups"><a class="el" href="group__lwip.html">lwIP</a> » <a class="el" href="group__lwip__opts.html">Options (lwipopts.h)</a></div></div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <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:ga35998a3d56af9940e6a80bb372597685" id="r_ga35998a3d56af9940e6a80bb372597685"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga35998a3d56af9940e6a80bb372597685">PBUF_LINK_HLEN</a>   (14 + <a class="el" href="group__lwip__opts__arp.html#gad7fa3b356ca7e603e848b069c4cc6276">ETH_PAD_SIZE</a>)</td></tr> |
| <tr class="separator:ga35998a3d56af9940e6a80bb372597685"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga6e1ba1875ae5168a17b53d83597bc1de" id="r_ga6e1ba1875ae5168a17b53d83597bc1de"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6e1ba1875ae5168a17b53d83597bc1de">PBUF_LINK_ENCAPSULATION_HLEN</a>   0</td></tr> |
| <tr class="separator:ga6e1ba1875ae5168a17b53d83597bc1de"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gae61f4491d56e805e79b79eb5d35a00e5" id="r_gae61f4491d56e805e79b79eb5d35a00e5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gae61f4491d56e805e79b79eb5d35a00e5">PBUF_POOL_BUFSIZE</a>   <a class="el" href="group__compiler__abstraction.html#gaef204be511fd32f681b55abc08e9ae18">LWIP_MEM_ALIGN_SIZE</a>(<a class="el" href="group__lwip__opts__tcp.html#gaf1ab7bb27860aa3677c387a2f3ba317b">TCP_MSS</a>+PBUF_IP_HLEN+PBUF_TRANSPORT_HLEN+<a class="el" href="#ga6e1ba1875ae5168a17b53d83597bc1de">PBUF_LINK_ENCAPSULATION_HLEN</a>+<a class="el" href="#ga35998a3d56af9940e6a80bb372597685">PBUF_LINK_HLEN</a>)</td></tr> |
| <tr class="separator:gae61f4491d56e805e79b79eb5d35a00e5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaaefb80d6bf9257c0f4322c36e1272c38" id="r_gaaefb80d6bf9257c0f4322c36e1272c38"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaaefb80d6bf9257c0f4322c36e1272c38">LWIP_PBUF_REF_T</a>   u8_t</td></tr> |
| <tr class="separator:gaaefb80d6bf9257c0f4322c36e1272c38"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga3b7067723b378457373722ca1a46a9d6" id="r_ga3b7067723b378457373722ca1a46a9d6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3b7067723b378457373722ca1a46a9d6">LWIP_PBUF_CUSTOM_DATA</a></td></tr> |
| <tr class="separator:ga3b7067723b378457373722ca1a46a9d6"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <h2 class="groupheader">Macro Definition Documentation</h2> |
| <a id="ga3b7067723b378457373722ca1a46a9d6" name="ga3b7067723b378457373722ca1a46a9d6"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga3b7067723b378457373722ca1a46a9d6">◆ </a></span>LWIP_PBUF_CUSTOM_DATA</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define LWIP_PBUF_CUSTOM_DATA</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>LWIP_PBUF_CUSTOM_DATA: Store private data on pbufs (e.g. timestamps) This extends struct pbuf so user can store custom data on every pbuf. </p> |
| |
| </div> |
| </div> |
| <a id="gaaefb80d6bf9257c0f4322c36e1272c38" name="gaaefb80d6bf9257c0f4322c36e1272c38"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gaaefb80d6bf9257c0f4322c36e1272c38">◆ </a></span>LWIP_PBUF_REF_T</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define LWIP_PBUF_REF_T   u8_t</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>LWIP_PBUF_REF_T: Refcount type in pbuf. Default width of u8_t can be increased if 255 refs are not enough for you. </p> |
| |
| </div> |
| </div> |
| <a id="ga6e1ba1875ae5168a17b53d83597bc1de" name="ga6e1ba1875ae5168a17b53d83597bc1de"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga6e1ba1875ae5168a17b53d83597bc1de">◆ </a></span>PBUF_LINK_ENCAPSULATION_HLEN</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define PBUF_LINK_ENCAPSULATION_HLEN   0</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>PBUF_LINK_ENCAPSULATION_HLEN: the number of bytes that should be allocated for an additional encapsulation header before ethernet headers (e.g. 802.11) </p> |
| |
| </div> |
| </div> |
| <a id="ga35998a3d56af9940e6a80bb372597685" name="ga35998a3d56af9940e6a80bb372597685"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ga35998a3d56af9940e6a80bb372597685">◆ </a></span>PBUF_LINK_HLEN</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define PBUF_LINK_HLEN   (14 + <a class="el" href="group__lwip__opts__arp.html#gad7fa3b356ca7e603e848b069c4cc6276">ETH_PAD_SIZE</a>)</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>PBUF_LINK_HLEN: the number of bytes that should be allocated for a link level header. The default is 14, the standard value for Ethernet. </p> |
| |
| </div> |
| </div> |
| <a id="gae61f4491d56e805e79b79eb5d35a00e5" name="gae61f4491d56e805e79b79eb5d35a00e5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#gae61f4491d56e805e79b79eb5d35a00e5">◆ </a></span>PBUF_POOL_BUFSIZE</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define PBUF_POOL_BUFSIZE   <a class="el" href="group__compiler__abstraction.html#gaef204be511fd32f681b55abc08e9ae18">LWIP_MEM_ALIGN_SIZE</a>(<a class="el" href="group__lwip__opts__tcp.html#gaf1ab7bb27860aa3677c387a2f3ba317b">TCP_MSS</a>+PBUF_IP_HLEN+PBUF_TRANSPORT_HLEN+<a class="el" href="#ga6e1ba1875ae5168a17b53d83597bc1de">PBUF_LINK_ENCAPSULATION_HLEN</a>+<a class="el" href="#ga35998a3d56af9940e6a80bb372597685">PBUF_LINK_HLEN</a>)</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>PBUF_POOL_BUFSIZE: the size of each pbuf in the pbuf pool. The default is designed to accommodate single full size TCP frame in one pbuf, including TCP_MSS, IP header, and link header. </p> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| </div><!-- doc-content --> |
| <!-- start footer part --> |
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> |
| <ul> |
| <li class="footer">Generated by <a href="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> |