<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Apache Portable Runtime Utility Library: Thread Safe FIFO bounded queue</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.5.4 -->
<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>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<h1>Thread Safe FIFO bounded queue<br>
<small>
[<a class="el" href="group___a_p_r___util.html">APR Utility Functions</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef struct <a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#g9c8c5ec3d8779a6c2ffffb8b74f784c7">apr_queue_create</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> **queue, unsigned int queue_capacity, apr_pool_t *a)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#g220fffb8eb2f23aa2fe626b64076df88">apr_queue_push</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> *queue, void *data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#g302387f5afb71d3c771b76448088bd34">apr_queue_pop</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> *queue, void **data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#gba8216476d7e5abc3a5ec8a47adf96d5">apr_queue_trypush</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> *queue, void *data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#g128207222433384f286f61ec806f4af8">apr_queue_trypop</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> *queue, void **data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#gf342a2e2ec195a30d6d8c9d95fbfbc30">apr_queue_size</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> *queue)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#g8757c7f87105e6ff4cf1ea5ac28dd26f">apr_queue_interrupt_all</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> *queue)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">apr_status_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#gbb8115bceb96a41df3e21544ce79bc68">apr_queue_term</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> *queue)</td></tr>
</table>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="g8c74c22abf47b63555a2109b06f83abb"></a><!-- doxytag: member="apr_queue.h::apr_queue_t" ref="g8c74c22abf47b63555a2109b06f83abb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> <a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
opaque structure
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g9c8c5ec3d8779a6c2ffffb8b74f784c7"></a><!-- doxytag: member="apr_queue.h::apr_queue_create" ref="g9c8c5ec3d8779a6c2ffffb8b74f784c7" args="(apr_queue_t **queue, unsigned int queue_capacity, apr_pool_t *a)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_status_t apr_queue_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> ** </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>queue_capacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t * </td>
<td class="paramname"> <em>a</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
create a FIFO queue <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em> </td><td>The new queue </td></tr>
<tr><td valign="top"></td><td valign="top"><em>queue_capacity</em> </td><td>maximum size of the queue </td></tr>
<tr><td valign="top"></td><td valign="top"><em>a</em> </td><td>pool to allocate queue from </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g8757c7f87105e6ff4cf1ea5ac28dd26f"></a><!-- doxytag: member="apr_queue.h::apr_queue_interrupt_all" ref="g8757c7f87105e6ff4cf1ea5ac28dd26f" args="(apr_queue_t *queue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_status_t apr_queue_interrupt_all </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> * </td>
<td class="paramname"> <em>queue</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
interrupt all the threads blocking on this queue.<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>queue</em> </td><td>the queue </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g302387f5afb71d3c771b76448088bd34"></a><!-- doxytag: member="apr_queue.h::apr_queue_pop" ref="g302387f5afb71d3c771b76448088bd34" args="(apr_queue_t *queue, void **data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_status_t apr_queue_pop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void ** </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
pop/get an object from the queue, blocking if the queue is already empty<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>queue</em> </td><td>the queue </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the data </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>APR_EINTR the blocking was interrupted (try again) <p>
APR_EOF if the queue has been terminated <p>
APR_SUCCESS on a successfull pop </dd></dl>
</div>
</div><p>
<a class="anchor" name="g220fffb8eb2f23aa2fe626b64076df88"></a><!-- doxytag: member="apr_queue.h::apr_queue_push" ref="g220fffb8eb2f23aa2fe626b64076df88" args="(apr_queue_t *queue, void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_status_t apr_queue_push </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
push/add a object to the queue, blocking if the queue is already full<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>queue</em> </td><td>the queue </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the data </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>APR_EINTR the blocking was interrupted (try again) <p>
APR_EOF the queue has been terminated <p>
APR_SUCCESS on a successfull push </dd></dl>
</div>
</div><p>
<a class="anchor" name="gf342a2e2ec195a30d6d8c9d95fbfbc30"></a><!-- doxytag: member="apr_queue.h::apr_queue_size" ref="gf342a2e2ec195a30d6d8c9d95fbfbc30" args="(apr_queue_t *queue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int apr_queue_size </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> * </td>
<td class="paramname"> <em>queue</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
returns the size of the queue.<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>this is not threadsafe, and is intended for reporting/monitoring of the queue. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>queue</em> </td><td>the queue </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the size of the queue </dd></dl>
</div>
</div><p>
<a class="anchor" name="gbb8115bceb96a41df3e21544ce79bc68"></a><!-- doxytag: member="apr_queue.h::apr_queue_term" ref="gbb8115bceb96a41df3e21544ce79bc68" args="(apr_queue_t *queue)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_status_t apr_queue_term </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> * </td>
<td class="paramname"> <em>queue</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
terminate all queue, sendinging a interupt to all the blocking threads<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>queue</em> </td><td>the queue </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g128207222433384f286f61ec806f4af8"></a><!-- doxytag: member="apr_queue.h::apr_queue_trypop" ref="g128207222433384f286f61ec806f4af8" args="(apr_queue_t *queue, void **data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_status_t apr_queue_trypop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void ** </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
pop/get an object to the queue, returning immediatly if the queue is empty<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>queue</em> </td><td>the queue </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the data </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>APR_EINTR the blocking operation was interrupted (try again) <p>
APR_EAGAIN the queue is empty <p>
APR_EOF the queue has been terminated <p>
APR_SUCCESS on a successfull push </dd></dl>
</div>
</div><p>
<a class="anchor" name="gba8216476d7e5abc3a5ec8a47adf96d5"></a><!-- doxytag: member="apr_queue.h::apr_queue_trypush" ref="gba8216476d7e5abc3a5ec8a47adf96d5" args="(apr_queue_t *queue, void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_status_t apr_queue_trypush </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#g8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> * </td>
<td class="paramname"> <em>queue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
push/add a object to the queue, returning immediatly if the queue is full<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>queue</em> </td><td>the queue </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>the data </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>APR_EINTR the blocking operation was interrupted (try again) <p>
APR_EAGAIN the queue is full <p>
APR_EOF the queue has been terminated <p>
APR_SUCCESS on a successfull push </dd></dl>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 24 02:22:55 2008 for Apache Portable Runtime Utility Library by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
bdcd72668be70f58bf0aa7c2102b0734
>
files
>
131
