ioqueue.h

Go to the documentation of this file.

/*
 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef __PJ_IOQUEUE_H__
#define __PJ_IOQUEUE_H__
 
#include <pj/types.h>
 
PJ_BEGIN_DECL
 
typedef struct pj_ioqueue_op_key_t
{
    void *internal__[32];           
    void *activesock_data;          
    void *user_data;                
} pj_ioqueue_op_key_t;
 
typedef struct pj_ioqueue_callback
{
    void (*on_read_complete)(pj_ioqueue_key_t *key,
                             pj_ioqueue_op_key_t *op_key,
                             pj_ssize_t bytes_read);
 
    void (*on_write_complete)(pj_ioqueue_key_t *key,
                              pj_ioqueue_op_key_t *op_key,
                              pj_ssize_t bytes_sent);
 
    void (*on_accept_complete)(pj_ioqueue_key_t *key,
                               pj_ioqueue_op_key_t *op_key,
                               pj_sock_t sock,
                               pj_status_t status);
 
    void (*on_connect_complete)(pj_ioqueue_key_t *key,
                                pj_status_t status);
} pj_ioqueue_callback;
 
 
typedef enum pj_ioqueue_operation_e
{
    PJ_IOQUEUE_OP_NONE          = 0,    
    PJ_IOQUEUE_OP_READ          = 1,    
    PJ_IOQUEUE_OP_RECV          = 2,    
    PJ_IOQUEUE_OP_RECV_FROM     = 4,    
    PJ_IOQUEUE_OP_WRITE         = 8,    
    PJ_IOQUEUE_OP_SEND          = 16,   
    PJ_IOQUEUE_OP_SEND_TO       = 32,   
#if defined(PJ_HAS_TCP) && PJ_HAS_TCP != 0
    PJ_IOQUEUE_OP_ACCEPT        = 64,   
    PJ_IOQUEUE_OP_CONNECT       = 128   
#endif  /* PJ_HAS_TCP */
} pj_ioqueue_operation_e;
 
 
#ifndef PJ_IOQUEUE_MAX_EVENTS_IN_SINGLE_POLL
#   define PJ_IOQUEUE_MAX_EVENTS_IN_SINGLE_POLL     (16)
#endif
 
 
#if !defined(PJ_IOQUEUE_MAX_CAND_EVENTS) || \
    PJ_IOQUEUE_MAX_CAND_EVENTS < PJ_IOQUEUE_MAX_EVENTS_IN_SINGLE_POLL
#   undef  PJ_IOQUEUE_MAX_CAND_EVENTS
#   define PJ_IOQUEUE_MAX_CAND_EVENTS   PJ_IOQUEUE_MAX_EVENTS_IN_SINGLE_POLL
#endif
 
 
#define PJ_IOQUEUE_ALWAYS_ASYNC     ((pj_uint32_t)1 << (pj_uint32_t)31)
 
 
typedef enum pj_ioqueue_epoll_flag
{
    PJ_IOQUEUE_EPOLL_EXCLUSIVE = 1,
 
    PJ_IOQUEUE_EPOLL_ONESHOT   = 2,
 
    PJ_IOQUEUE_EPOLL_AUTO      = PJ_IOQUEUE_EPOLL_EXCLUSIVE |
                                 PJ_IOQUEUE_EPOLL_ONESHOT,
 
} pj_ioqueue_epoll_flag;
 
 
typedef struct pj_ioqueue_cfg
{
    unsigned  epoll_flags;
 
    pj_bool_t default_concurrency;
 
} pj_ioqueue_cfg;
 
 
PJ_DECL(void) pj_ioqueue_cfg_default(pj_ioqueue_cfg *cfg);
 
 
PJ_DECL(const char*) pj_ioqueue_name(void);
 
 
PJ_DECL(pj_status_t) pj_ioqueue_create( pj_pool_t *pool,
                                        pj_size_t max_fd,
                                        pj_ioqueue_t **ioqueue);
 
PJ_DECL(pj_status_t) pj_ioqueue_create2( pj_pool_t *pool,
                                         pj_size_t max_fd,
                                         const pj_ioqueue_cfg *cfg,
                                         pj_ioqueue_t **ioqueue);
 
PJ_DECL(pj_status_t) pj_ioqueue_destroy( pj_ioqueue_t *ioque );
 
PJ_DECL(pj_status_t) pj_ioqueue_set_lock( pj_ioqueue_t *ioque,
                                          pj_lock_t *lock,
                                          pj_bool_t auto_delete );
 
PJ_DECL(pj_status_t) pj_ioqueue_set_default_concurrency(pj_ioqueue_t *ioqueue,
                                                        pj_bool_t allow);
 
PJ_DECL(pj_status_t) pj_ioqueue_register_sock( pj_pool_t *pool,
                                               pj_ioqueue_t *ioque,
                                               pj_sock_t sock,
                                               void *user_data,
                                               const pj_ioqueue_callback *cb,
                                               pj_ioqueue_key_t **key );
 
PJ_DECL(pj_status_t) pj_ioqueue_register_sock2(pj_pool_t *pool,
                                               pj_ioqueue_t *ioque,
                                               pj_sock_t sock,
                                               pj_grp_lock_t *grp_lock,
                                               void *user_data,
                                               const pj_ioqueue_callback *cb,
                                               pj_ioqueue_key_t **key );
 
PJ_DECL(pj_status_t) pj_ioqueue_unregister( pj_ioqueue_key_t *key );
 
 
PJ_DECL(void*) pj_ioqueue_get_user_data( pj_ioqueue_key_t *key );
 
PJ_DECL(pj_status_t) pj_ioqueue_set_user_data( pj_ioqueue_key_t *key,
                                               void *user_data,
                                               void **old_data);
 
PJ_DECL(pj_status_t) pj_ioqueue_set_concurrency(pj_ioqueue_key_t *key,
                                                pj_bool_t allow);
 
PJ_DECL(pj_status_t) pj_ioqueue_lock_key(pj_ioqueue_key_t *key);
 
PJ_DECL(pj_status_t) pj_ioqueue_trylock_key(pj_ioqueue_key_t *key);
 
PJ_DECL(pj_status_t) pj_ioqueue_unlock_key(pj_ioqueue_key_t *key);
 
PJ_DECL(void) pj_ioqueue_op_key_init( pj_ioqueue_op_key_t *op_key,
                                      pj_size_t size );
 
PJ_DECL(pj_bool_t) pj_ioqueue_is_pending( pj_ioqueue_key_t *key,
                                          pj_ioqueue_op_key_t *op_key );
 
 
PJ_DECL(pj_status_t) pj_ioqueue_post_completion( pj_ioqueue_key_t *key,
                                                 pj_ioqueue_op_key_t *op_key,
                                                 pj_ssize_t bytes_status );
 
 
PJ_DECL(pj_status_t) pj_ioqueue_clear_key( pj_ioqueue_key_t *key );
 
 
 
#if defined(PJ_HAS_TCP) && PJ_HAS_TCP != 0
PJ_DECL(pj_status_t) pj_ioqueue_accept( pj_ioqueue_key_t *key,
                                        pj_ioqueue_op_key_t *op_key,
                                        pj_sock_t *new_sock,
                                        pj_sockaddr_t *local,
                                        pj_sockaddr_t *remote,
                                        int *addrlen );
 
PJ_DECL(pj_status_t) pj_ioqueue_connect( pj_ioqueue_key_t *key,
                                         const pj_sockaddr_t *addr,
                                         int addrlen );
 
#endif  /* PJ_HAS_TCP */
 
PJ_DECL(int) pj_ioqueue_poll( pj_ioqueue_t *ioque,
                              const pj_time_val *timeout);
 
 
PJ_DECL(pj_status_t) pj_ioqueue_recv( pj_ioqueue_key_t *key,
                                      pj_ioqueue_op_key_t *op_key,
                                      void *buffer,
                                      pj_ssize_t *length,
                                      pj_uint32_t flags );
 
PJ_DECL(pj_status_t) pj_ioqueue_recvfrom( pj_ioqueue_key_t *key,
                                          pj_ioqueue_op_key_t *op_key,
                                          void *buffer,
                                          pj_ssize_t *length,
                                          pj_uint32_t flags,
                                          pj_sockaddr_t *addr,
                                          int *addrlen);
 
PJ_DECL(pj_status_t) pj_ioqueue_send( pj_ioqueue_key_t *key,
                                      pj_ioqueue_op_key_t *op_key,
                                      const void *data,
                                      pj_ssize_t *length,
                                      pj_uint32_t flags );
 
 
PJ_DECL(pj_status_t) pj_ioqueue_sendto( pj_ioqueue_key_t *key,
                                        pj_ioqueue_op_key_t *op_key,
                                        const void *data,
                                        pj_ssize_t *length,
                                        pj_uint32_t flags,
                                        const pj_sockaddr_t *addr,
                                        int addrlen);
 
 
PJ_END_DECL
 
#endif  /* __PJ_IOQUEUE_H__ */