<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Apache Portable Runtime: Poll Routines</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<h1>Poll Routines<br>
<small>
[<a class="el" href="group___a_p_r.html">Apache Portability Runtime library</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">union </td><td class="memItemRight" valign="bottom"><a class="el" href="unionapr__descriptor.html">apr_descriptor</a></td></tr>
<tr><td class="memItemLeft" nowrap 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><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#g3c2885c10b586c3385b468ec28522168">APR_POLLIN</a> 0x001</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#ga3b72f6cc9972590a473c139140a39f3">APR_POLLPRI</a> 0x002</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#g8c1e12da0f397805eb3984fa33ebfd82">APR_POLLOUT</a> 0x004</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#gc0fd9c11abeaeca30f34177f440d0f97">APR_POLLERR</a> 0x010</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#g79359c036fb7960efb48c2d763444113">APR_POLLHUP</a> 0x020</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#g52736590e42dfa626569290d11984a89">APR_POLLNVAL</a> 0x040</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#gf72e5668d63a2f4ba346b580f9d43c09">APR_POLLSET_THREADSAFE</a> 0x001</td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <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#g74f2a2078a80a7be834fab746ffe2e30">apr_pollfd_t</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">apr_pollset_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">apr_pollset_t</a></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#g7c017ccdfddbd53a97b6d3fbde3253de">apr_datatype_e</a> { <a class="el" href="group__apr__poll.html#gg7c017ccdfddbd53a97b6d3fbde3253ded4671734bde9f6dff6818c2d456e04c5">APR_NO_DESC</a>,
<a class="el" href="group__apr__poll.html#gg7c017ccdfddbd53a97b6d3fbde3253de06bdea788e31c230025bcb1d60ddd601">APR_POLL_SOCKET</a>,
<a class="el" href="group__apr__poll.html#gg7c017ccdfddbd53a97b6d3fbde3253dee42217f4871d27eb1a2261962ccc820f">APR_POLL_FILE</a>,
<a class="el" href="group__apr__poll.html#gg7c017ccdfddbd53a97b6d3fbde3253de0a5db12ada1f3a3cc9b46dad734b76b5">APR_POLL_LASTDESC</a>
}</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#gb9b82b09e4a92dca78efd903cd9c37c3">apr_pollset_create</a> (<a class="el" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">apr_pollset_t</a> **pollset, apr_uint32_t size, <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p, apr_uint32_t flags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#gaefd180858994eeb5b05e521a6d234ab">apr_pollset_destroy</a> (<a class="el" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">apr_pollset_t</a> *pollset)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#gd30ace9e897a9a0e23e8f5e00befb022">apr_pollset_add</a> (<a class="el" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">apr_pollset_t</a> *pollset, const <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> *descriptor)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#gc0f1d1190c6b3220700ee274b3b52365">apr_pollset_remove</a> (<a class="el" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">apr_pollset_t</a> *pollset, const <a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> *descriptor)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#g3cd04119cce9d48a552040fe9178bcff">apr_pollset_poll</a> (<a class="el" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">apr_pollset_t</a> *pollset, <a class="el" href="group__apr__time.html#g4867ccc083452a265915ac7dfafde457">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><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__poll.html#gafea48f0405cec2b130d53f34ffb9089">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#g4867ccc083452a265915ac7dfafde457">apr_interval_time_t</a> timeout)</td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="gc0fd9c11abeaeca30f34177f440d0f97"></a><!-- doxytag: member="apr_poll.h::APR_POLLERR" ref="gc0fd9c11abeaeca30f34177f440d0f97" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_POLLERR 0x010 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Pending error
</div>
</div><p>
<a class="anchor" name="g79359c036fb7960efb48c2d763444113"></a><!-- doxytag: member="apr_poll.h::APR_POLLHUP" ref="g79359c036fb7960efb48c2d763444113" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_POLLHUP 0x020 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Hangup occurred
</div>
</div><p>
<a class="anchor" name="g3c2885c10b586c3385b468ec28522168"></a><!-- doxytag: member="apr_poll.h::APR_POLLIN" ref="g3c2885c10b586c3385b468ec28522168" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_POLLIN 0x001 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Poll options Can read without blocking
</div>
</div><p>
<a class="anchor" name="g52736590e42dfa626569290d11984a89"></a><!-- doxytag: member="apr_poll.h::APR_POLLNVAL" ref="g52736590e42dfa626569290d11984a89" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_POLLNVAL 0x040 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Descriptior invalid
</div>
</div><p>
<a class="anchor" name="g8c1e12da0f397805eb3984fa33ebfd82"></a><!-- doxytag: member="apr_poll.h::APR_POLLOUT" ref="g8c1e12da0f397805eb3984fa33ebfd82" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_POLLOUT 0x004 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Can write without blocking
</div>
</div><p>
<a class="anchor" name="ga3b72f6cc9972590a473c139140a39f3"></a><!-- doxytag: member="apr_poll.h::APR_POLLPRI" ref="ga3b72f6cc9972590a473c139140a39f3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_POLLPRI 0x002 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Priority data available
</div>
</div><p>
<a class="anchor" name="gf72e5668d63a2f4ba346b580f9d43c09"></a><!-- doxytag: member="apr_poll.h::APR_POLLSET_THREADSAFE" ref="gf72e5668d63a2f4ba346b580f9d43c09" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_POLLSET_THREADSAFE 0x001 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Pollset Flags Adding or Removing a Descriptor is thread safe
</div>
</div><p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="g74f2a2078a80a7be834fab746ffe2e30"></a><!-- doxytag: member="apr_poll.h::apr_pollfd_t" ref="g74f2a2078a80a7be834fab746ffe2e30" args="" -->
<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">
<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="structapr__pollfd__t.html">apr_pollfd_t</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="g3f81be7d929391f76d1c87a463ce2226"></a><!-- doxytag: member="apr_poll.h::apr_pollset_t" ref="g3f81be7d929391f76d1c87a463ce2226" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">apr_pollset_t</a> <a class="el" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">apr_pollset_t</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Opaque structure used for pollset API
</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="g7c017ccdfddbd53a97b6d3fbde3253de"></a><!-- doxytag: member="apr_poll.h::apr_datatype_e" ref="g7c017ccdfddbd53a97b6d3fbde3253de" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__apr__poll.html#g7c017ccdfddbd53a97b6d3fbde3253de">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 <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="gg7c017ccdfddbd53a97b6d3fbde3253ded4671734bde9f6dff6818c2d456e04c5"></a><!-- doxytag: member="APR_NO_DESC" ref="gg7c017ccdfddbd53a97b6d3fbde3253ded4671734bde9f6dff6818c2d456e04c5" args="" -->APR_NO_DESC</em> </td><td>
nothing here </td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg7c017ccdfddbd53a97b6d3fbde3253de06bdea788e31c230025bcb1d60ddd601"></a><!-- doxytag: member="APR_POLL_SOCKET" ref="gg7c017ccdfddbd53a97b6d3fbde3253de06bdea788e31c230025bcb1d60ddd601" args="" -->APR_POLL_SOCKET</em> </td><td>
descriptor refers to a socket </td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg7c017ccdfddbd53a97b6d3fbde3253dee42217f4871d27eb1a2261962ccc820f"></a><!-- doxytag: member="APR_POLL_FILE" ref="gg7c017ccdfddbd53a97b6d3fbde3253dee42217f4871d27eb1a2261962ccc820f" args="" -->APR_POLL_FILE</em> </td><td>
descriptor refers to a file </td></tr>
<tr><td valign="top"><em><a class="anchor" name="gg7c017ccdfddbd53a97b6d3fbde3253de0a5db12ada1f3a3cc9b46dad734b76b5"></a><!-- doxytag: member="APR_POLL_LASTDESC" ref="gg7c017ccdfddbd53a97b6d3fbde3253de0a5db12ada1f3a3cc9b46dad734b76b5" args="" -->APR_POLL_LASTDESC</em> </td><td>
descriptor is the last one in the list </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gafea48f0405cec2b130d53f34ffb9089"></a><!-- doxytag: member="apr_poll.h::apr_poll" ref="gafea48f0405cec2b130d53f34ffb9089" args="(apr_pollfd_t *aprset, apr_int32_t numsock, apr_int32_t *nsds, apr_interval_time_t timeout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">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#g4867ccc083452a265915ac7dfafde457">apr_interval_time_t</a> </td>
<td class="paramname"> <em>timeout</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Poll the descriptors in the poll structure <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aprset</em> </td><td>The poll structure we will be using. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>numsock</em> </td><td>The number of descriptors we are polling </td></tr>
<tr><td valign="top"></td><td valign="top"><em>nsds</em> </td><td>The number of descriptors signalled. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>The amount of time in microseconds to wait. This is a maximum, not a minimum. If a descriptor is signalled, we will wake up before this time. A negative number means wait until a descriptor is signalled. </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></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. <p>
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><p>
<a class="anchor" name="gd30ace9e897a9a0e23e8f5e00befb022"></a><!-- doxytag: member="apr_poll.h::apr_pollset_add" ref="gd30ace9e897a9a0e23e8f5e00befb022" args="(apr_pollset_t *pollset, const apr_pollfd_t *descriptor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> apr_pollset_add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a socket or file descriptor to a pollset <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pollset</em> </td><td>The pollset to which to add the descriptor </td></tr>
<tr><td valign="top"></td><td valign="top"><em>descriptor</em> </td><td>The descriptor to add </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></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#g3cd04119cce9d48a552040fe9178bcff">apr_pollset_poll()</a>. <p>
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#g3cd04119cce9d48a552040fe9178bcff">apr_pollset_poll()</a> for this same pollset that is being modified via <a class="el" href="group__apr__poll.html#gd30ace9e897a9a0e23e8f5e00befb022">apr_pollset_add()</a> in thread T2, the currently executing <a class="el" href="group__apr__poll.html#g3cd04119cce9d48a552040fe9178bcff">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></dl>
</div>
</div><p>
<a class="anchor" name="gb9b82b09e4a92dca78efd903cd9c37c3"></a><!-- doxytag: member="apr_poll.h::apr_pollset_create" ref="gb9b82b09e4a92dca78efd903cd9c37c3" args="(apr_pollset_t **pollset, apr_uint32_t size, apr_pool_t *p, apr_uint32_t flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> apr_pollset_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">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#g06f17a7732f2d04d8ce7010fbb057a8b">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Setup a pollset object <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pollset</em> </td><td>The pointer in which to return the newly created object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>The maximum number of descriptors that this pollset can hold </td></tr>
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>The pool from which to allocate the pollset </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>Optional flags to modify the operation of the pollset.</td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></dt><dd>If flags equals 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#gd30ace9e897a9a0e23e8f5e00befb022">apr_pollset_add()</a>, <a class="el" href="group__apr__poll.html#gc0f1d1190c6b3220700ee274b3b52365">apr_pollset_remove()</a> and <a class="el" href="group__apr__poll.html#g3cd04119cce9d48a552040fe9178bcff">apr_pollset_poll()</a> from separate threads. This feature is only supported on some platforms; the <a class="el" href="group__apr__poll.html#gb9b82b09e4a92dca78efd903cd9c37c3">apr_pollset_create()</a> call will fail with APR_ENOTIMPL on platforms where it is not supported. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gaefd180858994eeb5b05e521a6d234ab"></a><!-- doxytag: member="apr_poll.h::apr_pollset_destroy" ref="gaefd180858994eeb5b05e521a6d234ab" args="(apr_pollset_t *pollset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> apr_pollset_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">apr_pollset_t</a> * </td>
<td class="paramname"> <em>pollset</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroy a pollset object <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pollset</em> </td><td>The pollset to destroy </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g3cd04119cce9d48a552040fe9178bcff"></a><!-- doxytag: member="apr_poll.h::apr_pollset_poll" ref="g3cd04119cce9d48a552040fe9178bcff" args="(apr_pollset_t *pollset, apr_interval_time_t timeout, apr_int32_t *num, const apr_pollfd_t **descriptors)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> apr_pollset_poll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">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#g4867ccc083452a265915ac7dfafde457">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Block for activity on the descriptor(s) in a pollset <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pollset</em> </td><td>The pollset to use </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>Timeout in microseconds </td></tr>
<tr><td valign="top"></td><td valign="top"><em>num</em> </td><td>Number of signalled descriptors (output parameter) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>descriptors</em> </td><td>Array of signalled descriptors (output parameter) </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gc0f1d1190c6b3220700ee274b3b52365"></a><!-- doxytag: member="apr_poll.h::apr_pollset_remove" ref="gc0f1d1190c6b3220700ee274b3b52365" args="(apr_pollset_t *pollset, const apr_pollfd_t *descriptor)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> apr_pollset_remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a descriptor from a pollset <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pollset</em> </td><td>The pollset from which to remove the descriptor </td></tr>
<tr><td valign="top"></td><td valign="top"><em>descriptor</em> </td><td>The descriptor to remove </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></dt><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#g3cd04119cce9d48a552040fe9178bcff">apr_pollset_poll()</a> for this same pollset that is being modified via <a class="el" href="group__apr__poll.html#gc0f1d1190c6b3220700ee274b3b52365">apr_pollset_remove()</a> in thread T2, the currently executing <a class="el" href="group__apr__poll.html#g3cd04119cce9d48a552040fe9178bcff">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></dl>
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Tue May 31 12:20:26 2011 for Apache Portable Runtime by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
