ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
(Generate patch)

Comparing libev/ev.h (file contents):
Revision 1.81 by root, Sat Dec 8 14:12:07 2007 UTC vs.
Revision 1.91 by root, Fri Jan 25 15:45:09 2008 UTC

1/* 1/*
2 * libev native API header
3 *
2 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>
3 * All rights reserved. 5 * All rights reserved.
4 * 6 *
5 * Redistribution and use in source and binary forms, with or without 7 * Redistribution and use in source and binary forms, with or without modifica-
6 * modification, are permitted provided that the following conditions are 8 * tion, are permitted provided that the following conditions are met:
7 * met: 9 *
10 * 1. Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 *
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
18 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19 * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21 * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
25 * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
26 * OF THE POSSIBILITY OF SUCH DAMAGE.
8 * 27 *
9 * * Redistributions of source code must retain the above copyright 28 * Alternatively, the contents of this file may be used under the terms of
10 * notice, this list of conditions and the following disclaimer. 29 * the GNU General Public License ("GPL") version 2 or any later version,
11 * 30 * in which case the provisions of the GPL are applicable instead of
12 * * Redistributions in binary form must reproduce the above 31 * the above. If you wish to allow the use of your version of this file
13 * copyright notice, this list of conditions and the following 32 * only under the terms of the GPL and not to allow others to use your
14 * disclaimer in the documentation and/or other materials provided 33 * version of this file under the BSD license, indicate your decision
15 * with the distribution. 34 * by deleting the provisions above and replace them with the notice
16 * 35 * and other provisions required by the GPL. If you do not delete the
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 36 * provisions above, a recipient may use your version of this file under
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 37 * either the BSD or the GPL.
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */ 38 */
29 39
30#ifndef EV_H__ 40#ifndef EV_H__
31#define EV_H__ 41#define EV_H__
32 42
… …
97/* eventmask, revents, events... */ 107/* eventmask, revents, events... */
98#define EV_UNDEF -1L /* guaranteed to be invalid */ 108#define EV_UNDEF -1L /* guaranteed to be invalid */
99#define EV_NONE 0x00L /* no events */ 109#define EV_NONE 0x00L /* no events */
100#define EV_READ 0x01L /* ev_io detected read will not block */ 110#define EV_READ 0x01L /* ev_io detected read will not block */
101#define EV_WRITE 0x02L /* ev_io detected write will not block */ 111#define EV_WRITE 0x02L /* ev_io detected write will not block */
112#define EV_IOFDSET 0x80L /* internal use only */
102#define EV_TIMEOUT 0x00000100L /* timer timed out */ 113#define EV_TIMEOUT 0x00000100L /* timer timed out */
103#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 114#define EV_PERIODIC 0x00000200L /* periodic timer timed out */
104#define EV_SIGNAL 0x00000400L /* signal was received */ 115#define EV_SIGNAL 0x00000400L /* signal was received */
105#define EV_CHILD 0x00000800L /* child/pid had status change */ 116#define EV_CHILD 0x00000800L /* child/pid had status change */
106#define EV_STAT 0x00001000L /* stat data changed */ 117#define EV_STAT 0x00001000L /* stat data changed */
… …
117#endif 128#endif
118#ifndef EV_PROTOTYPES 129#ifndef EV_PROTOTYPES
119# define EV_PROTOTYPES 1 130# define EV_PROTOTYPES 1
120#endif 131#endif
121 132
122#define EV_VERSION_MAJOR 1 133#define EV_VERSION_MAJOR 3
123#define EV_VERSION_MINOR 1 134#define EV_VERSION_MINOR 0
124 135
125#ifndef EV_CB_DECLARE 136#ifndef EV_CB_DECLARE
126# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 137# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
127#endif 138#endif
128#ifndef EV_CB_INVOKE 139#ifndef EV_CB_INVOKE
… …
193/* revent EV_PERIODIC */ 204/* revent EV_PERIODIC */
194typedef struct ev_periodic 205typedef struct ev_periodic
195{ 206{
196 EV_WATCHER_TIME (ev_periodic) 207 EV_WATCHER_TIME (ev_periodic)
197 208
209 ev_tstamp offset; /* rw */
198 ev_tstamp interval; /* rw */ 210 ev_tstamp interval; /* rw */
199 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 211 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
200} ev_periodic; 212} ev_periodic;
201 213
202/* invoked when the given signal has been received */ 214/* invoked when the given signal has been received */
… …
213/* does not support priorities */ 225/* does not support priorities */
214typedef struct ev_child 226typedef struct ev_child
215{ 227{
216 EV_WATCHER_LIST (ev_child) 228 EV_WATCHER_LIST (ev_child)
217 229
230 int flags; /* private */
218 int pid; /* ro */ 231 int pid; /* ro */
219 int rpid; /* rw, holds the received pid */ 232 int rpid; /* rw, holds the received pid */
220 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 233 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
221} ev_child; 234} ev_child;
222 235
… …
281/* the callback gets invoked when the event loop has handled events, and can be 0 */ 294/* the callback gets invoked when the event loop has handled events, and can be 0 */
282typedef struct ev_embed 295typedef struct ev_embed
283{ 296{
284 EV_WATCHER (ev_embed) 297 EV_WATCHER (ev_embed)
285 298
286 ev_io io; /* private */
287 struct ev_loop *loop; /* ro */ 299 struct ev_loop *other; /* ro */
300 ev_io io; /* private */
301 ev_prepare prepare; /* private */
302 ev_check check; /* unused */
303 ev_timer timer; /* unused */
304 ev_periodic periodic; /* unused */
305 ev_idle idle; /* unused */
306 ev_fork fork; /* unused */
288} ev_embed; 307} ev_embed;
289#endif 308#endif
290 309
291/* the presence of this union forces similar struct layout */ 310/* the presence of this union forces similar struct layout */
292union ev_any_watcher 311union ev_any_watcher
… …
336unsigned int ev_supported_backends (void); 355unsigned int ev_supported_backends (void);
337unsigned int ev_recommended_backends (void); 356unsigned int ev_recommended_backends (void);
338unsigned int ev_embeddable_backends (void); 357unsigned int ev_embeddable_backends (void);
339 358
340ev_tstamp ev_time (void); 359ev_tstamp ev_time (void);
360void ev_sleep (ev_tstamp delay); /* sleep for a while */
341 361
342/* Sets the allocation function to use, works like realloc. 362/* Sets the allocation function to use, works like realloc.
343 * It is used to allocate and free memory. 363 * It is used to allocate and free memory.
344 * If it returns zero when memory needs to be allocated, the library might abort 364 * If it returns zero when memory needs to be allocated, the library might abort
345 * or take some potentially destructive action. 365 * or take some potentially destructive action.
… …
393/* if you create alternative loops you have to call ev_loop_fork on them */ 413/* if you create alternative loops you have to call ev_loop_fork on them */
394/* you can call it in either the parent or the child */ 414/* you can call it in either the parent or the child */
395/* you can actually call it at any time, anywhere :) */ 415/* you can actually call it at any time, anywhere :) */
396void ev_default_fork (void); 416void ev_default_fork (void);
397 417
398unsigned int ev_backend (EV_P); 418unsigned int ev_backend (EV_P); /* backend in use by loop */
399unsigned int ev_loop_count (EV_P); 419unsigned int ev_loop_count (EV_P); /* number of loop iterations */
400#endif 420#endif
401 421
402#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 422#define EVLOOP_NONBLOCK 1 /* do not block/wait */
403#define EVLOOP_ONESHOT 2 /* block *once* only */ 423#define EVLOOP_ONESHOT 2 /* block *once* only */
404#define EVUNLOOP_CANCEL 0 /* undo unloop */ 424#define EVUNLOOP_CANCEL 0 /* undo unloop */
… …
406#define EVUNLOOP_ALL 2 /* unloop all loops */ 426#define EVUNLOOP_ALL 2 /* unloop all loops */
407 427
408#if EV_PROTOTYPES 428#if EV_PROTOTYPES
409void ev_loop (EV_P_ int flags); 429void ev_loop (EV_P_ int flags);
410void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */ 430void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
431
432void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
433void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
411 434
412/* 435/*
413 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 436 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
414 * keeps one reference. if you have a long-runing watcher you never unregister that 437 * keeps one reference. if you have a long-runing watcher you never unregister that
415 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 438 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
… …
429 ((ev_watcher *)(void *)(ev))->pending = \ 452 ((ev_watcher *)(void *)(ev))->pending = \
430 ((ev_watcher *)(void *)(ev))->priority = 0; \ 453 ((ev_watcher *)(void *)(ev))->priority = 0; \
431 ev_set_cb ((ev), cb_); \ 454 ev_set_cb ((ev), cb_); \
432} while (0) 455} while (0)
433 456
434#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 457#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0)
435#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 458#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
436#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 459#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
437#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 460#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
438#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 461#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
439#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) 462#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
440#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 463#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
441#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 464#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
442#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 465#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
443#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0) 466#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
444#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 467#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
445 468
446#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 469#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
447#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 470#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
448#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 471#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
449#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 472#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
450#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 473#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
451#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0) 474#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
452#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 475#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
453#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 476#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
454#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 477#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
455#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0) 478#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
456#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 479#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
457 480
458#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 481#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
459#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 482#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
460 483

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines