<!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: apr_poll.h Source File</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 id="current"><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>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<h1>apr_poll.h</h1><a href="apr__poll_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Copyright 2000-2005 The Apache Software Foundation or its licensors, as</span>
<a name="l00002"></a>00002 <span class="comment"> * applicable.</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span>
<a name="l00005"></a>00005 <span class="comment"> * you may not use this file except in compliance with the License.</span>
<a name="l00006"></a>00006 <span class="comment"> * You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment"> *</span>
<a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"> */</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef APR_POLL_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_POLL_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00020"></a>00020 <span class="comment"> * @file apr_poll.h</span>
<a name="l00021"></a>00021 <span class="comment"> * @brief APR Poll interface</span>
<a name="l00022"></a>00022 <span class="comment"> */</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="apr_8h.html">apr.h</a>"</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html">apr_pools.h</a>"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html">apr_errno.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="apr__inherit_8h.html">apr_inherit.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="apr__file__io_8h.html">apr_file_io.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="apr__network__io_8h.html">apr_network_io.h</a>"</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="preprocessor">#if APR_HAVE_NETINET_IN_H</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#include <netinet/in.h></span>
<a name="l00032"></a>00032 <span class="preprocessor">#endif</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span>
<a name="l00034"></a>00034 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00036"></a>00036 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/**</span>
<a name="l00039"></a>00039 <span class="comment"> * @defgroup apr_poll Poll Routines</span>
<a name="l00040"></a>00040 <span class="comment"> * @ingroup APR </span>
<a name="l00041"></a>00041 <span class="comment"> * @{</span>
<a name="l00042"></a>00042 <span class="comment"> */</span>
<a name="l00043"></a>00043 <span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment">/**</span>
<a name="l00045"></a>00045 <span class="comment"> * Poll options</span>
<a name="l00046"></a>00046 <span class="comment"> */</span>
<a name="l00047"></a><a class="code" href="group__apr__poll.html#g3c2885c10b586c3385b468ec28522168">00047</a> <span class="preprocessor">#define APR_POLLIN 0x001 </span><span class="comment">/**< Can read without blocking */</span>
<a name="l00048"></a><a class="code" href="group__apr__poll.html#ga3b72f6cc9972590a473c139140a39f3">00048</a> <span class="preprocessor">#define APR_POLLPRI 0x002 </span><span class="comment">/**< Priority data available */</span>
<a name="l00049"></a><a class="code" href="group__apr__poll.html#g8c1e12da0f397805eb3984fa33ebfd82">00049</a> <span class="preprocessor">#define APR_POLLOUT 0x004 </span><span class="comment">/**< Can write without blocking */</span>
<a name="l00050"></a><a class="code" href="group__apr__poll.html#gc0fd9c11abeaeca30f34177f440d0f97">00050</a> <span class="preprocessor">#define APR_POLLERR 0x010 </span><span class="comment">/**< Pending error */</span>
<a name="l00051"></a><a class="code" href="group__apr__poll.html#g79359c036fb7960efb48c2d763444113">00051</a> <span class="preprocessor">#define APR_POLLHUP 0x020 </span><span class="comment">/**< Hangup occurred */</span>
<a name="l00052"></a><a class="code" href="group__apr__poll.html#g52736590e42dfa626569290d11984a89">00052</a> <span class="preprocessor">#define APR_POLLNVAL 0x040 </span><span class="comment">/**< Descriptior invalid */</span>
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment">/**</span>
<a name="l00055"></a>00055 <span class="comment"> * Pollset Flags</span>
<a name="l00056"></a>00056 <span class="comment"> */</span>
<a name="l00057"></a><a class="code" href="group__apr__poll.html#gf72e5668d63a2f4ba346b580f9d43c09">00057</a> <span class="preprocessor">#define APR_POLLSET_THREADSAFE 0x001 </span><span class="comment">/**< Adding or Removing a Descriptor is thread safe */</span>
<a name="l00058"></a>00058 <span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment">/** Used in apr_pollfd_t to determine what the apr_descriptor is */</span>
<a name="l00060"></a><a class="code" href="group__apr__poll.html#g7c017ccdfddbd53a97b6d3fbde3253de">00060</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00061"></a>00061 <a class="code" href="group__apr__poll.html#gg7c017ccdfddbd53a97b6d3fbde3253ded4671734bde9f6dff6818c2d456e04c5">APR_NO_DESC</a>, <span class="comment">/**< nothing here */</span>
<a name="l00062"></a>00062 <a class="code" href="group__apr__poll.html#gg7c017ccdfddbd53a97b6d3fbde3253de06bdea788e31c230025bcb1d60ddd601">APR_POLL_SOCKET</a>, <span class="comment">/**< descriptor refers to a socket */</span>
<a name="l00063"></a>00063 <a class="code" href="group__apr__poll.html#gg7c017ccdfddbd53a97b6d3fbde3253dee42217f4871d27eb1a2261962ccc820f">APR_POLL_FILE</a>, <span class="comment">/**< descriptor refers to a file */</span>
<a name="l00064"></a><a class="code" href="group__apr__poll.html#gg7c017ccdfddbd53a97b6d3fbde3253de0a5db12ada1f3a3cc9b46dad734b76b5">00064</a> <a class="code" href="group__apr__poll.html#gg7c017ccdfddbd53a97b6d3fbde3253de0a5db12ada1f3a3cc9b46dad734b76b5">APR_POLL_LASTDESC</a> <span class="comment">/**< descriptor is the last one in the list */</span>
<a name="l00065"></a>00065 } <a class="code" href="group__apr__poll.html#g7c017ccdfddbd53a97b6d3fbde3253de">apr_datatype_e</a> ;
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment">/** Union of either an APR file or socket. */</span>
<a name="l00068"></a><a class="code" href="unionapr__descriptor.html">00068</a> <span class="keyword">typedef</span> <span class="keyword">union </span>{
<a name="l00069"></a><a class="code" href="unionapr__descriptor.html#e4e64a1ebf3ec9de68febc07d3f535a7">00069</a> <a class="code" href="group__apr__file__io.html#g804ab64a6f58ddcc3da8d9f54b6f51c2">apr_file_t</a> *f; <span class="comment">/**< file */</span>
<a name="l00070"></a><a class="code" href="unionapr__descriptor.html#6093cf2078d24166985ea197d3232149">00070</a> <a class="code" href="group__apr__network__io.html#gc6c71c07bdd54fd756f6bee50ae9e6ad">apr_socket_t</a> *s; <span class="comment">/**< socket */</span>
<a name="l00071"></a>00071 } <a class="code" href="unionapr__descriptor.html">apr_descriptor</a>;
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a>00073 <span class="comment">/** @see apr_pollfd_t */</span>
<a name="l00074"></a><a class="code" href="group__apr__poll.html#g74f2a2078a80a7be834fab746ffe2e30">00074</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structapr__pollfd__t.html">apr_pollfd_t</a> <a class="code" href="group__apr__poll.html#g74f2a2078a80a7be834fab746ffe2e30">apr_pollfd_t</a>;
<a name="l00075"></a>00075 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment">/** Poll descriptor set. */</span>
<a name="l00077"></a><a class="code" href="structapr__pollfd__t.html">00077</a> <span class="keyword">struct </span><a class="code" href="group__apr__poll.html#g74f2a2078a80a7be834fab746ffe2e30">apr_pollfd_t</a> {
<a name="l00078"></a><a class="code" href="structapr__pollfd__t.html#b0311d6809e0dbd96285dc14435704d1">00078</a> <a class="code" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *<a class="code" href="structapr__pollfd__t.html#b0311d6809e0dbd96285dc14435704d1">p</a>; <span class="comment">/**< associated pool */</span>
<a name="l00079"></a><a class="code" href="structapr__pollfd__t.html#36d24908785c762ea55d8c253b3a04ae">00079</a> apr_datatype_e <a class="code" href="structapr__pollfd__t.html#36d24908785c762ea55d8c253b3a04ae">desc_type</a>; <span class="comment">/**< descriptor type */</span>
<a name="l00080"></a><a class="code" href="structapr__pollfd__t.html#81dd55619146c4306a8adf1ab204f7c4">00080</a> apr_int16_t <a class="code" href="structapr__pollfd__t.html#81dd55619146c4306a8adf1ab204f7c4">reqevents</a>; <span class="comment">/**< requested events */</span>
<a name="l00081"></a><a class="code" href="structapr__pollfd__t.html#fac93b3eb7a33ecb8a0e75aa0cf3ec45">00081</a> apr_int16_t <a class="code" href="structapr__pollfd__t.html#fac93b3eb7a33ecb8a0e75aa0cf3ec45">rtnevents</a>; <span class="comment">/**< returned events */</span>
<a name="l00082"></a><a class="code" href="structapr__pollfd__t.html#3c72a25271b3bd5e1775f5ad39816fea">00082</a> <a class="code" href="unionapr__descriptor.html">apr_descriptor</a> <a class="code" href="structapr__pollfd__t.html#3c72a25271b3bd5e1775f5ad39816fea">desc</a>; <span class="comment">/**< @see apr_descriptor */</span>
<a name="l00083"></a><a class="code" href="structapr__pollfd__t.html#b00ac1859ae9f37bad8b0325302afc9c">00083</a> <span class="keywordtype">void</span> *<a class="code" href="structapr__pollfd__t.html#b00ac1859ae9f37bad8b0325302afc9c">client_data</a>; <span class="comment">/**< allows app to associate context */</span>
<a name="l00084"></a>00084 };
<a name="l00085"></a>00085
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="comment">/* General-purpose poll API for arbitrarily large numbers of</span>
<a name="l00088"></a>00088 <span class="comment"> * file descriptors</span>
<a name="l00089"></a>00089 <span class="comment"> */</span>
<a name="l00090"></a>00090 <span class="comment"></span>
<a name="l00091"></a>00091 <span class="comment">/** Opaque structure used for pollset API */</span>
<a name="l00092"></a><a class="code" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">00092</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__apr__poll.html#g3f81be7d929391f76d1c87a463ce2226">apr_pollset_t</a> apr_pollset_t;
<a name="l00093"></a>00093 <span class="comment"></span>
<a name="l00094"></a>00094 <span class="comment">/**</span>
<a name="l00095"></a>00095 <span class="comment"> * Setup a pollset object</span>
<a name="l00096"></a>00096 <span class="comment"> * @param pollset The pointer in which to return the newly created object </span>
<a name="l00097"></a>00097 <span class="comment"> * @param size The maximum number of descriptors that this pollset can hold</span>
<a name="l00098"></a>00098 <span class="comment"> * @param p The pool from which to allocate the pollset</span>
<a name="l00099"></a>00099 <span class="comment"> * @param flags Optional flags to modify the operation of the pollset.</span>
<a name="l00100"></a>00100 <span class="comment"> *</span>
<a name="l00101"></a>00101 <span class="comment"> * @remark If flags equals APR_POLLSET_THREADSAFE, then a pollset is</span>
<a name="l00102"></a>00102 <span class="comment"> * created on which it is safe to make concurrent calls to</span>
<a name="l00103"></a>00103 <span class="comment"> * apr_pollset_add(), apr_pollset_remove() and apr_pollset_poll() from</span>
<a name="l00104"></a>00104 <span class="comment"> * separate threads. This feature is only supported on some</span>
<a name="l00105"></a>00105 <span class="comment"> * platforms; the apr_pollset_create() call will fail with</span>
<a name="l00106"></a>00106 <span class="comment"> * APR_ENOTIMPL on platforms where it is not supported.</span>
<a name="l00107"></a>00107 <span class="comment"> */</span>
<a name="l00108"></a>00108 <a class="code" href="group__apr__platform.html#g4a5cbc739c4e19ab450020163d0899d4">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>) <a class="code" href="group__apr__poll.html#gb9b82b09e4a92dca78efd903cd9c37c3">apr_pollset_create</a>(apr_pollset_t **pollset,
<a name="l00109"></a>00109 apr_uint32_t size,
<a name="l00110"></a>00110 <a class="code" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p,
<a name="l00111"></a>00111 apr_uint32_t flags);
<a name="l00112"></a>00112 <span class="comment"></span>
<a name="l00113"></a>00113 <span class="comment">/**</span>
<a name="l00114"></a>00114 <span class="comment"> * Destroy a pollset object</span>
<a name="l00115"></a>00115 <span class="comment"> * @param pollset The pollset to destroy</span>
<a name="l00116"></a>00116 <span class="comment"> */</span>
<a name="l00117"></a>00117 <a class="code" href="group__apr__platform.html#g4a5cbc739c4e19ab450020163d0899d4">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>) <a class="code" href="group__apr__poll.html#gaefd180858994eeb5b05e521a6d234ab">apr_pollset_destroy</a>(apr_pollset_t *pollset);
<a name="l00118"></a>00118 <span class="comment"></span>
<a name="l00119"></a>00119 <span class="comment">/**</span>
<a name="l00120"></a>00120 <span class="comment"> * Add a socket or file descriptor to a pollset</span>
<a name="l00121"></a>00121 <span class="comment"> * @param pollset The pollset to which to add the descriptor</span>
<a name="l00122"></a>00122 <span class="comment"> * @param descriptor The descriptor to add</span>
<a name="l00123"></a>00123 <span class="comment"> * @remark If you set client_data in the descriptor, that value</span>
<a name="l00124"></a>00124 <span class="comment"> * will be returned in the client_data field whenever this</span>
<a name="l00125"></a>00125 <span class="comment"> * descriptor is signalled in apr_pollset_poll().</span>
<a name="l00126"></a>00126 <span class="comment"> * @remark If the pollset has been created with APR_POLLSET_THREADSAFE</span>
<a name="l00127"></a>00127 <span class="comment"> * and thread T1 is blocked in a call to apr_pollset_poll() for</span>
<a name="l00128"></a>00128 <span class="comment"> * this same pollset that is being modified via apr_pollset_add()</span>
<a name="l00129"></a>00129 <span class="comment"> * in thread T2, the currently executing apr_pollset_poll() call in</span>
<a name="l00130"></a>00130 <span class="comment"> * T1 will either: (1) automatically include the newly added descriptor</span>
<a name="l00131"></a>00131 <span class="comment"> * in the set of descriptors it is watching or (2) return immediately</span>
<a name="l00132"></a>00132 <span class="comment"> * with APR_EINTR. Option (1) is recommended, but option (2) is</span>
<a name="l00133"></a>00133 <span class="comment"> * allowed for implementations where option (1) is impossible</span>
<a name="l00134"></a>00134 <span class="comment"> * or impractical.</span>
<a name="l00135"></a>00135 <span class="comment"> */</span>
<a name="l00136"></a>00136 <a class="code" href="group__apr__platform.html#g4a5cbc739c4e19ab450020163d0899d4">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>) <a class="code" href="group__apr__poll.html#gd30ace9e897a9a0e23e8f5e00befb022">apr_pollset_add</a>(apr_pollset_t *pollset,
<a name="l00137"></a>00137 const <a class="code" href="group__apr__poll.html#g74f2a2078a80a7be834fab746ffe2e30">apr_pollfd_t</a> *descriptor);
<a name="l00138"></a>00138 <span class="comment"></span>
<a name="l00139"></a>00139 <span class="comment">/**</span>
<a name="l00140"></a>00140 <span class="comment"> * Remove a descriptor from a pollset</span>
<a name="l00141"></a>00141 <span class="comment"> * @param pollset The pollset from which to remove the descriptor</span>
<a name="l00142"></a>00142 <span class="comment"> * @param descriptor The descriptor to remove</span>
<a name="l00143"></a>00143 <span class="comment"> * @remark If the pollset has been created with APR_POLLSET_THREADSAFE</span>
<a name="l00144"></a>00144 <span class="comment"> * and thread T1 is blocked in a call to apr_pollset_poll() for</span>
<a name="l00145"></a>00145 <span class="comment"> * this same pollset that is being modified via apr_pollset_remove()</span>
<a name="l00146"></a>00146 <span class="comment"> * in thread T2, the currently executing apr_pollset_poll() call in</span>
<a name="l00147"></a>00147 <span class="comment"> * T1 will either: (1) automatically exclude the newly added descriptor</span>
<a name="l00148"></a>00148 <span class="comment"> * in the set of descriptors it is watching or (2) return immediately</span>
<a name="l00149"></a>00149 <span class="comment"> * with APR_EINTR. Option (1) is recommended, but option (2) is</span>
<a name="l00150"></a>00150 <span class="comment"> * allowed for implementations where option (1) is impossible</span>
<a name="l00151"></a>00151 <span class="comment"> * or impractical.</span>
<a name="l00152"></a>00152 <span class="comment"> */</span>
<a name="l00153"></a>00153 <a class="code" href="group__apr__platform.html#g4a5cbc739c4e19ab450020163d0899d4">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>) <a class="code" href="group__apr__poll.html#gc0f1d1190c6b3220700ee274b3b52365">apr_pollset_remove</a>(apr_pollset_t *pollset,
<a name="l00154"></a>00154 const <a class="code" href="group__apr__poll.html#g74f2a2078a80a7be834fab746ffe2e30">apr_pollfd_t</a> *descriptor);
<a name="l00155"></a>00155 <span class="comment"></span>
<a name="l00156"></a>00156 <span class="comment">/**</span>
<a name="l00157"></a>00157 <span class="comment"> * Block for activity on the descriptor(s) in a pollset</span>
<a name="l00158"></a>00158 <span class="comment"> * @param pollset The pollset to use</span>
<a name="l00159"></a>00159 <span class="comment"> * @param timeout Timeout in microseconds</span>
<a name="l00160"></a>00160 <span class="comment"> * @param num Number of signalled descriptors (output parameter)</span>
<a name="l00161"></a>00161 <span class="comment"> * @param descriptors Array of signalled descriptors (output parameter)</span>
<a name="l00162"></a>00162 <span class="comment"> */</span>
<a name="l00163"></a>00163 <a class="code" href="group__apr__platform.html#g4a5cbc739c4e19ab450020163d0899d4">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>) <a class="code" href="group__apr__poll.html#g3cd04119cce9d48a552040fe9178bcff">apr_pollset_poll</a>(apr_pollset_t *pollset,
<a name="l00164"></a>00164 <a class="code" href="group__apr__time.html#g4867ccc083452a265915ac7dfafde457">apr_interval_time_t</a> timeout,
<a name="l00165"></a>00165 apr_int32_t *num,
<a name="l00166"></a>00166 const <a class="code" href="group__apr__poll.html#g74f2a2078a80a7be834fab746ffe2e30">apr_pollfd_t</a> **descriptors);
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="comment"></span>
<a name="l00169"></a>00169 <span class="comment">/**</span>
<a name="l00170"></a>00170 <span class="comment"> * Poll the descriptors in the poll structure</span>
<a name="l00171"></a>00171 <span class="comment"> * @param aprset The poll structure we will be using. </span>
<a name="l00172"></a>00172 <span class="comment"> * @param numsock The number of descriptors we are polling</span>
<a name="l00173"></a>00173 <span class="comment"> * @param nsds The number of descriptors signalled.</span>
<a name="l00174"></a>00174 <span class="comment"> * @param timeout The amount of time in microseconds to wait. This is </span>
<a name="l00175"></a>00175 <span class="comment"> * a maximum, not a minimum. If a descriptor is signalled, we </span>
<a name="l00176"></a>00176 <span class="comment"> * will wake up before this time. A negative number means </span>
<a name="l00177"></a>00177 <span class="comment"> * wait until a descriptor is signalled.</span>
<a name="l00178"></a>00178 <span class="comment"> * @remark The number of descriptors signalled is returned in the third argument. </span>
<a name="l00179"></a>00179 <span class="comment"> * This is a blocking call, and it will not return until either a </span>
<a name="l00180"></a>00180 <span class="comment"> * descriptor has been signalled, or the timeout has expired. </span>
<a name="l00181"></a>00181 <span class="comment"> * @remark The rtnevents field in the apr_pollfd_t array will only be filled-</span>
<a name="l00182"></a>00182 <span class="comment"> * in if the return value is APR_SUCCESS.</span>
<a name="l00183"></a>00183 <span class="comment"> */</span>
<a name="l00184"></a>00184 <a class="code" href="group__apr__platform.html#g4a5cbc739c4e19ab450020163d0899d4">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>) <a class="code" href="group__apr__poll.html#gafea48f0405cec2b130d53f34ffb9089">apr_poll</a>(<a class="code" href="group__apr__poll.html#g74f2a2078a80a7be834fab746ffe2e30">apr_pollfd_t</a> *aprset, apr_int32_t numsock,
<a name="l00185"></a>00185 apr_int32_t *nsds,
<a name="l00186"></a>00186 <a class="code" href="group__apr__time.html#g4867ccc083452a265915ac7dfafde457">apr_interval_time_t</a> timeout);
<a name="l00187"></a>00187 <span class="comment"></span>
<a name="l00188"></a>00188 <span class="comment">/** @} */</span>
<a name="l00189"></a>00189
<a name="l00190"></a>00190
<a name="l00191"></a>00191 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00192"></a>00192 <span class="preprocessor"></span>}
<a name="l00193"></a>00193 <span class="preprocessor">#endif</span>
<a name="l00194"></a>00194 <span class="preprocessor"></span>
<a name="l00195"></a>00195 <span class="preprocessor">#endif </span><span class="comment">/* ! APR_POLL_H */</span>
<a name="l00196"></a>00196
</pre></div><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>
