<!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: pbuf Struct 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('structpbuf.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="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">pbuf Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="pbuf_8h_source.html">pbuf.h</a>></code></p>
<div class="dynheader">
Collaboration diagram for pbuf:</div>
<div class="dyncontent">
<div class="center"><img src="structpbuf__coll__graph.png" border="0" usemap="#pbuf_coll__map" alt="Collaboration graph"/></div>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aa4d1af2cab3d9280d29212095b5b872a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpbuf.html#aa4d1af2cab3d9280d29212095b5b872a">flags</a></td></tr>
<tr class="separator:aa4d1af2cab3d9280d29212095b5b872a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6f82449625e36e294f5d210268c0703f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpbuf.html#a6f82449625e36e294f5d210268c0703f">len</a></td></tr>
<tr class="separator:a6f82449625e36e294f5d210268c0703f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e5763c94fd18d78937b0b58ce7df341"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structpbuf.html">pbuf</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpbuf.html#a5e5763c94fd18d78937b0b58ce7df341">next</a></td></tr>
<tr class="separator:a5e5763c94fd18d78937b0b58ce7df341"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d32dc3e964369d4eec638fc37fbc460"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structpbuf.html#a8d32dc3e964369d4eec638fc37fbc460">payload</a></td></tr>
<tr class="separator:a8d32dc3e964369d4eec638fc37fbc460"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a18e2c02942feb1baa3756fcd585b6731"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpbuf.html#a18e2c02942feb1baa3756fcd585b6731">ref</a></td></tr>
<tr class="separator:a18e2c02942feb1baa3756fcd585b6731"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5259e7ec29bab9c0999b64f2e86b411f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpbuf.html#a5259e7ec29bab9c0999b64f2e86b411f">tot_len</a></td></tr>
<tr class="separator:a5259e7ec29bab9c0999b64f2e86b411f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afd7bff5210a022424caa97d2f25fe8e6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpbuf.html#afd7bff5210a022424caa97d2f25fe8e6">type</a></td></tr>
<tr class="separator:afd7bff5210a022424caa97d2f25fe8e6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Main packet buffer struct </p>
<p class="definition">Definition at line <a class="el" href="pbuf_8h_source.html#l00142">142</a> of file <a class="el" href="pbuf_8h_source.html">pbuf.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="aa4d1af2cab3d9280d29212095b5b872a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4d1af2cab3d9280d29212095b5b872a">◆ </a></span>flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> pbuf::flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>misc flags </p>
<p class="definition">Definition at line <a class="el" href="pbuf_8h_source.html#l00165">165</a> of file <a class="el" href="pbuf_8h_source.html">pbuf.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="pbuf_8c_source.html#l00248">pbuf_alloc()</a>, and <a class="el" href="pbuf_8c_source.html#l00493">pbuf_realloc()</a>.</p>
</div>
</div>
<a id="a6f82449625e36e294f5d210268c0703f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f82449625e36e294f5d210268c0703f">◆ </a></span>len</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> pbuf::len</td>
</tr>
</table>
</div><div class="memdoc">
<p>length of this buffer </p>
<p class="definition">Definition at line <a class="el" href="pbuf_8h_source.html#l00159">159</a> of file <a class="el" href="pbuf_8h_source.html">pbuf.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="inet__chksum_8c_source.html#l00555">inet_chksum()</a>, <a class="el" href="inet__chksum_8c_source.html#l00568">inet_chksum_pbuf()</a>, <a class="el" href="def_8c_source.html#l00161">lwip_strnicmp()</a>, <a class="el" href="pbuf_8c_source.html#l00248">pbuf_alloc()</a>, <a class="el" href="pbuf_8c_source.html#l00841">pbuf_cat()</a>, <a class="el" href="pbuf_8c_source.html#l00949">pbuf_copy()</a>, <a class="el" href="pbuf_8c_source.html#l01016">pbuf_copy_partial()</a>, <a class="el" href="pbuf_8c_source.html#l00900">pbuf_dechain()</a>, <a class="el" href="pbuf_8c_source.html#l01363">pbuf_memcmp()</a>, <a class="el" href="pbuf_8c_source.html#l01340">pbuf_put_at()</a>, <a class="el" href="pbuf_8c_source.html#l00493">pbuf_realloc()</a>, <a class="el" href="pbuf_8c_source.html#l01150">pbuf_take()</a>, and <a class="el" href="pbuf_8c_source.html#l01194">pbuf_take_at()</a>.</p>
</div>
</div>
<a id="a5e5763c94fd18d78937b0b58ce7df341"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e5763c94fd18d78937b0b58ce7df341">◆ </a></span>next</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structpbuf.html">pbuf</a>* pbuf::next</td>
</tr>
</table>
</div><div class="memdoc">
<p>next pbuf in singly linked pbuf chain </p>
<p class="definition">Definition at line <a class="el" href="pbuf_8h_source.html#l00144">144</a> of file <a class="el" href="pbuf_8h_source.html">pbuf.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="inet__chksum_8c_source.html#l00568">inet_chksum_pbuf()</a>, <a class="el" href="pbuf_8c_source.html#l00248">pbuf_alloc()</a>, <a class="el" href="pbuf_8c_source.html#l00841">pbuf_cat()</a>, <a class="el" href="pbuf_8c_source.html#l00801">pbuf_clen()</a>, <a class="el" href="pbuf_8c_source.html#l01230">pbuf_coalesce()</a>, <a class="el" href="pbuf_8c_source.html#l01016">pbuf_copy_partial()</a>, <a class="el" href="pbuf_8c_source.html#l00900">pbuf_dechain()</a>, <a class="el" href="pbuf_8c_source.html#l00715">pbuf_free()</a>, <a class="el" href="pbuf_8c_source.html#l01363">pbuf_memcmp()</a>, <a class="el" href="pbuf_8c_source.html#l00493">pbuf_realloc()</a>, <a class="el" href="pbuf_8c_source.html#l01150">pbuf_take()</a>, and <a class="el" href="pbuf_8c_source.html#l01194">pbuf_take_at()</a>.</p>
</div>
</div>
<a id="a8d32dc3e964369d4eec638fc37fbc460"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d32dc3e964369d4eec638fc37fbc460">◆ </a></span>payload</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* pbuf::payload</td>
</tr>
</table>
</div><div class="memdoc">
<p>pointer to the actual data in the buffer </p>
<p class="definition">Definition at line <a class="el" href="pbuf_8h_source.html#l00147">147</a> of file <a class="el" href="pbuf_8h_source.html">pbuf.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="arp_8c_source.html#l00197">arp_arp_input()</a>, <a class="el" href="arp_8c_source.html#l00181">arp_ip_input()</a>, <a class="el" href="arp_8c_source.html#l00273">arp_query()</a>, <a class="el" href="inet__chksum_8c_source.html#l00568">inet_chksum_pbuf()</a>, <a class="el" href="pbuf_8c_source.html#l00248">pbuf_alloc()</a>, <a class="el" href="pbuf_8c_source.html#l01016">pbuf_copy_partial()</a>, <a class="el" href="pbuf_8c_source.html#l01340">pbuf_put_at()</a>, <a class="el" href="pbuf_8c_source.html#l00493">pbuf_realloc()</a>, <a class="el" href="pbuf_8c_source.html#l01150">pbuf_take()</a>, and <a class="el" href="pbuf_8c_source.html#l01194">pbuf_take_at()</a>.</p>
</div>
</div>
<a id="a18e2c02942feb1baa3756fcd585b6731"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18e2c02942feb1baa3756fcd585b6731">◆ </a></span>ref</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> pbuf::ref</td>
</tr>
</table>
</div><div class="memdoc">
<p>the reference count always equals the number of pointers that refer to this pbuf. This can be pointers from an application, the stack itself, or pbuf->next pointers from a chain. </p>
<p class="definition">Definition at line <a class="el" href="pbuf_8h_source.html#l00172">172</a> of file <a class="el" href="pbuf_8h_source.html">pbuf.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="pbuf_8c_source.html#l00248">pbuf_alloc()</a>, <a class="el" href="pbuf_8c_source.html#l00715">pbuf_free()</a>, and <a class="el" href="pbuf_8c_source.html#l00821">pbuf_ref()</a>.</p>
</div>
</div>
<a id="a5259e7ec29bab9c0999b64f2e86b411f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5259e7ec29bab9c0999b64f2e86b411f">◆ </a></span>tot_len</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__compiler__abstraction.html#ga77570ac4fcab86864fa1916e55676da2">u16_t</a> pbuf::tot_len</td>
</tr>
</table>
</div><div class="memdoc">
<p>total length of this buffer and all next buffers in chain belonging to the same packet.</p>
<p>For non-queue packet chains this is the invariant: p->tot_len == p->len + (p->next? p->next->tot_len: 0) </p>
<p class="definition">Definition at line <a class="el" href="pbuf_8h_source.html#l00156">156</a> of file <a class="el" href="pbuf_8h_source.html">pbuf.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="arp_8c_source.html#l00197">arp_arp_input()</a>, <a class="el" href="pbuf_8c_source.html#l00248">pbuf_alloc()</a>, <a class="el" href="pbuf_8c_source.html#l00841">pbuf_cat()</a>, <a class="el" href="pbuf_8c_source.html#l01230">pbuf_coalesce()</a>, <a class="el" href="pbuf_8c_source.html#l00900">pbuf_dechain()</a>, <a class="el" href="pbuf_8c_source.html#l01363">pbuf_memcmp()</a>, <a class="el" href="pbuf_8c_source.html#l01405">pbuf_memfind()</a>, <a class="el" href="pbuf_8c_source.html#l00493">pbuf_realloc()</a>, <a class="el" href="pbuf_8c_source.html#l01432">pbuf_strstr()</a>, and <a class="el" href="pbuf_8c_source.html#l01194">pbuf_take_at()</a>.</p>
</div>
</div>
<a id="afd7bff5210a022424caa97d2f25fe8e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd7bff5210a022424caa97d2f25fe8e6">◆ </a></span>type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__compiler__abstraction.html#ga4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> pbuf::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>pbuf_type as u8_t instead of enum to save space </p>
<p class="definition">Definition at line <a class="el" href="pbuf_8h_source.html#l00162">162</a> of file <a class="el" href="pbuf_8h_source.html">pbuf.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="pbuf_8c_source.html#l00248">pbuf_alloc()</a>, <a class="el" href="pbuf_8c_source.html#l00715">pbuf_free()</a>, and <a class="el" href="pbuf_8c_source.html#l00493">pbuf_realloc()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>C:/Dev/git/UbixOS/sys/include/net/<a class="el" href="pbuf_8h_source.html">pbuf.h</a></li>
</ul>
</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="structpbuf.html">pbuf</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>
