BLOG | DOCUMENTATION | TRAC | 

Home --> Documentations --> PJLIB Reference

ioqueue.h
Go to the documentation of this file.
1 /* $Id: ioqueue.h 4359 2013-02-21 11:18:36Z bennylp $
2  */
3 /*
4  * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
5  * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20  */
21 #ifndef __PJ_IOQUEUE_H__
22 #define __PJ_IOQUEUE_H__
23 
29 #include <pj/types.h>
30 
31 PJ_BEGIN_DECL
32 
209 typedef struct pj_ioqueue_op_key_t
210 {
211  void *internal__[32];
212  void *activesock_data;
213  void *user_data;
214 } pj_ioqueue_op_key_t;
215 
220 typedef struct pj_ioqueue_callback
221 {
233  void (*on_read_complete)(pj_ioqueue_key_t *key,
234  pj_ioqueue_op_key_t *op_key,
235  pj_ssize_t bytes_read);
236 
248  void (*on_write_complete)(pj_ioqueue_key_t *key,
249  pj_ioqueue_op_key_t *op_key,
250  pj_ssize_t bytes_sent);
251 
260  void (*on_accept_complete)(pj_ioqueue_key_t *key,
261  pj_ioqueue_op_key_t *op_key,
262  pj_sock_t sock,
263  pj_status_t status);
264 
271  void (*on_connect_complete)(pj_ioqueue_key_t *key,
272  pj_status_t status);
273 } pj_ioqueue_callback;
274 
275 
280 typedef enum pj_ioqueue_operation_e
281 {
282  PJ_IOQUEUE_OP_NONE = 0,
283  PJ_IOQUEUE_OP_READ = 1,
284  PJ_IOQUEUE_OP_RECV = 2,
285  PJ_IOQUEUE_OP_RECV_FROM = 4,
286  PJ_IOQUEUE_OP_WRITE = 8,
287  PJ_IOQUEUE_OP_SEND = 16,
288  PJ_IOQUEUE_OP_SEND_TO = 32,
289 #if defined(PJ_HAS_TCP) && PJ_HAS_TCP != 0
290  PJ_IOQUEUE_OP_ACCEPT = 64,
291  PJ_IOQUEUE_OP_CONNECT = 128
292 #endif /* PJ_HAS_TCP */
293 } pj_ioqueue_operation_e;
294 
295 
302 #ifndef PJ_IOQUEUE_MAX_EVENTS_IN_SINGLE_POLL
303 # define PJ_IOQUEUE_MAX_EVENTS_IN_SINGLE_POLL (16)
304 #endif
305 
310 #define PJ_IOQUEUE_ALWAYS_ASYNC ((pj_uint32_t)1 << (pj_uint32_t)31)
311 
317 PJ_DECL(const char*) pj_ioqueue_name(void);
318 
319 
330 PJ_DECL(pj_status_t) pj_ioqueue_create( pj_pool_t *pool,
331  pj_size_t max_fd,
332  pj_ioqueue_t **ioqueue);
333 
341 PJ_DECL(pj_status_t) pj_ioqueue_destroy( pj_ioqueue_t *ioque );
342 
358 PJ_DECL(pj_status_t) pj_ioqueue_set_lock( pj_ioqueue_t *ioque,
359  pj_lock_t *lock,
360  pj_bool_t auto_delete );
361 
377 PJ_DECL(pj_status_t) pj_ioqueue_set_default_concurrency(pj_ioqueue_t *ioqueue,
378  pj_bool_t allow);
379 
400 PJ_DECL(pj_status_t) pj_ioqueue_register_sock( pj_pool_t *pool,
401  pj_ioqueue_t *ioque,
402  pj_sock_t sock,
403  void *user_data,
404  const pj_ioqueue_callback *cb,
405  pj_ioqueue_key_t **key );
406 
412 PJ_DECL(pj_status_t) pj_ioqueue_register_sock2(pj_pool_t *pool,
413  pj_ioqueue_t *ioque,
414  pj_sock_t sock,
415  pj_grp_lock_t *grp_lock,
416  void *user_data,
417  const pj_ioqueue_callback *cb,
418  pj_ioqueue_key_t **key );
419 
441 PJ_DECL(pj_status_t) pj_ioqueue_unregister( pj_ioqueue_key_t *key );
442 
443 
453 PJ_DECL(void*) pj_ioqueue_get_user_data( pj_ioqueue_key_t *key );
454 
465 PJ_DECL(pj_status_t) pj_ioqueue_set_user_data( pj_ioqueue_key_t *key,
466  void *user_data,
467  void **old_data);
468 
491 PJ_DECL(pj_status_t) pj_ioqueue_set_concurrency(pj_ioqueue_key_t *key,
492  pj_bool_t allow);
493 
504 PJ_DECL(pj_status_t) pj_ioqueue_lock_key(pj_ioqueue_key_t *key);
505 
513 PJ_DECL(pj_status_t) pj_ioqueue_unlock_key(pj_ioqueue_key_t *key);
514 
521 PJ_DECL(void) pj_ioqueue_op_key_init( pj_ioqueue_op_key_t *op_key,
522  pj_size_t size );
523 
536 PJ_DECL(pj_bool_t) pj_ioqueue_is_pending( pj_ioqueue_key_t *key,
537  pj_ioqueue_op_key_t *op_key );
538 
539 
554 PJ_DECL(pj_status_t) pj_ioqueue_post_completion( pj_ioqueue_key_t *key,
555  pj_ioqueue_op_key_t *op_key,
556  pj_ssize_t bytes_status );
557 
558 
559 
560 #if defined(PJ_HAS_TCP) && PJ_HAS_TCP != 0
561 
593 PJ_DECL(pj_status_t) pj_ioqueue_accept( pj_ioqueue_key_t *key,
594  pj_ioqueue_op_key_t *op_key,
595  pj_sock_t *new_sock,
596  pj_sockaddr_t *local,
597  pj_sockaddr_t *remote,
598  int *addrlen );
599 
617 PJ_DECL(pj_status_t) pj_ioqueue_connect( pj_ioqueue_key_t *key,
618  const pj_sockaddr_t *addr,
619  int addrlen );
620 
621 #endif /* PJ_HAS_TCP */
622 
638 PJ_DECL(int) pj_ioqueue_poll( pj_ioqueue_t *ioque,
639  const pj_time_val *timeout);
640 
641 
677 PJ_DECL(pj_status_t) pj_ioqueue_recv( pj_ioqueue_key_t *key,
678  pj_ioqueue_op_key_t *op_key,
679  void *buffer,
680  pj_ssize_t *length,
681  pj_uint32_t flags );
682 
720 PJ_DECL(pj_status_t) pj_ioqueue_recvfrom( pj_ioqueue_key_t *key,
721  pj_ioqueue_op_key_t *op_key,
722  void *buffer,
723  pj_ssize_t *length,
724  pj_uint32_t flags,
725  pj_sockaddr_t *addr,
726  int *addrlen);
727 
762 PJ_DECL(pj_status_t) pj_ioqueue_send( pj_ioqueue_key_t *key,
763  pj_ioqueue_op_key_t *op_key,
764  const void *data,
765  pj_ssize_t *length,
766  pj_uint32_t flags );
767 
768 
802 PJ_DECL(pj_status_t) pj_ioqueue_sendto( pj_ioqueue_key_t *key,
803  pj_ioqueue_op_key_t *op_key,
804  const void *data,
805  pj_ssize_t *length,
806  pj_uint32_t flags,
807  const pj_sockaddr_t *addr,
808  int addrlen);
809 
810 
815 PJ_END_DECL
816 
817 #endif /* __PJ_IOQUEUE_H__ */
818 

 

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