<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>UbixOS V2: src/sys/include/net/pbuf.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="classes.html"><span>Data Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="dir_897b6a2d7bab147dd1db58381aad3984.html">src</a> » <a class="el" href="dir_832905b1f7f5feaf61a306b40c0ac817.html">sys</a> » <a class="el" href="dir_caf4200c438ae9601464168e21e8e4d8.html">include</a> » <a class="el" href="dir_c1d11d251a83b2498f44d410b793c5eb.html">net</a></div>
<h1>pbuf.h</h1><a href="pbuf_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (c) 2001, Swedish Institute of Computer Science.</span>
<a name="l00003"></a>00003 <span class="comment"> * All rights reserved. </span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * Redistribution and use in source and binary forms, with or without </span>
<a name="l00006"></a>00006 <span class="comment"> * modification, are permitted provided that the following conditions </span>
<a name="l00007"></a>00007 <span class="comment"> * are met: </span>
<a name="l00008"></a>00008 <span class="comment"> * 1. Redistributions of source code must retain the above copyright </span>
<a name="l00009"></a>00009 <span class="comment"> * notice, this list of conditions and the following disclaimer. </span>
<a name="l00010"></a>00010 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright </span>
<a name="l00011"></a>00011 <span class="comment"> * notice, this list of conditions and the following disclaimer in the </span>
<a name="l00012"></a>00012 <span class="comment"> * documentation and/or other materials provided with the distribution. </span>
<a name="l00013"></a>00013 <span class="comment"> * 3. Neither the name of the Institute nor the names of its contributors </span>
<a name="l00014"></a>00014 <span class="comment"> * may be used to endorse or promote products derived from this software </span>
<a name="l00015"></a>00015 <span class="comment"> * without specific prior written permission. </span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND </span>
<a name="l00018"></a>00018 <span class="comment"> * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE </span>
<a name="l00019"></a>00019 <span class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE </span>
<a name="l00020"></a>00020 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE </span>
<a name="l00021"></a>00021 <span class="comment"> * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL </span>
<a name="l00022"></a>00022 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS </span>
<a name="l00023"></a>00023 <span class="comment"> * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) </span>
<a name="l00024"></a>00024 <span class="comment"> * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT </span>
<a name="l00025"></a>00025 <span class="comment"> * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY </span>
<a name="l00026"></a>00026 <span class="comment"> * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF </span>
<a name="l00027"></a>00027 <span class="comment"> * SUCH DAMAGE. </span>
<a name="l00028"></a>00028 <span class="comment"> *</span>
<a name="l00029"></a>00029 <span class="comment"> * This file is part of the lwIP TCP/IP stack.</span>
<a name="l00030"></a>00030 <span class="comment"> * </span>
<a name="l00031"></a>00031 <span class="comment"> * Author: Adam Dunkels <adam@sics.se></span>
<a name="l00032"></a>00032 <span class="comment"> *</span>
<a name="l00033"></a>00033 <span class="comment"> * $Id: pbuf_8h-source.html 88 2016-01-12 00:11:29Z reddawg $</span>
<a name="l00034"></a>00034 <span class="comment"> */</span>
<a name="l00035"></a>00035 <span class="comment">/*-----------------------------------------------------------------------------------*/</span>
<a name="l00036"></a>00036 <span class="preprocessor">#ifndef __LWIP_PBUF_H__</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#define __LWIP_PBUF_H__</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span>
<a name="l00039"></a>00039 <span class="preprocessor">#include "<a class="code" href="debug_8h.html">net/debug.h</a>"</span>
<a name="l00040"></a>00040 <span class="preprocessor">#include "<a class="code" href="arch_8h.html">net/arch.h</a>"</span>
<a name="l00041"></a>00041
<a name="l00042"></a>00042
<a name="l00043"></a><a class="code" href="pbuf_8h.html#f9da2e1ca60dc0c584938ccc5d662307">00043</a> <span class="preprocessor">#define PBUF_TRANSPORT_HLEN 20</span>
<a name="l00044"></a><a class="code" href="pbuf_8h.html#ae0fea237167bb06ea4dc5333df5b0a7">00044</a> <span class="preprocessor"></span><span class="preprocessor">#define PBUF_IP_HLEN 20</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span>
<a name="l00046"></a><a class="code" href="pbuf_8h.html#ee1baa59bb2f85ba575b5a8619ac1ebf">00046</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00047"></a>00047 <a class="code" href="pbuf_8h.html#ee1baa59bb2f85ba575b5a8619ac1ebf2ded3594a3977f8bf9cf09552be327b5">PBUF_TRANSPORT</a>,
<a name="l00048"></a>00048 <a class="code" href="pbuf_8h.html#ee1baa59bb2f85ba575b5a8619ac1ebffcc1e506061ba69dfa142eb6b3da5f13">PBUF_IP</a>,
<a name="l00049"></a>00049 <a class="code" href="pbuf_8h.html#ee1baa59bb2f85ba575b5a8619ac1ebfb4de441e737330558b609a990cd17346">PBUF_LINK</a>,
<a name="l00050"></a>00050 <a class="code" href="pbuf_8h.html#ee1baa59bb2f85ba575b5a8619ac1ebf21116654fbab6d5a4dfeb87a1bb8f0ba">PBUF_RAW</a>
<a name="l00051"></a>00051 } <a class="code" href="pbuf_8h.html#ee1baa59bb2f85ba575b5a8619ac1ebf">pbuf_layer</a>;
<a name="l00052"></a>00052
<a name="l00053"></a><a class="code" href="pbuf_8h.html#b3c589840cc5a202e7278f41463f97e7">00053</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00054"></a>00054 <a class="code" href="pbuf_8h.html#b3c589840cc5a202e7278f41463f97e7c5e9f28455bca98944a030d4b84ecfab">PBUF_RAM</a>,
<a name="l00055"></a>00055 <a class="code" href="pbuf_8h.html#b3c589840cc5a202e7278f41463f97e7c120b0fe39efe35bb682e4aa3b82e2c9">PBUF_ROM</a>,
<a name="l00056"></a>00056 <a class="code" href="pbuf_8h.html#b3c589840cc5a202e7278f41463f97e7e969347127387b9b59a23ccd24b76d21">PBUF_POOL</a>
<a name="l00057"></a>00057 } <a class="code" href="pbuf_8h.html#b3c589840cc5a202e7278f41463f97e7">pbuf_flag</a>;
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="comment">/* Definitions for the pbuf flag field (these are not the flags that</span>
<a name="l00060"></a>00060 <span class="comment"> are passed to pbuf_alloc()). */</span>
<a name="l00061"></a><a class="code" href="pbuf_8h.html#cf2ae058c765838582f1c099df7e16a1">00061</a> <span class="preprocessor">#define PBUF_FLAG_RAM 0x00 </span><span class="comment">/* Flags that pbuf data is stored in RAM. */</span>
<a name="l00062"></a><a class="code" href="pbuf_8h.html#63940b83910f19c67f77f0f329d5ab87">00062</a> <span class="preprocessor">#define PBUF_FLAG_ROM 0x01 </span><span class="comment">/* Flags that pbuf data is stored in ROM. */</span>
<a name="l00063"></a><a class="code" href="pbuf_8h.html#a804921a6fd47216f7a7f3fac704b3d9">00063</a> <span class="preprocessor">#define PBUF_FLAG_POOL 0x02 </span><span class="comment">/* Flags that the pbuf comes from the</span>
<a name="l00064"></a>00064 <span class="comment"> pbuf pool. */</span>
<a name="l00065"></a>00065
<a name="l00066"></a><a class="code" href="structpbuf.html">00066</a> <span class="keyword">struct </span><a class="code" href="structpbuf.html">pbuf</a> {
<a name="l00067"></a><a class="code" href="structpbuf.html#5e5763c94fd18d78937b0b58ce7df341">00067</a> <span class="keyword">struct </span><a class="code" href="structpbuf.html">pbuf</a> *<a class="code" href="structpbuf.html#5e5763c94fd18d78937b0b58ce7df341">next</a>;
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="comment">/* high 4 bits, flags, low 4 bits reference count */</span>
<a name="l00070"></a><a class="code" href="structpbuf.html#a8c1fc523add879c501909327c60a419">00070</a> <a class="code" href="types_8h.html#a4e0f27a9aca905e340c06d2dcae843c">uInt8</a> <a class="code" href="structpbuf.html#577f939137bc908b0256e24b517c705c">flags</a>, <a class="code" href="structpbuf.html#a8c1fc523add879c501909327c60a419">ref</a>;
<a name="l00071"></a><a class="code" href="structpbuf.html#8d32dc3e964369d4eec638fc37fbc460">00071</a> <span class="keywordtype">void</span> *<a class="code" href="structpbuf.html#8d32dc3e964369d4eec638fc37fbc460">payload</a>;
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <span class="comment">/* Total length of buffer + additionally chained buffers. */</span>
<a name="l00074"></a><a class="code" href="structpbuf.html#3b42932c0b26c9ff2b8fe88bd25fb127">00074</a> <a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> <a class="code" href="structpbuf.html#3b42932c0b26c9ff2b8fe88bd25fb127">tot_len</a>;
<a name="l00075"></a>00075 <span class="comment">/* Length of this buffer. */</span>
<a name="l00076"></a><a class="code" href="structpbuf.html#238f00a0024a32992599c9d1abf9bb44">00076</a> <a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> <a class="code" href="structpbuf.html#238f00a0024a32992599c9d1abf9bb44">len</a>;
<a name="l00077"></a>00077
<a name="l00078"></a>00078 };
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="comment">/* pbuf_init():</span>
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment"> Initializes the pbuf module. The num parameter determines how many</span>
<a name="l00083"></a>00083 <span class="comment"> pbufs that should be allocated to the pbuf pool, and the size</span>
<a name="l00084"></a>00084 <span class="comment"> parameter specifies the size of the data allocated to those. */</span>
<a name="l00085"></a>00085 <span class="keywordtype">void</span> <a class="code" href="pbuf_8h.html#a98d7fe8196cfd072a5c2b8de4ea5d1e">pbuf_init</a>(<span class="keywordtype">void</span>);
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="comment">/* pbuf_alloc():</span>
<a name="l00088"></a>00088 <span class="comment"> </span>
<a name="l00089"></a>00089 <span class="comment"> Allocates a pbuf at protocol layer l. The actual memory allocated</span>
<a name="l00090"></a>00090 <span class="comment"> for the pbuf is determined by the layer at which the pbuf is</span>
<a name="l00091"></a>00091 <span class="comment"> allocated and the requested size (from the size parameter). The</span>
<a name="l00092"></a>00092 <span class="comment"> flag parameter decides how and where the pbuf should be allocated</span>
<a name="l00093"></a>00093 <span class="comment"> as follows:</span>
<a name="l00094"></a>00094 <span class="comment"> </span>
<a name="l00095"></a>00095 <span class="comment"> * PBUF_RAM: buffer memory for pbuf is allocated as one large</span>
<a name="l00096"></a>00096 <span class="comment"> chunk. This includesprotocol headers as well.</span>
<a name="l00097"></a>00097 <span class="comment"> </span>
<a name="l00098"></a>00098 <span class="comment"> * RBUF_ROM: no buffer memory is allocated for the pbuf, even for</span>
<a name="l00099"></a>00099 <span class="comment"> protocol headers. Additional headers must be</span>
<a name="l00100"></a>00100 <span class="comment"> prepended by allocating another pbuf and chain in to</span>
<a name="l00101"></a>00101 <span class="comment"> the front of the ROM pbuf.</span>
<a name="l00102"></a>00102 <span class="comment"></span>
<a name="l00103"></a>00103 <span class="comment"> * PBUF_ROOL: the pbuf is allocated as a pbuf chain, with pbufs from</span>
<a name="l00104"></a>00104 <span class="comment"> the pbuf pool that is allocated during pbuf_init(). */</span>
<a name="l00105"></a>00105 <span class="keyword">struct </span><a class="code" href="structpbuf.html">pbuf</a> *<a class="code" href="pbuf_8h.html#bb6c8efa7f7739e71cb286c6dd4a47ef">pbuf_alloc</a>(<a class="code" href="pbuf_8h.html#ee1baa59bb2f85ba575b5a8619ac1ebf">pbuf_layer</a> l, <a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> size, <a class="code" href="pbuf_8h.html#b3c589840cc5a202e7278f41463f97e7">pbuf_flag</a> flag);
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="comment">/* pbuf_realloc():</span>
<a name="l00108"></a>00108 <span class="comment"></span>
<a name="l00109"></a>00109 <span class="comment"> Shrinks the pbuf to the size given by the size parameter. </span>
<a name="l00110"></a>00110 <span class="comment"> */</span>
<a name="l00111"></a>00111 <span class="keywordtype">void</span> <a class="code" href="pbuf_8h.html#2acee36fb0831879ffa1c45598bc0a0f">pbuf_realloc</a>(<span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *p, <a class="code" href="types_8h.html#3b65128d2644e9b80cec9a69bfa7e094">uInt16</a> size);
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="comment">/* pbuf_header():</span>
<a name="l00114"></a>00114 <span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment"> Tries to move the p->payload pointer header_size number of bytes</span>
<a name="l00116"></a>00116 <span class="comment"> upward within the pbuf. The return value is non-zero if it</span>
<a name="l00117"></a>00117 <span class="comment"> fails. If so, an additional pbuf should be allocated for the header</span>
<a name="l00118"></a>00118 <span class="comment"> and it should be chained to the front. */</span>
<a name="l00119"></a>00119 <a class="code" href="types_8h.html#a4e0f27a9aca905e340c06d2dcae843c">uInt8</a> <a class="code" href="pbuf_8h.html#c83243784ae907d307b4ac444282ccc5">pbuf_header</a>(<span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *p, <a class="code" href="types_8h.html#292a71e839a94f0bafde3510df52d972">Int16</a> header_size);
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="comment">/* pbuf_ref():</span>
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment"> Increments the reference count of the pbuf p.</span>
<a name="l00124"></a>00124 <span class="comment"> */</span>
<a name="l00125"></a>00125 <span class="keywordtype">void</span> <a class="code" href="pbuf_8h.html#77f6bbd69e45e542014d9c547c7da74e">pbuf_ref</a>(<span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *p);
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="comment">/* pbuf_free():</span>
<a name="l00128"></a>00128 <span class="comment"></span>
<a name="l00129"></a>00129 <span class="comment"> Decrements the reference count and deallocates the pbuf if the</span>
<a name="l00130"></a>00130 <span class="comment"> reference count is zero. If the pbuf is a chain all pbufs in the</span>
<a name="l00131"></a>00131 <span class="comment"> chain are deallocated. */</span>
<a name="l00132"></a>00132 <a class="code" href="types_8h.html#a4e0f27a9aca905e340c06d2dcae843c">uInt8</a> <a class="code" href="pbuf_8h.html#334112aa2ac402c254d604c0dbbbb746">pbuf_free</a>(<span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *p);
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <span class="comment">/* pbuf_clen():</span>
<a name="l00135"></a>00135 <span class="comment"></span>
<a name="l00136"></a>00136 <span class="comment"> Returns the length of the pbuf chain. */</span>
<a name="l00137"></a>00137 <a class="code" href="types_8h.html#a4e0f27a9aca905e340c06d2dcae843c">uInt8</a> <a class="code" href="pbuf_8h.html#8e606e36100a9b82f68b694f3f1d0b36">pbuf_clen</a>(<span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *p);
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="comment">/* pbuf_chain():</span>
<a name="l00140"></a>00140 <span class="comment"></span>
<a name="l00141"></a>00141 <span class="comment"> Chains pbuf t on the end of pbuf h. Pbuf h will have it's tot_len</span>
<a name="l00142"></a>00142 <span class="comment"> field adjusted accordingly. Pbuf t should no be used any more after</span>
<a name="l00143"></a>00143 <span class="comment"> a call to this function, since pbuf t is now a part of pbuf h. */</span>
<a name="l00144"></a>00144 <span class="keywordtype">void</span> <a class="code" href="pbuf_8h.html#831c9a72bda1d3bd4c7b96f5a0e3b891">pbuf_chain</a>(<span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *h, <span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *t);
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="comment">/* pbuf_dechain():</span>
<a name="l00147"></a>00147 <span class="comment"></span>
<a name="l00148"></a>00148 <span class="comment"> Picks off the first pbuf from the pbuf chain p. Returns the tail of</span>
<a name="l00149"></a>00149 <span class="comment"> the pbuf chain or NULL if the pbuf p was not chained. */</span>
<a name="l00150"></a>00150 <span class="keyword">struct </span><a class="code" href="structpbuf.html">pbuf</a> *<a class="code" href="pbuf_8h.html#bf3d29c4f43986b4cb5eb314d5b9729d">pbuf_dechain</a>(<span class="keyword">struct</span> <a class="code" href="structpbuf.html">pbuf</a> *p);
<a name="l00151"></a>00151
<a name="l00152"></a>00152 <span class="preprocessor">#endif </span><span class="comment">/* __LWIP_PBUF_H__ */</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Tue Dec 12 08:52:04 2006 for UbixOS V2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
