<!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>GNU CommonC++: buffer.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.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul></div>
<h1>buffer.h</h1><a href="buffer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Copyright (C) 1999-2005 Open Source Telecom Corporation.</span>
<a name="l00002"></a>00002 <span class="comment">// </span>
<a name="l00003"></a>00003 <span class="comment">// This program is free software; you can redistribute it and/or modify</span>
<a name="l00004"></a>00004 <span class="comment">// it under the terms of the GNU General Public License as published by</span>
<a name="l00005"></a>00005 <span class="comment">// the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00006"></a>00006 <span class="comment">// (at your option) any later version.</span>
<a name="l00007"></a>00007 <span class="comment">// </span>
<a name="l00008"></a>00008 <span class="comment">// This program is distributed in the hope that it will be useful,</span>
<a name="l00009"></a>00009 <span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00010"></a>00010 <span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00011"></a>00011 <span class="comment">// GNU General Public License for more details.</span>
<a name="l00012"></a>00012 <span class="comment">// </span>
<a name="l00013"></a>00013 <span class="comment">// You should have received a copy of the GNU General Public License</span>
<a name="l00014"></a>00014 <span class="comment">// along with this program; if not, write to the Free Software </span>
<a name="l00015"></a>00015 <span class="comment">// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</span>
<a name="l00016"></a>00016 <span class="comment">// </span>
<a name="l00017"></a>00017 <span class="comment">// As a special exception, you may use this file as part of a free software</span>
<a name="l00018"></a>00018 <span class="comment">// library without restriction. Specifically, if other files instantiate</span>
<a name="l00019"></a>00019 <span class="comment">// templates or use macros or inline functions from this file, or you compile</span>
<a name="l00020"></a>00020 <span class="comment">// this file and link it with other files to produce an executable, this</span>
<a name="l00021"></a>00021 <span class="comment">// file does not by itself cause the resulting executable to be covered by</span>
<a name="l00022"></a>00022 <span class="comment">// the GNU General Public License. This exception does not however</span>
<a name="l00023"></a>00023 <span class="comment">// invalidate any other reasons why the executable file might be covered by</span>
<a name="l00024"></a>00024 <span class="comment">// the GNU General Public License.</span>
<a name="l00025"></a>00025 <span class="comment">//</span>
<a name="l00026"></a>00026 <span class="comment">// This exception applies only to the code released under the name GNU</span>
<a name="l00027"></a>00027 <span class="comment">// Common C++. If you copy code from other releases into a copy of GNU </span>
<a name="l00028"></a>00028 <span class="comment">// Common C++, as the General Public License permits, the exception does</span>
<a name="l00029"></a>00029 <span class="comment">// not apply to the code that you add in this way. To avoid misleading</span>
<a name="l00030"></a>00030 <span class="comment">// anyone as to the status of such modified files, you must delete</span>
<a name="l00031"></a>00031 <span class="comment">// this exception notice from them.</span>
<a name="l00032"></a>00032 <span class="comment">//</span>
<a name="l00033"></a>00033 <span class="comment">// If you write modifications of your own for GNU Common C++, it is your choice</span>
<a name="l00034"></a>00034 <span class="comment">// whether to permit this exception to apply to your modifications.</span>
<a name="l00035"></a>00035 <span class="comment">// If you do not wish that, delete this exception notice.</span>
<a name="l00036"></a>00036 <span class="comment">//</span>
<a name="l00037"></a>00037
<a name="l00043"></a>00043 <span class="preprocessor">#ifndef CCXX_BUFFER_H_</span>
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#define CCXX_BUFFER_H_</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span>
<a name="l00046"></a>00046 <span class="preprocessor">#ifndef CCXX_THREAD_H_</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#include <<a class="code" href="thread_8h.html">cc++/thread.h</a>></span>
<a name="l00048"></a>00048 <span class="preprocessor">#endif</span>
<a name="l00049"></a>00049 <span class="preprocessor"></span>
<a name="l00050"></a>00050 <span class="preprocessor">#ifdef CCXX_NAMESPACES</span>
<a name="l00051"></a>00051 <span class="preprocessor"></span><span class="keyword">namespace </span>ost {
<a name="l00052"></a>00052 <span class="preprocessor">#endif</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span>
<a name="l00075"></a>00075 <span class="preprocessor">#ifdef WIN32</span>
<a name="l00076"></a>00076 <span class="preprocessor"></span><span class="keyword">class </span><a class="code" href="config_8h.html#d10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> Buffer : <span class="keyword">public</span> Mutex
<a name="l00077"></a>00077 #else
<a name="l00078"></a><a class="code" href="classost_1_1_buffer.html">00078</a> class <a class="code" href="config_8h.html#d10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> Buffer : <span class="keyword">public</span> <a class="code" href="classost_1_1_conditional.html">Conditional</a>
<a name="l00079"></a>00079 #endif
<a name="l00080"></a>00080 {
<a name="l00081"></a>00081 <span class="keyword">private</span>:
<a name="l00082"></a>00082 <span class="preprocessor">#ifdef WIN32</span>
<a name="l00083"></a>00083 <span class="preprocessor"></span> <a class="code" href="serial_8h.html#069bb8cb95b0528d5ce0304bb5561a40">HANDLE</a> sem_head, sem_tail;
<a name="l00084"></a>00084 <span class="preprocessor">#endif</span>
<a name="l00085"></a>00085 <span class="preprocessor"></span> size_t _size;
<a name="l00086"></a>00086 size_t _used;
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keyword">protected</span>:
<a name="l00094"></a>00094 <span class="keyword">virtual</span> size_t onPeek(<span class="keywordtype">void</span> *buf) = 0;
<a name="l00095"></a>00095
<a name="l00101"></a>00101 <span class="keyword">virtual</span> size_t onWait(<span class="keywordtype">void</span> *buf) = 0;
<a name="l00102"></a>00102
<a name="l00108"></a>00108 <span class="keyword">virtual</span> size_t onPost(<span class="keywordtype">void</span> *buf) = 0;
<a name="l00109"></a>00109
<a name="l00110"></a>00110 <span class="keyword">public</span>:
<a name="l00115"></a><a class="code" href="classost_1_1_buffer.html#e416c78e4d5dc50bfa3c4e0b98fd7a98">00115</a> <span class="keyword">static</span> <span class="keyword">const</span> size_t timeout;
<a name="l00116"></a>00116
<a name="l00121"></a>00121 Buffer(size_t capacity);
<a name="l00126"></a>00126 <span class="keyword">virtual</span> ~Buffer();
<a name="l00127"></a>00127
<a name="l00132"></a><a class="code" href="classost_1_1_buffer.html#edd8b294e02c08a60bde023bd2c1ff47">00132</a> <span class="keyword">inline</span> size_t getSize(<span class="keywordtype">void</span>)
<a name="l00133"></a>00133 {<span class="keywordflow">return</span> _size;};
<a name="l00134"></a>00134
<a name="l00141"></a><a class="code" href="classost_1_1_buffer.html#462525b42df6660894ccf8141d73071e">00141</a> <span class="keyword">inline</span> size_t getUsed(<span class="keywordtype">void</span>)
<a name="l00142"></a>00142 {<span class="keywordflow">return</span> _used;};
<a name="l00143"></a>00143
<a name="l00153"></a>00153 size_t <a class="code" href="namespaceost.html#24c7774639b3768bdd45b65a296f6369">wait</a>(<span class="keywordtype">void</span> *buf, <a class="code" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout = 0);
<a name="l00154"></a>00154
<a name="l00163"></a>00163 size_t post(<span class="keywordtype">void</span> *buf, <a class="code" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout = 0);
<a name="l00164"></a>00164
<a name="l00171"></a>00171 size_t peek(<span class="keywordtype">void</span> *buf);
<a name="l00172"></a>00172
<a name="l00177"></a>00177 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isValid(<span class="keywordtype">void</span>);
<a name="l00178"></a>00178 };
<a name="l00179"></a>00179
<a name="l00187"></a><a class="code" href="classost_1_1_fixed_buffer.html">00187</a> <span class="keyword">class </span><a class="code" href="config_8h.html#d10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> FixedBuffer : <span class="keyword">public</span> Buffer
<a name="l00188"></a>00188 {
<a name="l00189"></a>00189 <span class="keyword">private</span>:
<a name="l00190"></a>00190 <span class="keywordtype">char</span> *buf, *head, *tail;
<a name="l00191"></a>00191 size_t objsize;
<a name="l00192"></a>00192
<a name="l00193"></a>00193 <span class="keyword">protected</span>:
<a name="l00199"></a>00199 size_t onPeek(<span class="keywordtype">void</span> *buf);
<a name="l00200"></a>00200
<a name="l00206"></a>00206 size_t onWait(<span class="keywordtype">void</span> *buf);
<a name="l00207"></a>00207
<a name="l00213"></a>00213 size_t onPost(<span class="keywordtype">void</span> *buf);
<a name="l00214"></a>00214
<a name="l00215"></a>00215 <span class="keyword">public</span>:
<a name="l00223"></a>00223 FixedBuffer(size_t capacity, size_t objsize);
<a name="l00224"></a>00224
<a name="l00231"></a>00231 FixedBuffer(<span class="keyword">const</span> FixedBuffer &fb);
<a name="l00232"></a>00232
<a name="l00236"></a>00236 <span class="keyword">virtual</span> ~FixedBuffer();
<a name="l00237"></a>00237
<a name="l00238"></a>00238 FixedBuffer &operator=(<span class="keyword">const</span> FixedBuffer &fb);
<a name="l00239"></a>00239
<a name="l00240"></a>00240 <span class="keywordtype">bool</span> isValid(<span class="keywordtype">void</span>);
<a name="l00241"></a>00241 };
<a name="l00242"></a>00242
<a name="l00256"></a><a class="code" href="classost_1_1_thread_queue.html">00256</a> <span class="keyword">class </span><a class="code" href="config_8h.html#d10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> ThreadQueue : <span class="keyword">public</span> <a class="code" href="classost_1_1_mutex.html">Mutex</a>, <span class="keyword">public</span> <a class="code" href="classost_1_1_thread.html">Thread</a>, <span class="keyword">public</span> <a class="code" href="classost_1_1_semaphore.html">Semaphore</a>
<a name="l00257"></a>00257 {
<a name="l00258"></a>00258 <span class="keyword">private</span>:
<a name="l00259"></a>00259 <span class="keyword">typedef</span> <span class="keyword">struct </span>_data
<a name="l00260"></a>00260 {
<a name="l00261"></a>00261 <span class="keyword">struct </span>_data *next;
<a name="l00262"></a>00262 <span class="keywordtype">unsigned</span> len;
<a name="l00263"></a>00263 <span class="keywordtype">char</span> data[1];
<a name="l00264"></a>00264 } data_t;
<a name="l00265"></a>00265
<a name="l00266"></a>00266 <span class="keywordtype">bool</span> started;
<a name="l00267"></a>00267
<a name="l00268"></a>00268 data_t *first, *last; <span class="comment">// head/tail of list</span>
<a name="l00269"></a>00269
<a name="l00270"></a>00270 <span class="keywordtype">void</span> run(<span class="keywordtype">void</span>); <span class="comment">// private run method</span>
<a name="l00271"></a>00271
<a name="l00272"></a>00272 <span class="keyword">protected</span>:
<a name="l00273"></a><a class="code" href="classost_1_1_thread_queue.html#a3b975cb871cee2c8fc552117e8d4767">00273</a> <span class="keyword">const</span> <span class="keywordtype">char</span> *name; <span class="comment">// used for save/restore file</span>
<a name="l00274"></a>00274
<a name="l00279"></a>00279 <span class="keyword">virtual</span> <span class="keywordtype">void</span> startQueue(<span class="keywordtype">void</span>);
<a name="l00280"></a>00280
<a name="l00286"></a>00286 <span class="keyword">virtual</span> <span class="keywordtype">void</span> stopQueue(<span class="keywordtype">void</span>);
<a name="l00287"></a>00287
<a name="l00296"></a>00296 <span class="keyword">virtual</span> <span class="keywordtype">void</span> runQueue(<span class="keywordtype">void</span> *data) = 0;
<a name="l00297"></a>00297
<a name="l00298"></a>00298 <span class="keyword">public</span>:
<a name="l00306"></a>00306 ThreadQueue(<span class="keyword">const</span> <span class="keywordtype">char</span> *<span class="keywordtype">id</span>, <span class="keywordtype">int</span> pri, size_t stack = 0);
<a name="l00307"></a>00307
<a name="l00311"></a>00311 ~ThreadQueue();
<a name="l00312"></a>00312
<a name="l00321"></a>00321 <span class="keywordtype">void</span> post(<span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">unsigned</span> len);
<a name="l00322"></a>00322 };
<a name="l00323"></a>00323
<a name="l00324"></a>00324
<a name="l00326"></a><a class="code" href="classost_1_1_buffer.html#be2397b9087bd1651ee67ed5702c01dd">00326</a> <span class="keyword">inline</span> size_t get(Buffer &b, <span class="keywordtype">void</span> *o, <a class="code" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> t = 0)
<a name="l00327"></a>00327 {<span class="keywordflow">return</span> b.<a class="code" href="classost_1_1_buffer.html#5f67183f492fe6600456d919ed811fac">wait</a>(o, t);}
<a name="l00328"></a>00328
<a name="l00330"></a><a class="code" href="classost_1_1_buffer.html#1dc4ad52b6f17817e4afa981d1db6fae">00330</a> <span class="keyword">inline</span> size_t put(Buffer &b, <span class="keywordtype">void</span> *o, <a class="code" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> t = 0)
<a name="l00331"></a>00331 {<span class="keywordflow">return</span> b.<a class="code" href="classost_1_1_buffer.html#9d106bd44d9bee8d9ef049cfa264e5b7">post</a>(o, t);}
<a name="l00332"></a>00332
<a name="l00334"></a><a class="code" href="classost_1_1_buffer.html#2066fdf67ab3b6727be90a51fc5c4d64">00334</a> <span class="keyword">inline</span> size_t peek(Buffer &b, <span class="keywordtype">void</span> *o)
<a name="l00335"></a>00335 {<span class="keywordflow">return</span> b.<a class="code" href="classost_1_1_buffer.html#e613b6a13146b782ce5749b810cceba8">peek</a>(o);}
<a name="l00336"></a>00336
<a name="l00337"></a>00337
<a name="l00338"></a>00338 <span class="preprocessor">#ifdef CCXX_NAMESPACES</span>
<a name="l00339"></a>00339 <span class="preprocessor"></span>}
<a name="l00340"></a>00340 <span class="preprocessor">#endif</span>
<a name="l00341"></a>00341 <span class="preprocessor"></span>
<a name="l00342"></a>00342 <span class="preprocessor">#endif</span>
<a name="l00343"></a>00343 <span class="preprocessor"></span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:55 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
