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

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

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.81 by root, Sat Dec 8 14:12:07 2007 UTC vs. Revision 1.138 by root, Tue Mar 16 20:32:20 2010 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.81 by root, Sat Dec 8 14:12:07 2007 UTC vs.
Revision 1.138 by root, Tue Mar 16 20:32:20 2010 UTC