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

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

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.87 by root, Thu Dec 20 10:12:22 2007 UTC vs. Revision 1.147 by root, Fri Oct 22 09:24:11 2010 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.87 by root, Thu Dec 20 10:12:22 2007 UTC vs.
Revision 1.147 by root, Fri Oct 22 09:24:11 2010 UTC