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

Comparing libev/ev.h (file contents):
Revision 1.124 by root, Sun Jul 19 06:35:25 2009 UTC vs.
Revision 1.140 by root, Thu Oct 21 02:33:08 2010 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007,2008,2009 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008,2009,2010 Marc Alexander Lehmann <libev@schmorp.de>
5 * All rights reserved. 5 * All rights reserved.
6 * 6 *
7 * Redistribution and use in source and binary forms, with or without modifica- 7 * Redistribution and use in source and binary forms, with or without modifica-
8 * tion, are permitted provided that the following conditions are met: 8 * tion, are permitted provided that the following conditions are met:
9 * 9 *
… …
35 * and other provisions required by the GPL. If you do not delete the 35 * and other provisions required by the GPL. If you do not delete the
36 * provisions above, a recipient may use your version of this file under 36 * provisions above, a recipient may use your version of this file under
37 * either the BSD or the GPL. 37 * either the BSD or the GPL.
38 */ 38 */
39 39
40#ifndef EV_H__ 40#ifndef EV_H_
41#define EV_H__ 41#define EV_H_
42 42
43#ifdef __cplusplus 43#ifdef __cplusplus
44extern "C" { 44extern "C" {
45#endif 45#endif
46 46
47typedef double ev_tstamp; 47/*****************************************************************************/
48 48
49#ifndef EV_FEATURES
50# define EV_FEATURES 0x7f
51#endif
52
53#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
54#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
55#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
56#define EV_FEATURE_API ((EV_FEATURES) & 8)
57#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 16)
58#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 32)
59#define EV_FEATURE_OS ((EV_FEATURES) & 64)
60
49/* these priorities are inclusive, higher priorities will be called earlier */ 61/* these priorities are inclusive, higher priorities will be invoked earlier */
50#ifndef EV_MINPRI 62#ifndef EV_MINPRI
51# define EV_MINPRI -2 63# define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
52#endif 64#endif
53#ifndef EV_MAXPRI 65#ifndef EV_MAXPRI
54# define EV_MAXPRI +2 66# define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
55#endif 67#endif
56 68
57#ifndef EV_MULTIPLICITY 69#ifndef EV_MULTIPLICITY
58# define EV_MULTIPLICITY 1 70# define EV_MULTIPLICITY EV_FEATURE_CONFIG
59#endif 71#endif
60 72
61#ifndef EV_PERIODIC_ENABLE 73#ifndef EV_PERIODIC_ENABLE
62# define EV_PERIODIC_ENABLE 1 74# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
63#endif 75#endif
64 76
65#ifndef EV_STAT_ENABLE 77#ifndef EV_STAT_ENABLE
66# define EV_STAT_ENABLE 1 78# define EV_STAT_ENABLE EV_FEATURE_WATCHERS
79#endif
80
81#ifndef EV_PREPARE_ENABLE
82# define EV_PREPARE_ENABLE EV_FEATURE_WATCHERS
83#endif
84
85#ifndef EV_CHECK_ENABLE
86# define EV_CHECK_ENABLE EV_FEATURE_WATCHERS
67#endif 87#endif
68 88
69#ifndef EV_IDLE_ENABLE 89#ifndef EV_IDLE_ENABLE
70# define EV_IDLE_ENABLE 1 90# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
71#endif 91#endif
72 92
73#ifndef EV_FORK_ENABLE 93#ifndef EV_FORK_ENABLE
94# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
95#endif
96
97#ifndef EV_SIGNAL_ENABLE
98# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
99#endif
100
101#ifndef EV_CHILD_ENABLE
102# ifdef _WIN32
74# define EV_FORK_ENABLE 1 103# define EV_CHILD_ENABLE 0
104# else
105# define EV_CHILD_ENABLE EV_FEATURE_WATCHERS
106#endif
107#endif
108
109#ifndef EV_ASYNC_ENABLE
110# define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS
75#endif 111#endif
76 112
77#ifndef EV_EMBED_ENABLE 113#ifndef EV_EMBED_ENABLE
78# define EV_EMBED_ENABLE 1 114# define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
79#endif
80
81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1
83#endif 115#endif
84 116
85#ifndef EV_WALK_ENABLE 117#ifndef EV_WALK_ENABLE
86# define EV_WALK_ENABLE 0 /* not yet */ 118# define EV_WALK_ENABLE 0 /* not yet */
87#endif 119#endif
120
121/*****************************************************************************/
122
123#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
124# undef EV_SIGNAL_ENABLE
125# define EV_SIGNAL_ENABLE 1
126#endif
127
128/*****************************************************************************/
129
130typedef double ev_tstamp;
88 131
89#ifndef EV_ATOMIC_T 132#ifndef EV_ATOMIC_T
90# include <signal.h> 133# include <signal.h>
91# define EV_ATOMIC_T sig_atomic_t volatile 134# define EV_ATOMIC_T sig_atomic_t volatile
92#endif 135#endif
93
94/*****************************************************************************/
95 136
96#if EV_STAT_ENABLE 137#if EV_STAT_ENABLE
97# ifdef _WIN32 138# ifdef _WIN32
98# include <time.h> 139# include <time.h>
99# include <sys/types.h> 140# include <sys/types.h>
… …
128# define EV_INLINE static inline 169# define EV_INLINE static inline
129#else 170#else
130# define EV_INLINE static 171# define EV_INLINE static
131#endif 172#endif
132 173
174#ifndef EV_PROTOTYPES
175# define EV_PROTOTYPES 1
176#endif
177
133/*****************************************************************************/ 178/*****************************************************************************/
179
180#define EV_VERSION_MAJOR 4
181#define EV_VERSION_MINOR 0
134 182
135/* eventmask, revents, events... */ 183/* eventmask, revents, events... */
136#define EV_UNDEF -1 /* guaranteed to be invalid */ 184#define EV_UNDEF -1 /* guaranteed to be invalid */
137#define EV_NONE 0x00 /* no events */ 185#define EV_NONE 0x00 /* no events */
138#define EV_READ 0x01 /* ev_io detected read will not block */ 186#define EV_READ 0x01 /* ev_io detected read will not block */
139#define EV_WRITE 0x02 /* ev_io detected write will not block */ 187#define EV_WRITE 0x02 /* ev_io detected write will not block */
140#define EV__IOFDSET 0x80 /* internal use only */ 188#define EV__IOFDSET 0x80 /* internal use only */
141#define EV_IO EV_READ /* alias for type-detection */ 189#define EV_IO EV_READ /* alias for type-detection */
142#define EV_TIMEOUT 0x00000100 /* timer timed out */ 190#define EV_TIMER 0x00000100 /* timer timed out */
143#define EV_TIMER EV_TIMEOUT /* alias for type-detection */ 191#define EV_TIMEOUT EV_TIMER /* pre 4.0 API compatibility */
144#define EV_PERIODIC 0x00000200 /* periodic timer timed out */ 192#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
145#define EV_SIGNAL 0x00000400 /* signal was received */ 193#define EV_SIGNAL 0x00000400 /* signal was received */
146#define EV_CHILD 0x00000800 /* child/pid had status change */ 194#define EV_CHILD 0x00000800 /* child/pid had status change */
147#define EV_STAT 0x00001000 /* stat data changed */ 195#define EV_STAT 0x00001000 /* stat data changed */
148#define EV_IDLE 0x00002000 /* event loop is idling */ 196#define EV_IDLE 0x00002000 /* event loop is idling */
… …
156 204
157/* can be used to add custom fields to all watchers, while losing binary compatibility */ 205/* can be used to add custom fields to all watchers, while losing binary compatibility */
158#ifndef EV_COMMON 206#ifndef EV_COMMON
159# define EV_COMMON void *data; 207# define EV_COMMON void *data;
160#endif 208#endif
161#ifndef EV_PROTOTYPES
162# define EV_PROTOTYPES 1
163#endif
164
165#define EV_VERSION_MAJOR 3
166#define EV_VERSION_MINOR 7
167 209
168#ifndef EV_CB_DECLARE 210#ifndef EV_CB_DECLARE
169# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 211# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
170#endif 212#endif
171#ifndef EV_CB_INVOKE 213#ifndef EV_CB_INVOKE
172# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents)) 214# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
173#endif 215#endif
216
217/* not official, do not use */
218#define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
174 219
175/* 220/*
176 * struct member types: 221 * struct member types:
177 * private: you may look at them, but not change them, 222 * private: you may look at them, but not change them,
178 * and they might not mean anything to you. 223 * and they might not mean anything to you.
… …
189 * or the array index + 1 in the pendings array. 234 * or the array index + 1 in the pendings array.
190 */ 235 */
191 236
192#if EV_MINPRI == EV_MAXPRI 237#if EV_MINPRI == EV_MAXPRI
193# define EV_DECL_PRIORITY 238# define EV_DECL_PRIORITY
194#else 239#elif !defined (EV_DECL_PRIORITY)
195# define EV_DECL_PRIORITY int priority; 240# define EV_DECL_PRIORITY int priority;
196#endif 241#endif
197 242
198/* shared by all watchers */ 243/* shared by all watchers */
199#define EV_WATCHER(type) \ 244#define EV_WATCHER(type) \
… …
363 EV_WATCHER (ev_async) 408 EV_WATCHER (ev_async)
364 409
365 EV_ATOMIC_T sent; /* private */ 410 EV_ATOMIC_T sent; /* private */
366} ev_async; 411} ev_async;
367 412
368# define ev_async_pending(w) ((w)->sent + 0) 413# define ev_async_pending(w) (+(w)->sent)
369#endif 414#endif
370 415
371/* the presence of this union forces similar struct layout */ 416/* the presence of this union forces similar struct layout */
372union ev_any_watcher 417union ev_any_watcher
373{ 418{
… …
404/* flag bits */ 449/* flag bits */
405#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */ 450#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
406#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */ 451#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
407/* debugging/feature disable */ 452/* debugging/feature disable */
408#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */ 453#define EVFLAG_NOINOTIFY 0x00100000U /* do not attempt to use inotify */
454#define EVFLAG_NOSIGFD 0 /* compatibility to pre-3.9 */
409#define EVFLAG_NOSIGFD 0x00200000U /* do not attempt to use signalfd */ 455#define EVFLAG_SIGNALFD 0x00200000U /* attempt to use signalfd */
410/* method bits to be ored together */ 456/* method bits to be ored together */
411#define EVBACKEND_SELECT 0x00000001U /* about anywhere */ 457#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
412#define EVBACKEND_POLL 0x00000002U /* !win */ 458#define EVBACKEND_POLL 0x00000002U /* !win */
413#define EVBACKEND_EPOLL 0x00000004U /* linux */ 459#define EVBACKEND_EPOLL 0x00000004U /* linux */
414#define EVBACKEND_KQUEUE 0x00000008U /* bsd */ 460#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
415#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */ 461#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
416#define EVBACKEND_PORT 0x00000020U /* solaris 10 */ 462#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
463#define EVBACKEND_ALL 0x0000003FU
417 464
418#if EV_PROTOTYPES 465#if EV_PROTOTYPES
419int ev_version_major (void); 466int ev_version_major (void);
420int ev_version_minor (void); 467int ev_version_minor (void);
421 468
… …
540 * convenience function, wait for a single event, without registering an event watcher 587 * convenience function, wait for a single event, without registering an event watcher
541 * if timeout is < 0, do wait indefinitely 588 * if timeout is < 0, do wait indefinitely
542 */ 589 */
543void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg); 590void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
544 591
545# if EV_MINIMAL < 2 592# if EV_FEATURE_API
546unsigned int ev_loop_count (EV_P); /* number of loop iterations */ 593unsigned int ev_iteration (EV_P); /* number of loop iterations */
547unsigned int ev_loop_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */ 594unsigned int ev_depth (EV_P); /* #ev_loop enters - #ev_loop leaves */
548void ev_loop_verify (EV_P); /* abort if loop data corrupted */ 595void ev_verify (EV_P); /* abort if loop data corrupted */
596
597/* pre 4.0 API compatibility */
598# if EV_MULTIPLICITY
599# define ev_loop_count(l) ev_iteration (l)
600# define ev_loop_depth(l) ev_depth (l)
601# define ev_loop_verify(l) ev_verify (l)
602# endif
549 603
550void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 604void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
551void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */ 605void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
552 606
553/* advanced stuff for threading etc. support, see docs */ 607/* advanced stuff for threading etc. support, see docs */
… …
586#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 640#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
587#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 641#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
588#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 642#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
589#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 643#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
590#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 644#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
591#define ev_async_set(ev) do { (ev)->sent = 0; } while (0) 645#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
592 646
593#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 647#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
594#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 648#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
595#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0) 649#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
596#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 650#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
… …
610 664
611#if EV_MINPRI == EV_MAXPRI 665#if EV_MINPRI == EV_MAXPRI
612# define ev_priority(ev) ((ev), EV_MINPRI) 666# define ev_priority(ev) ((ev), EV_MINPRI)
613# define ev_set_priority(ev,pri) ((ev), (pri)) 667# define ev_set_priority(ev,pri) ((ev), (pri))
614#else 668#else
615# define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 669# define ev_priority(ev) (+(((ev_watcher *)(void *)(ev))->priority))
616# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri) 670# define ev_set_priority(ev,pri) ( (ev_watcher *)(void *)(ev))->priority = (pri)
617#endif 671#endif
618 672
619#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.) 673#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
620 674
621#ifndef ev_set_cb 675#ifndef ev_set_cb
622# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 676# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
623#endif 677#endif
624 678
… …
628 682
629/* feeds an event into a watcher as if the event actually occured */ 683/* feeds an event into a watcher as if the event actually occured */
630/* accepts any ev_watcher type */ 684/* accepts any ev_watcher type */
631void ev_feed_event (EV_P_ void *w, int revents); 685void ev_feed_event (EV_P_ void *w, int revents);
632void ev_feed_fd_event (EV_P_ int fd, int revents); 686void ev_feed_fd_event (EV_P_ int fd, int revents);
687#if EV_SIGNAL_ENABLE
633void ev_feed_signal_event (EV_P_ int signum); 688void ev_feed_signal_event (EV_P_ int signum);
689#endif
634void ev_invoke (EV_P_ void *w, int revents); 690void ev_invoke (EV_P_ void *w, int revents);
635int ev_clear_pending (EV_P_ void *w); 691int ev_clear_pending (EV_P_ void *w);
636 692
637void ev_io_start (EV_P_ ev_io *w); 693void ev_io_start (EV_P_ ev_io *w);
638void ev_io_stop (EV_P_ ev_io *w); 694void ev_io_stop (EV_P_ ev_io *w);
… …
649void ev_periodic_stop (EV_P_ ev_periodic *w); 705void ev_periodic_stop (EV_P_ ev_periodic *w);
650void ev_periodic_again (EV_P_ ev_periodic *w); 706void ev_periodic_again (EV_P_ ev_periodic *w);
651#endif 707#endif
652 708
653/* only supported in the default loop */ 709/* only supported in the default loop */
710#if EV_SIGNAL_ENABLE
654void ev_signal_start (EV_P_ ev_signal *w); 711void ev_signal_start (EV_P_ ev_signal *w);
655void ev_signal_stop (EV_P_ ev_signal *w); 712void ev_signal_stop (EV_P_ ev_signal *w);
713#endif
656 714
657/* only supported in the default loop */ 715/* only supported in the default loop */
716# if EV_CHILD_ENABLE
658void ev_child_start (EV_P_ ev_child *w); 717void ev_child_start (EV_P_ ev_child *w);
659void ev_child_stop (EV_P_ ev_child *w); 718void ev_child_stop (EV_P_ ev_child *w);
719# endif
660 720
661# if EV_STAT_ENABLE 721# if EV_STAT_ENABLE
662void ev_stat_start (EV_P_ ev_stat *w); 722void ev_stat_start (EV_P_ ev_stat *w);
663void ev_stat_stop (EV_P_ ev_stat *w); 723void ev_stat_stop (EV_P_ ev_stat *w);
664void ev_stat_stat (EV_P_ ev_stat *w); 724void ev_stat_stat (EV_P_ ev_stat *w);
… …
667# if EV_IDLE_ENABLE 727# if EV_IDLE_ENABLE
668void ev_idle_start (EV_P_ ev_idle *w); 728void ev_idle_start (EV_P_ ev_idle *w);
669void ev_idle_stop (EV_P_ ev_idle *w); 729void ev_idle_stop (EV_P_ ev_idle *w);
670# endif 730# endif
671 731
732#if EV_PREPARE_ENABLE
672void ev_prepare_start (EV_P_ ev_prepare *w); 733void ev_prepare_start (EV_P_ ev_prepare *w);
673void ev_prepare_stop (EV_P_ ev_prepare *w); 734void ev_prepare_stop (EV_P_ ev_prepare *w);
735#endif
674 736
737#if EV_CHECK_ENABLE
675void ev_check_start (EV_P_ ev_check *w); 738void ev_check_start (EV_P_ ev_check *w);
676void ev_check_stop (EV_P_ ev_check *w); 739void ev_check_stop (EV_P_ ev_check *w);
740#endif
677 741
678# if EV_FORK_ENABLE 742# if EV_FORK_ENABLE
679void ev_fork_start (EV_P_ ev_fork *w); 743void ev_fork_start (EV_P_ ev_fork *w);
680void ev_fork_stop (EV_P_ ev_fork *w); 744void ev_fork_stop (EV_P_ ev_fork *w);
681# endif 745# endif

Diff Legend

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