apr_poll.h

Go to the documentation of this file.

/* Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef APR_POLL_H
#define APR_POLL_H

#include "apr.h"
#include "apr_pools.h"
#include "apr_errno.h"
#include "apr_inherit.h" 
#include "apr_file_io.h" 
#include "apr_network_io.h" 

#if APR_HAVE_NETINET_IN_H
#include <netinet/in.h>
#endif

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#define APR_POLLIN    0x001     
#define APR_POLLPRI   0x002     
#define APR_POLLOUT   0x004     
#define APR_POLLERR   0x010     
#define APR_POLLHUP   0x020     
#define APR_POLLNVAL  0x040     
#define APR_POLLSET_THREADSAFE 0x001 
#define APR_POLLSET_NOCOPY     0x002 
#define APR_POLLSET_WAKEABLE   0x004 
#define APR_POLLSET_NODEFAULT  0x010 
typedef enum {
    APR_POLLSET_DEFAULT,        
    APR_POLLSET_SELECT,         
    APR_POLLSET_KQUEUE,         
    APR_POLLSET_PORT,           
    APR_POLLSET_EPOLL,          
    APR_POLLSET_POLL            
} apr_pollset_method_e;

typedef enum { 
    APR_NO_DESC,                
    APR_POLL_SOCKET,            
    APR_POLL_FILE,              
    APR_POLL_LASTDESC           
} apr_datatype_e ;

typedef union {
    apr_file_t *f;              
    apr_socket_t *s;            
} apr_descriptor;

typedef struct apr_pollfd_t apr_pollfd_t;

struct apr_pollfd_t {
    apr_pool_t *p;              
    apr_datatype_e desc_type;   
    apr_int16_t reqevents;      
    apr_int16_t rtnevents;      
    apr_descriptor desc;        
    void *client_data;          
};


/* General-purpose poll API for arbitrarily large numbers of
 * file descriptors
 */

typedef struct apr_pollset_t apr_pollset_t;

APR_DECLARE(apr_status_t) apr_pollset_create(apr_pollset_t **pollset,
                                             apr_uint32_t size,
                                             apr_pool_t *p,
                                             apr_uint32_t flags);

APR_DECLARE(apr_status_t) apr_pollset_create_ex(apr_pollset_t **pollset,
                                                apr_uint32_t size,
                                                apr_pool_t *p,
                                                apr_uint32_t flags,
                                                apr_pollset_method_e method);

APR_DECLARE(apr_status_t) apr_pollset_destroy(apr_pollset_t *pollset);

APR_DECLARE(apr_status_t) apr_pollset_add(apr_pollset_t *pollset,
                                          const apr_pollfd_t *descriptor);

APR_DECLARE(apr_status_t) apr_pollset_remove(apr_pollset_t *pollset,
                                             const apr_pollfd_t *descriptor);

APR_DECLARE(apr_status_t) apr_pollset_poll(apr_pollset_t *pollset,
                                           apr_interval_time_t timeout,
                                           apr_int32_t *num,
                                           const apr_pollfd_t **descriptors);

APR_DECLARE(apr_status_t) apr_pollset_wakeup(apr_pollset_t *pollset);

APR_DECLARE(apr_status_t) apr_poll(apr_pollfd_t *aprset, apr_int32_t numsock,
                                   apr_int32_t *nsds, 
                                   apr_interval_time_t timeout);

APR_DECLARE(const char *) apr_pollset_method_name(apr_pollset_t *pollset);

APR_DECLARE(const char *) apr_poll_method_defname(void);

typedef struct apr_pollcb_t apr_pollcb_t;

APR_DECLARE(apr_status_t) apr_pollcb_create(apr_pollcb_t **pollcb,
                                            apr_uint32_t size,
                                            apr_pool_t *p,
                                            apr_uint32_t flags);

APR_DECLARE(apr_status_t) apr_pollcb_create_ex(apr_pollcb_t **pollcb,
                                               apr_uint32_t size,
                                               apr_pool_t *p,
                                               apr_uint32_t flags,
                                               apr_pollset_method_e method);

APR_DECLARE(apr_status_t) apr_pollcb_add(apr_pollcb_t *pollcb,
                                         apr_pollfd_t *descriptor);
APR_DECLARE(apr_status_t) apr_pollcb_remove(apr_pollcb_t *pollcb,
                                            apr_pollfd_t *descriptor);

typedef apr_status_t (*apr_pollcb_cb_t)(void *baton, apr_pollfd_t *descriptor);

APR_DECLARE(apr_status_t) apr_pollcb_poll(apr_pollcb_t *pollcb,
                                          apr_interval_time_t timeout,
                                          apr_pollcb_cb_t func,
                                          void *baton); 

#ifdef __cplusplus
}
#endif

#endif  /* ! APR_POLL_H */