<!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++: ost::ThreadQueue Class Reference</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 id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><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="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_thread_queue.html">ThreadQueue</a></div>
<h1>ost::ThreadQueue Class Reference</h1><!-- doxytag: class="ost::ThreadQueue" --><!-- doxytag: inherits="ost::Mutex,ost::Thread,ost::Semaphore" -->Somewhat generic queue processing class to establish a producer consumer queue.in memory data queue interface.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="buffer_8h-source.html">buffer.h</a>></code>
<p>
<p>Inheritance diagram for ost::ThreadQueue:
<p><center><img src="classost_1_1_thread_queue.png" usemap="#ost::ThreadQueue_map" border="0" alt=""></center>
<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>
<a href="classost_1_1_thread_queue-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#a604895a1e9884e8a33d71542eab5fac">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="#a604895a1e9884e8a33d71542eab5fac"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#a10c32ac8c488de2b7640b8e109aea75">~ThreadQueue</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the queue. <a href="#a10c32ac8c488de2b7640b8e109aea75"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#ec4bca4a2933cd3063f76ac325774c35">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="#ec4bca4a2933cd3063f76ac325774c35"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#2687b56a3be47b5e9739737dcecd6c9d">startQueue</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start of dequeing. <a href="#2687b56a3be47b5e9739737dcecd6c9d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#573ca3660b00d14f79fe70773cd2d668">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="#573ca3660b00d14f79fe70773cd2d668"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#e26b60d8e9a3b130a89bee13aae7069e">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="#e26b60d8e9a3b130a89bee13aae7069e"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_thread_queue.html#a3b975cb871cee2c8fc552117e8d4767">name</a></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>_data</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Somewhat generic queue processing class to establish a producer consumer queue.in memory data queue interface.
<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">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>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a604895a1e9884e8a33d71542eab5fac"></a><!-- doxytag: member="ost::ThreadQueue::ThreadQueue" ref="a604895a1e9884e8a33d71542eab5fac" args="(const char *id, int pri, size_t stack=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::ThreadQueue::ThreadQueue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const char * </td>
<td class="mdname" nowrap> <em>id</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>pri</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>stack</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create instance of our queue and give it a process priority.
<p>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="a10c32ac8c488de2b7640b8e109aea75"></a><!-- doxytag: member="ost::ThreadQueue::~ThreadQueue" ref="a10c32ac8c488de2b7640b8e109aea75" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::ThreadQueue::~ThreadQueue </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destroy the queue.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ec4bca4a2933cd3063f76ac325774c35"></a><!-- doxytag: member="ost::ThreadQueue::post" ref="ec4bca4a2933cd3063f76ac325774c35" args="(const void *data, unsigned len)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::ThreadQueue::post </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const void * </td>
<td class="mdname" nowrap> <em>data</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>unsigned </td>
<td class="mdname" nowrap> <em>len</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Put some unspecified data into this queue.
<p>
A new qd structure is created and sized to contain a copy of the actual content.<p>
<dl compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="e26b60d8e9a3b130a89bee13aae7069e"></a><!-- doxytag: member="ost::ThreadQueue::runQueue" ref="e26b60d8e9a3b130a89bee13aae7069e" args="(void *data)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::ThreadQueue::runQueue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void * </td>
<td class="mdname1" valign="top" nowrap> <em>data</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Virtual callback method to handle processing of a queued data items.
<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 compact><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>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="2687b56a3be47b5e9739737dcecd6c9d"></a><!-- doxytag: member="ost::ThreadQueue::startQueue" ref="2687b56a3be47b5e9739737dcecd6c9d" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::ThreadQueue::startQueue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Start of dequeing.
<p>
Maybe we need to connect a database or something, so we have a virtual... </td>
</tr>
</table>
<a class="anchor" name="573ca3660b00d14f79fe70773cd2d668"></a><!-- doxytag: member="ost::ThreadQueue::stopQueue" ref="573ca3660b00d14f79fe70773cd2d668" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::ThreadQueue::stopQueue </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
End of dequeing, we expect the queue is empty for now.
<p>
Maybe we need to disconnect a database or something, so we have another virtual. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="a3b975cb871cee2c8fc552117e8d4767"></a><!-- doxytag: member="ost::ThreadQueue::name" ref="a3b975cb871cee2c8fc552117e8d4767" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">const char* <a class="el" href="classost_1_1_thread_queue.html#a3b975cb871cee2c8fc552117e8d4767">ost::ThreadQueue::name</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:56 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>
