activesock.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_ASYNCSOCK_H__
#define __PJ_ASYNCSOCK_H__
 
#include <pj/ioqueue.h>
#include <pj/sock.h>
 
 
PJ_BEGIN_DECL
 
typedef struct pj_activesock_t pj_activesock_t;
 
typedef struct pj_activesock_cb
{
    pj_bool_t (*on_data_read)(pj_activesock_t *asock,
                              void *data,
                              pj_size_t size,
                              pj_status_t status,
                              pj_size_t *remainder);
    pj_bool_t (*on_data_recvfrom)(pj_activesock_t *asock,
                                  void *data,
                                  pj_size_t size,
                                  const pj_sockaddr_t *src_addr,
                                  int addr_len,
                                  pj_status_t status);
 
    pj_bool_t (*on_data_sent)(pj_activesock_t *asock,
                              pj_ioqueue_op_key_t *send_key,
                              pj_ssize_t sent);
 
    pj_bool_t (*on_accept_complete)(pj_activesock_t *asock,
                                    pj_sock_t newsock,
                                    const pj_sockaddr_t *src_addr,
                                    int src_addr_len);
 
    pj_bool_t (*on_accept_complete2)(pj_activesock_t *asock,
                                     pj_sock_t newsock,
                                     const pj_sockaddr_t *src_addr,
                                     int src_addr_len, 
                                     pj_status_t status);
 
    pj_bool_t (*on_connect_complete)(pj_activesock_t *asock,
                                     pj_status_t status);
 
} pj_activesock_cb;
 
 
typedef struct pj_activesock_cfg
{
    pj_grp_lock_t *grp_lock;
 
    unsigned async_cnt;
 
    int concurrency;
 
    pj_bool_t whole_data;
 
} pj_activesock_cfg;
 
 
PJ_DECL(void) pj_activesock_cfg_default(pj_activesock_cfg *cfg);
 
 
PJ_DECL(pj_status_t) pj_activesock_create(pj_pool_t *pool,
                                          pj_sock_t sock,
                                          int sock_type,
                                          const pj_activesock_cfg *opt,
                                          pj_ioqueue_t *ioqueue,
                                          const pj_activesock_cb *cb,
                                          void *user_data,
                                          pj_activesock_t **p_asock);
 
PJ_DECL(pj_status_t) pj_activesock_create_udp(pj_pool_t *pool,
                                              const pj_sockaddr *addr,
                                              const pj_activesock_cfg *opt,
                                              pj_ioqueue_t *ioqueue,
                                              const pj_activesock_cb *cb,
                                              void *user_data,
                                              pj_activesock_t **p_asock,
                                              pj_sockaddr *bound_addr);
 
PJ_DECL(pj_status_t) pj_activesock_close(pj_activesock_t *asock);
 
#if (defined(PJ_IPHONE_OS_HAS_MULTITASKING_SUPPORT) && \
     PJ_IPHONE_OS_HAS_MULTITASKING_SUPPORT!=0) || \
     defined(DOXYGEN)
PJ_DECL(void) pj_activesock_set_iphone_os_bg(pj_activesock_t *asock,
                                             int val);
 
PJ_DECL(void) pj_activesock_enable_iphone_os_bg(pj_bool_t val);
#endif
 
PJ_DECL(pj_status_t) pj_activesock_set_user_data(pj_activesock_t *asock,
                                                 void *user_data);
 
PJ_DECL(void*) pj_activesock_get_user_data(pj_activesock_t *asock);
 
 
PJ_DECL(pj_status_t) pj_activesock_start_read(pj_activesock_t *asock,
                                              pj_pool_t *pool,
                                              unsigned buff_size,
                                              pj_uint32_t flags);
 
PJ_DECL(pj_status_t) pj_activesock_start_read2(pj_activesock_t *asock,
                                               pj_pool_t *pool,
                                               unsigned buff_size,
                                               void *readbuf[],
                                               pj_uint32_t flags);
 
PJ_DECL(pj_status_t) pj_activesock_start_recvfrom(pj_activesock_t *asock,
                                                  pj_pool_t *pool,
                                                  unsigned buff_size,
                                                  pj_uint32_t flags);
 
PJ_DECL(pj_status_t) pj_activesock_start_recvfrom2(pj_activesock_t *asock,
                                                   pj_pool_t *pool,
                                                   unsigned buff_size,
                                                   void *readbuf[],
                                                   pj_uint32_t flags);
 
PJ_DECL(pj_status_t) pj_activesock_send(pj_activesock_t *asock,
                                        pj_ioqueue_op_key_t *send_key,
                                        const void *data,
                                        pj_ssize_t *size,
                                        unsigned flags);
 
PJ_DECL(pj_status_t) pj_activesock_sendto(pj_activesock_t *asock,
                                          pj_ioqueue_op_key_t *send_key,
                                          const void *data,
                                          pj_ssize_t *size,
                                          unsigned flags,
                                          const pj_sockaddr_t *addr,
                                          int addr_len);
 
#if PJ_HAS_TCP
PJ_DECL(pj_status_t) pj_activesock_start_accept(pj_activesock_t *asock,
                                                pj_pool_t *pool);
 
PJ_DECL(pj_status_t) pj_activesock_start_connect(pj_activesock_t *asock,
                                                 pj_pool_t *pool,
                                                 const pj_sockaddr_t *remaddr,
                                                 int addr_len);
 
 
#endif  /* PJ_HAS_TCP */
 
PJ_END_DECL
 
#endif  /* __PJ_ASYNCSOCK_H__ */