diff options
Diffstat (limited to 'docs/doxygen/nel/buf__fifo_8h-source.html')
| -rw-r--r-- | docs/doxygen/nel/buf__fifo_8h-source.html | 191 |
1 files changed, 191 insertions, 0 deletions
diff --git a/docs/doxygen/nel/buf__fifo_8h-source.html b/docs/doxygen/nel/buf__fifo_8h-source.html new file mode 100644 index 00000000..61377e58 --- /dev/null +++ b/docs/doxygen/nel/buf__fifo_8h-source.html @@ -0,0 +1,191 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>buf_fifo.h</h1><a href="buf__fifo_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 +00007 <font class="comment">/* Copyright, 2001 Nevrax Ltd.</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This file is part of NEVRAX NEL.</font> +00010 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font> +00011 <font class="comment"> * it under the terms of the GNU General Public License as published by</font> +00012 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font> +00013 <font class="comment"> * any later version.</font> +00014 <font class="comment"></font> +00015 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"></font> +00020 <font class="comment"> * You should have received a copy of the GNU General Public License</font> +00021 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font> +00022 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font> +00023 <font class="comment"> * MA 02111-1307, USA.</font> +00024 <font class="comment"> */</font> +00025 +00026 <font class="preprocessor">#ifndef NL_BUF_FIFO_H</font> +00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_BUF_FIFO_H</font> +00028 <font class="preprocessor"></font> +00029 <font class="preprocessor">#include "<a class="code" href="types__nl_8h.html">nel/misc/types_nl.h</a>"</font> +00030 +00031 <font class="preprocessor">#include <vector></font> +00032 +00033 <font class="preprocessor">#include "<a class="code" href="time__nl_8h.html">nel/misc/time_nl.h</a>"</font> +00034 <font class="preprocessor">#include "<a class="code" href="mem__stream_8h.html">nel/misc/mem_stream.h</a>"</font> +00035 +00036 +00037 <font class="keyword">namespace </font>NLMISC { +00038 +00039 +<a name="l00064"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html">00064</a> <font class="keyword">class </font>CBufFIFO +00065 { +00066 <font class="keyword">public</font>: +00067 +00068 <a class="code" href="classNLMISC_1_1CBufFIFO.html#a0">CBufFIFO</a> (); +00069 <a class="code" href="classNLMISC_1_1CBufFIFO.html#a1">~CBufFIFO</a> (); +00070 +<a name="l00072"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#a2">00072</a> <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#a2">push</a> (<font class="keyword">const</font> std::vector<uint8> &buffer) { <a class="code" href="classNLMISC_1_1CBufFIFO.html#a2">push</a> (&buffer[0], buffer.size()); } +00073 +<a name="l00074"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#a3">00074</a> <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#a2">push</a> (<font class="keyword">const</font> <a class="code" href="classNLMISC_1_1CMemStream.html">NLMISC::CMemStream</a> &buffer) { <a class="code" href="classNLMISC_1_1CBufFIFO.html#a2">push</a> (buffer.<a class="code" href="classNLMISC_1_1CMemStream.html#a11">buffer</a>(), buffer.<a class="code" href="classNLMISC_1_1CMemStream.html#a10">length</a>()); } +00075 +00076 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#a2">push</a> (<font class="keyword">const</font> uint8 *buffer, uint32 <a class="code" href="classNLMISC_1_1CBufFIFO.html#a14">size</a>); +00077 +00079 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#a2">push</a> (<font class="keyword">const</font> std::vector<uint8> &buffer1, <font class="keyword">const</font> std::vector<uint8> &buffer2); +00080 +00082 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#a6">front</a> (std::vector<uint8> &buffer); +00083 +00084 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#a6">front</a> (<a class="code" href="classNLMISC_1_1CMemStream.html">NLMISC::CMemStream</a> &buffer); +00085 +00086 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#a6">front</a> (uint8 *&buffer, uint32 &<a class="code" href="classNLMISC_1_1CBufFIFO.html#a14">size</a>); +00087 +00090 uint8 <a class="code" href="classNLMISC_1_1CBufFIFO.html#a9">frontLast</a> (); +00091 +00092 +00094 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#a10">pop</a> (); +00095 +00097 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#a11">resize</a> (uint32 <a class="code" href="classNLMISC_1_1CBufFIFO.html#a14">size</a>); +00098 +<a name="l00100"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#a12">00100</a> <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#a12">empty</a> () { <font class="keywordflow">return</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#o2">_Empty</a>; } +00101 +00102 +00104 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#a13">clear</a> (); +00105 +00107 uint32 <a class="code" href="classNLMISC_1_1CBufFIFO.html#a14">size</a> (); +00108 +00110 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#a15">display</a> (); +00111 +00113 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#a16">displayStats</a> (); +00114 +00115 <font class="keyword">private</font>: +00116 +<a name="l00117"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#u0">00117</a> <font class="keyword">typedef</font> uint32 <a class="code" href="classNLMISC_1_1CBufFIFO.html#u0">TFifoSize</a>; +00118 +00119 <font class="comment">// pointer to the big buffer</font> +<a name="l00120"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o0">00120</a> uint8 *<a class="code" href="classNLMISC_1_1CBufFIFO.html#o0">_Buffer</a>; +00121 <font class="comment">// size of the big buffer</font> +<a name="l00122"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o1">00122</a> uint32 <a class="code" href="classNLMISC_1_1CBufFIFO.html#o1">_BufferSize</a>; +00123 +00124 <font class="comment">// true if the bufffer is empty</font> +<a name="l00125"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o2">00125</a> <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#o2">_Empty</a>; +00126 +00127 <font class="comment">// head of the FIFO</font> +<a name="l00128"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o3">00128</a> uint8 *<a class="code" href="classNLMISC_1_1CBufFIFO.html#o3">_Head</a>; +00129 <font class="comment">// tail of the FIFO</font> +<a name="l00130"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o4">00130</a> uint8 *<a class="code" href="classNLMISC_1_1CBufFIFO.html#o4">_Tail</a>; +00131 <font class="comment">// pointer to the rewinder of the FIFO</font> +<a name="l00132"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o5">00132</a> uint8 *<a class="code" href="classNLMISC_1_1CBufFIFO.html#o5">_Rewinder</a>; +00133 +00134 <font class="comment">// return true if we can put size bytes on the buffer</font> +00135 <font class="comment">// return false if we have to resize</font> +00136 <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1CBufFIFO.html#c0">canFit</a> (uint32 <a class="code" href="classNLMISC_1_1CBufFIFO.html#a14">size</a>); +00137 +00138 +00139 <font class="comment">// statisics of the FIFO</font> +<a name="l00140"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o6">00140</a> uint32 <a class="code" href="classNLMISC_1_1CBufFIFO.html#o6">_BiggestBlock</a>; +<a name="l00141"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o7">00141</a> uint32 <a class="code" href="classNLMISC_1_1CBufFIFO.html#o7">_SmallestBlock</a>; +<a name="l00142"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o8">00142</a> uint32 <a class="code" href="classNLMISC_1_1CBufFIFO.html#o8">_BiggestBuffer</a>; +<a name="l00143"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o9">00143</a> uint32 <a class="code" href="classNLMISC_1_1CBufFIFO.html#o9">_SmallestBuffer</a>; +<a name="l00144"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o10">00144</a> uint32 <a class="code" href="classNLMISC_1_1CBufFIFO.html#o10">_Pushed</a> ; +<a name="l00145"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o11">00145</a> uint32 <a class="code" href="classNLMISC_1_1CBufFIFO.html#o11">_Fronted</a>; +<a name="l00146"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o12">00146</a> uint32 <a class="code" href="classNLMISC_1_1CBufFIFO.html#o12">_Resized</a>; +<a name="l00147"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o13">00147</a> <a class="code" href="namespaceNLMISC.html#a184">TTicks</a> <a class="code" href="classNLMISC_1_1CBufFIFO.html#o13">_PushedTime</a>; +<a name="l00148"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o14">00148</a> <a class="code" href="namespaceNLMISC.html#a184">TTicks</a> <a class="code" href="classNLMISC_1_1CBufFIFO.html#o14">_FrontedTime</a>; +<a name="l00149"></a><a class="code" href="classNLMISC_1_1CBufFIFO.html#o15">00149</a> <a class="code" href="namespaceNLMISC.html#a184">TTicks</a> <a class="code" href="classNLMISC_1_1CBufFIFO.html#o15">_ResizedTime</a>; +00150 }; +00151 +00152 +00153 } <font class="comment">// NLMISC</font> +00154 +00155 +00156 <font class="preprocessor">#endif // NL_BUF_FIFO_H</font> +00157 <font class="preprocessor"></font> +00158 <font class="comment">/* End of buf_fifo.h */</font> +</pre></div> + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |