<!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>Apache Portable Runtime: Thread Safe FIFO bounded queue</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.7.3 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Apache Portable Runtime</div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</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 id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <h1>Thread Safe FIFO bounded queue</h1> </div> <div class="ingroups"><a class="el" href="group___a_p_r___util.html">APR Utility Functions</a></div></div> <div class="contents"> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a></td></tr> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#ga9c8c5ec3d8779a6c2ffffb8b74f784c7">apr_queue_create</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> **queue, unsigned int queue_capacity, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *a)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#ga220fffb8eb2f23aa2fe626b64076df88">apr_queue_push</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> *queue, void *data)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#ga302387f5afb71d3c771b76448088bd34">apr_queue_pop</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> *queue, void **data)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#gaba8216476d7e5abc3a5ec8a47adf96d5">apr_queue_trypush</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> *queue, void *data)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#ga128207222433384f286f61ec806f4af8">apr_queue_trypop</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> *queue, void **data)</td></tr> <tr><td class="memItemLeft" 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#gaf342a2e2ec195a30d6d8c9d95fbfbc30">apr_queue_size</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> *queue)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8757c7f87105e6ff4cf1ea5ac28dd26f">apr_queue_interrupt_all</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> *queue)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___a_p_r___util___f_i_f_o.html#gabb8115bceb96a41df3e21544ce79bc68">apr_queue_term</a> (<a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> *queue)</td></tr> </table> <hr/><h2>Typedef Documentation</h2> <a class="anchor" id="ga8c74c22abf47b63555a2109b06f83abb"></a><!-- doxytag: member="apr_queue.h::apr_queue_t" ref="ga8c74c22abf47b63555a2109b06f83abb" 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#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> <a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>opaque structure </p> </div> </div> <hr/><h2>Function Documentation</h2> <a class="anchor" id="ga9c8c5ec3d8779a6c2ffffb8b74f784c7"></a><!-- doxytag: member="apr_queue.h::apr_queue_create" ref="ga9c8c5ec3d8779a6c2ffffb8b74f784c7" 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"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_queue_create </td> <td>(</td> <td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">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"><a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> * </td> <td class="paramname"><em>a</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>create a FIFO queue </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">queue</td><td>The new queue </td></tr> <tr><td class="paramname">queue_capacity</td><td>maximum size of the queue </td></tr> <tr><td class="paramname">a</td><td>pool to allocate queue from </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ga8757c7f87105e6ff4cf1ea5ac28dd26f"></a><!-- doxytag: member="apr_queue.h::apr_queue_interrupt_all" ref="ga8757c7f87105e6ff4cf1ea5ac28dd26f" args="(apr_queue_t *queue)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_queue_interrupt_all </td> <td>(</td> <td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> * </td> <td class="paramname"><em>queue</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>interrupt all the threads blocking on this queue.</p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">queue</td><td>the queue </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ga302387f5afb71d3c771b76448088bd34"></a><!-- doxytag: member="apr_queue.h::apr_queue_pop" ref="ga302387f5afb71d3c771b76448088bd34" args="(apr_queue_t *queue, void **data)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_queue_pop </td> <td>(</td> <td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">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> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>pop/get an object from the queue, blocking if the queue is already empty</p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">queue</td><td>the queue </td></tr> <tr><td class="paramname">data</td><td>the data </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>APR_EINTR the blocking was interrupted (try again) </dd> <dd> APR_EOF if the queue has been terminated </dd> <dd> APR_SUCCESS on a successful pop </dd></dl> </div> </div> <a class="anchor" id="ga220fffb8eb2f23aa2fe626b64076df88"></a><!-- doxytag: member="apr_queue.h::apr_queue_push" ref="ga220fffb8eb2f23aa2fe626b64076df88" args="(apr_queue_t *queue, void *data)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_queue_push </td> <td>(</td> <td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">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> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>push/add an object to the queue, blocking if the queue is already full</p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">queue</td><td>the queue </td></tr> <tr><td class="paramname">data</td><td>the data </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>APR_EINTR the blocking was interrupted (try again) </dd> <dd> APR_EOF the queue has been terminated </dd> <dd> APR_SUCCESS on a successful push </dd></dl> </div> </div> <a class="anchor" id="gaf342a2e2ec195a30d6d8c9d95fbfbc30"></a><!-- doxytag: member="apr_queue.h::apr_queue_size" ref="gaf342a2e2ec195a30d6d8c9d95fbfbc30" 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#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> * </td> <td class="paramname"><em>queue</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>returns the size of the queue.</p> <dl class="warning"><dt><b>Warning:</b></dt><dd>this is not threadsafe, and is intended for reporting/monitoring of the queue. </dd></dl> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">queue</td><td>the queue </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>the size of the queue </dd></dl> </div> </div> <a class="anchor" id="gabb8115bceb96a41df3e21544ce79bc68"></a><!-- doxytag: member="apr_queue.h::apr_queue_term" ref="gabb8115bceb96a41df3e21544ce79bc68" args="(apr_queue_t *queue)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_queue_term </td> <td>(</td> <td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">apr_queue_t</a> * </td> <td class="paramname"><em>queue</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>terminate the queue, sending an interrupt to all the blocking threads</p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">queue</td><td>the queue </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ga128207222433384f286f61ec806f4af8"></a><!-- doxytag: member="apr_queue.h::apr_queue_trypop" ref="ga128207222433384f286f61ec806f4af8" args="(apr_queue_t *queue, void **data)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_queue_trypop </td> <td>(</td> <td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">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> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>pop/get an object to the queue, returning immediately if the queue is empty</p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">queue</td><td>the queue </td></tr> <tr><td class="paramname">data</td><td>the data </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>APR_EINTR the blocking operation was interrupted (try again) </dd> <dd> APR_EAGAIN the queue is empty </dd> <dd> APR_EOF the queue has been terminated </dd> <dd> APR_SUCCESS on a successful push </dd></dl> </div> </div> <a class="anchor" id="gaba8216476d7e5abc3a5ec8a47adf96d5"></a><!-- doxytag: member="apr_queue.h::apr_queue_trypush" ref="gaba8216476d7e5abc3a5ec8a47adf96d5" args="(apr_queue_t *queue, void *data)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> apr_queue_trypush </td> <td>(</td> <td class="paramtype"><a class="el" href="group___a_p_r___util___f_i_f_o.html#ga8c74c22abf47b63555a2109b06f83abb">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> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>push/add an object to the queue, returning immediately if the queue is full</p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">queue</td><td>the queue </td></tr> <tr><td class="paramname">data</td><td>the data </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>APR_EINTR the blocking operation was interrupted (try again) </dd> <dd> APR_EAGAIN the queue is full </dd> <dd> APR_EOF the queue has been terminated </dd> <dd> APR_SUCCESS on a successful push </dd></dl> </div> </div> </div> <!--- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address class="footer"><small>Generated on Wed May 25 2011 for Apache Portable Runtime by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address> </body> </html>