<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>Barry: dataqueue.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_65781e9408669bb8d7d9c025fdb5fe86.html">src</a>
</div>
</div>
<div class="contents">
<h1>dataqueue.h</h1><a href="dataqueue_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"></span><span class="comment">/// \file dataqueue.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// FIFO queue of Data objects</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2007-2010, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_DATAQUEUE_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_DATAQUEUE_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include <queue></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <pthread.h></span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">namespace </span>Barry {
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keyword">class </span>Data;
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="comment">//</span>
<a name="l00033"></a>00033 <span class="comment">// DataQueue class</span>
<a name="l00034"></a>00034 <span class="comment">//</span><span class="comment"></span>
<a name="l00035"></a>00035 <span class="comment">/// This class provides a thread aware fifo queue for Data objects,</span>
<a name="l00036"></a>00036 <span class="comment">/// providing memory management for all Data object pointers it contains.</span>
<a name="l00037"></a>00037 <span class="comment">///</span>
<a name="l00038"></a>00038 <span class="comment">/// It uses similar member names as std::queue<>, for consistency.</span>
<a name="l00039"></a>00039 <span class="comment">///</span>
<a name="l00040"></a><a class="code" href="classBarry_1_1DataQueue.html">00040</a> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classBarry_1_1DataQueue.html" title="This class provides a thread aware fifo queue for Data objects, providing memory...">DataQueue</a>
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 <span class="keyword">typedef</span> std::queue<Data*> queue_type;
<a name="l00043"></a>00043
<a name="l00044"></a>00044 pthread_mutex_t m_waitMutex;
<a name="l00045"></a>00045 pthread_cond_t m_waitCond;
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">mutable</span> pthread_mutex_t m_accessMutex; <span class="comment">// locked for each access of m_queue</span>
<a name="l00048"></a>00048
<a name="l00049"></a>00049 queue_type m_queue;
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keyword">public</span>:
<a name="l00052"></a>00052 <a class="code" href="classBarry_1_1DataQueue.html" title="This class provides a thread aware fifo queue for Data objects, providing memory...">DataQueue</a>();
<a name="l00053"></a>00053 ~<a class="code" href="classBarry_1_1DataQueue.html" title="This class provides a thread aware fifo queue for Data objects, providing memory...">DataQueue</a>(); <span class="comment">// frees all data in the queue</span>
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="comment">// Pushes data into the end of the queue.</span>
<a name="l00056"></a>00056 <span class="comment">// The queue owns this pointer as soon as the function is</span>
<a name="l00057"></a>00057 <span class="comment">// called. In the case of an exception, it will be freed.</span>
<a name="l00058"></a>00058 <span class="comment">// Performs a thread broadcast once new data has been added.</span>
<a name="l00059"></a>00059 <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1DataQueue.html#aea470a11cbda20dd9af1a92148ecb223" title="Pushes data into the end of the queue.">push</a>(<a class="code" href="classBarry_1_1Data.html">Data</a> *data);
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="comment">// Pops the next element off the front of the queue.</span>
<a name="l00062"></a>00062 <span class="comment">// Returns 0 if empty.</span>
<a name="l00063"></a>00063 <span class="comment">// The queue no longer owns this pointer upon return.</span>
<a name="l00064"></a>00064 <a class="code" href="classBarry_1_1Data.html">Data</a>* <a class="code" href="classBarry_1_1DataQueue.html#ad1f454f70a9b6ec667e0e22a7ddd6eca" title="Pops the next element off the front of the queue.">pop</a>();
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="comment">// Pops the next element off the front of the queue, and</span>
<a name="l00067"></a>00067 <span class="comment">// waits until one exists if empty. If still no data</span>
<a name="l00068"></a>00068 <span class="comment">// on timeout, returns null.</span>
<a name="l00069"></a>00069 <span class="comment">// Timeout specified in milliseconds. Default is wait forever.</span>
<a name="l00070"></a>00070 <a class="code" href="classBarry_1_1Data.html">Data</a>* <a class="code" href="classBarry_1_1DataQueue.html#a27d4830d37b0f7a1bee3a63b0f5a5b2b" title="Pops the next element off the front of the queue, and waits until one exists if empty...">wait_pop</a>(<span class="keywordtype">int</span> timeout = -1);
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="comment">// Pops all data from other and appends it to this.</span>
<a name="l00073"></a>00073 <span class="comment">// After calling this function, other will be empty, and</span>
<a name="l00074"></a>00074 <span class="comment">// this will contain all its data.</span>
<a name="l00075"></a>00075 <span class="comment">// In the case of an exception, any uncopied data will</span>
<a name="l00076"></a>00076 <span class="comment">// remain in other.</span>
<a name="l00077"></a>00077 <span class="keywordtype">void</span> <a class="code" href="classBarry_1_1DataQueue.html#a12a7a82124799a6803b28efd89e1dd05" title="Pops all data from other and appends it to this.">append_from</a>(<a class="code" href="classBarry_1_1DataQueue.html" title="This class provides a thread aware fifo queue for Data objects, providing memory...">DataQueue</a> &other);
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="keywordtype">bool</span> <a class="code" href="classBarry_1_1DataQueue.html#a76cecba41e423f7d20df464cf7524e76" title="Returns true if the queue is empty.">empty</a>() <span class="keyword">const</span>; <span class="comment">// return true if empty</span>
<a name="l00080"></a>00080 <span class="keywordtype">size_t</span> <a class="code" href="classBarry_1_1DataQueue.html#ada0c2fd55a8f221aadbf0b7165043e06" title="Returns number of items in the queue.">size</a>() <span class="keyword">const</span>;
<a name="l00081"></a>00081 };
<a name="l00082"></a>00082
<a name="l00083"></a>00083 } <span class="comment">// namespace Barry</span>
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="preprocessor">#endif</span>
<a name="l00086"></a>00086 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
