[ViewVC] Diff of: cvs/libev/ev.h

Comparing libev/ev.h (file contents):
Revision 1.10 by root, Wed Oct 31 14:44:15 2007 UTC vs.
Revision 1.146 by root, Fri Oct 22 06:14:28 2010 UTC

1	/*	1	/*
		2	* libev native API header
		3	*
2	* Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>	4	* Copyright (c) 2007,2008,2009,2010 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_
		42
		43	#ifdef __cplusplus
		44	extern "C" {
		45	#endif
		46
		47	/*****************************************************************************/
		48
		49	/* pre-4.0 compatibility */
		50	#ifndef EV_COMPAT3
		51	# define EV_COMPAT3 1
		52	#endif
		53
		54	#ifndef EV_FEATURES
		55	# define EV_FEATURES 0x7f
		56	#endif
		57
		58	#define EV_FEATURE_CODE ((EV_FEATURES) & 1)
		59	#define EV_FEATURE_DATA ((EV_FEATURES) & 2)
		60	#define EV_FEATURE_CONFIG ((EV_FEATURES) & 4)
		61	#define EV_FEATURE_API ((EV_FEATURES) & 8)
		62	#define EV_FEATURE_WATCHERS ((EV_FEATURES) & 16)
		63	#define EV_FEATURE_BACKENDS ((EV_FEATURES) & 32)
		64	#define EV_FEATURE_OS ((EV_FEATURES) & 64)
		65
		66	/* these priorities are inclusive, higher priorities will be invoked earlier */
		67	#ifndef EV_MINPRI
		68	# define EV_MINPRI (EV_FEATURE_CONFIG ? -2 : 0)
		69	#endif
		70	#ifndef EV_MAXPRI
		71	# define EV_MAXPRI (EV_FEATURE_CONFIG ? +2 : 0)
		72	#endif
		73
		74	#ifndef EV_MULTIPLICITY
		75	# define EV_MULTIPLICITY EV_FEATURE_CONFIG
		76	#endif
		77
		78	#ifndef EV_PERIODIC_ENABLE
		79	# define EV_PERIODIC_ENABLE EV_FEATURE_WATCHERS
		80	#endif
		81
		82	#ifndef EV_STAT_ENABLE
		83	# define EV_STAT_ENABLE EV_FEATURE_WATCHERS
		84	#endif
		85
		86	#ifndef EV_PREPARE_ENABLE
		87	# define EV_PREPARE_ENABLE EV_FEATURE_WATCHERS
		88	#endif
		89
		90	#ifndef EV_CHECK_ENABLE
		91	# define EV_CHECK_ENABLE EV_FEATURE_WATCHERS
		92	#endif
		93
		94	#ifndef EV_IDLE_ENABLE
		95	# define EV_IDLE_ENABLE EV_FEATURE_WATCHERS
		96	#endif
		97
		98	#ifndef EV_FORK_ENABLE
		99	# define EV_FORK_ENABLE EV_FEATURE_WATCHERS
		100	#endif
		101
		102	#ifndef EV_SIGNAL_ENABLE
		103	# define EV_SIGNAL_ENABLE EV_FEATURE_WATCHERS
		104	#endif
		105
		106	#ifndef EV_CHILD_ENABLE
		107	# ifdef _WIN32
		108	# define EV_CHILD_ENABLE 0
		109	# else
		110	# define EV_CHILD_ENABLE EV_FEATURE_WATCHERS
		111	#endif
		112	#endif
		113
		114	#ifndef EV_ASYNC_ENABLE
		115	# define EV_ASYNC_ENABLE EV_FEATURE_WATCHERS
		116	#endif
		117
		118	#ifndef EV_EMBED_ENABLE
		119	# define EV_EMBED_ENABLE EV_FEATURE_WATCHERS
		120	#endif
		121
		122	#ifndef EV_WALK_ENABLE
		123	# define EV_WALK_ENABLE 0 /* not yet */
		124	#endif
		125
		126	/*****************************************************************************/
		127
		128	#if EV_CHILD_ENABLE && !EV_SIGNAL_ENABLE
		129	# undef EV_SIGNAL_ENABLE
		130	# define EV_SIGNAL_ENABLE 1
		131	#endif
		132
		133	/*****************************************************************************/
32		134
33	typedef double ev_tstamp;	135	typedef double ev_tstamp;
34		136
35	/* eventmask, revents, events... */	137	#ifndef EV_ATOMIC_T
36	#define EV_UNDEF -1 /* guaranteed to be invalid */	138	# include <signal.h>
37	#define EV_NONE 0x00	139	# define EV_ATOMIC_T sig_atomic_t volatile
38	#define EV_READ 0x01	140	#endif
39	#define EV_WRITE 0x02
40	#define EV_TIMEOUT 0x04
41	#define EV_SIGNAL 0x08
42	#define EV_IDLE 0x10
43	#define EV_CHECK 0x20
44	#define EV_ERROR (0x3f\|0x80)
45		141
46	/* can be used to add custom fields to all watchers */	142	#if EV_STAT_ENABLE
47	#ifndef EV_COMMON	143	# ifdef _WIN32
48	# define EV_COMMON void *data	144	# include <time.h>
		145	# include <sys/types.h>
49	#endif	146	# endif
		147	# include <sys/stat.h>
		148	#endif
		149
		150	/* in C++ we can use this to provide default arguments */
		151	#ifdef __cplusplus
		152	# define EV_DEFARG(x) = x
		153	#else
		154	# define EV_DEFARG(x)
		155	#endif
		156
		157	/* support multiple event loops? */
		158	#if EV_MULTIPLICITY
		159	struct ev_loop;
		160	# define EV_P struct ev_loop loop / a loop as sole parameter in a declaration */
		161	# define EV_P_ EV_P, /* a loop as first of multiple parameters */
		162	# define EV_A loop /* a loop as sole argument to a function call */
		163	# define EV_A_ EV_A, /* a loop as first of multiple arguments */
		164	# define EV_DEFAULT_UC ev_default_loop_uc () /* the default loop, if initialised, as sole arg */
		165	# define EV_DEFAULT_UC_ EV_DEFAULT_UC, /* the default loop as first of multiple arguments */
		166	# define EV_DEFAULT ev_default_loop (0) /* the default loop as sole arg */
		167	# define EV_DEFAULT_ EV_DEFAULT, /* the default loop as first of multiple arguments */
		168	# define EV_PDEF EV_P EV_DEFARG (EV_DEFAULT_UC) /* EV_P, but with default argument in C++ */
		169	# define EV_PDEF_ EV_P EV_DEFARG (EV_DEFAULT_UC), /* EV_P_, but with default argument in C++ */
		170	#else
		171	# define EV_P void
		172	# define EV_P_
		173	# define EV_A
		174	# define EV_A_
		175	# define EV_DEFAULT
		176	# define EV_DEFAULT_
		177	# define EV_DEFAULT_UC
		178	# define EV_DEFAULT_UC_
		179	# define EV_PDEF EV_P
		180	# define EV_PDEF_ EV_P_
		181	# undef EV_EMBED_ENABLE
		182	#endif
		183
		184	/* EV_INLINE is used for functions in header files */
		185	#if __STDC_VERSION__ >= 199901L \|\| __GNUC__ >= 3
		186	# define EV_INLINE static inline
		187	#else
		188	# define EV_INLINE static
		189	#endif
		190
		191	/* EV_PROTOTYPES can be sued to switch of prototype declarations */
50	#ifndef EV_PROTOTYPES	192	#ifndef EV_PROTOTYPES
51	# define EV_PROTOTYPES 1	193	# define EV_PROTOTYPES 1
52	#endif	194	#endif
53		195
		196	/*****************************************************************************/
		197
		198	#define EV_VERSION_MAJOR 4
		199	#define EV_VERSION_MINOR 0
		200
		201	/* eventmask, revents, events... */
		202	enum {
		203	EV_UNDEF = -1, /* guaranteed to be invalid */
		204	EV_NONE = 0x00, /* no events */
		205	EV_READ = 0x01, /* ev_io detected read will not block */
		206	EV_WRITE = 0x02, /* ev_io detected write will not block */
		207	EV__IOFDSET = 0x80, /* internal use only */
		208	EV_IO = EV_READ, /* alias for type-detection */
		209	EV_TIMER = 0x00000100, /* timer timed out */
		210	#if EV_COMPAT3
		211	EV_TIMEOUT = EV_TIMER, /* pre 4.0 API compatibility */
		212	#endif
		213	EV_PERIODIC = 0x00000200, /* periodic timer timed out */
		214	EV_SIGNAL = 0x00000400, /* signal was received */
		215	EV_CHILD = 0x00000800, /* child/pid had status change */
		216	EV_STAT = 0x00001000, /* stat data changed */
		217	EV_IDLE = 0x00002000, /* event loop is idling */
		218	EV_PREPARE = 0x00004000, /* event loop about to poll */
		219	EV_CHECK = 0x00008000, /* event loop finished poll */
		220	EV_EMBED = 0x00010000, /* embedded event loop needs sweep */
		221	EV_FORK = 0x00020000, /* event loop resumed in child */
		222	EV_ASYNC = 0x00040000, /* async intra-loop signal */
		223	EV_CUSTOM = 0x01000000, /* for use by user code */
		224	EV_ERROR = 0x80000000 /* sent when an error occurs */
		225	};
		226
		227	/* can be used to add custom fields to all watchers, while losing binary compatibility */
		228	#ifndef EV_COMMON
		229	# define EV_COMMON void *data;
		230	#endif
		231
		232	#ifndef EV_CB_DECLARE
		233	# define EV_CB_DECLARE(type) void (cb)(EV_P_ struct type w, int revents);
		234	#endif
		235	#ifndef EV_CB_INVOKE
		236	# define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
		237	#endif
		238
		239	/* not official, do not use */
		240	#define EV_CB(type,name) void name (EV_P_ struct ev_ ## type *w, int revents)
		241
54	/*	242	/*
55	* struct member types:	243	* struct member types:
56	* private: you can look at them, but not change them, and they might not mean anything to you.	244	* private: you may look at them, but not change them,
		245	* and they might not mean anything to you.
57	* ro: can be read anytime, but only changed when the watcher isn't active	246	* ro: can be read anytime, but only changed when the watcher isn't active.
58	* rw: can be read and modified anytime, even when the watcher is active	247	* rw: can be read and modified anytime, even when the watcher is active.
		248	*
		249	* some internal details that might be helpful for debugging:
		250	*
		251	* active is either 0, which means the watcher is not active,
		252	* or the array index of the watcher (periodics, timers)
		253	* or the array index + 1 (most other watchers)
		254	* or simply 1 for watchers that aren't in some array.
		255	* pending is either 0, in which case the watcher isn't,
		256	* or the array index + 1 in the pendings array.
59	*/	257	*/
		258
		259	#if EV_MINPRI == EV_MAXPRI
		260	# define EV_DECL_PRIORITY
		261	#elif !defined (EV_DECL_PRIORITY)
		262	# define EV_DECL_PRIORITY int priority;
		263	#endif
60		264
61	/* shared by all watchers */	265	/* shared by all watchers */
62	#define EV_WATCHER(type) \	266	#define EV_WATCHER(type) \
63	int active; /* private */ \	267	int active; /* private */ \
64	int pending; /* private */ \	268	int pending; /* private */ \
		269	EV_DECL_PRIORITY /* private */ \
65	EV_COMMON; /* rw */ \	270	EV_COMMON /* rw */ \
66	void (cb)(struct type , int revents); /* rw / / gets invoked with an eventmask */	271	EV_CB_DECLARE (type) /* private */
67		272
68	#define EV_WATCHER_LIST(type) \	273	#define EV_WATCHER_LIST(type) \
69	EV_WATCHER (type); \	274	EV_WATCHER (type) \
70	struct type next / private */	275	struct ev_watcher_list next; / private */
71		276
72	#define EV_WATCHER_TIME(type) \	277	#define EV_WATCHER_TIME(type) \
73	EV_WATCHER (type); \	278	EV_WATCHER (type) \
74	ev_tstamp at /* private */	279	ev_tstamp at; /* private */
75		280
76	/* base class, nothing to see here unless you subclass */	281	/* base class, nothing to see here unless you subclass */
77	struct ev_watcher {	282	typedef struct ev_watcher
		283	{
78	EV_WATCHER (ev_watcher);	284	EV_WATCHER (ev_watcher)
79	};	285	} ev_watcher;
80		286
81	/* base class, nothing to see here unless you subclass */	287	/* base class, nothing to see here unless you subclass */
82	struct ev_watcher_list {	288	typedef struct ev_watcher_list
		289	{
83	EV_WATCHER_LIST (ev_watcher_list);	290	EV_WATCHER_LIST (ev_watcher_list)
84	};	291	} ev_watcher_list;
85		292
86	/* base class, nothing to see here unless you subclass */	293	/* base class, nothing to see here unless you subclass */
87	struct ev_watcher_time {	294	typedef struct ev_watcher_time
		295	{
88	EV_WATCHER_TIME (ev_watcher_time);	296	EV_WATCHER_TIME (ev_watcher_time)
89	};	297	} ev_watcher_time;
90
91	/* invoked after a specific time, repeatable (based on monotonic clock) */
92	struct ev_timer
93	{
94	EV_WATCHER_TIME (ev_timer);
95
96	ev_tstamp repeat; /* rw */
97	};
98
99	/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
100	struct ev_periodic
101	{
102	EV_WATCHER_TIME (ev_periodic);
103
104	ev_tstamp interval; /* rw */
105	};
106		298
107	/* invoked when fd is either EV_READable or EV_WRITEable */	299	/* invoked when fd is either EV_READable or EV_WRITEable */
		300	/* revent EV_READ, EV_WRITE */
108	struct ev_io	301	typedef struct ev_io
109	{	302	{
110	EV_WATCHER_LIST (ev_io);	303	EV_WATCHER_LIST (ev_io)
111		304
112	int fd; /* ro */	305	int fd; /* ro */
113	int events; /* ro */	306	int events; /* ro */
		307	} ev_io;
		308
		309	/* invoked after a specific time, repeatable (based on monotonic clock) */
		310	/* revent EV_TIMEOUT */
		311	typedef struct ev_timer
		312	{
		313	EV_WATCHER_TIME (ev_timer)
		314
		315	ev_tstamp repeat; /* rw */
		316	} ev_timer;
		317
		318	/* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
		319	/* revent EV_PERIODIC */
		320	typedef struct ev_periodic
		321	{
		322	EV_WATCHER_TIME (ev_periodic)
		323
		324	ev_tstamp offset; /* rw */
		325	ev_tstamp interval; /* rw */
		326	ev_tstamp (reschedule_cb)(struct ev_periodic w, ev_tstamp now); /* rw */
		327	} ev_periodic;
		328
		329	/* invoked when the given signal has been received */
		330	/* revent EV_SIGNAL */
		331	typedef struct ev_signal
		332	{
		333	EV_WATCHER_LIST (ev_signal)
		334
		335	int signum; /* ro */
		336	} ev_signal;
		337
		338	/* invoked when sigchld is received and waitpid indicates the given pid */
		339	/* revent EV_CHILD */
		340	/* does not support priorities */
		341	typedef struct ev_child
		342	{
		343	EV_WATCHER_LIST (ev_child)
		344
		345	int flags; /* private */
		346	int pid; /* ro */
		347	int rpid; /* rw, holds the received pid */
		348	int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
		349	} ev_child;
		350
		351	#if EV_STAT_ENABLE
		352	/* st_nlink = 0 means missing file or other error */
		353	# ifdef _WIN32
		354	typedef struct _stati64 ev_statdata;
		355	# else
		356	typedef struct stat ev_statdata;
		357	# endif
		358
		359	/* invoked each time the stat data changes for a given path */
		360	/* revent EV_STAT */
		361	typedef struct ev_stat
		362	{
		363	EV_WATCHER_LIST (ev_stat)
		364
		365	ev_timer timer; /* private */
		366	ev_tstamp interval; /* ro */
		367	const char path; / ro */
		368	ev_statdata prev; /* ro */
		369	ev_statdata attr; /* ro */
		370
		371	int wd; /* wd for inotify, fd for kqueue */
		372	} ev_stat;
		373	#endif
		374
		375	#if EV_IDLE_ENABLE
		376	/* invoked when the nothing else needs to be done, keeps the process from blocking */
		377	/* revent EV_IDLE */
		378	typedef struct ev_idle
		379	{
		380	EV_WATCHER (ev_idle)
		381	} ev_idle;
		382	#endif
		383
		384	/* invoked for each run of the mainloop, just before the blocking call */
		385	/* you can still change events in any way you like */
		386	/* revent EV_PREPARE */
		387	typedef struct ev_prepare
		388	{
		389	EV_WATCHER (ev_prepare)
		390	} ev_prepare;
		391
		392	/* invoked for each run of the mainloop, just after the blocking call */
		393	/* revent EV_CHECK */
		394	typedef struct ev_check
		395	{
		396	EV_WATCHER (ev_check)
		397	} ev_check;
		398
		399	#if EV_FORK_ENABLE
		400	/* the callback gets invoked before check in the child process when a fork was detected */
		401	typedef struct ev_fork
		402	{
		403	EV_WATCHER (ev_fork)
		404	} ev_fork;
		405	#endif
		406
		407	#if EV_EMBED_ENABLE
		408	/* used to embed an event loop inside another */
		409	/* the callback gets invoked when the event loop has handled events, and can be 0 */
		410	typedef struct ev_embed
		411	{
		412	EV_WATCHER (ev_embed)
		413
		414	struct ev_loop other; / ro */
		415	ev_io io; /* private */
		416	ev_prepare prepare; /* private */
		417	ev_check check; /* unused */
		418	ev_timer timer; /* unused */
		419	ev_periodic periodic; /* unused */
		420	ev_idle idle; /* unused */
		421	ev_fork fork; /* private */
		422	} ev_embed;
		423	#endif
		424
		425	#if EV_ASYNC_ENABLE
		426	/* invoked when somebody calls ev_async_send on the watcher */
		427	/* revent EV_ASYNC */
		428	typedef struct ev_async
		429	{
		430	EV_WATCHER (ev_async)
		431
		432	EV_ATOMIC_T sent; /* private */
		433	} ev_async;
		434
		435	# define ev_async_pending(w) (+(w)->sent)
		436	#endif
		437
		438	/* the presence of this union forces similar struct layout */
		439	union ev_any_watcher
		440	{
		441	struct ev_watcher w;
		442	struct ev_watcher_list wl;
		443
		444	struct ev_io io;
		445	struct ev_timer timer;
		446	struct ev_periodic periodic;
		447	struct ev_signal signal;
		448	struct ev_child child;
		449	#if EV_STAT_ENABLE
		450	struct ev_stat stat;
		451	#endif
		452	#if EV_IDLE_ENABLE
		453	struct ev_idle idle;
		454	#endif
		455	struct ev_prepare prepare;
		456	struct ev_check check;
		457	#if EV_FORK_ENABLE
		458	struct ev_fork fork;
		459	#endif
		460	#if EV_EMBED_ENABLE
		461	struct ev_embed embed;
		462	#endif
		463	#if EV_ASYNC_ENABLE
		464	struct ev_async async;
		465	#endif
114	};	466	};
115		467
116	/* invoked when the given signal has been received */	468	/* flag bits for ev_default_loop and ev_loop_new */
117	struct ev_signal	469	enum {
118	{	470	/* the default */
119	EV_WATCHER_LIST (ev_signal);	471	EVFLAG_AUTO = 0x00000000U, /* not quite a mask */
120		472	/* flag bits */
121	int signum; /* ro */	473	EVFLAG_NOENV = 0x01000000U, /* do NOT consult environment */
		474	EVFLAG_FORKCHECK = 0x02000000U, /* check for a fork in each iteration */
		475	/* debugging/feature disable */
		476	EVFLAG_NOINOTIFY = 0x00100000U, /* do not attempt to use inotify */
		477	#if EV_COMPAT3
		478	EVFLAG_NOSIGFD = 0, /* compatibility to pre-3.9 */
		479	#endif
		480	EVFLAG_SIGNALFD = 0x00200000U /* attempt to use signalfd */
122	};	481	};
123		482
124	/* invoked when the nothing else needs to be done, keeps the process from blocking */	483	/* method bits to be ored together */
125	struct ev_idle	484	enum {
126	{	485	EVBACKEND_SELECT = 0x00000001U, /* about anywhere */
127	EV_WATCHER (ev_idle);	486	EVBACKEND_POLL = 0x00000002U, /* !win */
		487	EVBACKEND_EPOLL = 0x00000004U, /* linux */
		488	EVBACKEND_KQUEUE = 0x00000008U, /* bsd */
		489	EVBACKEND_DEVPOLL = 0x00000010U, /* solaris 8 / / NYI */
		490	EVBACKEND_PORT = 0x00000020U, /* solaris 10 */
		491	EVBACKEND_ALL = 0x0000003FU
128	};	492	};
129		493
130	/* invoked for each run of the mainloop, just before the next blocking vall is initiated */	494	#if EV_PROTOTYPES
131	struct ev_check	495	int ev_version_major (void);
		496	int ev_version_minor (void);
		497
		498	unsigned int ev_supported_backends (void);
		499	unsigned int ev_recommended_backends (void);
		500	unsigned int ev_embeddable_backends (void);
		501
		502	ev_tstamp ev_time (void);
		503	void ev_sleep (ev_tstamp delay); /* sleep for a while */
		504
		505	/* Sets the allocation function to use, works like realloc.
		506	* It is used to allocate and free memory.
		507	* If it returns zero when memory needs to be allocated, the library might abort
		508	* or take some potentially destructive action.
		509	* The default is your system realloc function.
		510	*/
		511	void ev_set_allocator (void (cb)(void *ptr, long size));
		512
		513	/* set the callback function to call on a
		514	* retryable syscall error
		515	* (such as failed select, poll, epoll_wait)
		516	*/
		517	void ev_set_syserr_cb (void (cb)(const char msg));
		518
		519	#if EV_MULTIPLICITY
		520	EV_INLINE struct ev_loop *
		521	ev_default_loop_uc (void)
132	{	522	{
133	EV_WATCHER (ev_check);	523	extern struct ev_loop *ev_default_loop_ptr;
		524
		525	return ev_default_loop_ptr;
		526	}
		527
		528	/* the default loop is the only one that handles signals and child watchers */
		529	/* you can call this as often as you like */
		530	EV_INLINE struct ev_loop *
		531	ev_default_loop (unsigned int flags EV_DEFARG (0))
		532	{
		533	struct ev_loop *loop = ev_default_loop_uc ();
		534
		535	if (!loop)
		536	{
		537	extern struct ev_loop *ev_default_loop_init (unsigned int flags);
		538
		539	loop = ev_default_loop_init (flags);
		540	}
		541
		542	return loop;
		543	}
		544
		545	/* create and destroy alternative loops that don't handle signals */
		546	struct ev_loop *ev_loop_new (unsigned int flags EV_DEFARG (0));
		547	void ev_loop_destroy (EV_PDEF);
		548	void ev_loop_fork (EV_PDEF);
		549
		550	ev_tstamp ev_now (EV_PDEF); /* time w.r.t. timers and the eventloop, updated after each poll */
		551
		552	#else
		553
		554	int ev_default_loop (unsigned int flags EV_DEFARG (0)); /* returns true when successful */
		555
		556	EV_INLINE ev_tstamp
		557	ev_now (void)
		558	{
		559	extern ev_tstamp ev_rt_now;
		560
		561	return ev_rt_now;
		562	}
		563	#endif /* multiplicity */
		564
		565	EV_INLINE int
		566	ev_is_default_loop (EV_PDEF)
		567	{
		568	#if EV_MULTIPLICITY
		569	extern struct ev_loop *ev_default_loop_ptr;
		570
		571	return !!(EV_A == ev_default_loop_ptr);
		572	#else
		573	return 1;
		574	#endif
		575	}
		576
		577	void ev_default_destroy (void); /* destroy the default loop */
		578	/* this needs to be called after fork, to duplicate the default loop */
		579	/* if you create alternative loops you have to call ev_loop_fork on them */
		580	/* you can call it in either the parent or the child */
		581	/* you can actually call it at any time, anywhere :) */
		582	void ev_default_fork (void);
		583
		584	unsigned int ev_backend (EV_PDEF); /* backend in use by loop */
		585
		586	void ev_now_update (EV_PDEF); /* update event loop time */
		587
		588	#if EV_WALK_ENABLE
		589	/* walk (almost) all watchers in the loop of a given type, invoking the */
		590	/* callback on every such watcher. The callback might stop the watcher, */
		591	/* but do nothing else with the loop */
		592	void ev_walk (EV_P_ int types, void (cb)(EV_P_ int type, void w));
		593	#endif
		594
		595	#endif /* prototypes */
		596
		597	/* ev_run flags values */
		598	enum {
		599	EVRUN_NOWAIT = 1, /* do not block/wait */
		600	EVRUN_ONCE = 2 /* block once only */
134	};	601	};
135		602
136	#define EVMETHOD_NONE 0	603	/* ev_break how values */
137	#define EVMETHOD_SELECT 1	604	enum {
138	#define EVMETHOD_EPOLL 2	605	EVBREAK_CANCEL = 0, /* undo unloop */
		606	EVBREAK_ONE = 1, /* unloop once */
		607	EVBREAK_ALL = 2 /* unloop all loops */
		608	};
		609
139	#if EV_PROTOTYPES	610	#if EV_PROTOTYPES
140	extern int ev_method;	611	void ev_run (EV_PDEF_ int flags EV_DEFARG (0));
141	int ev_init (int flags); /* returns ev_method */	612	void ev_break (EV_PDEF_ int how EV_DEFARG (EVBREAK_ONE)); /* break out of the loop */
142		613
143	/* these three calls are suitable for plugging into pthread_atfork */	614	/*
144	void ev_prefork (void);	615	* ref/unref can be used to add or remove a refcount on the mainloop. every watcher
145	void ev_postfork_parent (void);	616	* keeps one reference. if you have a long-running watcher you never unregister that
146	void ev_postfork_child (void);	617	* should not keep ev_loop from running, unref() after starting, and ref() before stopping.
		618	*/
		619	void ev_ref (EV_PDEF);
		620	void ev_unref (EV_PDEF);
147		621
148	extern ev_tstamp ev_now; /* time w.r.t. timers and the eventloop, updated after each poll */	622	/*
149	ev_tstamp ev_time (void);
150	#endif
151
152	#define EVLOOP_NONBLOCK 1 /* do not block/wait */
153	#define EVLOOP_ONESHOT 2 /* block once only */
154	#if EV_PROTOTYPES
155	void ev_loop (int flags);
156	extern int ev_loop_done; /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
157
158	/* convinience function, wait for a single event, without registering an event watcher */	623	* convenience function, wait for a single event, without registering an event watcher
159	/* if timeout is < 0, do wait indefinitely */	624	* if timeout is < 0, do wait indefinitely
		625	*/
160	void ev_once (int fd, int events, ev_tstamp timeout, void (cb)(int revents, void arg), void *arg);	626	void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (cb)(int revents, void arg), void *arg);
		627
		628	# if EV_FEATURE_API
		629	unsigned int ev_iteration (EV_PDEF); /* number of loop iterations */
		630	unsigned int ev_depth (EV_PDEF); /* #ev_loop enters - #ev_loop leaves */
		631	void ev_verify (EV_PDEF); /* abort if loop data corrupted */
		632
		633	void ev_set_io_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
		634	void ev_set_timeout_collect_interval (EV_P_ ev_tstamp interval); /* sleep at least this time, default 0 */
		635
		636	/* advanced stuff for threading etc. support, see docs */
		637	void ev_set_userdata (EV_P_ void *data);
		638	void *ev_userdata (EV_PDEF);
		639	void ev_set_invoke_pending_cb (EV_P_ void (*invoke_pending_cb)(EV_P));
		640	void ev_set_loop_release_cb (EV_P_ void (release)(EV_P), void (acquire)(EV_P));
		641
		642	unsigned int ev_pending_count (EV_PDEF); /* number of pending events, if any */
		643	void ev_invoke_pending (EV_PDEF); /* invoke all pending watchers */
		644
		645	/*
		646	* stop/start the timer handling.
		647	*/
		648	void ev_suspend (EV_PDEF);
		649	void ev_resume (EV_PDEF);
		650	#endif
		651
161	#endif	652	#endif
162		653
163	/* these may evaluate ev multiple times, and the other arguments at most once */	654	/* these may evaluate ev multiple times, and the other arguments at most once */
164	/* either use evw_init + evXXX_set, or the evXXX_init macro, below, to first initialise a watcher */	655	/* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
165	#define evw_init(ev,cb_) do { (ev)->active = 0; (ev)->pending = 0; (ev)->cb = (cb_); } while (0)	656	#define ev_init(ev,cb_) do { \
		657	((ev_watcher )(void )(ev))->active = \
		658	((ev_watcher )(void )(ev))->pending = 0; \
		659	ev_set_priority ((ev), 0); \
		660	ev_set_cb ((ev), cb_); \
		661	} while (0)
166		662
167	#define evio_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)	663	#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) \| EV__IOFDSET; } while (0)
168	#define evtimer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)	664	#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
169	#define evperiodic_set(ev,at_,interval_) do { (ev)->at = (at_); (ev)->interval = (interval_); } while (0)	665	#define ev_periodic_set(ev,ofs_,ival_,rcb_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb = (rcb_); } while (0)
170	#define evsignal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)	666	#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
171	#define evcheck_set(ev) /* nop, yes, this is a serious in-joke */	667	#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
		668	#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
172	#define evidle_set(ev) /* nop, yes, this is a serious in-joke */	669	#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
		670	#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
		671	#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
		672	#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
		673	#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
		674	#define ev_async_set(ev) /* nop, yes, this is a serious in-joke */
173		675
174	#define evio_init(ev,cb,fd,events) do { evw_init ((ev), (cb)); evio_set ((ev),(fd),(events)); } while (0)	676	#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
175	#define evtimer_init(ev,cb,after,repeat) do { evw_init ((ev), (cb)); evtimer_set ((ev),(after),(repeat)); } while (0)	677	#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
176	#define evperiodic_init(ev,cb,at,interval) do { evw_init ((ev), (cb)); evperiodic_set ((ev),(at),(interval)); } while (0)	678	#define ev_periodic_init(ev,cb,ofs,ival,rcb) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(ofs),(ival),(rcb)); } while (0)
177	#define evsignal_init(ev,cb,signum) do { evw_init ((ev), (cb)); evsignal_set ((ev), (signum)); } while (0)	679	#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
		680	#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
		681	#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
		682	#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
		683	#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
178	#define evcheck_init(ev,cb) do { evw_init ((ev), (cb)); evcheck_set ((ev)); } while (0)	684	#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
		685	#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
179	#define evidle_init(ev,cb) do { evw_init ((ev), (cb)); evidle_set ((ev)); } while (0)	686	#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
		687	#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
180		688
		689	#define ev_is_pending(ev) (0 + ((ev_watcher )(void )(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
181	#define ev_is_active(ev) (0 + (ev)->active) /* true when the watcher has been started */	690	#define ev_is_active(ev) (0 + ((ev_watcher )(void )(ev))->active) /* ro, true when the watcher has been started */
		691
		692	#define ev_cb(ev) (ev)->cb /* rw */
		693
		694	#if EV_MINPRI == EV_MAXPRI
		695	# define ev_priority(ev) ((ev), EV_MINPRI)
		696	# define ev_set_priority(ev,pri) ((ev), (pri))
		697	#else
		698	# define ev_priority(ev) (+(((ev_watcher )(void )(ev))->priority))
		699	# define ev_set_priority(ev,pri) ( (ev_watcher )(void )(ev))->priority = (pri)
		700	#endif
		701
		702	#define ev_periodic_at(ev) (+((ev_watcher_time *)(ev))->at)
		703
		704	#ifndef ev_set_cb
		705	# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
		706	#endif
182		707
183	/* stopping (enabling, adding) a watcher does nothing if it is already running */	708	/* stopping (enabling, adding) a watcher does nothing if it is already running */
184	/* stopping (disabling, deleting) a watcher does nothing unless its already running */	709	/* stopping (disabling, deleting) a watcher does nothing unless its already running */
185	#if EV_PROTOTYPES	710	#if EV_PROTOTYPES
		711
		712	/* feeds an event into a watcher as if the event actually occured */
		713	/* accepts any ev_watcher type */
		714	void ev_feed_event (EV_P_ void *w, int revents);
		715	void ev_feed_fd_event (EV_P_ int fd, int revents);
		716	#if EV_SIGNAL_ENABLE
		717	void ev_feed_signal_event (EV_P_ int signum);
		718	#endif
		719	void ev_invoke (EV_P_ void *w, int revents);
		720	int ev_clear_pending (EV_P_ void *w);
		721
186	void evio_start (struct ev_io *w);	722	void ev_io_start (EV_P_ ev_io *w);
187	void evio_stop (struct ev_io *w);	723	void ev_io_stop (EV_P_ ev_io *w);
188		724
189	void evtimer_start (struct ev_timer *w);	725	void ev_timer_start (EV_P_ ev_timer *w);
190	void evtimer_stop (struct ev_timer *w);	726	void ev_timer_stop (EV_P_ ev_timer *w);
191	void evtimer_again (struct ev_timer w); / stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */	727	/* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
		728	void ev_timer_again (EV_P_ ev_timer *w);
		729	/* return remaining time */
		730	ev_tstamp ev_timer_remaining (EV_P_ ev_timer *w);
192		731
		732	#if EV_PERIODIC_ENABLE
193	void evperiodic_start (struct ev_periodic *w);	733	void ev_periodic_start (EV_P_ ev_periodic *w);
194	void evperiodic_stop (struct ev_periodic *w);	734	void ev_periodic_stop (EV_P_ ev_periodic *w);
		735	void ev_periodic_again (EV_P_ ev_periodic *w);
		736	#endif
195		737
		738	/* only supported in the default loop */
		739	#if EV_SIGNAL_ENABLE
196	void evsignal_start (struct ev_signal *w);	740	void ev_signal_start (EV_P_ ev_signal *w);
197	void evsignal_stop (struct ev_signal *w);	741	void ev_signal_stop (EV_P_ ev_signal *w);
		742	#endif
198		743
199	void evidle_start (struct ev_idle *w);	744	/* only supported in the default loop */
200	void evidle_stop (struct ev_idle *w);	745	# if EV_CHILD_ENABLE
201		746	void ev_child_start (EV_P_ ev_child *w);
202	void evcheck_start (struct ev_check *w);	747	void ev_child_stop (EV_P_ ev_child *w);
203	void evcheck_stop (struct ev_check *w);
204	#endif	748	# endif
205		749
		750	# if EV_STAT_ENABLE
		751	void ev_stat_start (EV_P_ ev_stat *w);
		752	void ev_stat_stop (EV_P_ ev_stat *w);
		753	void ev_stat_stat (EV_P_ ev_stat *w);
206	#endif	754	# endif
207		755
		756	# if EV_IDLE_ENABLE
		757	void ev_idle_start (EV_P_ ev_idle *w);
		758	void ev_idle_stop (EV_P_ ev_idle *w);
		759	# endif
		760
		761	#if EV_PREPARE_ENABLE
		762	void ev_prepare_start (EV_P_ ev_prepare *w);
		763	void ev_prepare_stop (EV_P_ ev_prepare *w);
		764	#endif
		765
		766	#if EV_CHECK_ENABLE
		767	void ev_check_start (EV_P_ ev_check *w);
		768	void ev_check_stop (EV_P_ ev_check *w);
		769	#endif
		770
		771	# if EV_FORK_ENABLE
		772	void ev_fork_start (EV_P_ ev_fork *w);
		773	void ev_fork_stop (EV_P_ ev_fork *w);
		774	# endif
		775
		776	# if EV_EMBED_ENABLE
		777	/* only supported when loop to be embedded is in fact embeddable */
		778	void ev_embed_start (EV_P_ ev_embed *w);
		779	void ev_embed_stop (EV_P_ ev_embed *w);
		780	void ev_embed_sweep (EV_P_ ev_embed *w);
		781	# endif
		782
		783	# if EV_ASYNC_ENABLE
		784	void ev_async_start (EV_P_ ev_async *w);
		785	void ev_async_stop (EV_P_ ev_async *w);
		786	void ev_async_send (EV_P_ ev_async *w);
		787	# endif
		788
		789	#if EV_COMPAT3
		790	#define EVLOOP_NONBLOCK EVRUN_NOWAIT
		791	#define EVLOOP_ONESHOT EVRUN_ONCE
		792	#define EVUNLOOP_CANCEL EVBREAK_CANCEL
		793	#define EVUNLOOP_ONE EVBREAK_ONE
		794	#define EVUNLOOP_ALL EVBREAK_ALL
		795	#if EV_PROTOTYPES
		796	EV_INLINE void ev_loop (EV_P_ int flags) { ev_run (EV_A_ flags); }
		797	EV_INLINE void ev_unloop (EV_P_ int how ) { ev_break (EV_A_ how ); }
		798	#if EV_FEATURE_API
		799	EV_INLINE void ev_loop_count (EV_P) { ev_iteration (EV_A); }
		800	EV_INLINE void ev_loop_depth (EV_P) { ev_depth (EV_A); }
		801	EV_INLINE void ev_loop_verify (EV_P) { ev_verify (EV_A); }
		802	#endif
		803	#endif
		804	#else
		805	typedef struct ev_loop ev_loop;
		806	#endif
		807
		808	#endif
		809
		810	#ifdef __cplusplus
		811	}
		812	#endif
		813
		814	#endif
		815

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.10 by root, Wed Oct 31 14:44:15 2007 UTC vs. Revision 1.146 by root, Fri Oct 22 06:14:28 2010 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.10 by root, Wed Oct 31 14:44:15 2007 UTC vs.
Revision 1.146 by root, Fri Oct 22 06:14:28 2010 UTC