Return-Path: Delivered-To: apmail-apr-commits-archive@www.apache.org Received: (qmail 82061 invoked from network); 6 Jan 2010 20:26:34 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3) by minotaur.apache.org with SMTP; 6 Jan 2010 20:26:34 -0000 Received: (qmail 34196 invoked by uid 500); 6 Jan 2010 20:26:34 -0000 Delivered-To: apmail-apr-commits-archive@apr.apache.org Received: (qmail 34127 invoked by uid 500); 6 Jan 2010 20:26:34 -0000 Mailing-List: contact commits-help@apr.apache.org; run by ezmlm Precedence: bulk List-Post: List-Help: List-Unsubscribe: Reply-To: dev@apr.apache.org List-Id: Delivered-To: mailing list commits@apr.apache.org Received: (qmail 34118 invoked by uid 99); 6 Jan 2010 20:26:33 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 06 Jan 2010 20:26:33 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 06 Jan 2010 20:26:33 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 3549123889CB; Wed, 6 Jan 2010 20:26:13 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r896655 - /apr/apr/branches/1.4.x/include/apr_poll.h Date: Wed, 06 Jan 2010 20:26:05 -0000 To: commits@apr.apache.org From: minfrin@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20100106202613.3549123889CB@eris.apache.org> Author: minfrin Date: Wed Jan 6 20:25:59 2010 New Revision: 896655 URL: http://svn.apache.org/viewvc?rev=896655&view=rev Log: Document the difference in behaviour between select and the other providers in the poll interface. Submitted by: Neil Conway Modified: apr/apr/branches/1.4.x/include/apr_poll.h Modified: apr/apr/branches/1.4.x/include/apr_poll.h URL: http://svn.apache.org/viewvc/apr/apr/branches/1.4.x/include/apr_poll.h?rev=896655&r1=896654&r2=896655&view=diff ============================================================================== --- apr/apr/branches/1.4.x/include/apr_poll.h (original) +++ apr/apr/branches/1.4.x/include/apr_poll.h Wed Jan 6 20:25:59 2010 @@ -74,10 +74,10 @@ typedef enum { APR_POLLSET_DEFAULT, /**< Platform default poll method */ APR_POLLSET_SELECT, /**< Poll uses select method */ - APR_POLLSET_KQUEUE, - APR_POLLSET_PORT, - APR_POLLSET_EPOLL, - APR_POLLSET_POLL + APR_POLLSET_KQUEUE, /**< Poll uses kqueue method */ + APR_POLLSET_PORT, /**< Poll uses Solaris event port method */ + APR_POLLSET_EPOLL, /**< Poll uses epoll method */ + APR_POLLSET_POLL /**< Poll uses poll method */ } apr_pollset_method_e; /** Used in apr_pollfd_t to determine what the apr_descriptor is */ @@ -137,6 +137,12 @@ * @remark If flags contains APR_POLLSET_NOCOPY, then the apr_pollfd_t * structures passed to apr_pollset_add() are not copied and * must have a lifetime at least as long as the pollset. + * @remark 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 + * apr_pollset_poll(). */ APR_DECLARE(apr_status_t) apr_pollset_create(apr_pollset_t **pollset, apr_uint32_t size, @@ -149,7 +155,7 @@ * @param size The maximum number of descriptors that this pollset can hold * @param p The pool from which to allocate the pollset * @param flags Optional flags to modify the operation of the pollset. - * @param method Poll method to use. See @apr_pollset_method_e. If this + * @param method Poll method to use. See #apr_pollset_method_e. If this * method cannot be used, the default method will be used unless the * APR_POLLSET_NODEFAULT flag has been specified. * @@ -168,6 +174,12 @@ * @remark If flags contains APR_POLLSET_NOCOPY, then the apr_pollfd_t * structures passed to apr_pollset_add() are not copied and * must have a lifetime at least as long as the pollset. + * @remark 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 + * apr_pollset_poll(). */ APR_DECLARE(apr_status_t) apr_pollset_create_ex(apr_pollset_t **pollset, apr_uint32_t size, @@ -308,7 +320,7 @@ */ APR_DECLARE(apr_status_t) apr_pollcb_create(apr_pollcb_t **pollcb, apr_uint32_t size, - apr_pool_t *pool, + apr_pool_t *p, apr_uint32_t flags); /** @@ -317,7 +329,7 @@ * @param size The maximum number of descriptors that a single _poll can return. * @param p The pool from which to allocate the pollcb * @param flags Optional flags to modify the operation of the pollcb. - * @param method Poll method to use. See @apr_pollset_method_e. If this + * @param method Poll method to use. See #apr_pollset_method_e. If this * method cannot be used, the default method will be used unless the * APR_POLLSET_NODEFAULT flag has been specified. * @@ -326,7 +338,7 @@ */ APR_DECLARE(apr_status_t) apr_pollcb_create_ex(apr_pollcb_t **pollcb, apr_uint32_t size, - apr_pool_t *pool, + apr_pool_t *p, apr_uint32_t flags, apr_pollset_method_e method); @@ -361,7 +373,7 @@ apr_pollfd_t *descriptor); /** Function prototype for pollcb handlers - * @param baton Opaque baton passed into apr_pollcb_poll + * @param baton Opaque baton passed into apr_pollcb_poll() * @param descriptor Contains the notification for an active descriptor, * the rtnevents member contains what events were triggered * for this descriptor.