<!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>GNU CommonC++: ost::ThreadQueue Class Reference</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.3 -->
<div class="navigation" id="top">
<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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_thread_queue.html">ThreadQueue</a>
</div>
</div>
<div class="contents">
<h1>ost::ThreadQueue Class Reference</h1><!-- doxytag: class="ost::ThreadQueue" --><!-- doxytag: inherits="ost::Mutex,ost::Thread,ost::Semaphore" -->
<p>Somewhat generic queue processing class to establish a producer consumer queue.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="buffer_8h_source.html">buffer.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::ThreadQueue:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_thread_queue.png" usemap="#ost::ThreadQueue_map" alt=""/>
<map id="ost::ThreadQueue_map" name="ost::ThreadQueue_map">
<area href="classost_1_1_mutex.html" alt="ost::Mutex" shape="rect" coords="0,0,112,24"/>
<area href="classost_1_1_thread.html" alt="ost::Thread" shape="rect" coords="122,0,234,24"/>
<area href="classost_1_1_semaphore.html" alt="ost::Semaphore" shape="rect" coords="244,0,356,24"/>
</map>
</div>
</div>
<p><a href="classost_1_1_thread_queue-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structost_1_1_thread_queue_1_1__data.html">_data</a></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#aa604895a1e9884e8a33d71542eab5fac">ThreadQueue</a> (const char *id, int pri, size_t stack=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create instance of our queue and give it a process priority. <a href="#aa604895a1e9884e8a33d71542eab5fac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#a8843f32e3bb271998fab06a6acabf256">~ThreadQueue</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the queue. <a href="#a8843f32e3bb271998fab06a6acabf256"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#a0813a4dc595164bc7216636503dd43c7">setTimer</a> (<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_thread_queue.html#adaf42df577b955fcea0dad9dd8a61202">timeout</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the queue timeout. <a href="#a0813a4dc595164bc7216636503dd43c7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#aec4bca4a2933cd3063f76ac325774c35">post</a> (const void *data, unsigned len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put some unspecified data into this queue. <a href="#aec4bca4a2933cd3063f76ac325774c35"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structost_1_1_thread_queue_1_1__data.html">ost::ThreadQueue::_data</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#adec9ed056f1e8400a50483ad5ee21437">data_t</a></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#a73e81c6abad4dd4758ea95171f67a42b">final</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#a2687b56a3be47b5e9739737dcecd6c9d">startQueue</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start of dequeing. <a href="#a2687b56a3be47b5e9739737dcecd6c9d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#a573ca3660b00d14f79fe70773cd2d668">stopQueue</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">End of dequeing, we expect the queue is empty for now. <a href="#a573ca3660b00d14f79fe70773cd2d668"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#a3699f0fc2d626367c17afd8e411943d3">onTimer</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A derivable method to call when the timout is expired. <a href="#a3699f0fc2d626367c17afd8e411943d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#ae26b60d8e9a3b130a89bee13aae7069e">runQueue</a> (void *data)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual callback method to handle processing of a queued data items. <a href="#ae26b60d8e9a3b130a89bee13aae7069e"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#adaf42df577b955fcea0dad9dd8a61202">timeout</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#a3202a4e136cd5e9b257b393a9984f3cd">started</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structost_1_1_thread_queue_1_1__data.html">data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#aa36470ebc7660a7abe9bbcd85ec221aa">first</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structost_1_1_thread_queue_1_1__data.html">data_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#a5d34d11fd2535869d62c2c505e35f0a4">last</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_string.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#a1737937abcd8b410758d47d18b651e40">name</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Somewhat generic queue processing class to establish a producer consumer queue. </p>
<p>This may be used to buffer cdr records, or for other purposes where an in-memory queue is needed for rapid posting. This class is derived from <a class="el" href="classost_1_1_mutex.html" title="The Mutex class is used to protect a section of code so that at any given time only...">Mutex</a> and maintains a linked list. A thread is used to dequeue data and pass it to a callback method that is used in place of "run" for each item present on the queue. The conditional is used to signal the run thread when new data is posted.</p>
<p>This class was changed by Angelo Naselli to have a timeout on the queue</p>
<p>in memory data queue interface. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<hr/><h2>Member Typedef Documentation</h2>
<a class="anchor" id="adec9ed056f1e8400a50483ad5ee21437"></a><!-- doxytag: member="ost::ThreadQueue::data_t" ref="adec9ed056f1e8400a50483ad5ee21437" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structost_1_1_thread_queue_1_1__data.html">ost::ThreadQueue::_data</a> <a class="el" href="structost_1_1_thread_queue_1_1__data.html">ost::ThreadQueue::data_t</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa604895a1e9884e8a33d71542eab5fac"></a><!-- doxytag: member="ost::ThreadQueue::ThreadQueue" ref="aa604895a1e9884e8a33d71542eab5fac" args="(const char *id, int pri, size_t stack=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::ThreadQueue::ThreadQueue </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>pri</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>stack</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create instance of our queue and give it a process priority. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>queue ID. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pri</em> </td><td>process priority. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>stack</em> </td><td>stack size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8843f32e3bb271998fab06a6acabf256"></a><!-- doxytag: member="ost::ThreadQueue::~ThreadQueue" ref="a8843f32e3bb271998fab06a6acabf256" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::ThreadQueue::~ThreadQueue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy the queue. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a73e81c6abad4dd4758ea95171f67a42b"></a><!-- doxytag: member="ost::ThreadQueue::final" ref="a73e81c6abad4dd4758ea95171f67a42b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::ThreadQueue::final </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_thread.html#a6fb521eb3d23c51925472a3fe0abf327">ost::Thread</a>.</p>
</div>
</div>
<a class="anchor" id="a3699f0fc2d626367c17afd8e411943d3"></a><!-- doxytag: member="ost::ThreadQueue::onTimer" ref="a3699f0fc2d626367c17afd8e411943d3" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::ThreadQueue::onTimer </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A derivable method to call when the timout is expired. </p>
</div>
</div>
<a class="anchor" id="aec4bca4a2933cd3063f76ac325774c35"></a><!-- doxytag: member="ost::ThreadQueue::post" ref="aec4bca4a2933cd3063f76ac325774c35" args="(const void *data, unsigned len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::ThreadQueue::post </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Put some unspecified data into this queue. </p>
<p>A new qd structure is created and sized to contain a copy of the actual content.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>pointer to data. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>size of data. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae26b60d8e9a3b130a89bee13aae7069e"></a><!-- doxytag: member="ost::ThreadQueue::runQueue" ref="ae26b60d8e9a3b130a89bee13aae7069e" args="(void *data)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::ThreadQueue::runQueue </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em></td>
<td> ) </td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Virtual callback method to handle processing of a queued data items. </p>
<p>After the item is processed, it is deleted from memory. We can call multiple instances of runQueue in order if multiple items are waiting.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>item being dequed. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0813a4dc595164bc7216636503dd43c7"></a><!-- doxytag: member="ost::ThreadQueue::setTimer" ref="a0813a4dc595164bc7216636503dd43c7" args="(timeout_t timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ost::ThreadQueue::setTimer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>timeout</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the queue timeout. </p>
<p>When the timer expires, the <a class="el" href="classost_1_1_thread_queue.html#a3699f0fc2d626367c17afd8e411943d3" title="A derivable method to call when the timout is expired.">onTimer()</a> method is called for the thread</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>timeout in milliseconds. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2687b56a3be47b5e9739737dcecd6c9d"></a><!-- doxytag: member="ost::ThreadQueue::startQueue" ref="a2687b56a3be47b5e9739737dcecd6c9d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::ThreadQueue::startQueue </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Start of dequeing. </p>
<p>Maybe we need to connect a database or something, so we have a virtual... </p>
</div>
</div>
<a class="anchor" id="a573ca3660b00d14f79fe70773cd2d668"></a><!-- doxytag: member="ost::ThreadQueue::stopQueue" ref="a573ca3660b00d14f79fe70773cd2d668" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ost::ThreadQueue::stopQueue </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>End of dequeing, we expect the queue is empty for now. </p>
<p>Maybe we need to disconnect a database or something, so we have another virtual. </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="aa36470ebc7660a7abe9bbcd85ec221aa"></a><!-- doxytag: member="ost::ThreadQueue::first" ref="aa36470ebc7660a7abe9bbcd85ec221aa" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structost_1_1_thread_queue_1_1__data.html">data_t</a>* <a class="el" href="classost_1_1_thread_queue.html#aa36470ebc7660a7abe9bbcd85ec221aa">ost::ThreadQueue::first</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a5d34d11fd2535869d62c2c505e35f0a4"></a><!-- doxytag: member="ost::ThreadQueue::last" ref="a5d34d11fd2535869d62c2c505e35f0a4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structost_1_1_thread_queue_1_1__data.html">data_t</a> * <a class="el" href="classost_1_1_thread_queue.html#a5d34d11fd2535869d62c2c505e35f0a4">ost::ThreadQueue::last</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1737937abcd8b410758d47d18b651e40"></a><!-- doxytag: member="ost::ThreadQueue::name" ref="a1737937abcd8b410758d47d18b651e40" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_string.html">String</a> <a class="el" href="classost_1_1_thread_queue.html#a1737937abcd8b410758d47d18b651e40">ost::ThreadQueue::name</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a3202a4e136cd5e9b257b393a9984f3cd"></a><!-- doxytag: member="ost::ThreadQueue::started" ref="a3202a4e136cd5e9b257b393a9984f3cd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classost_1_1_thread_queue.html#a3202a4e136cd5e9b257b393a9984f3cd">ost::ThreadQueue::started</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="adaf42df577b955fcea0dad9dd8a61202"></a><!-- doxytag: member="ost::ThreadQueue::timeout" ref="adaf42df577b955fcea0dad9dd8a61202" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> <a class="el" href="classost_1_1_thread_queue.html#adaf42df577b955fcea0dad9dd8a61202">ost::ThreadQueue::timeout</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="buffer_8h_source.html">buffer.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:46 2010 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
ed376d6842ea322c25405e7c23b3bc12
>
files
>
402
