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

Comparing libev/ev.h (file contents):
Revision 1.77 by root, Mon Dec 3 13:41:25 2007 UTC vs.
Revision 1.90 by root, Tue Dec 25 07:05:45 2007 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
… …
52# define EV_PERIODIC_ENABLE 1 62# define EV_PERIODIC_ENABLE 1
53#endif 63#endif
54 64
55#ifndef EV_STAT_ENABLE 65#ifndef EV_STAT_ENABLE
56# define EV_STAT_ENABLE 1 66# define EV_STAT_ENABLE 1
67#endif
68
69#ifndef EV_IDLE_ENABLE
70# define EV_IDLE_ENABLE 1
57#endif 71#endif
58 72
59#ifndef EV_FORK_ENABLE 73#ifndef EV_FORK_ENABLE
60# define EV_FORK_ENABLE 1 74# define EV_FORK_ENABLE 1
61#endif 75#endif
… …
93/* eventmask, revents, events... */ 107/* eventmask, revents, events... */
94#define EV_UNDEF -1L /* guaranteed to be invalid */ 108#define EV_UNDEF -1L /* guaranteed to be invalid */
95#define EV_NONE 0x00L /* no events */ 109#define EV_NONE 0x00L /* no events */
96#define EV_READ 0x01L /* ev_io detected read will not block */ 110#define EV_READ 0x01L /* ev_io detected read will not block */
97#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 */
98#define EV_TIMEOUT 0x00000100L /* timer timed out */ 113#define EV_TIMEOUT 0x00000100L /* timer timed out */
99#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 114#define EV_PERIODIC 0x00000200L /* periodic timer timed out */
100#define EV_SIGNAL 0x00000400L /* signal was received */ 115#define EV_SIGNAL 0x00000400L /* signal was received */
101#define EV_CHILD 0x00000800L /* child/pid had status change */ 116#define EV_CHILD 0x00000800L /* child/pid had status change */
102#define EV_STAT 0x00001000L /* stat data changed */ 117#define EV_STAT 0x00001000L /* stat data changed */
… …
113#endif 128#endif
114#ifndef EV_PROTOTYPES 129#ifndef EV_PROTOTYPES
115# define EV_PROTOTYPES 1 130# define EV_PROTOTYPES 1
116#endif 131#endif
117 132
118#define EV_VERSION_MAJOR 1 133#define EV_VERSION_MAJOR 2
119#define EV_VERSION_MINOR 1 134#define EV_VERSION_MINOR 0
120 135
121#ifndef EV_CB_DECLARE 136#ifndef EV_CB_DECLARE
122# 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);
123#endif 138#endif
124#ifndef EV_CB_INVOKE 139#ifndef EV_CB_INVOKE
… …
189/* revent EV_PERIODIC */ 204/* revent EV_PERIODIC */
190typedef struct ev_periodic 205typedef struct ev_periodic
191{ 206{
192 EV_WATCHER_TIME (ev_periodic) 207 EV_WATCHER_TIME (ev_periodic)
193 208
209 ev_tstamp offset; /* rw */
194 ev_tstamp interval; /* rw */ 210 ev_tstamp interval; /* rw */
195 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 */
196} ev_periodic; 212} ev_periodic;
197 213
198/* invoked when the given signal has been received */ 214/* invoked when the given signal has been received */
… …
238 254
239 int wd; /* wd for inotify, fd for kqueue */ 255 int wd; /* wd for inotify, fd for kqueue */
240} ev_stat; 256} ev_stat;
241#endif 257#endif
242 258
259#if EV_IDLE_ENABLE
243/* invoked when the nothing else needs to be done, keeps the process from blocking */ 260/* invoked when the nothing else needs to be done, keeps the process from blocking */
244/* revent EV_IDLE */ 261/* revent EV_IDLE */
245typedef struct ev_idle 262typedef struct ev_idle
246{ 263{
247 EV_WATCHER (ev_idle) 264 EV_WATCHER (ev_idle)
248} ev_idle; 265} ev_idle;
266#endif
249 267
250/* invoked for each run of the mainloop, just before the blocking call */ 268/* invoked for each run of the mainloop, just before the blocking call */
251/* you can still change events in any way you like */ 269/* you can still change events in any way you like */
252/* revent EV_PREPARE */ 270/* revent EV_PREPARE */
253typedef struct ev_prepare 271typedef struct ev_prepare
… …
275/* the callback gets invoked when the event loop has handled events, and can be 0 */ 293/* the callback gets invoked when the event loop has handled events, and can be 0 */
276typedef struct ev_embed 294typedef struct ev_embed
277{ 295{
278 EV_WATCHER (ev_embed) 296 EV_WATCHER (ev_embed)
279 297
280 ev_io io; /* private */
281 struct ev_loop *loop; /* ro */ 298 struct ev_loop *other; /* ro */
299 ev_io io; /* private */
300 ev_prepare prepare; /* private */
301 ev_check check; /* unused */
302 ev_timer timer; /* unused */
303 ev_periodic periodic; /* unused */
304 ev_idle idle; /* unused */
305 ev_fork fork; /* unused */
282} ev_embed; 306} ev_embed;
283#endif 307#endif
284 308
285/* the presence of this union forces similar struct layout */ 309/* the presence of this union forces similar struct layout */
286union ev_any_watcher 310union ev_any_watcher
… …
294 struct ev_signal signal; 318 struct ev_signal signal;
295 struct ev_child child; 319 struct ev_child child;
296#if EV_STAT_ENABLE 320#if EV_STAT_ENABLE
297 struct ev_stat stat; 321 struct ev_stat stat;
298#endif 322#endif
323#if EV_IDLE_ENABLE
299 struct ev_idle idle; 324 struct ev_idle idle;
325#endif
300 struct ev_prepare prepare; 326 struct ev_prepare prepare;
301 struct ev_check check; 327 struct ev_check check;
302#if EV_FORK_ENABLE 328#if EV_FORK_ENABLE
303 struct ev_fork fork; 329 struct ev_fork fork;
304#endif 330#endif
… …
328unsigned int ev_supported_backends (void); 354unsigned int ev_supported_backends (void);
329unsigned int ev_recommended_backends (void); 355unsigned int ev_recommended_backends (void);
330unsigned int ev_embeddable_backends (void); 356unsigned int ev_embeddable_backends (void);
331 357
332ev_tstamp ev_time (void); 358ev_tstamp ev_time (void);
359void ev_sleep (ev_tstamp delay); /* sleep for a while */
333 360
334/* Sets the allocation function to use, works like realloc. 361/* Sets the allocation function to use, works like realloc.
335 * It is used to allocate and free memory. 362 * It is used to allocate and free memory.
336 * If it returns zero when memory needs to be allocated, the library might abort 363 * If it returns zero when memory needs to be allocated, the library might abort
337 * or take some potentially destructive action. 364 * or take some potentially destructive action.
… …
385/* if you create alternative loops you have to call ev_loop_fork on them */ 412/* if you create alternative loops you have to call ev_loop_fork on them */
386/* you can call it in either the parent or the child */ 413/* you can call it in either the parent or the child */
387/* you can actually call it at any time, anywhere :) */ 414/* you can actually call it at any time, anywhere :) */
388void ev_default_fork (void); 415void ev_default_fork (void);
389 416
390unsigned int ev_backend (EV_P); 417unsigned int ev_backend (EV_P); /* backend in use by loop */
391unsigned int ev_loop_count (EV_P); 418unsigned int ev_loop_count (EV_P); /* number of loop iterations */
392#endif 419#endif
393 420
394#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 421#define EVLOOP_NONBLOCK 1 /* do not block/wait */
395#define EVLOOP_ONESHOT 2 /* block *once* only */ 422#define EVLOOP_ONESHOT 2 /* block *once* only */
396#define EVUNLOOP_CANCEL 0 /* undo unloop */ 423#define EVUNLOOP_CANCEL 0 /* undo unloop */
… …
398#define EVUNLOOP_ALL 2 /* unloop all loops */ 425#define EVUNLOOP_ALL 2 /* unloop all loops */
399 426
400#if EV_PROTOTYPES 427#if EV_PROTOTYPES
401void ev_loop (EV_P_ int flags); 428void ev_loop (EV_P_ int flags);
402void 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 */ 429void 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 */
430
431void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
432void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
403 433
404/* 434/*
405 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 435 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
406 * keeps one reference. if you have a long-runing watcher you never unregister that 436 * keeps one reference. if you have a long-runing watcher you never unregister that
407 * should not keep ev_loop from running, unref() after starting, and ref() before stopping. 437 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
… …
414void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 444void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
415#endif 445#endif
416 446
417/* these may evaluate ev multiple times, and the other arguments at most once */ 447/* these may evaluate ev multiple times, and the other arguments at most once */
418/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */ 448/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
419#define ev_init(ev,cb_) do { \ 449#define ev_init(ev,cb_) do { \
420 ((ev_watcher *)(void *)(ev))->active = \ 450 ((ev_watcher *)(void *)(ev))->active = \
421 ((ev_watcher *)(void *)(ev))->pending = \ 451 ((ev_watcher *)(void *)(ev))->pending = \
422 ((ev_watcher *)(void *)(ev))->priority = 0; \ 452 ((ev_watcher *)(void *)(ev))->priority = 0; \
423 ev_set_cb ((ev), cb_); \ 453 ev_set_cb ((ev), cb_); \
424} while (0) 454} while (0)
425 455
426#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 456#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0)
427#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 457#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
428#define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 458#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
429#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 459#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
430#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 460#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
431#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) 461#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
432#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 462#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
433#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 463#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
434#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 464#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
435#define ev_embed_set(ev,loop_) do { (ev)->loop = (loop_); } while (0) 465#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
436#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 466#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
437 467
438#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 468#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
439#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 469#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
440#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 470#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
441#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 471#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
442#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 472#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
443#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0) 473#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
444#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 474#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
445#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 475#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
446#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 476#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
447#define ev_embed_init(ev,cb,loop) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0) 477#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
448#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 478#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
449 479
450#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 480#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
451#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 481#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
452 482
453#define ev_priority(ev) ((ev_watcher *)(void *)(ev))->priority /* rw */ 483#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
454#define ev_cb(ev) (ev)->cb /* rw */ 484#define ev_cb(ev) (ev)->cb /* rw */
455#define ev_set_priority(ev,pri) ev_priority (ev) = (pri) 485#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
456 486
457#ifndef ev_set_cb 487#ifndef ev_set_cb
458# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 488# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
459#endif 489#endif
460 490
… …
465/* feeds an event into a watcher as if the event actually occured */ 495/* feeds an event into a watcher as if the event actually occured */
466/* accepts any ev_watcher type */ 496/* accepts any ev_watcher type */
467void ev_feed_event (EV_P_ void *w, int revents); 497void ev_feed_event (EV_P_ void *w, int revents);
468void ev_feed_fd_event (EV_P_ int fd, int revents); 498void ev_feed_fd_event (EV_P_ int fd, int revents);
469void ev_feed_signal_event (EV_P_ int signum); 499void ev_feed_signal_event (EV_P_ int signum);
500void ev_invoke (EV_P_ void *w, int revents);
501int ev_clear_pending (EV_P_ void *w);
470 502
471void ev_io_start (EV_P_ ev_io *w); 503void ev_io_start (EV_P_ ev_io *w);
472void ev_io_stop (EV_P_ ev_io *w); 504void ev_io_stop (EV_P_ ev_io *w);
473 505
474void ev_timer_start (EV_P_ ev_timer *w); 506void ev_timer_start (EV_P_ ev_timer *w);
… …
494void ev_stat_start (EV_P_ ev_stat *w); 526void ev_stat_start (EV_P_ ev_stat *w);
495void ev_stat_stop (EV_P_ ev_stat *w); 527void ev_stat_stop (EV_P_ ev_stat *w);
496void ev_stat_stat (EV_P_ ev_stat *w); 528void ev_stat_stat (EV_P_ ev_stat *w);
497# endif 529# endif
498 530
531# if EV_IDLE_ENABLE
499void ev_idle_start (EV_P_ ev_idle *w); 532void ev_idle_start (EV_P_ ev_idle *w);
500void ev_idle_stop (EV_P_ ev_idle *w); 533void ev_idle_stop (EV_P_ ev_idle *w);
534# endif
501 535
502void ev_prepare_start (EV_P_ ev_prepare *w); 536void ev_prepare_start (EV_P_ ev_prepare *w);
503void ev_prepare_stop (EV_P_ ev_prepare *w); 537void ev_prepare_stop (EV_P_ ev_prepare *w);
504 538
505void ev_check_start (EV_P_ ev_check *w); 539void ev_check_start (EV_P_ ev_check *w);

Diff Legend

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