<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Apache Portable Runtime Utility Library: Thread Safe FIFO bounded queue</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Apache Portable Runtime Utility Library </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="summary"> <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Thread Safe FIFO bounded queue<div class="ingroups"><a class="el" href="group___a_p_r___util.html">APR Utility Functions</a></div></div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:ga8c74c22abf47b63555a2109b06f83abb"><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 class="separator:ga8c74c22abf47b63555a2109b06f83abb"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga9c8c5ec3d8779a6c2ffffb8b74f784c7"><td class="memItemLeft" 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#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, apr_pool_t *a)</td></tr> <tr class="separator:ga9c8c5ec3d8779a6c2ffffb8b74f784c7"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga220fffb8eb2f23aa2fe626b64076df88"><td class="memItemLeft" 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#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 class="separator:ga220fffb8eb2f23aa2fe626b64076df88"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga302387f5afb71d3c771b76448088bd34"><td class="memItemLeft" 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#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 class="separator:ga302387f5afb71d3c771b76448088bd34"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaba8216476d7e5abc3a5ec8a47adf96d5"><td class="memItemLeft" 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#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 class="separator:gaba8216476d7e5abc3a5ec8a47adf96d5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga128207222433384f286f61ec806f4af8"><td class="memItemLeft" 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#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 class="separator:ga128207222433384f286f61ec806f4af8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaf342a2e2ec195a30d6d8c9d95fbfbc30"><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 class="separator:gaf342a2e2ec195a30d6d8c9d95fbfbc30"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga8757c7f87105e6ff4cf1ea5ac28dd26f"><td class="memItemLeft" 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#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 class="separator:ga8757c7f87105e6ff4cf1ea5ac28dd26f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gabb8115bceb96a41df3e21544ce79bc68"><td class="memItemLeft" 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#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> <tr class="separator:gabb8115bceb96a41df3e21544ce79bc68"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <h2 class="groupheader">Typedef Documentation</h2> <a id="ga8c74c22abf47b63555a2109b06f83abb"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga8c74c22abf47b63555a2109b06f83abb">◆ </a></span>apr_queue_t</h2> <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> <h2 class="groupheader">Function Documentation</h2> <a id="ga9c8c5ec3d8779a6c2ffffb8b74f784c7"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga9c8c5ec3d8779a6c2ffffb8b74f784c7">◆ </a></span>apr_queue_create()</h2> <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#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">apr_pool_t * </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 class="params"><dt>Parameters</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 id="ga8757c7f87105e6ff4cf1ea5ac28dd26f"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga8757c7f87105e6ff4cf1ea5ac28dd26f">◆ </a></span>apr_queue_interrupt_all()</h2> <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#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 class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">queue</td><td>the queue </td></tr> </table> </dd> </dl> </div> </div> <a id="ga302387f5afb71d3c771b76448088bd34"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga302387f5afb71d3c771b76448088bd34">◆ </a></span>apr_queue_pop()</h2> <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#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 class="params"><dt>Parameters</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="section return"><dt>Returns</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 id="ga220fffb8eb2f23aa2fe626b64076df88"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga220fffb8eb2f23aa2fe626b64076df88">◆ </a></span>apr_queue_push()</h2> <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#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 class="params"><dt>Parameters</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="section return"><dt>Returns</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 id="gaf342a2e2ec195a30d6d8c9d95fbfbc30"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaf342a2e2ec195a30d6d8c9d95fbfbc30">◆ </a></span>apr_queue_size()</h2> <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="section warning"><dt>Warning</dt><dd>this is not threadsafe, and is intended for reporting/monitoring of the queue. </dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">queue</td><td>the queue </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>the size of the queue </dd></dl> </div> </div> <a id="gabb8115bceb96a41df3e21544ce79bc68"></a> <h2 class="memtitle"><span class="permalink"><a href="#gabb8115bceb96a41df3e21544ce79bc68">◆ </a></span>apr_queue_term()</h2> <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#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 class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">queue</td><td>the queue </td></tr> </table> </dd> </dl> </div> </div> <a id="ga128207222433384f286f61ec806f4af8"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga128207222433384f286f61ec806f4af8">◆ </a></span>apr_queue_trypop()</h2> <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#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 class="params"><dt>Parameters</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="section return"><dt>Returns</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 pop </dd></dl> </div> </div> <a id="gaba8216476d7e5abc3a5ec8a47adf96d5"></a> <h2 class="memtitle"><span class="permalink"><a href="#gaba8216476d7e5abc3a5ec8a47adf96d5">◆ </a></span>apr_queue_trypush()</h2> <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#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 class="params"><dt>Parameters</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="section return"><dt>Returns</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><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>