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

Comparing libev/ev.h (file contents):
Revision 1.91 by root, Fri Jan 25 15:45:09 2008 UTC vs.
Revision 1.149 by root, Sun Oct 24 17:58:41 2010 UTC

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

Diff Legend

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

Comparing libev/ev.h (file contents): Revision 1.91 by root, Fri Jan 25 15:45:09 2008 UTC vs. Revision 1.149 by root, Sun Oct 24 17:58:41 2010 UTC

Diff Legend

Comparing libev/ev.h (file contents):
Revision 1.91 by root, Fri Jan 25 15:45:09 2008 UTC vs.
Revision 1.149 by root, Sun Oct 24 17:58:41 2010 UTC