1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 1999 - 2005, Digium, Inc.
*
* Mark Spencer <markster@digium.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*! \file
* \brief I/O Management (derived from Cheops-NG)
*/
#ifndef _ASTERISK_IO_H
#define _ASTERISK_IO_H
#ifdef POLLCOMPAT
#include "asterisk/poll-compat.h"
#else
#include <sys/poll.h> /* For POLL* constants */
#endif
#if defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif
/*! Input ready */
#define AST_IO_IN POLLIN
/*! Output ready */
#define AST_IO_OUT POLLOUT
/*! Priority input ready */
#define AST_IO_PRI POLLPRI
/* Implicitly polled for */
/*! Error condition (errno or getsockopt) */
#define AST_IO_ERR POLLERR
/*! Hangup */
#define AST_IO_HUP POLLHUP
/*! Invalid fd */
#define AST_IO_NVAL POLLNVAL
/*
* An Asterisk IO callback takes its id, a file descriptor, list of events, and
* callback data as arguments and returns 0 if it should not be
* run again, or non-zero if it should be run again.
*/
struct io_context;
/*! Creates a context */
/*!
* Create a context for I/O operations
* Basically mallocs an IO structure and sets up some default values.
* Returns an allocated io_context structure
*/
extern struct io_context *io_context_create(void);
/*! Destroys a context */
/*
* \param ioc structure to destroy
* Destroy a context for I/O operations
* Frees all memory associated with the given io_context structure along with the structure itself
*/
extern void io_context_destroy(struct io_context *ioc);
typedef int (*ast_io_cb)(int *id, int fd, short events, void *cbdata);
#define AST_IO_CB(a) ((ast_io_cb)(a))
/*! Adds an IO context */
/*!
* \param ioc which context to use
* \param fd which fd to monitor
* \param callback callback function to run
* \param events event mask of events to wait for
* \param data data to pass to the callback
* Watch for any of revents activites on fd, calling callback with data as
* callback data. Returns a pointer to ID of the IO event, or NULL on failure.
*/
extern int *ast_io_add(struct io_context *ioc, int fd, ast_io_cb callback, short events, void *data);
/*! Changes an IO handler */
/*!
* \param ioc which context to use
* \param id
* \param fd the fd you wish it to contain now
* \param callback new callback function
* \param events event mask to wait for
* \param data data to pass to the callback function
* Change an i/o handler, updating fd if > -1, callback if non-null, and revents
* if >-1, and data if non-null. Returns a pointero to the ID of the IO event,
* or NULL on failure.
*/
extern int *ast_io_change(struct io_context *ioc, int *id, int fd, ast_io_cb callback, short events, void *data);
/*! Removes an IO context */
/*!
* \param ioc which io_context to remove it from
* \param id which ID to remove
* Remove an I/O id from consideration Returns 0 on success or -1 on failure.
*/
extern int ast_io_remove(struct io_context *ioc, int *id);
/*! Waits for IO */
/*!
* \param ioc which context to act upon
* \param howlong how many milliseconds to wait
* Wait for I/O to happen, returning after
* howlong milliseconds, and after processing
* any necessary I/O. Returns the number of
* I/O events which took place.
*/
extern int ast_io_wait(struct io_context *ioc, int howlong);
/*! Dumps the IO array */
/*
* Debugging: Dump everything in the I/O array
*/
extern void ast_io_dump(struct io_context *ioc);
/*! Set fd into non-echoing mode (if fd is a tty) */
extern int ast_hide_password(int fd);
/*! Restores TTY mode */
/*
* Call with result from previous ast_hide_password
*/
extern int ast_restore_tty(int fd, int oldstatus);
extern int ast_get_termcols(int fd);
#if defined(__cplusplus) || defined(c_plusplus)
}
#endif
#endif /* _ASTERISK_IO_H */
|
