BLOG | DOCUMENTATION | TRAC | 

Home --> Documentations --> PJLIB Reference

activesock.h
Go to the documentation of this file.
1 /* $Id: activesock.h 4359 2013-02-21 11:18:36Z bennylp $ */
2 /*
3  * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
4  * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  */
20 #ifndef __PJ_ASYNCSOCK_H__
21 #define __PJ_ASYNCSOCK_H__
22 
28 #include <pj/ioqueue.h>
29 #include <pj/sock.h>
30 
31 
32 PJ_BEGIN_DECL
33 
51 typedef struct pj_activesock_t pj_activesock_t;
52 
56 typedef struct pj_activesock_cb
57 {
84  pj_bool_t (*on_data_read)(pj_activesock_t *asock,
85  void *data,
86  pj_size_t size,
87  pj_status_t status,
88  pj_size_t *remainder);
109  pj_bool_t (*on_data_recvfrom)(pj_activesock_t *asock,
110  void *data,
111  pj_size_t size,
112  const pj_sockaddr_t *src_addr,
113  int addr_len,
114  pj_status_t status);
115 
129  pj_bool_t (*on_data_sent)(pj_activesock_t *asock,
130  pj_ioqueue_op_key_t *send_key,
131  pj_ssize_t sent);
132 
147  pj_bool_t (*on_accept_complete)(pj_activesock_t *asock,
148  pj_sock_t newsock,
149  const pj_sockaddr_t *src_addr,
150  int src_addr_len);
151 
164  pj_bool_t (*on_connect_complete)(pj_activesock_t *asock,
165  pj_status_t status);
166 
167 } pj_activesock_cb;
168 
169 
174 typedef struct pj_activesock_cfg
175 {
179  pj_grp_lock_t *grp_lock;
180 
193  unsigned async_cnt;
194 
208  int concurrency;
209 
223  pj_bool_t whole_data;
224 
225 } pj_activesock_cfg;
226 
227 
233 PJ_DECL(void) pj_activesock_cfg_default(pj_activesock_cfg *cfg);
234 
235 
258 PJ_DECL(pj_status_t) pj_activesock_create(pj_pool_t *pool,
259  pj_sock_t sock,
260  int sock_type,
261  const pj_activesock_cfg *opt,
262  pj_ioqueue_t *ioqueue,
263  const pj_activesock_cb *cb,
264  void *user_data,
265  pj_activesock_t **p_asock);
266 
289 PJ_DECL(pj_status_t) pj_activesock_create_udp(pj_pool_t *pool,
290  const pj_sockaddr *addr,
291  const pj_activesock_cfg *opt,
292  pj_ioqueue_t *ioqueue,
293  const pj_activesock_cb *cb,
294  void *user_data,
295  pj_activesock_t **p_asock,
296  pj_sockaddr *bound_addr);
297 
307 PJ_DECL(pj_status_t) pj_activesock_close(pj_activesock_t *asock);
308 
309 #if (defined(PJ_IPHONE_OS_HAS_MULTITASKING_SUPPORT) && \
310  PJ_IPHONE_OS_HAS_MULTITASKING_SUPPORT!=0) || \
311  defined(DOXYGEN)
312 
325 PJ_DECL(void) pj_activesock_set_iphone_os_bg(pj_activesock_t *asock,
326  int val);
327 
341 PJ_DECL(void) pj_activesock_enable_iphone_os_bg(pj_bool_t val);
342 #endif
343 
356 PJ_DECL(pj_status_t) pj_activesock_set_user_data(pj_activesock_t *asock,
357  void *user_data);
358 
367 PJ_DECL(void*) pj_activesock_get_user_data(pj_activesock_t *asock);
368 
369 
392 PJ_DECL(pj_status_t) pj_activesock_start_read(pj_activesock_t *asock,
393  pj_pool_t *pool,
394  unsigned buff_size,
395  pj_uint32_t flags);
396 
411 PJ_DECL(pj_status_t) pj_activesock_start_read2(pj_activesock_t *asock,
412  pj_pool_t *pool,
413  unsigned buff_size,
414  void *readbuf[],
415  pj_uint32_t flags);
416 
430 PJ_DECL(pj_status_t) pj_activesock_start_recvfrom(pj_activesock_t *asock,
431  pj_pool_t *pool,
432  unsigned buff_size,
433  pj_uint32_t flags);
434 
449 PJ_DECL(pj_status_t) pj_activesock_start_recvfrom2(pj_activesock_t *asock,
450  pj_pool_t *pool,
451  unsigned buff_size,
452  void *readbuf[],
453  pj_uint32_t flags);
454 
475 PJ_DECL(pj_status_t) pj_activesock_send(pj_activesock_t *asock,
476  pj_ioqueue_op_key_t *send_key,
477  const void *data,
478  pj_ssize_t *size,
479  unsigned flags);
480 
502 PJ_DECL(pj_status_t) pj_activesock_sendto(pj_activesock_t *asock,
503  pj_ioqueue_op_key_t *send_key,
504  const void *data,
505  pj_ssize_t *size,
506  unsigned flags,
507  const pj_sockaddr_t *addr,
508  int addr_len);
509 
510 #if PJ_HAS_TCP
511 
530 PJ_DECL(pj_status_t) pj_activesock_start_accept(pj_activesock_t *asock,
531  pj_pool_t *pool);
532 
550 PJ_DECL(pj_status_t) pj_activesock_start_connect(pj_activesock_t *asock,
551  pj_pool_t *pool,
552  const pj_sockaddr_t *remaddr,
553  int addr_len);
554 
555 
556 #endif /* PJ_HAS_TCP */
557 
562 PJ_END_DECL
563 
564 #endif /* __PJ_ASYNCSOCK_H__ */
565 

 

PJLIB Open Source, high performance, small footprint, and very very portable framework
Copyright (C) 2006-2009 Teluu Inc.