2 * This file is part of DisOrder.
3 * Copyright (C) 2004 Richard Kettlewell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
24 typedef struct ev_source ev_source;
29 ev_source *ev_new(void);
30 /* create a new event loop */
32 int ev_run(ev_source *ev);
33 /* run an event loop. If any callback returns nonzero then that value
34 * is returned. If an error occurs then -1 is returned and @error@ is
37 /* file descriptors ***********************************************************/
47 typedef int ev_fd_callback(ev_source *ev, int fd, void *u);
48 /* signature for fd callback functions */
50 int ev_fd(ev_source *ev,
53 ev_fd_callback *callback,
55 /* register a callback on a file descriptor */
57 int ev_fd_cancel(ev_source *ev,
60 /* cancel a callback on a file descriptor */
62 int ev_fd_disable(ev_source *ev,
65 /* temporarily disable callbacks on a file descriptor */
67 int ev_fd_enable(ev_source *ev,
70 /* re-enable callbacks on a file descriptor */
72 /* timeouts *******************************************************************/
74 typedef int ev_timeout_callback(ev_source *ev,
75 const struct timeval *now,
77 /* signature for timeout callback functions */
79 typedef void *ev_timeout_handle;
81 int ev_timeout(ev_source *ev,
82 ev_timeout_handle *handlep,
83 const struct timeval *when,
84 ev_timeout_callback *callback,
86 /* register a timeout callback. If @handlep@ is not a null pointer then a
87 * handle suitable for ev_timeout_cancel() below is returned through it. */
89 int ev_timeout_cancel(ev_source *ev,
90 ev_timeout_handle handle);
91 /* cancel a timeout callback */
93 /* signals ********************************************************************/
95 typedef int ev_signal_callback(ev_source *ev,
98 /* signature for signal callback functions */
100 int ev_signal(ev_source *ev,
102 ev_signal_callback *callback,
104 /* register a signal callback */
106 int ev_signal_cancel(ev_source *ev,
108 /* cancel a signal callback */
110 void ev_signal_atfork(ev_source *ev);
111 /* unhandle and unblock handled signals - call after calling fork and
112 * then setting @exitfn@ */
114 /* child processes ************************************************************/
116 typedef int ev_child_callback(ev_source *ev,
119 const struct rusage *rusage,
121 /* signature for child wait callbacks */
123 int ev_child_setup(ev_source *ev);
124 /* must be called exactly once before @ev_child@ */
126 int ev_child(ev_source *ev,
129 ev_child_callback *callback,
131 /* register a child callback. @options@ must be 0 or WUNTRACED. */
133 int ev_child_cancel(ev_source *ev,
135 /* cancel a child callback. */
137 /* socket listeners ***********************************************************/
139 typedef int ev_listen_callback(ev_source *ev,
141 const struct sockaddr *remote,
144 /* callback when a connection arrives. */
146 int ev_listen(ev_source *ev,
148 ev_listen_callback *callback,
150 /* register a socket listener callback. @bind@ and @listen@ should
151 * already have been called. */
153 int ev_listen_cancel(ev_source *ev,
155 /* cancel a socket listener callback */
157 /* buffered writer ************************************************************/
159 typedef struct ev_writer ev_writer;
161 typedef int ev_error_callback(ev_source *ev,
165 /* called when an error occurs on a writer. Called with @errno_value@
166 * of 0 when finished. */
168 ev_writer *ev_writer_new(ev_source *ev,
170 ev_error_callback *callback,
172 /* create a new buffered writer, writing to @fd@. Calls @error@ if an
175 int ev_writer_close(ev_writer *w);
176 /* close a writer (i.e. promise not to write to it any more) */
178 int ev_writer_cancel(ev_writer *w);
179 /* cancel a writer */
181 int ev_writer_flush(ev_writer *w);
182 /* attempt to flush the buffer */
184 struct sink *ev_writer_sink(ev_writer *w) attribute((const));
185 /* return a sink for the writer - use this to actually write to it */
187 /* buffered reader ************************************************************/
189 typedef struct ev_reader ev_reader;
191 typedef int ev_reader_callback(ev_source *ev,
198 /* Called when data is read or an error occurs. @ptr@ and @bytes@
199 * indicate the amount of data available. @eof@ will be 1 at eof. */
201 ev_reader *ev_reader_new(ev_source *ev,
203 ev_reader_callback *callback,
204 ev_error_callback *error_callback,
206 /* register a new reader. @callback@ will be called whenever data is
209 void ev_reader_buffer(ev_reader *r, size_t nbytes);
210 /* specify a buffer size *case */
212 void ev_reader_consume(ev_reader *r, size_t nbytes);
213 /* consume @nbytes@ bytes. */
215 int ev_reader_cancel(ev_reader *r);
216 /* cancel a reader */
218 int ev_reader_disable(ev_reader *r);
219 /* disable reading */
221 int ev_reader_incomplete(ev_reader *r);
222 /* callback didn't fully process buffer, but would like another
223 * callback (used where processing more would block too long) */
225 int ev_reader_enable(ev_reader *r);
226 /* enable reading. If there is unconsumed data then you get a
227 * callback next time round the event loop even if nothing new has
230 * The idea is in your read callback you come across a line (or
231 * whatever) that can't be processed immediately. So you set up
232 * processing and disable reading. Later when you finish processing
233 * you re-enable. You'll automatically get another callback pretty
234 * much direct from the event loop (not from inside ev_reader_enable)
235 * so you can handle the next line (or whatever) if the whole thing
236 * has in fact already arrived.