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

Comparing libev/ev.h (file contents):
Revision 1.78 by root, Fri Dec 7 16:44:10 2007 UTC vs.
Revision 1.92 by root, Thu Jan 31 13:10:56 2008 UTC

1/* 1/*
2 * libev native API header
3 *
2 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008 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
… …
64# define EV_FORK_ENABLE 1 74# define EV_FORK_ENABLE 1
65#endif 75#endif
66 76
67#ifndef EV_EMBED_ENABLE 77#ifndef EV_EMBED_ENABLE
68# define EV_EMBED_ENABLE 1 78# define EV_EMBED_ENABLE 1
79#endif
80
81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1
83#endif
84
85#ifndef EV_ATOMIC_T
86# include <signal.h>
87# define EV_ATOMIC_T sig_atomic_t volatile
69#endif 88#endif
70 89
71/*****************************************************************************/ 90/*****************************************************************************/
72 91
73#if EV_STAT_ENABLE 92#if EV_STAT_ENABLE
… …
97/* eventmask, revents, events... */ 116/* eventmask, revents, events... */
98#define EV_UNDEF -1L /* guaranteed to be invalid */ 117#define EV_UNDEF -1L /* guaranteed to be invalid */
99#define EV_NONE 0x00L /* no events */ 118#define EV_NONE 0x00L /* no events */
100#define EV_READ 0x01L /* ev_io detected read will not block */ 119#define EV_READ 0x01L /* ev_io detected read will not block */
101#define EV_WRITE 0x02L /* ev_io detected write will not block */ 120#define EV_WRITE 0x02L /* ev_io detected write will not block */
121#define EV_IOFDSET 0x80L /* internal use only */
102#define EV_TIMEOUT 0x00000100L /* timer timed out */ 122#define EV_TIMEOUT 0x00000100L /* timer timed out */
103#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 123#define EV_PERIODIC 0x00000200L /* periodic timer timed out */
104#define EV_SIGNAL 0x00000400L /* signal was received */ 124#define EV_SIGNAL 0x00000400L /* signal was received */
105#define EV_CHILD 0x00000800L /* child/pid had status change */ 125#define EV_CHILD 0x00000800L /* child/pid had status change */
106#define EV_STAT 0x00001000L /* stat data changed */ 126#define EV_STAT 0x00001000L /* stat data changed */
107#define EV_IDLE 0x00002000L /* event loop is idling */ 127#define EV_IDLE 0x00002000L /* event loop is idling */
108#define EV_PREPARE 0x00004000L /* event loop about to poll */ 128#define EV_PREPARE 0x00004000L /* event loop about to poll */
109#define EV_CHECK 0x00008000L /* event loop finished poll */ 129#define EV_CHECK 0x00008000L /* event loop finished poll */
110#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */ 130#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */
111#define EV_FORK 0x00020000L /* event loop resumed in child */ 131#define EV_FORK 0x00020000L /* event loop resumed in child */
132#define EV_ASYNC 0x00040000L /* async intra-loop signal */
112#define EV_ERROR 0x80000000L /* sent when an error occurs */ 133#define EV_ERROR 0x80000000L /* sent when an error occurs */
113 134
114/* can be used to add custom fields to all watchers, while losing binary compatibility */ 135/* can be used to add custom fields to all watchers, while losing binary compatibility */
115#ifndef EV_COMMON 136#ifndef EV_COMMON
116# define EV_COMMON void *data; 137# define EV_COMMON void *data;
117#endif 138#endif
118#ifndef EV_PROTOTYPES 139#ifndef EV_PROTOTYPES
119# define EV_PROTOTYPES 1 140# define EV_PROTOTYPES 1
120#endif 141#endif
121 142
122#define EV_VERSION_MAJOR 1 143#define EV_VERSION_MAJOR 3
123#define EV_VERSION_MINOR 1 144#define EV_VERSION_MINOR 0
124 145
125#ifndef EV_CB_DECLARE 146#ifndef EV_CB_DECLARE
126# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 147# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
127#endif 148#endif
128#ifndef EV_CB_INVOKE 149#ifndef EV_CB_INVOKE
… …
193/* revent EV_PERIODIC */ 214/* revent EV_PERIODIC */
194typedef struct ev_periodic 215typedef struct ev_periodic
195{ 216{
196 EV_WATCHER_TIME (ev_periodic) 217 EV_WATCHER_TIME (ev_periodic)
197 218
219 ev_tstamp offset; /* rw */
198 ev_tstamp interval; /* rw */ 220 ev_tstamp interval; /* rw */
199 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */ 221 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
200} ev_periodic; 222} ev_periodic;
201 223
202/* invoked when the given signal has been received */ 224/* invoked when the given signal has been received */
… …
213/* does not support priorities */ 235/* does not support priorities */
214typedef struct ev_child 236typedef struct ev_child
215{ 237{
216 EV_WATCHER_LIST (ev_child) 238 EV_WATCHER_LIST (ev_child)
217 239
240 int flags; /* private */
218 int pid; /* ro */ 241 int pid; /* ro */
219 int rpid; /* rw, holds the received pid */ 242 int rpid; /* rw, holds the received pid */
220 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 243 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
221} ev_child; 244} ev_child;
222 245
… …
281/* the callback gets invoked when the event loop has handled events, and can be 0 */ 304/* the callback gets invoked when the event loop has handled events, and can be 0 */
282typedef struct ev_embed 305typedef struct ev_embed
283{ 306{
284 EV_WATCHER (ev_embed) 307 EV_WATCHER (ev_embed)
285 308
286 ev_io io; /* private */
287 struct ev_loop *loop; /* ro */ 309 struct ev_loop *other; /* ro */
310 ev_io io; /* private */
311 ev_prepare prepare; /* private */
312 ev_check check; /* unused */
313 ev_timer timer; /* unused */
314 ev_periodic periodic; /* unused */
315 ev_idle idle; /* unused */
316 ev_fork fork; /* unused */
288} ev_embed; 317} ev_embed;
318#endif
319
320#if EV_ASYNC_ENABLE
321/* invoked when somebody calls ev_async_send on the watcher */
322/* revent EV_ASYNC */
323typedef struct ev_async
324{
325 EV_WATCHER (ev_async)
326
327 EV_ATOMIC_T sent; /* private */
328} ev_async;
289#endif 329#endif
290 330
291/* the presence of this union forces similar struct layout */ 331/* the presence of this union forces similar struct layout */
292union ev_any_watcher 332union ev_any_watcher
293{ 333{
… …
310#if EV_FORK_ENABLE 350#if EV_FORK_ENABLE
311 struct ev_fork fork; 351 struct ev_fork fork;
312#endif 352#endif
313#if EV_EMBED_ENABLE 353#if EV_EMBED_ENABLE
314 struct ev_embed embed; 354 struct ev_embed embed;
355#endif
356#if EV_ASYND_ENABLE
357 struct ev_async async;
315#endif 358#endif
316}; 359};
317 360
318/* bits for ev_default_loop and ev_loop_new */ 361/* bits for ev_default_loop and ev_loop_new */
319/* the default */ 362/* the default */
… …
336unsigned int ev_supported_backends (void); 379unsigned int ev_supported_backends (void);
337unsigned int ev_recommended_backends (void); 380unsigned int ev_recommended_backends (void);
338unsigned int ev_embeddable_backends (void); 381unsigned int ev_embeddable_backends (void);
339 382
340ev_tstamp ev_time (void); 383ev_tstamp ev_time (void);
384void ev_sleep (ev_tstamp delay); /* sleep for a while */
341 385
342/* Sets the allocation function to use, works like realloc. 386/* Sets the allocation function to use, works like realloc.
343 * It is used to allocate and free memory. 387 * It is used to allocate and free memory.
344 * If it returns zero when memory needs to be allocated, the library might abort 388 * If it returns zero when memory needs to be allocated, the library might abort
345 * or take some potentially destructive action. 389 * or take some potentially destructive action.
… …
393/* if you create alternative loops you have to call ev_loop_fork on them */ 437/* 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 */ 438/* you can call it in either the parent or the child */
395/* you can actually call it at any time, anywhere :) */ 439/* you can actually call it at any time, anywhere :) */
396void ev_default_fork (void); 440void ev_default_fork (void);
397 441
398unsigned int ev_backend (EV_P); 442unsigned int ev_backend (EV_P); /* backend in use by loop */
399unsigned int ev_loop_count (EV_P); 443unsigned int ev_loop_count (EV_P); /* number of loop iterations */
400#endif 444#endif
401 445
402#define EVLOOP_NONBLOCK 1 /* do not block/wait */ 446#define EVLOOP_NONBLOCK 1 /* do not block/wait */
403#define EVLOOP_ONESHOT 2 /* block *once* only */ 447#define EVLOOP_ONESHOT 2 /* block *once* only */
404#define EVUNLOOP_CANCEL 0 /* undo unloop */ 448#define EVUNLOOP_CANCEL 0 /* undo unloop */
… …
406#define EVUNLOOP_ALL 2 /* unloop all loops */ 450#define EVUNLOOP_ALL 2 /* unloop all loops */
407 451
408#if EV_PROTOTYPES 452#if EV_PROTOTYPES
409void ev_loop (EV_P_ int flags); 453void 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 */ 454void 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 */
455
456void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
457void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
411 458
412/* 459/*
413 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher 460 * 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 461 * 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. 462 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
… …
429 ((ev_watcher *)(void *)(ev))->pending = \ 476 ((ev_watcher *)(void *)(ev))->pending = \
430 ((ev_watcher *)(void *)(ev))->priority = 0; \ 477 ((ev_watcher *)(void *)(ev))->priority = 0; \
431 ev_set_cb ((ev), cb_); \ 478 ev_set_cb ((ev), cb_); \
432} while (0) 479} while (0)
433 480
434#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0) 481#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) 482#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) 483#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) 484#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) 485#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) 486#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 */ 487#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 */ 488#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 */ 489#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) 490#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 */ 491#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
492#define ev_async_set(ev) do { (ev)->gotasync = 0; } while (0)
445 493
446#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 494#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) 495#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) 496#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) 497#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) 498#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) 499#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) 500#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) 501#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) 502#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) 503#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) 504#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
505#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
457 506
458#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 507#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 */ 508#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
460 509
461#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 510#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
… …
473/* feeds an event into a watcher as if the event actually occured */ 522/* feeds an event into a watcher as if the event actually occured */
474/* accepts any ev_watcher type */ 523/* accepts any ev_watcher type */
475void ev_feed_event (EV_P_ void *w, int revents); 524void ev_feed_event (EV_P_ void *w, int revents);
476void ev_feed_fd_event (EV_P_ int fd, int revents); 525void ev_feed_fd_event (EV_P_ int fd, int revents);
477void ev_feed_signal_event (EV_P_ int signum); 526void ev_feed_signal_event (EV_P_ int signum);
527void ev_invoke (EV_P_ void *w, int revents);
528int ev_clear_pending (EV_P_ void *w);
478 529
479void ev_io_start (EV_P_ ev_io *w); 530void ev_io_start (EV_P_ ev_io *w);
480void ev_io_stop (EV_P_ ev_io *w); 531void ev_io_stop (EV_P_ ev_io *w);
481 532
482void ev_timer_start (EV_P_ ev_timer *w); 533void ev_timer_start (EV_P_ ev_timer *w);
… …
525void ev_embed_start (EV_P_ ev_embed *w); 576void ev_embed_start (EV_P_ ev_embed *w);
526void ev_embed_stop (EV_P_ ev_embed *w); 577void ev_embed_stop (EV_P_ ev_embed *w);
527void ev_embed_sweep (EV_P_ ev_embed *w); 578void ev_embed_sweep (EV_P_ ev_embed *w);
528# endif 579# endif
529 580
581# if EV_ASYNC_ENABLE
582void ev_async_start (EV_P_ ev_async *w);
583void ev_async_stop (EV_P_ ev_async *w);
584void ev_async_send (EV_P_ ev_async *w);
585# endif
586
530#endif 587#endif
531 588
532#ifdef __cplusplus 589#ifdef __cplusplus
533} 590}
534#endif 591#endif

Diff Legend

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