<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Apache Portable Runtime: Poll Routines</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
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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="#groups">Modules</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Poll Routines<div class="ingroups"><a class="el" href="group___a_p_r.html">Apache Portability Runtime library</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__pollopts"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pollopts.html">Poll options</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__pollflags"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__pollflags.html">Pollset Flags</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union  </td><td class="memItemRight" valign="bottom"><a class="el" href="unionapr__descriptor.html">apr_descriptor</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga0c89b184cbe2337e44207f1ad245129b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#ga0c89b184cbe2337e44207f1ad245129b">apr_pollfd_t</a></td></tr>
<tr class="separator:ga0c89b184cbe2337e44207f1ad245129b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga680da1f10ac5ef75efc503a9d15b8906"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a></td></tr>
<tr class="separator:ga680da1f10ac5ef75efc503a9d15b8906"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae382e39bdf0c5a02fca7da3944bece08"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__apr__poll.html#gae382e39bdf0c5a02fca7da3944bece08">apr_pollcb_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#gae382e39bdf0c5a02fca7da3944bece08">apr_pollcb_t</a></td></tr>
<tr class="separator:gae382e39bdf0c5a02fca7da3944bece08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1dcd8c87e233dbf105e83d50ef601f55"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#ga1dcd8c87e233dbf105e83d50ef601f55">apr_pollcb_cb_t</a>) (void *baton, <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> *descriptor)</td></tr>
<tr class="separator:ga1dcd8c87e233dbf105e83d50ef601f55"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gabe6f1238ea45e9425fa052e2788e4a29"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#gabe6f1238ea45e9425fa052e2788e4a29">apr_pollset_method_e</a> { <br />
  <a class="el" href="group__apr__poll.html#ggabe6f1238ea45e9425fa052e2788e4a29ae68b155914b79d4a58519675dfc24d94">APR_POLLSET_DEFAULT</a>,
<a class="el" href="group__apr__poll.html#ggabe6f1238ea45e9425fa052e2788e4a29aa6613bebee1abb348da2a153f91c738e">APR_POLLSET_SELECT</a>,
<a class="el" href="group__apr__poll.html#ggabe6f1238ea45e9425fa052e2788e4a29a2722387d6523f8f02cec7c31a45966d4">APR_POLLSET_KQUEUE</a>,
<a class="el" href="group__apr__poll.html#ggabe6f1238ea45e9425fa052e2788e4a29aec66f6da923595ff0a6fa20f4bc41e46">APR_POLLSET_PORT</a>,
<br />
  <a class="el" href="group__apr__poll.html#ggabe6f1238ea45e9425fa052e2788e4a29a142ebdcab58ccfabd5d964ff3ab476ab">APR_POLLSET_EPOLL</a>,
<a class="el" href="group__apr__poll.html#ggabe6f1238ea45e9425fa052e2788e4a29aa8c0b4c036644ea4518f8d7c2fd4fe8e">APR_POLLSET_POLL</a>,
<a class="el" href="group__apr__poll.html#ggabe6f1238ea45e9425fa052e2788e4a29ace0288893b2db65847536c41c0048e82">APR_POLLSET_AIO_MSGQ</a>
<br />
}</td></tr>
<tr class="separator:gabe6f1238ea45e9425fa052e2788e4a29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0a8549d84c1721788b102a4cc8b4b0f0"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#ga0a8549d84c1721788b102a4cc8b4b0f0">apr_datatype_e</a> { <a class="el" href="group__apr__poll.html#gga0a8549d84c1721788b102a4cc8b4b0f0aeb85f43492052bf0788d31f6dd85a222">APR_NO_DESC</a>,
<a class="el" href="group__apr__poll.html#gga0a8549d84c1721788b102a4cc8b4b0f0a3629c5b3166fde91792f2f913fbd72f0">APR_POLL_SOCKET</a>,
<a class="el" href="group__apr__poll.html#gga0a8549d84c1721788b102a4cc8b4b0f0a8351d461bf66b706232962fd02e84202">APR_POLL_FILE</a>,
<a class="el" href="group__apr__poll.html#gga0a8549d84c1721788b102a4cc8b4b0f0a413b387c7fe1ca7b096d46dfd9942fe5">APR_POLL_LASTDESC</a>
}</td></tr>
<tr class="separator:ga0a8549d84c1721788b102a4cc8b4b0f0"><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:ga4ca4056a19daee8fe94ddba100fe2326"><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__apr__poll.html#ga4ca4056a19daee8fe94ddba100fe2326">apr_pollset_create</a> (<a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> **pollset, apr_uint32_t size, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, apr_uint32_t flags)</td></tr>
<tr class="separator:ga4ca4056a19daee8fe94ddba100fe2326"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9448a2d756868aa1c6dbc9726a2e32b5"><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__apr__poll.html#ga9448a2d756868aa1c6dbc9726a2e32b5">apr_pollset_create_ex</a> (<a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> **pollset, apr_uint32_t size, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, apr_uint32_t flags, <a class="el" href="group__apr__poll.html#gabe6f1238ea45e9425fa052e2788e4a29">apr_pollset_method_e</a> method)</td></tr>
<tr class="separator:ga9448a2d756868aa1c6dbc9726a2e32b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa06c538d3fea9d860374043aff9450b2"><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__apr__poll.html#gaa06c538d3fea9d860374043aff9450b2">apr_pollset_destroy</a> (<a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> *pollset)</td></tr>
<tr class="separator:gaa06c538d3fea9d860374043aff9450b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4ec50bf9a11c6b60927c51b81412f5b9"><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__apr__poll.html#ga4ec50bf9a11c6b60927c51b81412f5b9">apr_pollset_add</a> (<a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> *pollset, const <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> *descriptor)</td></tr>
<tr class="separator:ga4ec50bf9a11c6b60927c51b81412f5b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3c99c06e142d6b6b789eeb6086122e3a"><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__apr__poll.html#ga3c99c06e142d6b6b789eeb6086122e3a">apr_pollset_remove</a> (<a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> *pollset, const <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> *descriptor)</td></tr>
<tr class="separator:ga3c99c06e142d6b6b789eeb6086122e3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6b31d7b3a7b2d356370403dd2b79ecf3"><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__apr__poll.html#ga6b31d7b3a7b2d356370403dd2b79ecf3">apr_pollset_poll</a> (<a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> *pollset, <a class="el" href="group__apr__time.html#gaae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a> timeout, apr_int32_t *num, const <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> **descriptors)</td></tr>
<tr class="separator:ga6b31d7b3a7b2d356370403dd2b79ecf3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac5e86828143e169e18b2a6eab94be531"><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__apr__poll.html#gac5e86828143e169e18b2a6eab94be531">apr_pollset_wakeup</a> (<a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> *pollset)</td></tr>
<tr class="separator:gac5e86828143e169e18b2a6eab94be531"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad1d8a1ccd14952be6da5f272ca8dda76"><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__apr__poll.html#gad1d8a1ccd14952be6da5f272ca8dda76">apr_poll</a> (<a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> *aprset, apr_int32_t numsock, apr_int32_t *nsds, <a class="el" href="group__apr__time.html#gaae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a> timeout)</td></tr>
<tr class="separator:gad1d8a1ccd14952be6da5f272ca8dda76"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga942ebbcc17d27911da86e1bd5c7a592e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#ga942ebbcc17d27911da86e1bd5c7a592e">apr_pollset_method_name</a> (<a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> *pollset)</td></tr>
<tr class="separator:ga942ebbcc17d27911da86e1bd5c7a592e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5d64867d7a3abd53d3765b4b47cf774f"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#ga5d64867d7a3abd53d3765b4b47cf774f">apr_poll_method_defname</a> (void)</td></tr>
<tr class="separator:ga5d64867d7a3abd53d3765b4b47cf774f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga76c33736268d57fca503790711d6d04e"><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__apr__poll.html#ga76c33736268d57fca503790711d6d04e">apr_pollcb_create</a> (<a class="el" href="group__apr__poll.html#gae382e39bdf0c5a02fca7da3944bece08">apr_pollcb_t</a> **pollcb, apr_uint32_t size, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, apr_uint32_t flags)</td></tr>
<tr class="separator:ga76c33736268d57fca503790711d6d04e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2ebdd0cba2d3b8333c46ee48170f8e90"><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__apr__poll.html#ga2ebdd0cba2d3b8333c46ee48170f8e90">apr_pollcb_create_ex</a> (<a class="el" href="group__apr__poll.html#gae382e39bdf0c5a02fca7da3944bece08">apr_pollcb_t</a> **pollcb, apr_uint32_t size, <a class="el" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *p, apr_uint32_t flags, <a class="el" href="group__apr__poll.html#gabe6f1238ea45e9425fa052e2788e4a29">apr_pollset_method_e</a> method)</td></tr>
<tr class="separator:ga2ebdd0cba2d3b8333c46ee48170f8e90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8fab02dfa803d911dae98656fac7a2c8"><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__apr__poll.html#ga8fab02dfa803d911dae98656fac7a2c8">apr_pollcb_add</a> (<a class="el" href="group__apr__poll.html#gae382e39bdf0c5a02fca7da3944bece08">apr_pollcb_t</a> *pollcb, <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> *descriptor)</td></tr>
<tr class="separator:ga8fab02dfa803d911dae98656fac7a2c8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad004b778a14d6bcc4e48a10e5af729d8"><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__apr__poll.html#gad004b778a14d6bcc4e48a10e5af729d8">apr_pollcb_remove</a> (<a class="el" href="group__apr__poll.html#gae382e39bdf0c5a02fca7da3944bece08">apr_pollcb_t</a> *pollcb, <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> *descriptor)</td></tr>
<tr class="separator:gad004b778a14d6bcc4e48a10e5af729d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga11765d1b27e2f621a8dcd2c40f0e259c"><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__apr__poll.html#ga11765d1b27e2f621a8dcd2c40f0e259c">apr_pollcb_poll</a> (<a class="el" href="group__apr__poll.html#gae382e39bdf0c5a02fca7da3944bece08">apr_pollcb_t</a> *pollcb, <a class="el" href="group__apr__time.html#gaae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a> timeout, <a class="el" href="group__apr__poll.html#ga1dcd8c87e233dbf105e83d50ef601f55">apr_pollcb_cb_t</a> func, void *baton)</td></tr>
<tr class="separator:ga11765d1b27e2f621a8dcd2c40f0e259c"><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="ga1dcd8c87e233dbf105e83d50ef601f55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1dcd8c87e233dbf105e83d50ef601f55">◆ </a></span>apr_pollcb_cb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>(* apr_pollcb_cb_t) (void *baton, <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> *descriptor)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Function prototype for pollcb handlers </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">baton</td><td>Opaque baton passed into <a class="el" href="group__apr__poll.html#ga11765d1b27e2f621a8dcd2c40f0e259c">apr_pollcb_poll()</a> </td></tr>
<tr><td class="paramname">descriptor</td><td>Contains the notification for an active descriptor, the rtnevents member contains what events were triggered for this descriptor. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gae382e39bdf0c5a02fca7da3944bece08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae382e39bdf0c5a02fca7da3944bece08">◆ </a></span>apr_pollcb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__apr__poll.html#gae382e39bdf0c5a02fca7da3944bece08">apr_pollcb_t</a> <a class="el" href="group__apr__poll.html#gae382e39bdf0c5a02fca7da3944bece08">apr_pollcb_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opaque structure used for pollcb API </p>
</div>
</div>
<a id="ga0c89b184cbe2337e44207f1ad245129b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0c89b184cbe2337e44207f1ad245129b">◆ </a></span>apr_pollfd_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> </dd></dl>
</div>
</div>
<a id="ga680da1f10ac5ef75efc503a9d15b8906"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga680da1f10ac5ef75efc503a9d15b8906">◆ </a></span>apr_pollset_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> <a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Opaque structure used for pollset API </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga0a8549d84c1721788b102a4cc8b4b0f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0a8549d84c1721788b102a4cc8b4b0f0">◆ </a></span>apr_datatype_e</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__apr__poll.html#ga0a8549d84c1721788b102a4cc8b4b0f0">apr_datatype_e</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Used in <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> to determine what the <a class="el" href="unionapr__descriptor.html">apr_descriptor</a> is </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga0a8549d84c1721788b102a4cc8b4b0f0aeb85f43492052bf0788d31f6dd85a222"></a>APR_NO_DESC </td><td class="fielddoc"><p>nothing here </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0a8549d84c1721788b102a4cc8b4b0f0a3629c5b3166fde91792f2f913fbd72f0"></a>APR_POLL_SOCKET </td><td class="fielddoc"><p>descriptor refers to a socket </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0a8549d84c1721788b102a4cc8b4b0f0a8351d461bf66b706232962fd02e84202"></a>APR_POLL_FILE </td><td class="fielddoc"><p>descriptor refers to a file </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0a8549d84c1721788b102a4cc8b4b0f0a413b387c7fe1ca7b096d46dfd9942fe5"></a>APR_POLL_LASTDESC </td><td class="fielddoc"><dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000032">Deprecated:</a></b></dt><dd>descriptor is the last one in the list </dd></dl>
</td></tr>
</table>
</div>
</div>
<a id="gabe6f1238ea45e9425fa052e2788e4a29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabe6f1238ea45e9425fa052e2788e4a29">◆ </a></span>apr_pollset_method_e</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__apr__poll.html#gabe6f1238ea45e9425fa052e2788e4a29">apr_pollset_method_e</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pollset Methods </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggabe6f1238ea45e9425fa052e2788e4a29ae68b155914b79d4a58519675dfc24d94"></a>APR_POLLSET_DEFAULT </td><td class="fielddoc"><p>Platform default poll method </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabe6f1238ea45e9425fa052e2788e4a29aa6613bebee1abb348da2a153f91c738e"></a>APR_POLLSET_SELECT </td><td class="fielddoc"><p>Poll uses select method </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabe6f1238ea45e9425fa052e2788e4a29a2722387d6523f8f02cec7c31a45966d4"></a>APR_POLLSET_KQUEUE </td><td class="fielddoc"><p>Poll uses kqueue method </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabe6f1238ea45e9425fa052e2788e4a29aec66f6da923595ff0a6fa20f4bc41e46"></a>APR_POLLSET_PORT </td><td class="fielddoc"><p>Poll uses Solaris event port method </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabe6f1238ea45e9425fa052e2788e4a29a142ebdcab58ccfabd5d964ff3ab476ab"></a>APR_POLLSET_EPOLL </td><td class="fielddoc"><p>Poll uses epoll method </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabe6f1238ea45e9425fa052e2788e4a29aa8c0b4c036644ea4518f8d7c2fd4fe8e"></a>APR_POLLSET_POLL </td><td class="fielddoc"><p>Poll uses poll method </p>
</td></tr>
<tr><td class="fieldname"><a id="ggabe6f1238ea45e9425fa052e2788e4a29ace0288893b2db65847536c41c0048e82"></a>APR_POLLSET_AIO_MSGQ </td><td class="fielddoc"><p>Poll uses z/OS asio method </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad1d8a1ccd14952be6da5f272ca8dda76"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad1d8a1ccd14952be6da5f272ca8dda76">◆ </a></span>apr_poll()</h2>
<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_poll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> * </td>
<td class="paramname"><em>aprset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_int32_t </td>
<td class="paramname"><em>numsock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_int32_t * </td>
<td class="paramname"><em>nsds</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__time.html#gaae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a> </td>
<td class="paramname"><em>timeout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Poll the descriptors in the poll structure </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">aprset</td><td>The poll structure we will be using. </td></tr>
<tr><td class="paramname">numsock</td><td>The number of descriptors we are polling </td></tr>
<tr><td class="paramname">nsds</td><td>The number of descriptors signalled (output parameter) </td></tr>
<tr><td class="paramname">timeout</td><td>The amount of time in microseconds to wait. This is a maximum, not a minimum. If a descriptor is signalled, the function will return before this time. If timeout is negative, the function will block until a descriptor is signalled or until <a class="el" href="group__apr__poll.html#gac5e86828143e169e18b2a6eab94be531">apr_pollset_wakeup()</a> has been called. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>The number of descriptors signalled is returned in the third argument. This is a blocking call, and it will not return until either a descriptor has been signalled or the timeout has expired. </dd>
<dd>
The rtnevents field in the <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> array will only be filled- in if the return value is APR_SUCCESS. </dd></dl>
</div>
</div>
<a id="ga5d64867d7a3abd53d3765b4b47cf774f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5d64867d7a3abd53d3765b4b47cf774f">◆ </a></span>apr_poll_method_defname()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* apr_poll_method_defname </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a printable representation of the default pollset method (APR_POLLSET_DEFAULT). </p>
</div>
</div>
<a id="ga8fab02dfa803d911dae98656fac7a2c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8fab02dfa803d911dae98656fac7a2c8">◆ </a></span>apr_pollcb_add()</h2>
<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_pollcb_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#gae382e39bdf0c5a02fca7da3944bece08">apr_pollcb_t</a> * </td>
<td class="paramname"><em>pollcb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> * </td>
<td class="paramname"><em>descriptor</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a socket or file descriptor to a pollcb </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pollcb</td><td>The pollcb to which to add the descriptor </td></tr>
<tr><td class="paramname">descriptor</td><td>The descriptor to add </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>If you set client_data in the descriptor, that value will be returned in the client_data field whenever this descriptor is signalled in <a class="el" href="group__apr__poll.html#ga11765d1b27e2f621a8dcd2c40f0e259c">apr_pollcb_poll()</a>. </dd>
<dd>
Unlike the apr_pollset API, the descriptor is not copied, and users must retain the memory used by descriptor, as the same pointer will be returned to them from apr_pollcb_poll. </dd>
<dd>
Do not add the same socket or file descriptor to the same pollcb multiple times, even if the requested events differ for the different calls to <a class="el" href="group__apr__poll.html#ga8fab02dfa803d911dae98656fac7a2c8">apr_pollcb_add()</a>. If the events of interest for a descriptor change, you must first remove the descriptor from the pollcb with <a class="el" href="group__apr__poll.html#gad004b778a14d6bcc4e48a10e5af729d8">apr_pollcb_remove()</a>, then add it again specifying all requested events. </dd></dl>
</div>
</div>
<a id="ga76c33736268d57fca503790711d6d04e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga76c33736268d57fca503790711d6d04e">◆ </a></span>apr_pollcb_create()</h2>
<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_pollcb_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#gae382e39bdf0c5a02fca7da3944bece08">apr_pollcb_t</a> ** </td>
<td class="paramname"><em>pollcb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_uint32_t </td>
<td class="paramname"><em>size</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>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_uint32_t </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set up a pollcb object </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pollcb</td><td>The pointer in which to return the newly created object </td></tr>
<tr><td class="paramname">size</td><td>The maximum number of descriptors that a single _poll can return. </td></tr>
<tr><td class="paramname">p</td><td>The pool from which to allocate the pollcb </td></tr>
<tr><td class="paramname">flags</td><td>Optional flags to modify the operation of the pollcb.</td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>Pollcb is only supported on some platforms; the <a class="el" href="group__apr__poll.html#ga76c33736268d57fca503790711d6d04e">apr_pollcb_create()</a> call will fail with APR_ENOTIMPL on platforms where it is not supported. </dd></dl>
</div>
</div>
<a id="ga2ebdd0cba2d3b8333c46ee48170f8e90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2ebdd0cba2d3b8333c46ee48170f8e90">◆ </a></span>apr_pollcb_create_ex()</h2>
<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_pollcb_create_ex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#gae382e39bdf0c5a02fca7da3944bece08">apr_pollcb_t</a> ** </td>
<td class="paramname"><em>pollcb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_uint32_t </td>
<td class="paramname"><em>size</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>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_uint32_t </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#gabe6f1238ea45e9425fa052e2788e4a29">apr_pollset_method_e</a> </td>
<td class="paramname"><em>method</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set up a pollcb object </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pollcb</td><td>The pointer in which to return the newly created object </td></tr>
<tr><td class="paramname">size</td><td>The maximum number of descriptors that a single _poll can return. </td></tr>
<tr><td class="paramname">p</td><td>The pool from which to allocate the pollcb </td></tr>
<tr><td class="paramname">flags</td><td>Optional flags to modify the operation of the pollcb. </td></tr>
<tr><td class="paramname">method</td><td>Poll method to use. See <a class="el" href="group__apr__poll.html#gabe6f1238ea45e9425fa052e2788e4a29">apr_pollset_method_e</a>. If this method cannot be used, the default method will be used unless the APR_POLLSET_NODEFAULT flag has been specified.</td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>Pollcb is only supported on some platforms; the <a class="el" href="group__apr__poll.html#ga2ebdd0cba2d3b8333c46ee48170f8e90">apr_pollcb_create_ex()</a> call will fail with APR_ENOTIMPL on platforms where it is not supported. </dd></dl>
</div>
</div>
<a id="ga11765d1b27e2f621a8dcd2c40f0e259c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga11765d1b27e2f621a8dcd2c40f0e259c">◆ </a></span>apr_pollcb_poll()</h2>
<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_pollcb_poll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#gae382e39bdf0c5a02fca7da3944bece08">apr_pollcb_t</a> * </td>
<td class="paramname"><em>pollcb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__time.html#gaae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a> </td>
<td class="paramname"><em>timeout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#ga1dcd8c87e233dbf105e83d50ef601f55">apr_pollcb_cb_t</a> </td>
<td class="paramname"><em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>baton</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Block for activity on the descriptor(s) in a pollcb </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pollcb</td><td>The pollcb to use </td></tr>
<tr><td class="paramname">timeout</td><td>The amount of time in microseconds to wait. This is a maximum, not a minimum. If a descriptor is signalled, the function will return before this time. If timeout is negative, the function will block until a descriptor is signalled. </td></tr>
<tr><td class="paramname">func</td><td>Callback function to call for each active descriptor. </td></tr>
<tr><td class="paramname">baton</td><td>Opaque baton passed to the callback function. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>Multiple signalled conditions for the same descriptor may be reported in one or more calls to the callback function, depending on the implementation. </dd></dl>
</div>
</div>
<a id="gad004b778a14d6bcc4e48a10e5af729d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad004b778a14d6bcc4e48a10e5af729d8">◆ </a></span>apr_pollcb_remove()</h2>
<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_pollcb_remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#gae382e39bdf0c5a02fca7da3944bece08">apr_pollcb_t</a> * </td>
<td class="paramname"><em>pollcb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> * </td>
<td class="paramname"><em>descriptor</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a descriptor from a pollcb </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pollcb</td><td>The pollcb from which to remove the descriptor </td></tr>
<tr><td class="paramname">descriptor</td><td>The descriptor to remove </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd><a class="el" href="group__apr__poll.html#gad004b778a14d6bcc4e48a10e5af729d8">apr_pollcb_remove()</a> cannot be used to remove a subset of requested events for a descriptor. The reqevents field in the <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> parameter must contain the same value when removing as when adding. </dd></dl>
</div>
</div>
<a id="ga4ec50bf9a11c6b60927c51b81412f5b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4ec50bf9a11c6b60927c51b81412f5b9">◆ </a></span>apr_pollset_add()</h2>
<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_pollset_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> * </td>
<td class="paramname"><em>pollset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> * </td>
<td class="paramname"><em>descriptor</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a socket or file descriptor to a pollset </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pollset</td><td>The pollset to which to add the descriptor </td></tr>
<tr><td class="paramname">descriptor</td><td>The descriptor to add </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>If you set client_data in the descriptor, that value will be returned in the client_data field whenever this descriptor is signalled in <a class="el" href="group__apr__poll.html#ga6b31d7b3a7b2d356370403dd2b79ecf3">apr_pollset_poll()</a>. </dd>
<dd>
If the pollset has been created with APR_POLLSET_THREADSAFE and thread T1 is blocked in a call to <a class="el" href="group__apr__poll.html#ga6b31d7b3a7b2d356370403dd2b79ecf3">apr_pollset_poll()</a> for this same pollset that is being modified via <a class="el" href="group__apr__poll.html#ga4ec50bf9a11c6b60927c51b81412f5b9">apr_pollset_add()</a> in thread T2, the currently executing <a class="el" href="group__apr__poll.html#ga6b31d7b3a7b2d356370403dd2b79ecf3">apr_pollset_poll()</a> call in T1 will either: (1) automatically include the newly added descriptor in the set of descriptors it is watching or (2) return immediately with APR_EINTR. Option (1) is recommended, but option (2) is allowed for implementations where option (1) is impossible or impractical. </dd>
<dd>
If the pollset has been created with APR_POLLSET_NOCOPY, the <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> structure referenced by descriptor will not be copied and must have a lifetime at least as long as the pollset. </dd>
<dd>
Do not add the same socket or file descriptor to the same pollset multiple times, even if the requested events differ for the different calls to <a class="el" href="group__apr__poll.html#ga4ec50bf9a11c6b60927c51b81412f5b9">apr_pollset_add()</a>. If the events of interest for a descriptor change, you must first remove the descriptor from the pollset with <a class="el" href="group__apr__poll.html#ga3c99c06e142d6b6b789eeb6086122e3a">apr_pollset_remove()</a>, then add it again specifying all requested events. </dd></dl>
</div>
</div>
<a id="ga4ca4056a19daee8fe94ddba100fe2326"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4ca4056a19daee8fe94ddba100fe2326">◆ </a></span>apr_pollset_create()</h2>
<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_pollset_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> ** </td>
<td class="paramname"><em>pollset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_uint32_t </td>
<td class="paramname"><em>size</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>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_uint32_t </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set up a pollset object </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pollset</td><td>The pointer in which to return the newly created object </td></tr>
<tr><td class="paramname">size</td><td>The maximum number of descriptors that this pollset can hold </td></tr>
<tr><td class="paramname">p</td><td>The pool from which to allocate the pollset </td></tr>
<tr><td class="paramname">flags</td><td>Optional flags to modify the operation of the pollset.</td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>If flags contains APR_POLLSET_THREADSAFE, then a pollset is created on which it is safe to make concurrent calls to <a class="el" href="group__apr__poll.html#ga4ec50bf9a11c6b60927c51b81412f5b9">apr_pollset_add()</a>, <a class="el" href="group__apr__poll.html#ga3c99c06e142d6b6b789eeb6086122e3a">apr_pollset_remove()</a> and <a class="el" href="group__apr__poll.html#ga6b31d7b3a7b2d356370403dd2b79ecf3">apr_pollset_poll()</a> from separate threads. This feature is only supported on some platforms; the <a class="el" href="group__apr__poll.html#ga4ca4056a19daee8fe94ddba100fe2326">apr_pollset_create()</a> call will fail with APR_ENOTIMPL on platforms where it is not supported. </dd>
<dd>
If flags contains APR_POLLSET_WAKEABLE, then a pollset is created with an additional internal pipe object used for the <a class="el" href="group__apr__poll.html#gac5e86828143e169e18b2a6eab94be531">apr_pollset_wakeup()</a> call. The actual size of pollset is in that case <em>size</em> + 1. This feature is only supported on some platforms; the <a class="el" href="group__apr__poll.html#ga4ca4056a19daee8fe94ddba100fe2326">apr_pollset_create()</a> call will fail with APR_ENOTIMPL on platforms where it is not supported. </dd>
<dd>
If flags contains APR_POLLSET_NOCOPY, then the <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> structures passed to <a class="el" href="group__apr__poll.html#ga4ec50bf9a11c6b60927c51b81412f5b9">apr_pollset_add()</a> are not copied and must have a lifetime at least as long as the pollset. </dd>
<dd>
Some poll methods (including APR_POLLSET_KQUEUE, APR_POLLSET_PORT, and APR_POLLSET_EPOLL) do not have a fixed limit on the size of the pollset. For these methods, the size parameter controls the maximum number of descriptors that will be returned by a single call to <a class="el" href="group__apr__poll.html#ga6b31d7b3a7b2d356370403dd2b79ecf3">apr_pollset_poll()</a>. </dd></dl>
</div>
</div>
<a id="ga9448a2d756868aa1c6dbc9726a2e32b5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9448a2d756868aa1c6dbc9726a2e32b5">◆ </a></span>apr_pollset_create_ex()</h2>
<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_pollset_create_ex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> ** </td>
<td class="paramname"><em>pollset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_uint32_t </td>
<td class="paramname"><em>size</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>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_uint32_t </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#gabe6f1238ea45e9425fa052e2788e4a29">apr_pollset_method_e</a> </td>
<td class="paramname"><em>method</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set up a pollset object </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pollset</td><td>The pointer in which to return the newly created object </td></tr>
<tr><td class="paramname">size</td><td>The maximum number of descriptors that this pollset can hold </td></tr>
<tr><td class="paramname">p</td><td>The pool from which to allocate the pollset </td></tr>
<tr><td class="paramname">flags</td><td>Optional flags to modify the operation of the pollset. </td></tr>
<tr><td class="paramname">method</td><td>Poll method to use. See <a class="el" href="group__apr__poll.html#gabe6f1238ea45e9425fa052e2788e4a29">apr_pollset_method_e</a>. If this method cannot be used, the default method will be used unless the APR_POLLSET_NODEFAULT flag has been specified.</td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>If flags contains APR_POLLSET_THREADSAFE, then a pollset is created on which it is safe to make concurrent calls to <a class="el" href="group__apr__poll.html#ga4ec50bf9a11c6b60927c51b81412f5b9">apr_pollset_add()</a>, <a class="el" href="group__apr__poll.html#ga3c99c06e142d6b6b789eeb6086122e3a">apr_pollset_remove()</a> and <a class="el" href="group__apr__poll.html#ga6b31d7b3a7b2d356370403dd2b79ecf3">apr_pollset_poll()</a> from separate threads. This feature is only supported on some platforms; the <a class="el" href="group__apr__poll.html#ga9448a2d756868aa1c6dbc9726a2e32b5">apr_pollset_create_ex()</a> call will fail with APR_ENOTIMPL on platforms where it is not supported. </dd>
<dd>
If flags contains APR_POLLSET_WAKEABLE, then a pollset is created with additional internal pipe object used for the <a class="el" href="group__apr__poll.html#gac5e86828143e169e18b2a6eab94be531">apr_pollset_wakeup()</a> call. The actual size of pollset is in that case size + 1. This feature is only supported on some platforms; the <a class="el" href="group__apr__poll.html#ga9448a2d756868aa1c6dbc9726a2e32b5">apr_pollset_create_ex()</a> call will fail with APR_ENOTIMPL on platforms where it is not supported. </dd>
<dd>
If flags contains APR_POLLSET_NOCOPY, then the <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> structures passed to <a class="el" href="group__apr__poll.html#ga4ec50bf9a11c6b60927c51b81412f5b9">apr_pollset_add()</a> are not copied and must have a lifetime at least as long as the pollset. </dd>
<dd>
Some poll methods (including APR_POLLSET_KQUEUE, APR_POLLSET_PORT, and APR_POLLSET_EPOLL) do not have a fixed limit on the size of the pollset. For these methods, the size parameter controls the maximum number of descriptors that will be returned by a single call to <a class="el" href="group__apr__poll.html#ga6b31d7b3a7b2d356370403dd2b79ecf3">apr_pollset_poll()</a>. </dd></dl>
</div>
</div>
<a id="gaa06c538d3fea9d860374043aff9450b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa06c538d3fea9d860374043aff9450b2">◆ </a></span>apr_pollset_destroy()</h2>
<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_pollset_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> * </td>
<td class="paramname"><em>pollset</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy a pollset object </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pollset</td><td>The pollset to destroy </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga942ebbcc17d27911da86e1bd5c7a592e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga942ebbcc17d27911da86e1bd5c7a592e">◆ </a></span>apr_pollset_method_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* apr_pollset_method_name </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> * </td>
<td class="paramname"><em>pollset</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a printable representation of the pollset method. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pollset</td><td>The pollset to use </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ga6b31d7b3a7b2d356370403dd2b79ecf3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6b31d7b3a7b2d356370403dd2b79ecf3">◆ </a></span>apr_pollset_poll()</h2>
<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_pollset_poll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> * </td>
<td class="paramname"><em>pollset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__time.html#gaae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a> </td>
<td class="paramname"><em>timeout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_int32_t * </td>
<td class="paramname"><em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> ** </td>
<td class="paramname"><em>descriptors</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Block for activity on the descriptor(s) in a pollset </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pollset</td><td>The pollset to use </td></tr>
<tr><td class="paramname">timeout</td><td>The amount of time in microseconds to wait. This is a maximum, not a minimum. If a descriptor is signalled, the function will return before this time. If timeout is negative, the function will block until a descriptor is signalled or until <a class="el" href="group__apr__poll.html#gac5e86828143e169e18b2a6eab94be531">apr_pollset_wakeup()</a> has been called. </td></tr>
<tr><td class="paramname">num</td><td>Number of signalled descriptors (output parameter) </td></tr>
<tr><td class="paramname">descriptors</td><td>Array of signalled descriptors (output parameter) </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>APR_EINTR will be returned if the pollset has been created with APR_POLLSET_WAKEABLE, <a class="el" href="group__apr__poll.html#gac5e86828143e169e18b2a6eab94be531">apr_pollset_wakeup()</a> has been called while waiting for activity, and there were no signalled descriptors at the time of the wakeup call. </dd>
<dd>
Multiple signalled conditions for the same descriptor may be reported in one or more returned <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> structures, depending on the implementation. </dd></dl>
</div>
</div>
<a id="ga3c99c06e142d6b6b789eeb6086122e3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3c99c06e142d6b6b789eeb6086122e3a">◆ </a></span>apr_pollset_remove()</h2>
<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_pollset_remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> * </td>
<td class="paramname"><em>pollset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> * </td>
<td class="paramname"><em>descriptor</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove a descriptor from a pollset </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pollset</td><td>The pollset from which to remove the descriptor </td></tr>
<tr><td class="paramname">descriptor</td><td>The descriptor to remove </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>If the descriptor is not found, APR_NOTFOUND is returned. </dd>
<dd>
If the pollset has been created with APR_POLLSET_THREADSAFE and thread T1 is blocked in a call to <a class="el" href="group__apr__poll.html#ga6b31d7b3a7b2d356370403dd2b79ecf3">apr_pollset_poll()</a> for this same pollset that is being modified via <a class="el" href="group__apr__poll.html#ga3c99c06e142d6b6b789eeb6086122e3a">apr_pollset_remove()</a> in thread T2, the currently executing <a class="el" href="group__apr__poll.html#ga6b31d7b3a7b2d356370403dd2b79ecf3">apr_pollset_poll()</a> call in T1 will either: (1) automatically exclude the newly added descriptor in the set of descriptors it is watching or (2) return immediately with APR_EINTR. Option (1) is recommended, but option (2) is allowed for implementations where option (1) is impossible or impractical. </dd>
<dd>
<a class="el" href="group__apr__poll.html#ga3c99c06e142d6b6b789eeb6086122e3a">apr_pollset_remove()</a> cannot be used to remove a subset of requested events for a descriptor. The reqevents field in the <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> parameter must contain the same value when removing as when adding. </dd></dl>
</div>
</div>
<a id="gac5e86828143e169e18b2a6eab94be531"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac5e86828143e169e18b2a6eab94be531">◆ </a></span>apr_pollset_wakeup()</h2>
<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_pollset_wakeup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#ga680da1f10ac5ef75efc503a9d15b8906">apr_pollset_t</a> * </td>
<td class="paramname"><em>pollset</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Interrupt the blocked <a class="el" href="group__apr__poll.html#ga6b31d7b3a7b2d356370403dd2b79ecf3">apr_pollset_poll()</a> call. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pollset</td><td>The pollset to use </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>If the pollset was not created with APR_POLLSET_WAKEABLE the return value is APR_EINIT. </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.13
</small></address>
</body>
</html>
