64d039a511005e86809c9ebefa989219f490af72
[asterisk/asterisk.git] / include / asterisk / io.h
1 /*
2  * Asterisk
3  * 
4  * Mark Spencer <markster@marko.net>
5  *
6  * Copyright(C) 1999, Adtran, Inc.
7  * 
8  * Distributed under the terms of the GNU General Public License (GPL) Version 2
9  *
10  * I/O Managment (derived from Cheops-NG)
11  *
12  */
13
14 #ifndef _IO_H
15 #define _IO_H
16
17 #include <sys/poll.h>           /* For POLL* constants */
18
19 #if defined(__cplusplus) || defined(c_plusplus)
20 extern "C" {
21 #endif
22
23 #define AST_IO_IN       POLLIN          /* Input ready */
24 #define AST_IO_OUT      POLLOUT         /* Output ready */
25 #define AST_IO_PRI      POLLPRI         /* Priority input ready */
26
27 /* Implicitly polled for */
28 #define AST_IO_ERR      POLLERR         /* Error condition (errno or getsockopt) */
29 #define AST_IO_HUP      POLLHUP         /* Hangup */
30 #define AST_IO_NVAL     POLLNVAL        /* Invalid fd */
31
32 /*
33  * An Asterisk IO callback takes its id, a file descriptor, list of events, and
34  * callback data as arguments and returns 0 if it should not be
35  * run again, or non-zero if it should be run again.
36  */
37
38 struct io_context;
39
40 /* Create a context for I/O operations */
41 struct io_context *io_context_create();
42
43 /* Destroy a context for I/O operations */
44 void io_context_destroy(struct io_context *ioc);
45
46 typedef int (*ast_io_cb)(int *id, int fd, short events, void *cbdata);
47 #define AST_IO_CB(a) ((ast_io_cb)(a))
48
49 /* 
50  * Watch for any of revents activites on fd, calling callback with data as 
51  * callback data.  Returns a pointer to ID of the IO event, or NULL on failure.
52  */
53 extern int *ast_io_add(struct io_context *ioc, int fd, ast_io_cb callback, short events, void *data);
54
55 /*
56  * Change an i/o handler, updating fd if > -1, callback if non-null, and revents
57  * if >-1, and data if non-null.  Returns a pointero to the ID of the IO event,
58  * or NULL on failure.
59  */
60 extern int *ast_io_change(struct io_context *ioc, int *id, int fd, ast_io_cb callback, short events, void *data);
61
62 /* 
63  * Remove an I/O id from consideration  Returns 0 on success or -1 on failure.
64  */
65 extern int ast_io_remove(struct io_context *ioc, int *id);
66
67 /*
68  * Wait for I/O to happen, returning after
69  * howlong milliseconds, and after processing
70  * any necessary I/O.  Returns the number of
71  * I/O events which took place.
72  */
73 extern int ast_io_wait(struct io_context *ioc, int howlong);
74
75 /*
76  * Debugging: Dump everything in the I/O array
77  */
78 extern void ast_io_dump(struct io_context *ioc);
79
80 #if defined(__cplusplus) || defined(c_plusplus)
81 }
82 #endif
83
84
85 #endif