ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.265 by root, Wed Aug 26 17:11:42 2009 UTC vs.
Revision 1.370 by root, Thu Jun 2 23:42:40 2011 UTC

…		…
26	puts ("stdin ready");	26	puts ("stdin ready");
27	// for one-shot events, one must manually stop the watcher	27	// for one-shot events, one must manually stop the watcher
28	// with its corresponding stop function.	28	// with its corresponding stop function.
29	ev_io_stop (EV_A_ w);	29	ev_io_stop (EV_A_ w);
30		30
31	// this causes all nested ev_loop's to stop iterating	31	// this causes all nested ev_run's to stop iterating
32	ev_unloop (EV_A_ EVUNLOOP_ALL);	32	ev_break (EV_A_ EVBREAK_ALL);
33	}	33	}
34		34
35	// another callback, this time for a time-out	35	// another callback, this time for a time-out
36	static void	36	static void
37	timeout_cb (EV_P_ ev_timer *w, int revents)	37	timeout_cb (EV_P_ ev_timer *w, int revents)
38	{	38	{
39	puts ("timeout");	39	puts ("timeout");
40	// this causes the innermost ev_loop to stop iterating	40	// this causes the innermost ev_run to stop iterating
41	ev_unloop (EV_A_ EVUNLOOP_ONE);	41	ev_break (EV_A_ EVBREAK_ONE);
42	}	42	}
43		43
44	int	44	int
45	main (void)	45	main (void)
46	{	46	{
47	// use the default event loop unless you have special needs	47	// use the default event loop unless you have special needs
48	struct ev_loop *loop = ev_default_loop (0);	48	struct ev_loop *loop = EV_DEFAULT;
49		49
50	// initialise an io watcher, then start it	50	// initialise an io watcher, then start it
51	// this one will watch for stdin to become readable	51	// this one will watch for stdin to become readable
52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
53	ev_io_start (loop, &stdin_watcher);	53	ev_io_start (loop, &stdin_watcher);
…		…
56	// simple non-repeating 5.5 second timeout	56	// simple non-repeating 5.5 second timeout
57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
58	ev_timer_start (loop, &timeout_watcher);	58	ev_timer_start (loop, &timeout_watcher);
59		59
60	// now wait for events to arrive	60	// now wait for events to arrive
61	ev_loop (loop, 0);	61	ev_run (loop, 0);
62		62
63	// unloop was called, so exit	63	// break was called, so exit
64	return 0;	64	return 0;
65	}	65	}
66		66
67	=head1 ABOUT THIS DOCUMENT	67	=head1 ABOUT THIS DOCUMENT
68		68
…		…
75	While this document tries to be as complete as possible in documenting	75	While this document tries to be as complete as possible in documenting
76	libev, its usage and the rationale behind its design, it is not a tutorial	76	libev, its usage and the rationale behind its design, it is not a tutorial
77	on event-based programming, nor will it introduce event-based programming	77	on event-based programming, nor will it introduce event-based programming
78	with libev.	78	with libev.
79		79
80	Familarity with event based programming techniques in general is assumed	80	Familiarity with event based programming techniques in general is assumed
81	throughout this document.	81	throughout this document.
		82
		83	=head1 WHAT TO READ WHEN IN A HURRY
		84
		85	This manual tries to be very detailed, but unfortunately, this also makes
		86	it very long. If you just want to know the basics of libev, I suggest
		87	reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and
		88	look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and
		89	C<ev_timer> sections in L<WATCHER TYPES>.
82		90
83	=head1 ABOUT LIBEV	91	=head1 ABOUT LIBEV
84		92
85	Libev is an event loop: you register interest in certain events (such as a	93	Libev is an event loop: you register interest in certain events (such as a
86	file descriptor being readable or a timeout occurring), and it will manage	94	file descriptor being readable or a timeout occurring), and it will manage
…		…
118	Libev is very configurable. In this manual the default (and most common)	126	Libev is very configurable. In this manual the default (and most common)
119	configuration will be described, which supports multiple event loops. For	127	configuration will be described, which supports multiple event loops. For
120	more info about various configuration options please have a look at	128	more info about various configuration options please have a look at
121	B<EMBED> section in this manual. If libev was configured without support	129	B<EMBED> section in this manual. If libev was configured without support
122	for multiple event loops, then all functions taking an initial argument of	130	for multiple event loops, then all functions taking an initial argument of
123	name C<loop> (which is always of type C<ev_loop *>) will not have	131	name C<loop> (which is always of type C<struct ev_loop *>) will not have
124	this argument.	132	this argument.
125		133
126	=head2 TIME REPRESENTATION	134	=head2 TIME REPRESENTATION
127		135
128	Libev represents time as a single floating point number, representing	136	Libev represents time as a single floating point number, representing
129	the (fractional) number of seconds since the (POSIX) epoch (somewhere	137	the (fractional) number of seconds since the (POSIX) epoch (in practice
130	near the beginning of 1970, details are complicated, don't ask). This	138	somewhere near the beginning of 1970, details are complicated, don't
131	type is called C<ev_tstamp>, which is what you should use too. It usually	139	ask). This type is called C<ev_tstamp>, which is what you should use
132	aliases to the C<double> type in C. When you need to do any calculations	140	too. It usually aliases to the C<double> type in C. When you need to do
133	on it, you should treat it as some floating point value. Unlike the name	141	any calculations on it, you should treat it as some floating point value.
		142
134	component C<stamp> might indicate, it is also used for time differences	143	Unlike the name component C<stamp> might indicate, it is also used for
135	throughout libev.	144	time differences (e.g. delays) throughout libev.
136		145
137	=head1 ERROR HANDLING	146	=head1 ERROR HANDLING
138		147
139	Libev knows three classes of errors: operating system errors, usage errors	148	Libev knows three classes of errors: operating system errors, usage errors
140	and internal errors (bugs).	149	and internal errors (bugs).
…		…
164		173
165	=item ev_tstamp ev_time ()	174	=item ev_tstamp ev_time ()
166		175
167	Returns the current time as libev would use it. Please note that the	176	Returns the current time as libev would use it. Please note that the
168	C<ev_now> function is usually faster and also often returns the timestamp	177	C<ev_now> function is usually faster and also often returns the timestamp
169	you actually want to know.	178	you actually want to know. Also interesting is the combination of
		179	C<ev_update_now> and C<ev_now>.
170		180
171	=item ev_sleep (ev_tstamp interval)	181	=item ev_sleep (ev_tstamp interval)
172		182
173	Sleep for the given interval: The current thread will be blocked until	183	Sleep for the given interval: The current thread will be blocked until
174	either it is interrupted or the given time interval has passed. Basically	184	either it is interrupted or the given time interval has passed. Basically
…		…
191	as this indicates an incompatible change. Minor versions are usually	201	as this indicates an incompatible change. Minor versions are usually
192	compatible to older versions, so a larger minor version alone is usually	202	compatible to older versions, so a larger minor version alone is usually
193	not a problem.	203	not a problem.
194		204
195	Example: Make sure we haven't accidentally been linked against the wrong	205	Example: Make sure we haven't accidentally been linked against the wrong
196	version.	206	version (note, however, that this will not detect other ABI mismatches,
		207	such as LFS or reentrancy).
197		208
198	assert (("libev version mismatch",	209	assert (("libev version mismatch",
199	ev_version_major () == EV_VERSION_MAJOR	210	ev_version_major () == EV_VERSION_MAJOR
200	&& ev_version_minor () >= EV_VERSION_MINOR));	211	&& ev_version_minor () >= EV_VERSION_MINOR));
201		212
…		…
212	assert (("sorry, no epoll, no sex",	223	assert (("sorry, no epoll, no sex",
213	ev_supported_backends () & EVBACKEND_EPOLL));	224	ev_supported_backends () & EVBACKEND_EPOLL));
214		225
215	=item unsigned int ev_recommended_backends ()	226	=item unsigned int ev_recommended_backends ()
216		227
217	Return the set of all backends compiled into this binary of libev and also	228	Return the set of all backends compiled into this binary of libev and
218	recommended for this platform. This set is often smaller than the one	229	also recommended for this platform, meaning it will work for most file
		230	descriptor types. This set is often smaller than the one returned by
219	returned by C<ev_supported_backends>, as for example kqueue is broken on	231	C<ev_supported_backends>, as for example kqueue is broken on most BSDs
220	most BSDs and will not be auto-detected unless you explicitly request it	232	and will not be auto-detected unless you explicitly request it (assuming
221	(assuming you know what you are doing). This is the set of backends that	233	you know what you are doing). This is the set of backends that libev will
222	libev will probe for if you specify no backends explicitly.	234	probe for if you specify no backends explicitly.
223		235
224	=item unsigned int ev_embeddable_backends ()	236	=item unsigned int ev_embeddable_backends ()
225		237
226	Returns the set of backends that are embeddable in other event loops. This	238	Returns the set of backends that are embeddable in other event loops. This
227	is the theoretical, all-platform, value. To find which backends	239	value is platform-specific but can include backends not available on the
228	might be supported on the current system, you would need to look at	240	current system. To find which embeddable backends might be supported on
229	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	241	the current system, you would need to look at C<ev_embeddable_backends ()
230	recommended ones.	242	& ev_supported_backends ()>, likewise for recommended ones.
231		243
232	See the description of C<ev_embed> watchers for more info.	244	See the description of C<ev_embed> watchers for more info.
233		245
234	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]	246	=item ev_set_allocator (void *(*cb)(void *ptr, long size))
235		247
236	Sets the allocation function to use (the prototype is similar - the	248	Sets the allocation function to use (the prototype is similar - the
237	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is	249	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
238	used to allocate and free memory (no surprises here). If it returns zero	250	used to allocate and free memory (no surprises here). If it returns zero
239	when memory needs to be allocated (C<size != 0>), the library might abort	251	when memory needs to be allocated (C<size != 0>), the library might abort
…		…
265	}	277	}
266		278
267	...	279	...
268	ev_set_allocator (persistent_realloc);	280	ev_set_allocator (persistent_realloc);
269		281
270	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]	282	=item ev_set_syserr_cb (void (*cb)(const char *msg))
271		283
272	Set the callback function to call on a retryable system call error (such	284	Set the callback function to call on a retryable system call error (such
273	as failed select, poll, epoll_wait). The message is a printable string	285	as failed select, poll, epoll_wait). The message is a printable string
274	indicating the system call or subsystem causing the problem. If this	286	indicating the system call or subsystem causing the problem. If this
275	callback is set, then libev will expect it to remedy the situation, no	287	callback is set, then libev will expect it to remedy the situation, no
…		…
287	}	299	}
288		300
289	...	301	...
290	ev_set_syserr_cb (fatal_error);	302	ev_set_syserr_cb (fatal_error);
291		303
		304	=item ev_feed_signal (int signum)
		305
		306	This function can be used to "simulate" a signal receive. It is completely
		307	safe to call this function at any time, from any context, including signal
		308	handlers or random threads.
		309
		310	Its main use is to customise signal handling in your process, especially
		311	in the presence of threads. For example, you could block signals
		312	by default in all threads (and specifying C<EVFLAG_NOSIGMASK> when
		313	creating any loops), and in one thread, use C<sigwait> or any other
		314	mechanism to wait for signals, then "deliver" them to libev by calling
		315	C<ev_feed_signal>.
		316
292	=back	317	=back
293		318
294	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	319	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
295		320
296	An event loop is described by a C<struct ev_loop *> (the C<struct>	321	An event loop is described by a C<struct ev_loop *> (the C<struct> is
297	is I<not> optional in this case, as there is also an C<ev_loop>	322	I<not> optional in this case unless libev 3 compatibility is disabled, as
298	I<function>).	323	libev 3 had an C<ev_loop> function colliding with the struct name).
299		324
300	The library knows two types of such loops, the I<default> loop, which	325	The library knows two types of such loops, the I<default> loop, which
301	supports signals and child events, and dynamically created loops which do	326	supports child process events, and dynamically created event loops which
302	not.	327	do not.
303		328
304	=over 4	329	=over 4
305		330
306	=item struct ev_loop *ev_default_loop (unsigned int flags)	331	=item struct ev_loop *ev_default_loop (unsigned int flags)
307		332
308	This will initialise the default event loop if it hasn't been initialised	333	This returns the "default" event loop object, which is what you should
309	yet and return it. If the default loop could not be initialised, returns	334	normally use when you just need "the event loop". Event loop objects and
310	false. If it already was initialised it simply returns it (and ignores the	335	the C<flags> parameter are described in more detail in the entry for
311	flags. If that is troubling you, check C<ev_backend ()> afterwards).	336	C<ev_loop_new>.
		337
		338	If the default loop is already initialised then this function simply
		339	returns it (and ignores the flags. If that is troubling you, check
		340	C<ev_backend ()> afterwards). Otherwise it will create it with the given
		341	flags, which should almost always be C<0>, unless the caller is also the
		342	one calling C<ev_run> or otherwise qualifies as "the main program".
312		343
313	If you don't know what event loop to use, use the one returned from this	344	If you don't know what event loop to use, use the one returned from this
314	function.	345	function (or via the C<EV_DEFAULT> macro).
315		346
316	Note that this function is I<not> thread-safe, so if you want to use it	347	Note that this function is I<not> thread-safe, so if you want to use it
317	from multiple threads, you have to lock (note also that this is unlikely,	348	from multiple threads, you have to employ some kind of mutex (note also
318	as loops cannot be shared easily between threads anyway).	349	that this case is unlikely, as loops cannot be shared easily between
		350	threads anyway).
319		351
320	The default loop is the only loop that can handle C<ev_signal> and	352	The default loop is the only loop that can handle C<ev_child> watchers,
321	C<ev_child> watchers, and to do this, it always registers a handler	353	and to do this, it always registers a handler for C<SIGCHLD>. If this is
322	for C<SIGCHLD>. If this is a problem for your application you can either	354	a problem for your application you can either create a dynamic loop with
323	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	355	C<ev_loop_new> which doesn't do that, or you can simply overwrite the
324	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	356	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
325	C<ev_default_init>.	357
		358	Example: This is the most typical usage.
		359
		360	if (!ev_default_loop (0))
		361	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
		362
		363	Example: Restrict libev to the select and poll backends, and do not allow
		364	environment settings to be taken into account:
		365
		366	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
		367
		368	=item struct ev_loop *ev_loop_new (unsigned int flags)
		369
		370	This will create and initialise a new event loop object. If the loop
		371	could not be initialised, returns false.
		372
		373	This function is thread-safe, and one common way to use libev with
		374	threads is indeed to create one loop per thread, and using the default
		375	loop in the "main" or "initial" thread.
326		376
327	The flags argument can be used to specify special behaviour or specific	377	The flags argument can be used to specify special behaviour or specific
328	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).	378	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
329		379
330	The following flags are supported:	380	The following flags are supported:
…		…
345	useful to try out specific backends to test their performance, or to work	395	useful to try out specific backends to test their performance, or to work
346	around bugs.	396	around bugs.
347		397
348	=item C<EVFLAG_FORKCHECK>	398	=item C<EVFLAG_FORKCHECK>
349		399
350	Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after	400	Instead of calling C<ev_loop_fork> manually after a fork, you can also
351	a fork, you can also make libev check for a fork in each iteration by	401	make libev check for a fork in each iteration by enabling this flag.
352	enabling this flag.
353		402
354	This works by calling C<getpid ()> on every iteration of the loop,	403	This works by calling C<getpid ()> on every iteration of the loop,
355	and thus this might slow down your event loop if you do a lot of loop	404	and thus this might slow down your event loop if you do a lot of loop
356	iterations and little real work, but is usually not noticeable (on my	405	iterations and little real work, but is usually not noticeable (on my
357	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence	406	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
…		…
366	environment variable.	415	environment variable.
367		416
368	=item C<EVFLAG_NOINOTIFY>	417	=item C<EVFLAG_NOINOTIFY>
369		418
370	When this flag is specified, then libev will not attempt to use the	419	When this flag is specified, then libev will not attempt to use the
371	I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and	420	I<inotify> API for its C<ev_stat> watchers. Apart from debugging and
372	testing, this flag can be useful to conserve inotify file descriptors, as	421	testing, this flag can be useful to conserve inotify file descriptors, as
373	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.	422	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
374		423
375	=item C<EVFLAG_NOSIGNALFD>	424	=item C<EVFLAG_SIGNALFD>
376		425
377	When this flag is specified, then libev will not attempt to use the	426	When this flag is specified, then libev will attempt to use the
378	I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This is	427	I<signalfd> API for its C<ev_signal> (and C<ev_child>) watchers. This API
379	probably only useful to work around any bugs in libev. Consequently, this	428	delivers signals synchronously, which makes it both faster and might make
380	flag might go away once the signalfd functionality is considered stable,	429	it possible to get the queued signal data. It can also simplify signal
381	so it's useful mostly in environment variables and not in program code.	430	handling with threads, as long as you properly block signals in your
		431	threads that are not interested in handling them.
		432
		433	Signalfd will not be used by default as this changes your signal mask, and
		434	there are a lot of shoddy libraries and programs (glib's threadpool for
		435	example) that can't properly initialise their signal masks.
		436
		437	=item C<EVFLAG_NOSIGMASK>
		438
		439	When this flag is specified, then libev will avoid to modify the signal
		440	mask. Specifically, this means you ahve to make sure signals are unblocked
		441	when you want to receive them.
		442
		443	This behaviour is useful when you want to do your own signal handling, or
		444	want to handle signals only in specific threads and want to avoid libev
		445	unblocking the signals.
		446
		447	It's also required by POSIX in a threaded program, as libev calls
		448	C<sigprocmask>, whose behaviour is officially unspecified.
		449
		450	This flag's behaviour will become the default in future versions of libev.
382		451
383	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	452	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
384		453
385	This is your standard select(2) backend. Not I<completely> standard, as	454	This is your standard select(2) backend. Not I<completely> standard, as
386	libev tries to roll its own fd_set with no limits on the number of fds,	455	libev tries to roll its own fd_set with no limits on the number of fds,
…		…
411	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and	480	This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
412	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.	481	C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
413		482
414	=item C<EVBACKEND_EPOLL> (value 4, Linux)	483	=item C<EVBACKEND_EPOLL> (value 4, Linux)
415		484
		485	Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
		486	kernels).
		487
416	For few fds, this backend is a bit little slower than poll and select,	488	For few fds, this backend is a bit little slower than poll and select, but
417	but it scales phenomenally better. While poll and select usually scale	489	it scales phenomenally better. While poll and select usually scale like
418	like O(total_fds) where n is the total number of fds (or the highest fd),	490	O(total_fds) where total_fds is the total number of fds (or the highest
419	epoll scales either O(1) or O(active_fds).	491	fd), epoll scales either O(1) or O(active_fds).
420		492
421	The epoll mechanism deserves honorable mention as the most misdesigned	493	The epoll mechanism deserves honorable mention as the most misdesigned
422	of the more advanced event mechanisms: mere annoyances include silently	494	of the more advanced event mechanisms: mere annoyances include silently
423	dropping file descriptors, requiring a system call per change per file	495	dropping file descriptors, requiring a system call per change per file
424	descriptor (and unnecessary guessing of parameters), problems with dup and	496	descriptor (and unnecessary guessing of parameters), problems with dup,
		497	returning before the timeout value, resulting in additional iterations
		498	(and only giving 5ms accuracy while select on the same platform gives
425	so on. The biggest issue is fork races, however - if a program forks then	499	0.1ms) and so on. The biggest issue is fork races, however - if a program
426	I<both> parent and child process have to recreate the epoll set, which can	500	forks then I<both> parent and child process have to recreate the epoll
427	take considerable time (one syscall per file descriptor) and is of course	501	set, which can take considerable time (one syscall per file descriptor)
428	hard to detect.	502	and is of course hard to detect.
429		503
430	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	504	Epoll is also notoriously buggy - embedding epoll fds I<should> work,
431	of course I<doesn't>, and epoll just loves to report events for totally	505	but of course I<doesn't>, and epoll just loves to report events for
432	I<different> file descriptors (even already closed ones, so one cannot	506	totally I<different> file descriptors (even already closed ones, so
433	even remove them from the set) than registered in the set (especially	507	one cannot even remove them from the set) than registered in the set
434	on SMP systems). Libev tries to counter these spurious notifications by	508	(especially on SMP systems). Libev tries to counter these spurious
435	employing an additional generation counter and comparing that against the	509	notifications by employing an additional generation counter and comparing
436	events to filter out spurious ones, recreating the set when required.	510	that against the events to filter out spurious ones, recreating the set
		511	when required. Epoll also errornously rounds down timeouts, but gives you
		512	no way to know when and by how much, so sometimes you have to busy-wait
		513	because epoll returns immediately despite a nonzero timeout. And last
		514	not least, it also refuses to work with some file descriptors which work
		515	perfectly fine with C<select> (files, many character devices...).
		516
		517	Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
		518	cobbled together in a hurry, no thought to design or interaction with
		519	others. Oh, the pain, will it ever stop...
437		520
438	While stopping, setting and starting an I/O watcher in the same iteration	521	While stopping, setting and starting an I/O watcher in the same iteration
439	will result in some caching, there is still a system call per such	522	will result in some caching, there is still a system call per such
440	incident (because the same I<file descriptor> could point to a different	523	incident (because the same I<file descriptor> could point to a different
441	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed	524	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
…		…
507	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	590	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
508		591
509	This uses the Solaris 10 event port mechanism. As with everything on Solaris,	592	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
510	it's really slow, but it still scales very well (O(active_fds)).	593	it's really slow, but it still scales very well (O(active_fds)).
511		594
512	Please note that Solaris event ports can deliver a lot of spurious
513	notifications, so you need to use non-blocking I/O or other means to avoid
514	blocking when no data (or space) is available.
515
516	While this backend scales well, it requires one system call per active	595	While this backend scales well, it requires one system call per active
517	file descriptor per loop iteration. For small and medium numbers of file	596	file descriptor per loop iteration. For small and medium numbers of file
518	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	597	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
519	might perform better.	598	might perform better.
520		599
521	On the positive side, with the exception of the spurious readiness	600	On the positive side, this backend actually performed fully to
522	notifications, this backend actually performed fully to specification
523	in all tests and is fully embeddable, which is a rare feat among the	601	specification in all tests and is fully embeddable, which is a rare feat
524	OS-specific backends (I vastly prefer correctness over speed hacks).	602	among the OS-specific backends (I vastly prefer correctness over speed
		603	hacks).
		604
		605	On the negative side, the interface is I<bizarre> - so bizarre that
		606	even sun itself gets it wrong in their code examples: The event polling
		607	function sometimes returning events to the caller even though an error
		608	occurred, but with no indication whether it has done so or not (yes, it's
		609	even documented that way) - deadly for edge-triggered interfaces where
		610	you absolutely have to know whether an event occurred or not because you
		611	have to re-arm the watcher.
		612
		613	Fortunately libev seems to be able to work around these idiocies.
525		614
526	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	615	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
527	C<EVBACKEND_POLL>.	616	C<EVBACKEND_POLL>.
528		617
529	=item C<EVBACKEND_ALL>	618	=item C<EVBACKEND_ALL>
530		619
531	Try all backends (even potentially broken ones that wouldn't be tried	620	Try all backends (even potentially broken ones that wouldn't be tried
532	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	621	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
533	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	622	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
534		623
535	It is definitely not recommended to use this flag.	624	It is definitely not recommended to use this flag, use whatever
		625	C<ev_recommended_backends ()> returns, or simply do not specify a backend
		626	at all.
		627
		628	=item C<EVBACKEND_MASK>
		629
		630	Not a backend at all, but a mask to select all backend bits from a
		631	C<flags> value, in case you want to mask out any backends from a flags
		632	value (e.g. when modifying the C<LIBEV_FLAGS> environment variable).
536		633
537	=back	634	=back
538		635
539	If one or more of the backend flags are or'ed into the flags value,	636	If one or more of the backend flags are or'ed into the flags value,
540	then only these backends will be tried (in the reverse order as listed	637	then only these backends will be tried (in the reverse order as listed
541	here). If none are specified, all backends in C<ev_recommended_backends	638	here). If none are specified, all backends in C<ev_recommended_backends
542	()> will be tried.	639	()> will be tried.
543		640
544	Example: This is the most typical usage.
545
546	if (!ev_default_loop (0))
547	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
548
549	Example: Restrict libev to the select and poll backends, and do not allow
550	environment settings to be taken into account:
551
552	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
553
554	Example: Use whatever libev has to offer, but make sure that kqueue is
555	used if available (warning, breaks stuff, best use only with your own
556	private event loop and only if you know the OS supports your types of
557	fds):
558
559	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
560
561	=item struct ev_loop *ev_loop_new (unsigned int flags)
562
563	Similar to C<ev_default_loop>, but always creates a new event loop that is
564	always distinct from the default loop. Unlike the default loop, it cannot
565	handle signal and child watchers, and attempts to do so will be greeted by
566	undefined behaviour (or a failed assertion if assertions are enabled).
567
568	Note that this function I<is> thread-safe, and the recommended way to use
569	libev with threads is indeed to create one loop per thread, and using the
570	default loop in the "main" or "initial" thread.
571
572	Example: Try to create a event loop that uses epoll and nothing else.	641	Example: Try to create a event loop that uses epoll and nothing else.
573		642
574	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	643	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
575	if (!epoller)	644	if (!epoller)
576	fatal ("no epoll found here, maybe it hides under your chair");	645	fatal ("no epoll found here, maybe it hides under your chair");
577		646
		647	Example: Use whatever libev has to offer, but make sure that kqueue is
		648	used if available.
		649
		650	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
		651
578	=item ev_default_destroy ()	652	=item ev_loop_destroy (loop)
579		653
580	Destroys the default loop again (frees all memory and kernel state	654	Destroys an event loop object (frees all memory and kernel state
581	etc.). None of the active event watchers will be stopped in the normal	655	etc.). None of the active event watchers will be stopped in the normal
582	sense, so e.g. C<ev_is_active> might still return true. It is your	656	sense, so e.g. C<ev_is_active> might still return true. It is your
583	responsibility to either stop all watchers cleanly yourself I<before>	657	responsibility to either stop all watchers cleanly yourself I<before>
584	calling this function, or cope with the fact afterwards (which is usually	658	calling this function, or cope with the fact afterwards (which is usually
585	the easiest thing, you can just ignore the watchers and/or C<free ()> them	659	the easiest thing, you can just ignore the watchers and/or C<free ()> them
…		…
587		661
588	Note that certain global state, such as signal state (and installed signal	662	Note that certain global state, such as signal state (and installed signal
589	handlers), will not be freed by this function, and related watchers (such	663	handlers), will not be freed by this function, and related watchers (such
590	as signal and child watchers) would need to be stopped manually.	664	as signal and child watchers) would need to be stopped manually.
591		665
592	In general it is not advisable to call this function except in the	666	This function is normally used on loop objects allocated by
593	rare occasion where you really need to free e.g. the signal handling	667	C<ev_loop_new>, but it can also be used on the default loop returned by
		668	C<ev_default_loop>, in which case it is not thread-safe.
		669
		670	Note that it is not advisable to call this function on the default loop
		671	except in the rare occasion where you really need to free its resources.
594	pipe fds. If you need dynamically allocated loops it is better to use	672	If you need dynamically allocated loops it is better to use C<ev_loop_new>
595	C<ev_loop_new> and C<ev_loop_destroy>).	673	and C<ev_loop_destroy>.
596		674
597	=item ev_loop_destroy (loop)	675	=item ev_loop_fork (loop)
598		676
599	Like C<ev_default_destroy>, but destroys an event loop created by an
600	earlier call to C<ev_loop_new>.
601
602	=item ev_default_fork ()
603
604	This function sets a flag that causes subsequent C<ev_loop> iterations	677	This function sets a flag that causes subsequent C<ev_run> iterations to
605	to reinitialise the kernel state for backends that have one. Despite the	678	reinitialise the kernel state for backends that have one. Despite the
606	name, you can call it anytime, but it makes most sense after forking, in	679	name, you can call it anytime, but it makes most sense after forking, in
607	the child process (or both child and parent, but that again makes little	680	the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the
608	sense). You I<must> call it in the child before using any of the libev	681	child before resuming or calling C<ev_run>.
609	functions, and it will only take effect at the next C<ev_loop> iteration.	682
		683	Again, you I<have> to call it on I<any> loop that you want to re-use after
		684	a fork, I<even if you do not plan to use the loop in the parent>. This is
		685	because some kernel interfaces *cough* I<kqueue> *cough* do funny things
		686	during fork.
610		687
611	On the other hand, you only need to call this function in the child	688	On the other hand, you only need to call this function in the child
612	process if and only if you want to use the event library in the child. If	689	process if and only if you want to use the event loop in the child. If
613	you just fork+exec, you don't have to call it at all.	690	you just fork+exec or create a new loop in the child, you don't have to
		691	call it at all (in fact, C<epoll> is so badly broken that it makes a
		692	difference, but libev will usually detect this case on its own and do a
		693	costly reset of the backend).
614		694
615	The function itself is quite fast and it's usually not a problem to call	695	The function itself is quite fast and it's usually not a problem to call
616	it just in case after a fork. To make this easy, the function will fit in	696	it just in case after a fork.
617	quite nicely into a call to C<pthread_atfork>:
618		697
		698	Example: Automate calling C<ev_loop_fork> on the default loop when
		699	using pthreads.
		700
		701	static void
		702	post_fork_child (void)
		703	{
		704	ev_loop_fork (EV_DEFAULT);
		705	}
		706
		707	...
619	pthread_atfork (0, 0, ev_default_fork);	708	pthread_atfork (0, 0, post_fork_child);
620
621	=item ev_loop_fork (loop)
622
623	Like C<ev_default_fork>, but acts on an event loop created by
624	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
625	after fork that you want to re-use in the child, and how you do this is
626	entirely your own problem.
627		709
628	=item int ev_is_default_loop (loop)	710	=item int ev_is_default_loop (loop)
629		711
630	Returns true when the given loop is, in fact, the default loop, and false	712	Returns true when the given loop is, in fact, the default loop, and false
631	otherwise.	713	otherwise.
632		714
633	=item unsigned int ev_loop_count (loop)	715	=item unsigned int ev_iteration (loop)
634		716
635	Returns the count of loop iterations for the loop, which is identical to	717	Returns the current iteration count for the event loop, which is identical
636	the number of times libev did poll for new events. It starts at C<0> and	718	to the number of times libev did poll for new events. It starts at C<0>
637	happily wraps around with enough iterations.	719	and happily wraps around with enough iterations.
638		720
639	This value can sometimes be useful as a generation counter of sorts (it	721	This value can sometimes be useful as a generation counter of sorts (it
640	"ticks" the number of loop iterations), as it roughly corresponds with	722	"ticks" the number of loop iterations), as it roughly corresponds with
641	C<ev_prepare> and C<ev_check> calls.	723	C<ev_prepare> and C<ev_check> calls - and is incremented between the
		724	prepare and check phases.
642		725
643	=item unsigned int ev_loop_depth (loop)	726	=item unsigned int ev_depth (loop)
644		727
645	Returns the number of times C<ev_loop> was entered minus the number of	728	Returns the number of times C<ev_run> was entered minus the number of
646	times C<ev_loop> was exited, in other words, the recursion depth.	729	times C<ev_run> was exited normally, in other words, the recursion depth.
647		730
648	Outside C<ev_loop>, this number is zero. In a callback, this number is	731	Outside C<ev_run>, this number is zero. In a callback, this number is
649	C<1>, unless C<ev_loop> was invoked recursively (or from another thread),	732	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
650	in which case it is higher.	733	in which case it is higher.
651		734
652	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread	735	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread,
653	etc.), doesn't count as exit.	736	throwing an exception etc.), doesn't count as "exit" - consider this
		737	as a hint to avoid such ungentleman-like behaviour unless it's really
		738	convenient, in which case it is fully supported.
654		739
655	=item unsigned int ev_backend (loop)	740	=item unsigned int ev_backend (loop)
656		741
657	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	742	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
658	use.	743	use.
…		…
667		752
668	=item ev_now_update (loop)	753	=item ev_now_update (loop)
669		754
670	Establishes the current time by querying the kernel, updating the time	755	Establishes the current time by querying the kernel, updating the time
671	returned by C<ev_now ()> in the progress. This is a costly operation and	756	returned by C<ev_now ()> in the progress. This is a costly operation and
672	is usually done automatically within C<ev_loop ()>.	757	is usually done automatically within C<ev_run ()>.
673		758
674	This function is rarely useful, but when some event callback runs for a	759	This function is rarely useful, but when some event callback runs for a
675	very long time without entering the event loop, updating libev's idea of	760	very long time without entering the event loop, updating libev's idea of
676	the current time is a good idea.	761	the current time is a good idea.
677		762
…		…
679		764
680	=item ev_suspend (loop)	765	=item ev_suspend (loop)
681		766
682	=item ev_resume (loop)	767	=item ev_resume (loop)
683		768
684	These two functions suspend and resume a loop, for use when the loop is	769	These two functions suspend and resume an event loop, for use when the
685	not used for a while and timeouts should not be processed.	770	loop is not used for a while and timeouts should not be processed.
686		771
687	A typical use case would be an interactive program such as a game: When	772	A typical use case would be an interactive program such as a game: When
688	the user presses C<^Z> to suspend the game and resumes it an hour later it	773	the user presses C<^Z> to suspend the game and resumes it an hour later it
689	would be best to handle timeouts as if no time had actually passed while	774	would be best to handle timeouts as if no time had actually passed while
690	the program was suspended. This can be achieved by calling C<ev_suspend>	775	the program was suspended. This can be achieved by calling C<ev_suspend>
…		…
692	C<ev_resume> directly afterwards to resume timer processing.	777	C<ev_resume> directly afterwards to resume timer processing.
693		778
694	Effectively, all C<ev_timer> watchers will be delayed by the time spend	779	Effectively, all C<ev_timer> watchers will be delayed by the time spend
695	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers	780	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
696	will be rescheduled (that is, they will lose any events that would have	781	will be rescheduled (that is, they will lose any events that would have
697	occured while suspended).	782	occurred while suspended).
698		783
699	After calling C<ev_suspend> you B<must not> call I<any> function on the	784	After calling C<ev_suspend> you B<must not> call I<any> function on the
700	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>	785	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
701	without a previous call to C<ev_suspend>.	786	without a previous call to C<ev_suspend>.
702		787
703	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the	788	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
704	event loop time (see C<ev_now_update>).	789	event loop time (see C<ev_now_update>).
705		790
706	=item ev_loop (loop, int flags)	791	=item ev_run (loop, int flags)
707		792
708	Finally, this is it, the event handler. This function usually is called	793	Finally, this is it, the event handler. This function usually is called
709	after you initialised all your watchers and you want to start handling	794	after you have initialised all your watchers and you want to start
710	events.	795	handling events. It will ask the operating system for any new events, call
		796	the watcher callbacks, an then repeat the whole process indefinitely: This
		797	is why event loops are called I<loops>.
711		798
712	If the flags argument is specified as C<0>, it will not return until	799	If the flags argument is specified as C<0>, it will keep handling events
713	either no event watchers are active anymore or C<ev_unloop> was called.	800	until either no event watchers are active anymore or C<ev_break> was
		801	called.
714		802
715	Please note that an explicit C<ev_unloop> is usually better than	803	Please note that an explicit C<ev_break> is usually better than
716	relying on all watchers to be stopped when deciding when a program has	804	relying on all watchers to be stopped when deciding when a program has
717	finished (especially in interactive programs), but having a program	805	finished (especially in interactive programs), but having a program
718	that automatically loops as long as it has to and no longer by virtue	806	that automatically loops as long as it has to and no longer by virtue
719	of relying on its watchers stopping correctly, that is truly a thing of	807	of relying on its watchers stopping correctly, that is truly a thing of
720	beauty.	808	beauty.
721		809
		810	This function is also I<mostly> exception-safe - you can break out of
		811	a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
		812	exception and so on. This does not decrement the C<ev_depth> value, nor
		813	will it clear any outstanding C<EVBREAK_ONE> breaks.
		814
722	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	815	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
723	those events and any already outstanding ones, but will not block your	816	those events and any already outstanding ones, but will not wait and
724	process in case there are no events and will return after one iteration of	817	block your process in case there are no events and will return after one
725	the loop.	818	iteration of the loop. This is sometimes useful to poll and handle new
		819	events while doing lengthy calculations, to keep the program responsive.
726		820
727	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	821	A flags value of C<EVRUN_ONCE> will look for new events (waiting if
728	necessary) and will handle those and any already outstanding ones. It	822	necessary) and will handle those and any already outstanding ones. It
729	will block your process until at least one new event arrives (which could	823	will block your process until at least one new event arrives (which could
730	be an event internal to libev itself, so there is no guarantee that a	824	be an event internal to libev itself, so there is no guarantee that a
731	user-registered callback will be called), and will return after one	825	user-registered callback will be called), and will return after one
732	iteration of the loop.	826	iteration of the loop.
733		827
734	This is useful if you are waiting for some external event in conjunction	828	This is useful if you are waiting for some external event in conjunction
735	with something not expressible using other libev watchers (i.e. "roll your	829	with something not expressible using other libev watchers (i.e. "roll your
736	own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is	830	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
737	usually a better approach for this kind of thing.	831	usually a better approach for this kind of thing.
738		832
739	Here are the gory details of what C<ev_loop> does:	833	Here are the gory details of what C<ev_run> does (this is for your
		834	understanding, not a guarantee that things will work exactly like this in
		835	future versions):
740		836
		837	- Increment loop depth.
		838	- Reset the ev_break status.
741	- Before the first iteration, call any pending watchers.	839	- Before the first iteration, call any pending watchers.
		840	LOOP:
742	* If EVFLAG_FORKCHECK was used, check for a fork.	841	- If EVFLAG_FORKCHECK was used, check for a fork.
743	- If a fork was detected (by any means), queue and call all fork watchers.	842	- If a fork was detected (by any means), queue and call all fork watchers.
744	- Queue and call all prepare watchers.	843	- Queue and call all prepare watchers.
		844	- If ev_break was called, goto FINISH.
745	- If we have been forked, detach and recreate the kernel state	845	- If we have been forked, detach and recreate the kernel state
746	as to not disturb the other process.	846	as to not disturb the other process.
747	- Update the kernel state with all outstanding changes.	847	- Update the kernel state with all outstanding changes.
748	- Update the "event loop time" (ev_now ()).	848	- Update the "event loop time" (ev_now ()).
749	- Calculate for how long to sleep or block, if at all	849	- Calculate for how long to sleep or block, if at all
750	(active idle watchers, EVLOOP_NONBLOCK or not having	850	(active idle watchers, EVRUN_NOWAIT or not having
751	any active watchers at all will result in not sleeping).	851	any active watchers at all will result in not sleeping).
752	- Sleep if the I/O and timer collect interval say so.	852	- Sleep if the I/O and timer collect interval say so.
		853	- Increment loop iteration counter.
753	- Block the process, waiting for any events.	854	- Block the process, waiting for any events.
754	- Queue all outstanding I/O (fd) events.	855	- Queue all outstanding I/O (fd) events.
755	- Update the "event loop time" (ev_now ()), and do time jump adjustments.	856	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
756	- Queue all expired timers.	857	- Queue all expired timers.
757	- Queue all expired periodics.	858	- Queue all expired periodics.
758	- Unless any events are pending now, queue all idle watchers.	859	- Queue all idle watchers with priority higher than that of pending events.
759	- Queue all check watchers.	860	- Queue all check watchers.
760	- Call all queued watchers in reverse order (i.e. check watchers first).	861	- Call all queued watchers in reverse order (i.e. check watchers first).
761	Signals and child watchers are implemented as I/O watchers, and will	862	Signals and child watchers are implemented as I/O watchers, and will
762	be handled here by queueing them when their watcher gets executed.	863	be handled here by queueing them when their watcher gets executed.
763	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	864	- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
764	were used, or there are no active watchers, return, otherwise	865	were used, or there are no active watchers, goto FINISH, otherwise
765	continue with step *.	866	continue with step LOOP.
		867	FINISH:
		868	- Reset the ev_break status iff it was EVBREAK_ONE.
		869	- Decrement the loop depth.
		870	- Return.
766		871
767	Example: Queue some jobs and then loop until no events are outstanding	872	Example: Queue some jobs and then loop until no events are outstanding
768	anymore.	873	anymore.
769		874
770	... queue jobs here, make sure they register event watchers as long	875	... queue jobs here, make sure they register event watchers as long
771	... as they still have work to do (even an idle watcher will do..)	876	... as they still have work to do (even an idle watcher will do..)
772	ev_loop (my_loop, 0);	877	ev_run (my_loop, 0);
773	... jobs done or somebody called unloop. yeah!	878	... jobs done or somebody called break. yeah!
774		879
775	=item ev_unloop (loop, how)	880	=item ev_break (loop, how)
776		881
777	Can be used to make a call to C<ev_loop> return early (but only after it	882	Can be used to make a call to C<ev_run> return early (but only after it
778	has processed all outstanding events). The C<how> argument must be either	883	has processed all outstanding events). The C<how> argument must be either
779	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	884	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
780	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	885	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
781		886
782	This "unloop state" will be cleared when entering C<ev_loop> again.	887	This "break state" will be cleared on the next call to C<ev_run>.
783		888
784	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.	889	It is safe to call C<ev_break> from outside any C<ev_run> calls, too, in
		890	which case it will have no effect.
785		891
786	=item ev_ref (loop)	892	=item ev_ref (loop)
787		893
788	=item ev_unref (loop)	894	=item ev_unref (loop)
789		895
790	Ref/unref can be used to add or remove a reference count on the event	896	Ref/unref can be used to add or remove a reference count on the event
791	loop: Every watcher keeps one reference, and as long as the reference	897	loop: Every watcher keeps one reference, and as long as the reference
792	count is nonzero, C<ev_loop> will not return on its own.	898	count is nonzero, C<ev_run> will not return on its own.
793		899
794	If you have a watcher you never unregister that should not keep C<ev_loop>	900	This is useful when you have a watcher that you never intend to
795	from returning, call ev_unref() after starting, and ev_ref() before	901	unregister, but that nevertheless should not keep C<ev_run> from
		902	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
796	stopping it.	903	before stopping it.
797		904
798	As an example, libev itself uses this for its internal signal pipe: It	905	As an example, libev itself uses this for its internal signal pipe: It
799	is not visible to the libev user and should not keep C<ev_loop> from	906	is not visible to the libev user and should not keep C<ev_run> from
800	exiting if no event watchers registered by it are active. It is also an	907	exiting if no event watchers registered by it are active. It is also an
801	excellent way to do this for generic recurring timers or from within	908	excellent way to do this for generic recurring timers or from within
802	third-party libraries. Just remember to I<unref after start> and I<ref	909	third-party libraries. Just remember to I<unref after start> and I<ref
803	before stop> (but only if the watcher wasn't active before, or was active	910	before stop> (but only if the watcher wasn't active before, or was active
804	before, respectively. Note also that libev might stop watchers itself	911	before, respectively. Note also that libev might stop watchers itself
805	(e.g. non-repeating timers) in which case you have to C<ev_ref>	912	(e.g. non-repeating timers) in which case you have to C<ev_ref>
806	in the callback).	913	in the callback).
807		914
808	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	915	Example: Create a signal watcher, but keep it from keeping C<ev_run>
809	running when nothing else is active.	916	running when nothing else is active.
810		917
811	ev_signal exitsig;	918	ev_signal exitsig;
812	ev_signal_init (&exitsig, sig_cb, SIGINT);	919	ev_signal_init (&exitsig, sig_cb, SIGINT);
813	ev_signal_start (loop, &exitsig);	920	ev_signal_start (loop, &exitsig);
814	evf_unref (loop);	921	ev_unref (loop);
815		922
816	Example: For some weird reason, unregister the above signal handler again.	923	Example: For some weird reason, unregister the above signal handler again.
817		924
818	ev_ref (loop);	925	ev_ref (loop);
819	ev_signal_stop (loop, &exitsig);	926	ev_signal_stop (loop, &exitsig);
…		…
858	usually doesn't make much sense to set it to a lower value than C<0.01>,	965	usually doesn't make much sense to set it to a lower value than C<0.01>,
859	as this approaches the timing granularity of most systems. Note that if	966	as this approaches the timing granularity of most systems. Note that if
860	you do transactions with the outside world and you can't increase the	967	you do transactions with the outside world and you can't increase the
861	parallelity, then this setting will limit your transaction rate (if you	968	parallelity, then this setting will limit your transaction rate (if you
862	need to poll once per transaction and the I/O collect interval is 0.01,	969	need to poll once per transaction and the I/O collect interval is 0.01,
863	then you can't do more than 100 transations per second).	970	then you can't do more than 100 transactions per second).
864		971
865	Setting the I<timeout collect interval> can improve the opportunity for	972	Setting the I<timeout collect interval> can improve the opportunity for
866	saving power, as the program will "bundle" timer callback invocations that	973	saving power, as the program will "bundle" timer callback invocations that
867	are "near" in time together, by delaying some, thus reducing the number of	974	are "near" in time together, by delaying some, thus reducing the number of
868	times the process sleeps and wakes up again. Another useful technique to	975	times the process sleeps and wakes up again. Another useful technique to
…		…
876	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);	983	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
877		984
878	=item ev_invoke_pending (loop)	985	=item ev_invoke_pending (loop)
879		986
880	This call will simply invoke all pending watchers while resetting their	987	This call will simply invoke all pending watchers while resetting their
881	pending state. Normally, C<ev_loop> does this automatically when required,	988	pending state. Normally, C<ev_run> does this automatically when required,
882	but when overriding the invoke callback this call comes handy.	989	but when overriding the invoke callback this call comes handy. This
		990	function can be invoked from a watcher - this can be useful for example
		991	when you want to do some lengthy calculation and want to pass further
		992	event handling to another thread (you still have to make sure only one
		993	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
883		994
884	=item int ev_pending_count (loop)	995	=item int ev_pending_count (loop)
885		996
886	Returns the number of pending watchers - zero indicates that no watchers	997	Returns the number of pending watchers - zero indicates that no watchers
887	are pending.	998	are pending.
888		999
889	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))	1000	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
890		1001
891	This overrides the invoke pending functionality of the loop: Instead of	1002	This overrides the invoke pending functionality of the loop: Instead of
892	invoking all pending watchers when there are any, C<ev_loop> will call	1003	invoking all pending watchers when there are any, C<ev_run> will call
893	this callback instead. This is useful, for example, when you want to	1004	this callback instead. This is useful, for example, when you want to
894	invoke the actual watchers inside another context (another thread etc.).	1005	invoke the actual watchers inside another context (another thread etc.).
895		1006
896	If you want to reset the callback, use C<ev_invoke_pending> as new	1007	If you want to reset the callback, use C<ev_invoke_pending> as new
897	callback.	1008	callback.
…		…
900		1011
901	Sometimes you want to share the same loop between multiple threads. This	1012	Sometimes you want to share the same loop between multiple threads. This
902	can be done relatively simply by putting mutex_lock/unlock calls around	1013	can be done relatively simply by putting mutex_lock/unlock calls around
903	each call to a libev function.	1014	each call to a libev function.
904		1015
905	However, C<ev_loop> can run an indefinite time, so it is not feasible to	1016	However, C<ev_run> can run an indefinite time, so it is not feasible
906	wait for it to return. One way around this is to wake up the loop via	1017	to wait for it to return. One way around this is to wake up the event
907	C<ev_unloop> and C<av_async_send>, another way is to set these I<release>	1018	loop via C<ev_break> and C<av_async_send>, another way is to set these
908	and I<acquire> callbacks on the loop.	1019	I<release> and I<acquire> callbacks on the loop.
909		1020
910	When set, then C<release> will be called just before the thread is	1021	When set, then C<release> will be called just before the thread is
911	suspended waiting for new events, and C<acquire> is called just	1022	suspended waiting for new events, and C<acquire> is called just
912	afterwards.	1023	afterwards.
913		1024
…		…
916		1027
917	While event loop modifications are allowed between invocations of	1028	While event loop modifications are allowed between invocations of
918	C<release> and C<acquire> (that's their only purpose after all), no	1029	C<release> and C<acquire> (that's their only purpose after all), no
919	modifications done will affect the event loop, i.e. adding watchers will	1030	modifications done will affect the event loop, i.e. adding watchers will
920	have no effect on the set of file descriptors being watched, or the time	1031	have no effect on the set of file descriptors being watched, or the time
921	waited. USe an C<ev_async> watcher to wake up C<ev_loop> when you want it	1032	waited. Use an C<ev_async> watcher to wake up C<ev_run> when you want it
922	to take note of any changes you made.	1033	to take note of any changes you made.
923		1034
924	In theory, threads executing C<ev_loop> will be async-cancel safe between	1035	In theory, threads executing C<ev_run> will be async-cancel safe between
925	invocations of C<release> and C<acquire>.	1036	invocations of C<release> and C<acquire>.
926		1037
927	See also the locking example in the C<THREADS> section later in this	1038	See also the locking example in the C<THREADS> section later in this
928	document.	1039	document.
929		1040
930	=item ev_set_userdata (loop, void *data)	1041	=item ev_set_userdata (loop, void *data)
931		1042
932	=item ev_userdata (loop)	1043	=item void *ev_userdata (loop)
933		1044
934	Set and retrieve a single C<void *> associated with a loop. When	1045	Set and retrieve a single C<void *> associated with a loop. When
935	C<ev_set_userdata> has never been called, then C<ev_userdata> returns	1046	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
936	C<0.>	1047	C<0>.
937		1048
938	These two functions can be used to associate arbitrary data with a loop,	1049	These two functions can be used to associate arbitrary data with a loop,
939	and are intended solely for the C<invoke_pending_cb>, C<release> and	1050	and are intended solely for the C<invoke_pending_cb>, C<release> and
940	C<acquire> callbacks described above, but of course can be (ab-)used for	1051	C<acquire> callbacks described above, but of course can be (ab-)used for
941	any other purpose as well.	1052	any other purpose as well.
942		1053
943	=item ev_loop_verify (loop)	1054	=item ev_verify (loop)
944		1055
945	This function only does something when C<EV_VERIFY> support has been	1056	This function only does something when C<EV_VERIFY> support has been
946	compiled in, which is the default for non-minimal builds. It tries to go	1057	compiled in, which is the default for non-minimal builds. It tries to go
947	through all internal structures and checks them for validity. If anything	1058	through all internal structures and checks them for validity. If anything
948	is found to be inconsistent, it will print an error message to standard	1059	is found to be inconsistent, it will print an error message to standard
…		…
959		1070
960	In the following description, uppercase C<TYPE> in names stands for the	1071	In the following description, uppercase C<TYPE> in names stands for the
961	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer	1072	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
962	watchers and C<ev_io_start> for I/O watchers.	1073	watchers and C<ev_io_start> for I/O watchers.
963		1074
964	A watcher is a structure that you create and register to record your	1075	A watcher is an opaque structure that you allocate and register to record
965	interest in some event. For instance, if you want to wait for STDIN to	1076	your interest in some event. To make a concrete example, imagine you want
966	become readable, you would create an C<ev_io> watcher for that:	1077	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1078	for that:
967		1079
968	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)	1080	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
969	{	1081	{
970	ev_io_stop (w);	1082	ev_io_stop (w);
971	ev_unloop (loop, EVUNLOOP_ALL);	1083	ev_break (loop, EVBREAK_ALL);
972	}	1084	}
973		1085
974	struct ev_loop *loop = ev_default_loop (0);	1086	struct ev_loop *loop = ev_default_loop (0);
975		1087
976	ev_io stdin_watcher;	1088	ev_io stdin_watcher;
977		1089
978	ev_init (&stdin_watcher, my_cb);	1090	ev_init (&stdin_watcher, my_cb);
979	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1091	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
980	ev_io_start (loop, &stdin_watcher);	1092	ev_io_start (loop, &stdin_watcher);
981		1093
982	ev_loop (loop, 0);	1094	ev_run (loop, 0);
983		1095
984	As you can see, you are responsible for allocating the memory for your	1096	As you can see, you are responsible for allocating the memory for your
985	watcher structures (and it is I<usually> a bad idea to do this on the	1097	watcher structures (and it is I<usually> a bad idea to do this on the
986	stack).	1098	stack).
987		1099
988	Each watcher has an associated watcher structure (called C<struct ev_TYPE>	1100	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
989	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).	1101	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
990		1102
991	Each watcher structure must be initialised by a call to C<ev_init	1103	Each watcher structure must be initialised by a call to C<ev_init (watcher
992	(watcher *, callback)>, which expects a callback to be provided. This	1104	*, callback)>, which expects a callback to be provided. This callback is
993	callback gets invoked each time the event occurs (or, in the case of I/O	1105	invoked each time the event occurs (or, in the case of I/O watchers, each
994	watchers, each time the event loop detects that the file descriptor given	1106	time the event loop detects that the file descriptor given is readable
995	is readable and/or writable).	1107	and/or writable).
996		1108
997	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>	1109	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
998	macro to configure it, with arguments specific to the watcher type. There	1110	macro to configure it, with arguments specific to the watcher type. There
999	is also a macro to combine initialisation and setting in one call: C<<	1111	is also a macro to combine initialisation and setting in one call: C<<
1000	ev_TYPE_init (watcher *, callback, ...) >>.	1112	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
1023	=item C<EV_WRITE>	1135	=item C<EV_WRITE>
1024		1136
1025	The file descriptor in the C<ev_io> watcher has become readable and/or	1137	The file descriptor in the C<ev_io> watcher has become readable and/or
1026	writable.	1138	writable.
1027		1139
1028	=item C<EV_TIMEOUT>	1140	=item C<EV_TIMER>
1029		1141
1030	The C<ev_timer> watcher has timed out.	1142	The C<ev_timer> watcher has timed out.
1031		1143
1032	=item C<EV_PERIODIC>	1144	=item C<EV_PERIODIC>
1033		1145
…		…
1051		1163
1052	=item C<EV_PREPARE>	1164	=item C<EV_PREPARE>
1053		1165
1054	=item C<EV_CHECK>	1166	=item C<EV_CHECK>
1055		1167
1056	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts	1168	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts
1057	to gather new events, and all C<ev_check> watchers are invoked just after	1169	to gather new events, and all C<ev_check> watchers are invoked just after
1058	C<ev_loop> has gathered them, but before it invokes any callbacks for any	1170	C<ev_run> has gathered them, but before it invokes any callbacks for any
1059	received events. Callbacks of both watcher types can start and stop as	1171	received events. Callbacks of both watcher types can start and stop as
1060	many watchers as they want, and all of them will be taken into account	1172	many watchers as they want, and all of them will be taken into account
1061	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	1173	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
1062	C<ev_loop> from blocking).	1174	C<ev_run> from blocking).
1063		1175
1064	=item C<EV_EMBED>	1176	=item C<EV_EMBED>
1065		1177
1066	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1178	The embedded event loop specified in the C<ev_embed> watcher needs attention.
1067		1179
1068	=item C<EV_FORK>	1180	=item C<EV_FORK>
1069		1181
1070	The event loop has been resumed in the child process after fork (see	1182	The event loop has been resumed in the child process after fork (see
1071	C<ev_fork>).	1183	C<ev_fork>).
		1184
		1185	=item C<EV_CLEANUP>
		1186
		1187	The event loop is about to be destroyed (see C<ev_cleanup>).
1072		1188
1073	=item C<EV_ASYNC>	1189	=item C<EV_ASYNC>
1074		1190
1075	The given async watcher has been asynchronously notified (see C<ev_async>).	1191	The given async watcher has been asynchronously notified (see C<ev_async>).
1076		1192
…		…
1123		1239
1124	ev_io w;	1240	ev_io w;
1125	ev_init (&w, my_cb);	1241	ev_init (&w, my_cb);
1126	ev_io_set (&w, STDIN_FILENO, EV_READ);	1242	ev_io_set (&w, STDIN_FILENO, EV_READ);
1127		1243
1128	=item C<ev_TYPE_set> (ev_TYPE *, [args])	1244	=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
1129		1245
1130	This macro initialises the type-specific parts of a watcher. You need to	1246	This macro initialises the type-specific parts of a watcher. You need to
1131	call C<ev_init> at least once before you call this macro, but you can	1247	call C<ev_init> at least once before you call this macro, but you can
1132	call C<ev_TYPE_set> any number of times. You must not, however, call this	1248	call C<ev_TYPE_set> any number of times. You must not, however, call this
1133	macro on a watcher that is active (it can be pending, however, which is a	1249	macro on a watcher that is active (it can be pending, however, which is a
…		…
1146		1262
1147	Example: Initialise and set an C<ev_io> watcher in one step.	1263	Example: Initialise and set an C<ev_io> watcher in one step.
1148		1264
1149	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);	1265	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1150		1266
1151	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1267	=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1152		1268
1153	Starts (activates) the given watcher. Only active watchers will receive	1269	Starts (activates) the given watcher. Only active watchers will receive
1154	events. If the watcher is already active nothing will happen.	1270	events. If the watcher is already active nothing will happen.
1155		1271
1156	Example: Start the C<ev_io> watcher that is being abused as example in this	1272	Example: Start the C<ev_io> watcher that is being abused as example in this
1157	whole section.	1273	whole section.
1158		1274
1159	ev_io_start (EV_DEFAULT_UC, &w);	1275	ev_io_start (EV_DEFAULT_UC, &w);
1160		1276
1161	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1277	=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1162		1278
1163	Stops the given watcher if active, and clears the pending status (whether	1279	Stops the given watcher if active, and clears the pending status (whether
1164	the watcher was active or not).	1280	the watcher was active or not).
1165		1281
1166	It is possible that stopped watchers are pending - for example,	1282	It is possible that stopped watchers are pending - for example,
…		…
1191	=item ev_cb_set (ev_TYPE *watcher, callback)	1307	=item ev_cb_set (ev_TYPE *watcher, callback)
1192		1308
1193	Change the callback. You can change the callback at virtually any time	1309	Change the callback. You can change the callback at virtually any time
1194	(modulo threads).	1310	(modulo threads).
1195		1311
1196	=item ev_set_priority (ev_TYPE *watcher, priority)	1312	=item ev_set_priority (ev_TYPE *watcher, int priority)
1197		1313
1198	=item int ev_priority (ev_TYPE *watcher)	1314	=item int ev_priority (ev_TYPE *watcher)
1199		1315
1200	Set and query the priority of the watcher. The priority is a small	1316	Set and query the priority of the watcher. The priority is a small
1201	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>	1317	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
…		…
1233	watcher isn't pending it does nothing and returns C<0>.	1349	watcher isn't pending it does nothing and returns C<0>.
1234		1350
1235	Sometimes it can be useful to "poll" a watcher instead of waiting for its	1351	Sometimes it can be useful to "poll" a watcher instead of waiting for its
1236	callback to be invoked, which can be accomplished with this function.	1352	callback to be invoked, which can be accomplished with this function.
1237		1353
		1354	=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
		1355
		1356	Feeds the given event set into the event loop, as if the specified event
		1357	had happened for the specified watcher (which must be a pointer to an
		1358	initialised but not necessarily started event watcher). Obviously you must
		1359	not free the watcher as long as it has pending events.
		1360
		1361	Stopping the watcher, letting libev invoke it, or calling
		1362	C<ev_clear_pending> will clear the pending event, even if the watcher was
		1363	not started in the first place.
		1364
		1365	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
		1366	functions that do not need a watcher.
		1367
1238	=back	1368	=back
1239		1369
		1370	See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
		1371	OWN COMPOSITE WATCHERS> idioms.
1240		1372
1241	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1373	=head2 WATCHER STATES
1242		1374
1243	Each watcher has, by default, a member C<void *data> that you can change	1375	There are various watcher states mentioned throughout this manual -
1244	and read at any time: libev will completely ignore it. This can be used	1376	active, pending and so on. In this section these states and the rules to
1245	to associate arbitrary data with your watcher. If you need more data and	1377	transition between them will be described in more detail - and while these
1246	don't want to allocate memory and store a pointer to it in that data	1378	rules might look complicated, they usually do "the right thing".
1247	member, you can also "subclass" the watcher type and provide your own
1248	data:
1249		1379
1250	struct my_io	1380	=over 4
1251	{
1252	ev_io io;
1253	int otherfd;
1254	void *somedata;
1255	struct whatever *mostinteresting;
1256	};
1257		1381
1258	...	1382	=item initialiased
1259	struct my_io w;
1260	ev_io_init (&w.io, my_cb, fd, EV_READ);
1261		1383
1262	And since your callback will be called with a pointer to the watcher, you	1384	Before a watcher can be registered with the event looop it has to be
1263	can cast it back to your own type:	1385	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1386	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1264		1387
1265	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)	1388	In this state it is simply some block of memory that is suitable for
1266	{	1389	use in an event loop. It can be moved around, freed, reused etc. at
1267	struct my_io *w = (struct my_io *)w_;	1390	will - as long as you either keep the memory contents intact, or call
1268	...	1391	C<ev_TYPE_init> again.
1269	}
1270		1392
1271	More interesting and less C-conformant ways of casting your callback type	1393	=item started/running/active
1272	instead have been omitted.
1273		1394
1274	Another common scenario is to use some data structure with multiple	1395	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1275	embedded watchers:	1396	property of the event loop, and is actively waiting for events. While in
		1397	this state it cannot be accessed (except in a few documented ways), moved,
		1398	freed or anything else - the only legal thing is to keep a pointer to it,
		1399	and call libev functions on it that are documented to work on active watchers.
1276		1400
1277	struct my_biggy	1401	=item pending
1278	{
1279	int some_data;
1280	ev_timer t1;
1281	ev_timer t2;
1282	}
1283		1402
1284	In this case getting the pointer to C<my_biggy> is a bit more	1403	If a watcher is active and libev determines that an event it is interested
1285	complicated: Either you store the address of your C<my_biggy> struct	1404	in has occurred (such as a timer expiring), it will become pending. It will
1286	in the C<data> member of the watcher (for woozies), or you need to use	1405	stay in this pending state until either it is stopped or its callback is
1287	some pointer arithmetic using C<offsetof> inside your watchers (for real	1406	about to be invoked, so it is not normally pending inside the watcher
1288	programmers):	1407	callback.
1289		1408
1290	#include <stddef.h>	1409	The watcher might or might not be active while it is pending (for example,
		1410	an expired non-repeating timer can be pending but no longer active). If it
		1411	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1412	but it is still property of the event loop at this time, so cannot be
		1413	moved, freed or reused. And if it is active the rules described in the
		1414	previous item still apply.
1291		1415
1292	static void	1416	It is also possible to feed an event on a watcher that is not active (e.g.
1293	t1_cb (EV_P_ ev_timer *w, int revents)	1417	via C<ev_feed_event>), in which case it becomes pending without being
1294	{	1418	active.
1295	struct my_biggy big = (struct my_biggy *)
1296	(((char *)w) - offsetof (struct my_biggy, t1));
1297	}
1298		1419
1299	static void	1420	=item stopped
1300	t2_cb (EV_P_ ev_timer *w, int revents)	1421
1301	{	1422	A watcher can be stopped implicitly by libev (in which case it might still
1302	struct my_biggy big = (struct my_biggy *)	1423	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
1303	(((char *)w) - offsetof (struct my_biggy, t2));	1424	latter will clear any pending state the watcher might be in, regardless
1304	}	1425	of whether it was active or not, so stopping a watcher explicitly before
		1426	freeing it is often a good idea.
		1427
		1428	While stopped (and not pending) the watcher is essentially in the
		1429	initialised state, that is, it can be reused, moved, modified in any way
		1430	you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
		1431	it again).
		1432
		1433	=back
1305		1434
1306	=head2 WATCHER PRIORITY MODELS	1435	=head2 WATCHER PRIORITY MODELS
1307		1436
1308	Many event loops support I<watcher priorities>, which are usually small	1437	Many event loops support I<watcher priorities>, which are usually small
1309	integers that influence the ordering of event callback invocation	1438	integers that influence the ordering of event callback invocation
…		…
1352		1481
1353	For example, to emulate how many other event libraries handle priorities,	1482	For example, to emulate how many other event libraries handle priorities,
1354	you can associate an C<ev_idle> watcher to each such watcher, and in	1483	you can associate an C<ev_idle> watcher to each such watcher, and in
1355	the normal watcher callback, you just start the idle watcher. The real	1484	the normal watcher callback, you just start the idle watcher. The real
1356	processing is done in the idle watcher callback. This causes libev to	1485	processing is done in the idle watcher callback. This causes libev to
1357	continously poll and process kernel event data for the watcher, but when	1486	continuously poll and process kernel event data for the watcher, but when
1358	the lock-out case is known to be rare (which in turn is rare :), this is	1487	the lock-out case is known to be rare (which in turn is rare :), this is
1359	workable.	1488	workable.
1360		1489
1361	Usually, however, the lock-out model implemented that way will perform	1490	Usually, however, the lock-out model implemented that way will perform
1362	miserably under the type of load it was designed to handle. In that case,	1491	miserably under the type of load it was designed to handle. In that case,
…		…
1376	{	1505	{
1377	// stop the I/O watcher, we received the event, but	1506	// stop the I/O watcher, we received the event, but
1378	// are not yet ready to handle it.	1507	// are not yet ready to handle it.
1379	ev_io_stop (EV_A_ w);	1508	ev_io_stop (EV_A_ w);
1380		1509
1381	// start the idle watcher to ahndle the actual event.	1510	// start the idle watcher to handle the actual event.
1382	// it will not be executed as long as other watchers	1511	// it will not be executed as long as other watchers
1383	// with the default priority are receiving events.	1512	// with the default priority are receiving events.
1384	ev_idle_start (EV_A_ &idle);	1513	ev_idle_start (EV_A_ &idle);
1385	}	1514	}
1386		1515
…		…
1436	In general you can register as many read and/or write event watchers per	1565	In general you can register as many read and/or write event watchers per
1437	fd as you want (as long as you don't confuse yourself). Setting all file	1566	fd as you want (as long as you don't confuse yourself). Setting all file
1438	descriptors to non-blocking mode is also usually a good idea (but not	1567	descriptors to non-blocking mode is also usually a good idea (but not
1439	required if you know what you are doing).	1568	required if you know what you are doing).
1440		1569
1441	If you cannot use non-blocking mode, then force the use of a
1442	known-to-be-good backend (at the time of this writing, this includes only
1443	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1444	descriptors for which non-blocking operation makes no sense (such as
1445	files) - libev doesn't guarentee any specific behaviour in that case.
1446
1447	Another thing you have to watch out for is that it is quite easy to	1570	Another thing you have to watch out for is that it is quite easy to
1448	receive "spurious" readiness notifications, that is your callback might	1571	receive "spurious" readiness notifications, that is, your callback might
1449	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1572	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1450	because there is no data. Not only are some backends known to create a	1573	because there is no data. It is very easy to get into this situation even
1451	lot of those (for example Solaris ports), it is very easy to get into	1574	with a relatively standard program structure. Thus it is best to always
1452	this situation even with a relatively standard program structure. Thus	1575	use non-blocking I/O: An extra C<read>(2) returning C<EAGAIN> is far
1453	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1454	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1576	preferable to a program hanging until some data arrives.
1455		1577
1456	If you cannot run the fd in non-blocking mode (for example you should	1578	If you cannot run the fd in non-blocking mode (for example you should
1457	not play around with an Xlib connection), then you have to separately	1579	not play around with an Xlib connection), then you have to separately
1458	re-test whether a file descriptor is really ready with a known-to-be good	1580	re-test whether a file descriptor is really ready with a known-to-be good
1459	interface such as poll (fortunately in our Xlib example, Xlib already	1581	interface such as poll (fortunately in the case of Xlib, it already does
1460	does this on its own, so its quite safe to use). Some people additionally	1582	this on its own, so its quite safe to use). Some people additionally
1461	use C<SIGALRM> and an interval timer, just to be sure you won't block	1583	use C<SIGALRM> and an interval timer, just to be sure you won't block
1462	indefinitely.	1584	indefinitely.
1463		1585
1464	But really, best use non-blocking mode.	1586	But really, best use non-blocking mode.
1465		1587
…		…
1493		1615
1494	There is no workaround possible except not registering events	1616	There is no workaround possible except not registering events
1495	for potentially C<dup ()>'ed file descriptors, or to resort to	1617	for potentially C<dup ()>'ed file descriptors, or to resort to
1496	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1618	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1497		1619
		1620	=head3 The special problem of files
		1621
		1622	Many people try to use C<select> (or libev) on file descriptors
		1623	representing files, and expect it to become ready when their program
		1624	doesn't block on disk accesses (which can take a long time on their own).
		1625
		1626	However, this cannot ever work in the "expected" way - you get a readiness
		1627	notification as soon as the kernel knows whether and how much data is
		1628	there, and in the case of open files, that's always the case, so you
		1629	always get a readiness notification instantly, and your read (or possibly
		1630	write) will still block on the disk I/O.
		1631
		1632	Another way to view it is that in the case of sockets, pipes, character
		1633	devices and so on, there is another party (the sender) that delivers data
		1634	on its own, but in the case of files, there is no such thing: the disk
		1635	will not send data on its own, simply because it doesn't know what you
		1636	wish to read - you would first have to request some data.
		1637
		1638	Since files are typically not-so-well supported by advanced notification
		1639	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1640	to files, even though you should not use it. The reason for this is
		1641	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1642	usually a tty, often a pipe, but also sometimes files or special devices
		1643	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1644	F</dev/urandom>), and even though the file might better be served with
		1645	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1646	it "just works" instead of freezing.
		1647
		1648	So avoid file descriptors pointing to files when you know it (e.g. use
		1649	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1650	when you rarely read from a file instead of from a socket, and want to
		1651	reuse the same code path.
		1652
1498	=head3 The special problem of fork	1653	=head3 The special problem of fork
1499		1654
1500	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1655	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1501	useless behaviour. Libev fully supports fork, but needs to be told about	1656	useless behaviour. Libev fully supports fork, but needs to be told about
1502	it in the child.	1657	it in the child if you want to continue to use it in the child.
1503		1658
1504	To support fork in your programs, you either have to call	1659	To support fork in your child processes, you have to call C<ev_loop_fork
1505	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1660	()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1506	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1661	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1507	C<EVBACKEND_POLL>.
1508		1662
1509	=head3 The special problem of SIGPIPE	1663	=head3 The special problem of SIGPIPE
1510		1664
1511	While not really specific to libev, it is easy to forget about C<SIGPIPE>:	1665	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1512	when writing to a pipe whose other end has been closed, your program gets	1666	when writing to a pipe whose other end has been closed, your program gets
…		…
1515		1669
1516	So when you encounter spurious, unexplained daemon exits, make sure you	1670	So when you encounter spurious, unexplained daemon exits, make sure you
1517	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon	1671	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1518	somewhere, as that would have given you a big clue).	1672	somewhere, as that would have given you a big clue).
1519		1673
		1674	=head3 The special problem of accept()ing when you can't
		1675
		1676	Many implementations of the POSIX C<accept> function (for example,
		1677	found in post-2004 Linux) have the peculiar behaviour of not removing a
		1678	connection from the pending queue in all error cases.
		1679
		1680	For example, larger servers often run out of file descriptors (because
		1681	of resource limits), causing C<accept> to fail with C<ENFILE> but not
		1682	rejecting the connection, leading to libev signalling readiness on
		1683	the next iteration again (the connection still exists after all), and
		1684	typically causing the program to loop at 100% CPU usage.
		1685
		1686	Unfortunately, the set of errors that cause this issue differs between
		1687	operating systems, there is usually little the app can do to remedy the
		1688	situation, and no known thread-safe method of removing the connection to
		1689	cope with overload is known (to me).
		1690
		1691	One of the easiest ways to handle this situation is to just ignore it
		1692	- when the program encounters an overload, it will just loop until the
		1693	situation is over. While this is a form of busy waiting, no OS offers an
		1694	event-based way to handle this situation, so it's the best one can do.
		1695
		1696	A better way to handle the situation is to log any errors other than
		1697	C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such
		1698	messages, and continue as usual, which at least gives the user an idea of
		1699	what could be wrong ("raise the ulimit!"). For extra points one could stop
		1700	the C<ev_io> watcher on the listening fd "for a while", which reduces CPU
		1701	usage.
		1702
		1703	If your program is single-threaded, then you could also keep a dummy file
		1704	descriptor for overload situations (e.g. by opening F</dev/null>), and
		1705	when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>,
		1706	close that fd, and create a new dummy fd. This will gracefully refuse
		1707	clients under typical overload conditions.
		1708
		1709	The last way to handle it is to simply log the error and C<exit>, as
		1710	is often done with C<malloc> failures, but this results in an easy
		1711	opportunity for a DoS attack.
1520		1712
1521	=head3 Watcher-Specific Functions	1713	=head3 Watcher-Specific Functions
1522		1714
1523	=over 4	1715	=over 4
1524		1716
…		…
1556	...	1748	...
1557	struct ev_loop *loop = ev_default_init (0);	1749	struct ev_loop *loop = ev_default_init (0);
1558	ev_io stdin_readable;	1750	ev_io stdin_readable;
1559	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1751	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1560	ev_io_start (loop, &stdin_readable);	1752	ev_io_start (loop, &stdin_readable);
1561	ev_loop (loop, 0);	1753	ev_run (loop, 0);
1562		1754
1563		1755
1564	=head2 C<ev_timer> - relative and optionally repeating timeouts	1756	=head2 C<ev_timer> - relative and optionally repeating timeouts
1565		1757
1566	Timer watchers are simple relative timers that generate an event after a	1758	Timer watchers are simple relative timers that generate an event after a
…		…
1575	The callback is guaranteed to be invoked only I<after> its timeout has	1767	The callback is guaranteed to be invoked only I<after> its timeout has
1576	passed (not I<at>, so on systems with very low-resolution clocks this	1768	passed (not I<at>, so on systems with very low-resolution clocks this
1577	might introduce a small delay). If multiple timers become ready during the	1769	might introduce a small delay). If multiple timers become ready during the
1578	same loop iteration then the ones with earlier time-out values are invoked	1770	same loop iteration then the ones with earlier time-out values are invoked
1579	before ones of the same priority with later time-out values (but this is	1771	before ones of the same priority with later time-out values (but this is
1580	no longer true when a callback calls C<ev_loop> recursively).	1772	no longer true when a callback calls C<ev_run> recursively).
1581		1773
1582	=head3 Be smart about timeouts	1774	=head3 Be smart about timeouts
1583		1775
1584	Many real-world problems involve some kind of timeout, usually for error	1776	Many real-world problems involve some kind of timeout, usually for error
1585	recovery. A typical example is an HTTP request - if the other side hangs,	1777	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1671	ev_tstamp timeout = last_activity + 60.;	1863	ev_tstamp timeout = last_activity + 60.;
1672		1864
1673	// if last_activity + 60. is older than now, we did time out	1865	// if last_activity + 60. is older than now, we did time out
1674	if (timeout < now)	1866	if (timeout < now)
1675	{	1867	{
1676	// timeout occured, take action	1868	// timeout occurred, take action
1677	}	1869	}
1678	else	1870	else
1679	{	1871	{
1680	// callback was invoked, but there was some activity, re-arm	1872	// callback was invoked, but there was some activity, re-arm
1681	// the watcher to fire in last_activity + 60, which is	1873	// the watcher to fire in last_activity + 60, which is
…		…
1703	to the current time (meaning we just have some activity :), then call the	1895	to the current time (meaning we just have some activity :), then call the
1704	callback, which will "do the right thing" and start the timer:	1896	callback, which will "do the right thing" and start the timer:
1705		1897
1706	ev_init (timer, callback);	1898	ev_init (timer, callback);
1707	last_activity = ev_now (loop);	1899	last_activity = ev_now (loop);
1708	callback (loop, timer, EV_TIMEOUT);	1900	callback (loop, timer, EV_TIMER);
1709		1901
1710	And when there is some activity, simply store the current time in	1902	And when there is some activity, simply store the current time in
1711	C<last_activity>, no libev calls at all:	1903	C<last_activity>, no libev calls at all:
1712		1904
1713	last_actiivty = ev_now (loop);	1905	last_activity = ev_now (loop);
1714		1906
1715	This technique is slightly more complex, but in most cases where the	1907	This technique is slightly more complex, but in most cases where the
1716	time-out is unlikely to be triggered, much more efficient.	1908	time-out is unlikely to be triggered, much more efficient.
1717		1909
1718	Changing the timeout is trivial as well (if it isn't hard-coded in the	1910	Changing the timeout is trivial as well (if it isn't hard-coded in the
…		…
1756		1948
1757	=head3 The special problem of time updates	1949	=head3 The special problem of time updates
1758		1950
1759	Establishing the current time is a costly operation (it usually takes at	1951	Establishing the current time is a costly operation (it usually takes at
1760	least two system calls): EV therefore updates its idea of the current	1952	least two system calls): EV therefore updates its idea of the current
1761	time only before and after C<ev_loop> collects new events, which causes a	1953	time only before and after C<ev_run> collects new events, which causes a
1762	growing difference between C<ev_now ()> and C<ev_time ()> when handling	1954	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1763	lots of events in one iteration.	1955	lots of events in one iteration.
1764		1956
1765	The relative timeouts are calculated relative to the C<ev_now ()>	1957	The relative timeouts are calculated relative to the C<ev_now ()>
1766	time. This is usually the right thing as this timestamp refers to the time	1958	time. This is usually the right thing as this timestamp refers to the time
…		…
1837	C<repeat> value), or reset the running timer to the C<repeat> value.	2029	C<repeat> value), or reset the running timer to the C<repeat> value.
1838		2030
1839	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a	2031	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1840	usage example.	2032	usage example.
1841		2033
1842	=item ev_timer_remaining (loop, ev_timer *)	2034	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
1843		2035
1844	Returns the remaining time until a timer fires. If the timer is active,	2036	Returns the remaining time until a timer fires. If the timer is active,
1845	then this time is relative to the current event loop time, otherwise it's	2037	then this time is relative to the current event loop time, otherwise it's
1846	the timeout value currently configured.	2038	the timeout value currently configured.
1847		2039
1848	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns	2040	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
1849	C<5>. When the timer is started and one second passes, C<ev_timer_remain>	2041	C<5>. When the timer is started and one second passes, C<ev_timer_remaining>
1850	will return C<4>. When the timer expires and is restarted, it will return	2042	will return C<4>. When the timer expires and is restarted, it will return
1851	roughly C<7> (likely slightly less as callback invocation takes some time,	2043	roughly C<7> (likely slightly less as callback invocation takes some time,
1852	too), and so on.	2044	too), and so on.
1853		2045
1854	=item ev_tstamp repeat [read-write]	2046	=item ev_tstamp repeat [read-write]
…		…
1883	}	2075	}
1884		2076
1885	ev_timer mytimer;	2077	ev_timer mytimer;
1886	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	2078	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1887	ev_timer_again (&mytimer); /* start timer */	2079	ev_timer_again (&mytimer); /* start timer */
1888	ev_loop (loop, 0);	2080	ev_run (loop, 0);
1889		2081
1890	// and in some piece of code that gets executed on any "activity":	2082	// and in some piece of code that gets executed on any "activity":
1891	// reset the timeout to start ticking again at 10 seconds	2083	// reset the timeout to start ticking again at 10 seconds
1892	ev_timer_again (&mytimer);	2084	ev_timer_again (&mytimer);
1893		2085
…		…
1919		2111
1920	As with timers, the callback is guaranteed to be invoked only when the	2112	As with timers, the callback is guaranteed to be invoked only when the
1921	point in time where it is supposed to trigger has passed. If multiple	2113	point in time where it is supposed to trigger has passed. If multiple
1922	timers become ready during the same loop iteration then the ones with	2114	timers become ready during the same loop iteration then the ones with
1923	earlier time-out values are invoked before ones with later time-out values	2115	earlier time-out values are invoked before ones with later time-out values
1924	(but this is no longer true when a callback calls C<ev_loop> recursively).	2116	(but this is no longer true when a callback calls C<ev_run> recursively).
1925		2117
1926	=head3 Watcher-Specific Functions and Data Members	2118	=head3 Watcher-Specific Functions and Data Members
1927		2119
1928	=over 4	2120	=over 4
1929		2121
…		…
1964		2156
1965	Another way to think about it (for the mathematically inclined) is that	2157	Another way to think about it (for the mathematically inclined) is that
1966	C<ev_periodic> will try to run the callback in this mode at the next possible	2158	C<ev_periodic> will try to run the callback in this mode at the next possible
1967	time where C<time = offset (mod interval)>, regardless of any time jumps.	2159	time where C<time = offset (mod interval)>, regardless of any time jumps.
1968		2160
1969	For numerical stability it is preferable that the C<offset> value is near	2161	The C<interval> I<MUST> be positive, and for numerical stability, the
1970	C<ev_now ()> (the current time), but there is no range requirement for	2162	interval value should be higher than C<1/8192> (which is around 100
1971	this value, and in fact is often specified as zero.	2163	microseconds) and C<offset> should be higher than C<0> and should have
		2164	at most a similar magnitude as the current time (say, within a factor of
		2165	ten). Typical values for offset are, in fact, C<0> or something between
		2166	C<0> and C<interval>, which is also the recommended range.
1972		2167
1973	Note also that there is an upper limit to how often a timer can fire (CPU	2168	Note also that there is an upper limit to how often a timer can fire (CPU
1974	speed for example), so if C<interval> is very small then timing stability	2169	speed for example), so if C<interval> is very small then timing stability
1975	will of course deteriorate. Libev itself tries to be exact to be about one	2170	will of course deteriorate. Libev itself tries to be exact to be about one
1976	millisecond (if the OS supports it and the machine is fast enough).	2171	millisecond (if the OS supports it and the machine is fast enough).
…		…
2057	Example: Call a callback every hour, or, more precisely, whenever the	2252	Example: Call a callback every hour, or, more precisely, whenever the
2058	system time is divisible by 3600. The callback invocation times have	2253	system time is divisible by 3600. The callback invocation times have
2059	potentially a lot of jitter, but good long-term stability.	2254	potentially a lot of jitter, but good long-term stability.
2060		2255
2061	static void	2256	static void
2062	clock_cb (struct ev_loop *loop, ev_io *w, int revents)	2257	clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
2063	{	2258	{
2064	... its now a full hour (UTC, or TAI or whatever your clock follows)	2259	... its now a full hour (UTC, or TAI or whatever your clock follows)
2065	}	2260	}
2066		2261
2067	ev_periodic hourly_tick;	2262	ev_periodic hourly_tick;
…		…
2090		2285
2091	=head2 C<ev_signal> - signal me when a signal gets signalled!	2286	=head2 C<ev_signal> - signal me when a signal gets signalled!
2092		2287
2093	Signal watchers will trigger an event when the process receives a specific	2288	Signal watchers will trigger an event when the process receives a specific
2094	signal one or more times. Even though signals are very asynchronous, libev	2289	signal one or more times. Even though signals are very asynchronous, libev
2095	will try it's best to deliver signals synchronously, i.e. as part of the	2290	will try its best to deliver signals synchronously, i.e. as part of the
2096	normal event processing, like any other event.	2291	normal event processing, like any other event.
2097		2292
2098	If you want signals to be delivered truly asynchronously, just use	2293	If you want signals to be delivered truly asynchronously, just use
2099	C<sigaction> as you would do without libev and forget about sharing	2294	C<sigaction> as you would do without libev and forget about sharing
2100	the signal. You can even use C<ev_async> from a signal handler to	2295	the signal. You can even use C<ev_async> from a signal handler to
…		…
2114	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should	2309	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2115	not be unduly interrupted. If you have a problem with system calls getting	2310	not be unduly interrupted. If you have a problem with system calls getting
2116	interrupted by signals you can block all signals in an C<ev_check> watcher	2311	interrupted by signals you can block all signals in an C<ev_check> watcher
2117	and unblock them in an C<ev_prepare> watcher.	2312	and unblock them in an C<ev_prepare> watcher.
2118		2313
2119	=head3 The special problem of inheritance over execve	2314	=head3 The special problem of inheritance over fork/execve/pthread_create
2120		2315
2121	Both the signal mask (C<sigprocmask>) and the signal disposition	2316	Both the signal mask (C<sigprocmask>) and the signal disposition
2122	(C<sigaction>) are unspecified after starting a signal watcher (and after	2317	(C<sigaction>) are unspecified after starting a signal watcher (and after
2123	stopping it again), that is, libev might or might not block the signal,	2318	stopping it again), that is, libev might or might not block the signal,
2124	and might or might not set or restore the installed signal handler.	2319	and might or might not set or restore the installed signal handler (but
		2320	see C<EVFLAG_NOSIGMASK>).
2125		2321
2126	While this does not matter for the signal disposition (libev never	2322	While this does not matter for the signal disposition (libev never
2127	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on	2323	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2128	C<execve>), this matters for the signal mask: many programs do not expect	2324	C<execve>), this matters for the signal mask: many programs do not expect
2129	many signals to be blocked.	2325	certain signals to be blocked.
2130		2326
2131	This means that before calling C<exec> (from the child) you should reset	2327	This means that before calling C<exec> (from the child) you should reset
2132	the signal mask to whatever "default" you expect (all clear is a good	2328	the signal mask to whatever "default" you expect (all clear is a good
2133	choice usually).	2329	choice usually).
2134		2330
		2331	The simplest way to ensure that the signal mask is reset in the child is
		2332	to install a fork handler with C<pthread_atfork> that resets it. That will
		2333	catch fork calls done by libraries (such as the libc) as well.
		2334
		2335	In current versions of libev, the signal will not be blocked indefinitely
		2336	unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces
		2337	the window of opportunity for problems, it will not go away, as libev
		2338	I<has> to modify the signal mask, at least temporarily.
		2339
		2340	So I can't stress this enough: I<If you do not reset your signal mask when
		2341	you expect it to be empty, you have a race condition in your code>. This
		2342	is not a libev-specific thing, this is true for most event libraries.
		2343
		2344	=head3 The special problem of threads signal handling
		2345
		2346	POSIX threads has problematic signal handling semantics, specifically,
		2347	a lot of functionality (sigfd, sigwait etc.) only really works if all
		2348	threads in a process block signals, which is hard to achieve.
		2349
		2350	When you want to use sigwait (or mix libev signal handling with your own
		2351	for the same signals), you can tackle this problem by globally blocking
		2352	all signals before creating any threads (or creating them with a fully set
		2353	sigprocmask) and also specifying the C<EVFLAG_NOSIGMASK> when creating
		2354	loops. Then designate one thread as "signal receiver thread" which handles
		2355	these signals. You can pass on any signals that libev might be interested
		2356	in by calling C<ev_feed_signal>.
		2357
2135	=head3 Watcher-Specific Functions and Data Members	2358	=head3 Watcher-Specific Functions and Data Members
2136		2359
2137	=over 4	2360	=over 4
2138		2361
2139	=item ev_signal_init (ev_signal *, callback, int signum)	2362	=item ev_signal_init (ev_signal *, callback, int signum)
…		…
2154	Example: Try to exit cleanly on SIGINT.	2377	Example: Try to exit cleanly on SIGINT.
2155		2378
2156	static void	2379	static void
2157	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)	2380	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2158	{	2381	{
2159	ev_unloop (loop, EVUNLOOP_ALL);	2382	ev_break (loop, EVBREAK_ALL);
2160	}	2383	}
2161		2384
2162	ev_signal signal_watcher;	2385	ev_signal signal_watcher;
2163	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2386	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2164	ev_signal_start (loop, &signal_watcher);	2387	ev_signal_start (loop, &signal_watcher);
…		…
2550		2773
2551	Prepare and check watchers are usually (but not always) used in pairs:	2774	Prepare and check watchers are usually (but not always) used in pairs:
2552	prepare watchers get invoked before the process blocks and check watchers	2775	prepare watchers get invoked before the process blocks and check watchers
2553	afterwards.	2776	afterwards.
2554		2777
2555	You I<must not> call C<ev_loop> or similar functions that enter	2778	You I<must not> call C<ev_run> or similar functions that enter
2556	the current event loop from either C<ev_prepare> or C<ev_check>	2779	the current event loop from either C<ev_prepare> or C<ev_check>
2557	watchers. Other loops than the current one are fine, however. The	2780	watchers. Other loops than the current one are fine, however. The
2558	rationale behind this is that you do not need to check for recursion in	2781	rationale behind this is that you do not need to check for recursion in
2559	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2782	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
2560	C<ev_check> so if you have one watcher of each kind they will always be	2783	C<ev_check> so if you have one watcher of each kind they will always be
…		…
2728		2951
2729	if (timeout >= 0)	2952	if (timeout >= 0)
2730	// create/start timer	2953	// create/start timer
2731		2954
2732	// poll	2955	// poll
2733	ev_loop (EV_A_ 0);	2956	ev_run (EV_A_ 0);
2734		2957
2735	// stop timer again	2958	// stop timer again
2736	if (timeout >= 0)	2959	if (timeout >= 0)
2737	ev_timer_stop (EV_A_ &to);	2960	ev_timer_stop (EV_A_ &to);
2738		2961
…		…
2816	if you do not want that, you need to temporarily stop the embed watcher).	3039	if you do not want that, you need to temporarily stop the embed watcher).
2817		3040
2818	=item ev_embed_sweep (loop, ev_embed *)	3041	=item ev_embed_sweep (loop, ev_embed *)
2819		3042
2820	Make a single, non-blocking sweep over the embedded loop. This works	3043	Make a single, non-blocking sweep over the embedded loop. This works
2821	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	3044	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2822	appropriate way for embedded loops.	3045	appropriate way for embedded loops.
2823		3046
2824	=item struct ev_loop *other [read-only]	3047	=item struct ev_loop *other [read-only]
2825		3048
2826	The embedded event loop.	3049	The embedded event loop.
…		…
2886	C<ev_default_fork> cheats and calls it in the wrong process, the fork	3109	C<ev_default_fork> cheats and calls it in the wrong process, the fork
2887	handlers will be invoked, too, of course.	3110	handlers will be invoked, too, of course.
2888		3111
2889	=head3 The special problem of life after fork - how is it possible?	3112	=head3 The special problem of life after fork - how is it possible?
2890		3113
2891	Most uses of C<fork()> consist of forking, then some simple calls to ste	3114	Most uses of C<fork()> consist of forking, then some simple calls to set
2892	up/change the process environment, followed by a call to C<exec()>. This	3115	up/change the process environment, followed by a call to C<exec()>. This
2893	sequence should be handled by libev without any problems.	3116	sequence should be handled by libev without any problems.
2894		3117
2895	This changes when the application actually wants to do event handling	3118	This changes when the application actually wants to do event handling
2896	in the child, or both parent in child, in effect "continuing" after the	3119	in the child, or both parent in child, in effect "continuing" after the
…		…
2912	disadvantage of having to use multiple event loops (which do not support	3135	disadvantage of having to use multiple event loops (which do not support
2913	signal watchers).	3136	signal watchers).
2914		3137
2915	When this is not possible, or you want to use the default loop for	3138	When this is not possible, or you want to use the default loop for
2916	other reasons, then in the process that wants to start "fresh", call	3139	other reasons, then in the process that wants to start "fresh", call
2917	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3140	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
2918	the default loop will "orphan" (not stop) all registered watchers, so you	3141	Destroying the default loop will "orphan" (not stop) all registered
2919	have to be careful not to execute code that modifies those watchers. Note	3142	watchers, so you have to be careful not to execute code that modifies
2920	also that in that case, you have to re-register any signal watchers.	3143	those watchers. Note also that in that case, you have to re-register any
		3144	signal watchers.
2921		3145
2922	=head3 Watcher-Specific Functions and Data Members	3146	=head3 Watcher-Specific Functions and Data Members
2923		3147
2924	=over 4	3148	=over 4
2925		3149
2926	=item ev_fork_init (ev_signal *, callback)	3150	=item ev_fork_init (ev_fork *, callback)
2927		3151
2928	Initialises and configures the fork watcher - it has no parameters of any	3152	Initialises and configures the fork watcher - it has no parameters of any
2929	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3153	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
2930	believe me.	3154	really.
2931		3155
2932	=back	3156	=back
2933		3157
2934		3158
		3159	=head2 C<ev_cleanup> - even the best things end
		3160
		3161	Cleanup watchers are called just before the event loop is being destroyed
		3162	by a call to C<ev_loop_destroy>.
		3163
		3164	While there is no guarantee that the event loop gets destroyed, cleanup
		3165	watchers provide a convenient method to install cleanup hooks for your
		3166	program, worker threads and so on - you just to make sure to destroy the
		3167	loop when you want them to be invoked.
		3168
		3169	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3170	all other watchers, they do not keep a reference to the event loop (which
		3171	makes a lot of sense if you think about it). Like all other watchers, you
		3172	can call libev functions in the callback, except C<ev_cleanup_start>.
		3173
		3174	=head3 Watcher-Specific Functions and Data Members
		3175
		3176	=over 4
		3177
		3178	=item ev_cleanup_init (ev_cleanup *, callback)
		3179
		3180	Initialises and configures the cleanup watcher - it has no parameters of
		3181	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3182	pointless, I assure you.
		3183
		3184	=back
		3185
		3186	Example: Register an atexit handler to destroy the default loop, so any
		3187	cleanup functions are called.
		3188
		3189	static void
		3190	program_exits (void)
		3191	{
		3192	ev_loop_destroy (EV_DEFAULT_UC);
		3193	}
		3194
		3195	...
		3196	atexit (program_exits);
		3197
		3198
2935	=head2 C<ev_async> - how to wake up another event loop	3199	=head2 C<ev_async> - how to wake up an event loop
2936		3200
2937	In general, you cannot use an C<ev_loop> from multiple threads or other	3201	In general, you cannot use an C<ev_loop> from multiple threads or other
2938	asynchronous sources such as signal handlers (as opposed to multiple event	3202	asynchronous sources such as signal handlers (as opposed to multiple event
2939	loops - those are of course safe to use in different threads).	3203	loops - those are of course safe to use in different threads).
2940		3204
2941	Sometimes, however, you need to wake up another event loop you do not	3205	Sometimes, however, you need to wake up an event loop you do not control,
2942	control, for example because it belongs to another thread. This is what	3206	for example because it belongs to another thread. This is what C<ev_async>
2943	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you	3207	watchers do: as long as the C<ev_async> watcher is active, you can signal
2944	can signal it by calling C<ev_async_send>, which is thread- and signal	3208	it by calling C<ev_async_send>, which is thread- and signal safe.
2945	safe.
2946		3209
2947	This functionality is very similar to C<ev_signal> watchers, as signals,	3210	This functionality is very similar to C<ev_signal> watchers, as signals,
2948	too, are asynchronous in nature, and signals, too, will be compressed	3211	too, are asynchronous in nature, and signals, too, will be compressed
2949	(i.e. the number of callback invocations may be less than the number of	3212	(i.e. the number of callback invocations may be less than the number of
2950	C<ev_async_sent> calls).	3213	C<ev_async_sent> calls). In fact, you could use signal watchers as a kind
		3214	of "global async watchers" by using a watcher on an otherwise unused
		3215	signal, and C<ev_feed_signal> to signal this watcher from another thread,
		3216	even without knowing which loop owns the signal.
2951		3217
2952	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not	3218	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
2953	just the default loop.	3219	just the default loop.
2954		3220
2955	=head3 Queueing	3221	=head3 Queueing
2956		3222
2957	C<ev_async> does not support queueing of data in any way. The reason	3223	C<ev_async> does not support queueing of data in any way. The reason
2958	is that the author does not know of a simple (or any) algorithm for a	3224	is that the author does not know of a simple (or any) algorithm for a
2959	multiple-writer-single-reader queue that works in all cases and doesn't	3225	multiple-writer-single-reader queue that works in all cases and doesn't
2960	need elaborate support such as pthreads.	3226	need elaborate support such as pthreads or unportable memory access
		3227	semantics.
2961		3228
2962	That means that if you want to queue data, you have to provide your own	3229	That means that if you want to queue data, you have to provide your own
2963	queue. But at least I can tell you how to implement locking around your	3230	queue. But at least I can tell you how to implement locking around your
2964	queue:	3231	queue:
2965		3232
…		…
3049	trust me.	3316	trust me.
3050		3317
3051	=item ev_async_send (loop, ev_async *)	3318	=item ev_async_send (loop, ev_async *)
3052		3319
3053	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	3320	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
3054	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	3321	an C<EV_ASYNC> event on the watcher into the event loop, and instantly
		3322	returns.
		3323
3055	C<ev_feed_event>, this call is safe to do from other threads, signal or	3324	Unlike C<ev_feed_event>, this call is safe to do from other threads,
3056	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	3325	signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3057	section below on what exactly this means).	3326	embedding section below on what exactly this means).
3058		3327
3059	Note that, as with other watchers in libev, multiple events might get	3328	Note that, as with other watchers in libev, multiple events might get
3060	compressed into a single callback invocation (another way to look at this	3329	compressed into a single callback invocation (another way to look at this
3061	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,	3330	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
3062	reset when the event loop detects that).	3331	reset when the event loop detects that).
…		…
3104		3373
3105	If C<timeout> is less than 0, then no timeout watcher will be	3374	If C<timeout> is less than 0, then no timeout watcher will be
3106	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	3375	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
3107	repeat = 0) will be started. C<0> is a valid timeout.	3376	repeat = 0) will be started. C<0> is a valid timeout.
3108		3377
3109	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	3378	The callback has the type C<void (*cb)(int revents, void *arg)> and is
3110	passed an C<revents> set like normal event callbacks (a combination of	3379	passed an C<revents> set like normal event callbacks (a combination of
3111	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	3380	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg>
3112	value passed to C<ev_once>. Note that it is possible to receive I<both>	3381	value passed to C<ev_once>. Note that it is possible to receive I<both>
3113	a timeout and an io event at the same time - you probably should give io	3382	a timeout and an io event at the same time - you probably should give io
3114	events precedence.	3383	events precedence.
3115		3384
3116	Example: wait up to ten seconds for data to appear on STDIN_FILENO.	3385	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
3117		3386
3118	static void stdin_ready (int revents, void *arg)	3387	static void stdin_ready (int revents, void *arg)
3119	{	3388	{
3120	if (revents & EV_READ)	3389	if (revents & EV_READ)
3121	/* stdin might have data for us, joy! */;	3390	/* stdin might have data for us, joy! */;
3122	else if (revents & EV_TIMEOUT)	3391	else if (revents & EV_TIMER)
3123	/* doh, nothing entered */;	3392	/* doh, nothing entered */;
3124	}	3393	}
3125		3394
3126	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3395	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3127		3396
3128	=item ev_feed_event (struct ev_loop *, watcher *, int revents)
3129
3130	Feeds the given event set into the event loop, as if the specified event
3131	had happened for the specified watcher (which must be a pointer to an
3132	initialised but not necessarily started event watcher).
3133
3134	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)	3397	=item ev_feed_fd_event (loop, int fd, int revents)
3135		3398
3136	Feed an event on the given fd, as if a file descriptor backend detected	3399	Feed an event on the given fd, as if a file descriptor backend detected
3137	the given events it.	3400	the given events it.
3138		3401
3139	=item ev_feed_signal_event (struct ev_loop *loop, int signum)	3402	=item ev_feed_signal_event (loop, int signum)
3140		3403
3141	Feed an event as if the given signal occurred (C<loop> must be the default	3404	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3142	loop!).	3405	which is async-safe.
3143		3406
3144	=back	3407	=back
		3408
		3409
		3410	=head1 COMMON OR USEFUL IDIOMS (OR BOTH)
		3411
		3412	This section explains some common idioms that are not immediately
		3413	obvious. Note that examples are sprinkled over the whole manual, and this
		3414	section only contains stuff that wouldn't fit anywhere else.
		3415
		3416	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
		3417
		3418	Each watcher has, by default, a C<void *data> member that you can read
		3419	or modify at any time: libev will completely ignore it. This can be used
		3420	to associate arbitrary data with your watcher. If you need more data and
		3421	don't want to allocate memory separately and store a pointer to it in that
		3422	data member, you can also "subclass" the watcher type and provide your own
		3423	data:
		3424
		3425	struct my_io
		3426	{
		3427	ev_io io;
		3428	int otherfd;
		3429	void *somedata;
		3430	struct whatever *mostinteresting;
		3431	};
		3432
		3433	...
		3434	struct my_io w;
		3435	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3436
		3437	And since your callback will be called with a pointer to the watcher, you
		3438	can cast it back to your own type:
		3439
		3440	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
		3441	{
		3442	struct my_io *w = (struct my_io *)w_;
		3443	...
		3444	}
		3445
		3446	More interesting and less C-conformant ways of casting your callback
		3447	function type instead have been omitted.
		3448
		3449	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3450
		3451	Another common scenario is to use some data structure with multiple
		3452	embedded watchers, in effect creating your own watcher that combines
		3453	multiple libev event sources into one "super-watcher":
		3454
		3455	struct my_biggy
		3456	{
		3457	int some_data;
		3458	ev_timer t1;
		3459	ev_timer t2;
		3460	}
		3461
		3462	In this case getting the pointer to C<my_biggy> is a bit more
		3463	complicated: Either you store the address of your C<my_biggy> struct in
		3464	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3465	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3466	real programmers):
		3467
		3468	#include <stddef.h>
		3469
		3470	static void
		3471	t1_cb (EV_P_ ev_timer *w, int revents)
		3472	{
		3473	struct my_biggy big = (struct my_biggy *)
		3474	(((char *)w) - offsetof (struct my_biggy, t1));
		3475	}
		3476
		3477	static void
		3478	t2_cb (EV_P_ ev_timer *w, int revents)
		3479	{
		3480	struct my_biggy big = (struct my_biggy *)
		3481	(((char *)w) - offsetof (struct my_biggy, t2));
		3482	}
		3483
		3484	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
		3485
		3486	Often (especially in GUI toolkits) there are places where you have
		3487	I<modal> interaction, which is most easily implemented by recursively
		3488	invoking C<ev_run>.
		3489
		3490	This brings the problem of exiting - a callback might want to finish the
		3491	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
		3492	a modal "Are you sure?" dialog is still waiting), or just the nested one
		3493	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
		3494	other combination: In these cases, C<ev_break> will not work alone.
		3495
		3496	The solution is to maintain "break this loop" variable for each C<ev_run>
		3497	invocation, and use a loop around C<ev_run> until the condition is
		3498	triggered, using C<EVRUN_ONCE>:
		3499
		3500	// main loop
		3501	int exit_main_loop = 0;
		3502
		3503	while (!exit_main_loop)
		3504	ev_run (EV_DEFAULT_ EVRUN_ONCE);
		3505
		3506	// in a model watcher
		3507	int exit_nested_loop = 0;
		3508
		3509	while (!exit_nested_loop)
		3510	ev_run (EV_A_ EVRUN_ONCE);
		3511
		3512	To exit from any of these loops, just set the corresponding exit variable:
		3513
		3514	// exit modal loop
		3515	exit_nested_loop = 1;
		3516
		3517	// exit main program, after modal loop is finished
		3518	exit_main_loop = 1;
		3519
		3520	// exit both
		3521	exit_main_loop = exit_nested_loop = 1;
		3522
		3523	=head2 THREAD LOCKING EXAMPLE
		3524
		3525	Here is a fictitious example of how to run an event loop in a different
		3526	thread from where callbacks are being invoked and watchers are
		3527	created/added/removed.
		3528
		3529	For a real-world example, see the C<EV::Loop::Async> perl module,
		3530	which uses exactly this technique (which is suited for many high-level
		3531	languages).
		3532
		3533	The example uses a pthread mutex to protect the loop data, a condition
		3534	variable to wait for callback invocations, an async watcher to notify the
		3535	event loop thread and an unspecified mechanism to wake up the main thread.
		3536
		3537	First, you need to associate some data with the event loop:
		3538
		3539	typedef struct {
		3540	mutex_t lock; /* global loop lock */
		3541	ev_async async_w;
		3542	thread_t tid;
		3543	cond_t invoke_cv;
		3544	} userdata;
		3545
		3546	void prepare_loop (EV_P)
		3547	{
		3548	// for simplicity, we use a static userdata struct.
		3549	static userdata u;
		3550
		3551	ev_async_init (&u->async_w, async_cb);
		3552	ev_async_start (EV_A_ &u->async_w);
		3553
		3554	pthread_mutex_init (&u->lock, 0);
		3555	pthread_cond_init (&u->invoke_cv, 0);
		3556
		3557	// now associate this with the loop
		3558	ev_set_userdata (EV_A_ u);
		3559	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3560	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3561
		3562	// then create the thread running ev_run
		3563	pthread_create (&u->tid, 0, l_run, EV_A);
		3564	}
		3565
		3566	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3567	solely to wake up the event loop so it takes notice of any new watchers
		3568	that might have been added:
		3569
		3570	static void
		3571	async_cb (EV_P_ ev_async *w, int revents)
		3572	{
		3573	// just used for the side effects
		3574	}
		3575
		3576	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3577	protecting the loop data, respectively.
		3578
		3579	static void
		3580	l_release (EV_P)
		3581	{
		3582	userdata *u = ev_userdata (EV_A);
		3583	pthread_mutex_unlock (&u->lock);
		3584	}
		3585
		3586	static void
		3587	l_acquire (EV_P)
		3588	{
		3589	userdata *u = ev_userdata (EV_A);
		3590	pthread_mutex_lock (&u->lock);
		3591	}
		3592
		3593	The event loop thread first acquires the mutex, and then jumps straight
		3594	into C<ev_run>:
		3595
		3596	void *
		3597	l_run (void *thr_arg)
		3598	{
		3599	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		3600
		3601	l_acquire (EV_A);
		3602	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3603	ev_run (EV_A_ 0);
		3604	l_release (EV_A);
		3605
		3606	return 0;
		3607	}
		3608
		3609	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3610	signal the main thread via some unspecified mechanism (signals? pipe
		3611	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3612	have been called (in a while loop because a) spurious wakeups are possible
		3613	and b) skipping inter-thread-communication when there are no pending
		3614	watchers is very beneficial):
		3615
		3616	static void
		3617	l_invoke (EV_P)
		3618	{
		3619	userdata *u = ev_userdata (EV_A);
		3620
		3621	while (ev_pending_count (EV_A))
		3622	{
		3623	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3624	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3625	}
		3626	}
		3627
		3628	Now, whenever the main thread gets told to invoke pending watchers, it
		3629	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3630	thread to continue:
		3631
		3632	static void
		3633	real_invoke_pending (EV_P)
		3634	{
		3635	userdata *u = ev_userdata (EV_A);
		3636
		3637	pthread_mutex_lock (&u->lock);
		3638	ev_invoke_pending (EV_A);
		3639	pthread_cond_signal (&u->invoke_cv);
		3640	pthread_mutex_unlock (&u->lock);
		3641	}
		3642
		3643	Whenever you want to start/stop a watcher or do other modifications to an
		3644	event loop, you will now have to lock:
		3645
		3646	ev_timer timeout_watcher;
		3647	userdata *u = ev_userdata (EV_A);
		3648
		3649	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3650
		3651	pthread_mutex_lock (&u->lock);
		3652	ev_timer_start (EV_A_ &timeout_watcher);
		3653	ev_async_send (EV_A_ &u->async_w);
		3654	pthread_mutex_unlock (&u->lock);
		3655
		3656	Note that sending the C<ev_async> watcher is required because otherwise
		3657	an event loop currently blocking in the kernel will have no knowledge
		3658	about the newly added timer. By waking up the loop it will pick up any new
		3659	watchers in the next event loop iteration.
		3660
		3661	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3662
		3663	While the overhead of a callback that e.g. schedules a thread is small, it
		3664	is still an overhead. If you embed libev, and your main usage is with some
		3665	kind of threads or coroutines, you might want to customise libev so that
		3666	doesn't need callbacks anymore.
		3667
		3668	Imagine you have coroutines that you can switch to using a function
		3669	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3670	and that due to some magic, the currently active coroutine is stored in a
		3671	global called C<current_coro>. Then you can build your own "wait for libev
		3672	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3673	the differing C<;> conventions):
		3674
		3675	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3676	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3677
		3678	That means instead of having a C callback function, you store the
		3679	coroutine to switch to in each watcher, and instead of having libev call
		3680	your callback, you instead have it switch to that coroutine.
		3681
		3682	A coroutine might now wait for an event with a function called
		3683	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		3684	matter when, or whether the watcher is active or not when this function is
		3685	called):
		3686
		3687	void
		3688	wait_for_event (ev_watcher *w)
		3689	{
		3690	ev_cb_set (w) = current_coro;
		3691	switch_to (libev_coro);
		3692	}
		3693
		3694	That basically suspends the coroutine inside C<wait_for_event> and
		3695	continues the libev coroutine, which, when appropriate, switches back to
		3696	this or any other coroutine. I am sure if you sue this your own :)
		3697
		3698	You can do similar tricks if you have, say, threads with an event queue -
		3699	instead of storing a coroutine, you store the queue object and instead of
		3700	switching to a coroutine, you push the watcher onto the queue and notify
		3701	any waiters.
		3702
		3703	To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two
		3704	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		3705
		3706	// my_ev.h
		3707	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3708	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
		3709	#include "../libev/ev.h"
		3710
		3711	// my_ev.c
		3712	#define EV_H "my_ev.h"
		3713	#include "../libev/ev.c"
		3714
		3715	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		3716	F<my_ev.c> into your project. When properly specifying include paths, you
		3717	can even use F<ev.h> as header file name directly.
3145		3718
3146		3719
3147	=head1 LIBEVENT EMULATION	3720	=head1 LIBEVENT EMULATION
3148		3721
3149	Libev offers a compatibility emulation layer for libevent. It cannot	3722	Libev offers a compatibility emulation layer for libevent. It cannot
3150	emulate the internals of libevent, so here are some usage hints:	3723	emulate the internals of libevent, so here are some usage hints:
3151		3724
3152	=over 4	3725	=over 4
		3726
		3727	=item * Only the libevent-1.4.1-beta API is being emulated.
		3728
		3729	This was the newest libevent version available when libev was implemented,
		3730	and is still mostly unchanged in 2010.
3153		3731
3154	=item * Use it by including <event.h>, as usual.	3732	=item * Use it by including <event.h>, as usual.
3155		3733
3156	=item * The following members are fully supported: ev_base, ev_callback,	3734	=item * The following members are fully supported: ev_base, ev_callback,
3157	ev_arg, ev_fd, ev_res, ev_events.	3735	ev_arg, ev_fd, ev_res, ev_events.
…		…
3163	=item * Priorities are not currently supported. Initialising priorities	3741	=item * Priorities are not currently supported. Initialising priorities
3164	will fail and all watchers will have the same priority, even though there	3742	will fail and all watchers will have the same priority, even though there
3165	is an ev_pri field.	3743	is an ev_pri field.
3166		3744
3167	=item * In libevent, the last base created gets the signals, in libev, the	3745	=item * In libevent, the last base created gets the signals, in libev, the
3168	first base created (== the default loop) gets the signals.	3746	base that registered the signal gets the signals.
3169		3747
3170	=item * Other members are not supported.	3748	=item * Other members are not supported.
3171		3749
3172	=item * The libev emulation is I<not> ABI compatible to libevent, you need	3750	=item * The libev emulation is I<not> ABI compatible to libevent, you need
3173	to use the libev header file and library.	3751	to use the libev header file and library.
…		…
3192	Care has been taken to keep the overhead low. The only data member the C++	3770	Care has been taken to keep the overhead low. The only data member the C++
3193	classes add (compared to plain C-style watchers) is the event loop pointer	3771	classes add (compared to plain C-style watchers) is the event loop pointer
3194	that the watcher is associated with (or no additional members at all if	3772	that the watcher is associated with (or no additional members at all if
3195	you disable C<EV_MULTIPLICITY> when embedding libev).	3773	you disable C<EV_MULTIPLICITY> when embedding libev).
3196		3774
3197	Currently, functions, and static and non-static member functions can be	3775	Currently, functions, static and non-static member functions and classes
3198	used as callbacks. Other types should be easy to add as long as they only	3776	with C<operator ()> can be used as callbacks. Other types should be easy
3199	need one additional pointer for context. If you need support for other	3777	to add as long as they only need one additional pointer for context. If
3200	types of functors please contact the author (preferably after implementing	3778	you need support for other types of functors please contact the author
3201	it).	3779	(preferably after implementing it).
3202		3780
3203	Here is a list of things available in the C<ev> namespace:	3781	Here is a list of things available in the C<ev> namespace:
3204		3782
3205	=over 4	3783	=over 4
3206		3784
…		…
3224		3802
3225	=over 4	3803	=over 4
3226		3804
3227	=item ev::TYPE::TYPE ()	3805	=item ev::TYPE::TYPE ()
3228		3806
3229	=item ev::TYPE::TYPE (struct ev_loop *)	3807	=item ev::TYPE::TYPE (loop)
3230		3808
3231	=item ev::TYPE::~TYPE	3809	=item ev::TYPE::~TYPE
3232		3810
3233	The constructor (optionally) takes an event loop to associate the watcher	3811	The constructor (optionally) takes an event loop to associate the watcher
3234	with. If it is omitted, it will use C<EV_DEFAULT>.	3812	with. If it is omitted, it will use C<EV_DEFAULT>.
…		…
3267	myclass obj;	3845	myclass obj;
3268	ev::io iow;	3846	ev::io iow;
3269	iow.set <myclass, &myclass::io_cb> (&obj);	3847	iow.set <myclass, &myclass::io_cb> (&obj);
3270		3848
3271	=item w->set (object *)	3849	=item w->set (object *)
3272
3273	This is an B<experimental> feature that might go away in a future version.
3274		3850
3275	This is a variation of a method callback - leaving out the method to call	3851	This is a variation of a method callback - leaving out the method to call
3276	will default the method to C<operator ()>, which makes it possible to use	3852	will default the method to C<operator ()>, which makes it possible to use
3277	functor objects without having to manually specify the C<operator ()> all	3853	functor objects without having to manually specify the C<operator ()> all
3278	the time. Incidentally, you can then also leave out the template argument	3854	the time. Incidentally, you can then also leave out the template argument
…		…
3311	Example: Use a plain function as callback.	3887	Example: Use a plain function as callback.
3312		3888
3313	static void io_cb (ev::io &w, int revents) { }	3889	static void io_cb (ev::io &w, int revents) { }
3314	iow.set <io_cb> ();	3890	iow.set <io_cb> ();
3315		3891
3316	=item w->set (struct ev_loop *)	3892	=item w->set (loop)
3317		3893
3318	Associates a different C<struct ev_loop> with this watcher. You can only	3894	Associates a different C<struct ev_loop> with this watcher. You can only
3319	do this when the watcher is inactive (and not pending either).	3895	do this when the watcher is inactive (and not pending either).
3320		3896
3321	=item w->set ([arguments])	3897	=item w->set ([arguments])
3322		3898
3323	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be	3899	Basically the same as C<ev_TYPE_set>, with the same arguments. Either this
3324	called at least once. Unlike the C counterpart, an active watcher gets	3900	method or a suitable start method must be called at least once. Unlike the
3325	automatically stopped and restarted when reconfiguring it with this	3901	C counterpart, an active watcher gets automatically stopped and restarted
3326	method.	3902	when reconfiguring it with this method.
3327		3903
3328	=item w->start ()	3904	=item w->start ()
3329		3905
3330	Starts the watcher. Note that there is no C<loop> argument, as the	3906	Starts the watcher. Note that there is no C<loop> argument, as the
3331	constructor already stores the event loop.	3907	constructor already stores the event loop.
3332		3908
		3909	=item w->start ([arguments])
		3910
		3911	Instead of calling C<set> and C<start> methods separately, it is often
		3912	convenient to wrap them in one call. Uses the same type of arguments as
		3913	the configure C<set> method of the watcher.
		3914
3333	=item w->stop ()	3915	=item w->stop ()
3334		3916
3335	Stops the watcher if it is active. Again, no C<loop> argument.	3917	Stops the watcher if it is active. Again, no C<loop> argument.
3336		3918
3337	=item w->again () (C<ev::timer>, C<ev::periodic> only)	3919	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
3349		3931
3350	=back	3932	=back
3351		3933
3352	=back	3934	=back
3353		3935
3354	Example: Define a class with an IO and idle watcher, start one of them in	3936	Example: Define a class with two I/O and idle watchers, start the I/O
3355	the constructor.	3937	watchers in the constructor.
3356		3938
3357	class myclass	3939	class myclass
3358	{	3940	{
3359	ev::io io ; void io_cb (ev::io &w, int revents);	3941	ev::io io ; void io_cb (ev::io &w, int revents);
		3942	ev::io2 io2 ; void io2_cb (ev::io &w, int revents);
3360	ev::idle idle; void idle_cb (ev::idle &w, int revents);	3943	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3361		3944
3362	myclass (int fd)	3945	myclass (int fd)
3363	{	3946	{
3364	io .set <myclass, &myclass::io_cb > (this);	3947	io .set <myclass, &myclass::io_cb > (this);
		3948	io2 .set <myclass, &myclass::io2_cb > (this);
3365	idle.set <myclass, &myclass::idle_cb> (this);	3949	idle.set <myclass, &myclass::idle_cb> (this);
3366		3950
3367	io.start (fd, ev::READ);	3951	io.set (fd, ev::WRITE); // configure the watcher
		3952	io.start (); // start it whenever convenient
		3953
		3954	io2.start (fd, ev::READ); // set + start in one call
3368	}	3955	}
3369	};	3956	};
3370		3957
3371		3958
3372	=head1 OTHER LANGUAGE BINDINGS	3959	=head1 OTHER LANGUAGE BINDINGS
…		…
3420	Erkki Seppala has written Ocaml bindings for libev, to be found at	4007	Erkki Seppala has written Ocaml bindings for libev, to be found at
3421	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	4008	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3422		4009
3423	=item Lua	4010	=item Lua
3424		4011
3425	Brian Maher has written a partial interface to libev	4012	Brian Maher has written a partial interface to libev for lua (at the
3426	for lua (only C<ev_io> and C<ev_timer>), to be found at	4013	time of this writing, only C<ev_io> and C<ev_timer>), to be found at
3427	L<http://github.com/brimworks/lua-ev>.	4014	L<http://github.com/brimworks/lua-ev>.
3428		4015
3429	=back	4016	=back
3430		4017
3431		4018
…		…
3446	loop argument"). The C<EV_A> form is used when this is the sole argument,	4033	loop argument"). The C<EV_A> form is used when this is the sole argument,
3447	C<EV_A_> is used when other arguments are following. Example:	4034	C<EV_A_> is used when other arguments are following. Example:
3448		4035
3449	ev_unref (EV_A);	4036	ev_unref (EV_A);
3450	ev_timer_add (EV_A_ watcher);	4037	ev_timer_add (EV_A_ watcher);
3451	ev_loop (EV_A_ 0);	4038	ev_run (EV_A_ 0);
3452		4039
3453	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	4040	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
3454	which is often provided by the following macro.	4041	which is often provided by the following macro.
3455		4042
3456	=item C<EV_P>, C<EV_P_>	4043	=item C<EV_P>, C<EV_P_>
…		…
3496	}	4083	}
3497		4084
3498	ev_check check;	4085	ev_check check;
3499	ev_check_init (&check, check_cb);	4086	ev_check_init (&check, check_cb);
3500	ev_check_start (EV_DEFAULT_ &check);	4087	ev_check_start (EV_DEFAULT_ &check);
3501	ev_loop (EV_DEFAULT_ 0);	4088	ev_run (EV_DEFAULT_ 0);
3502		4089
3503	=head1 EMBEDDING	4090	=head1 EMBEDDING
3504		4091
3505	Libev can (and often is) directly embedded into host	4092	Libev can (and often is) directly embedded into host
3506	applications. Examples of applications that embed it include the Deliantra	4093	applications. Examples of applications that embed it include the Deliantra
…		…
3586	libev.m4	4173	libev.m4
3587		4174
3588	=head2 PREPROCESSOR SYMBOLS/MACROS	4175	=head2 PREPROCESSOR SYMBOLS/MACROS
3589		4176
3590	Libev can be configured via a variety of preprocessor symbols you have to	4177	Libev can be configured via a variety of preprocessor symbols you have to
3591	define before including any of its files. The default in the absence of	4178	define before including (or compiling) any of its files. The default in
3592	autoconf is documented for every option.	4179	the absence of autoconf is documented for every option.
		4180
		4181	Symbols marked with "(h)" do not change the ABI, and can have different
		4182	values when compiling libev vs. including F<ev.h>, so it is permissible
		4183	to redefine them before including F<ev.h> without breaking compatibility
		4184	to a compiled library. All other symbols change the ABI, which means all
		4185	users of libev and the libev code itself must be compiled with compatible
		4186	settings.
3593		4187
3594	=over 4	4188	=over 4
3595		4189
		4190	=item EV_COMPAT3 (h)
		4191
		4192	Backwards compatibility is a major concern for libev. This is why this
		4193	release of libev comes with wrappers for the functions and symbols that
		4194	have been renamed between libev version 3 and 4.
		4195
		4196	You can disable these wrappers (to test compatibility with future
		4197	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		4198	sources. This has the additional advantage that you can drop the C<struct>
		4199	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		4200	typedef in that case.
		4201
		4202	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		4203	and in some even more future version the compatibility code will be
		4204	removed completely.
		4205
3596	=item EV_STANDALONE	4206	=item EV_STANDALONE (h)
3597		4207
3598	Must always be C<1> if you do not use autoconf configuration, which	4208	Must always be C<1> if you do not use autoconf configuration, which
3599	keeps libev from including F<config.h>, and it also defines dummy	4209	keeps libev from including F<config.h>, and it also defines dummy
3600	implementations for some libevent functions (such as logging, which is not	4210	implementations for some libevent functions (such as logging, which is not
3601	supported). It will also not define any of the structs usually found in	4211	supported). It will also not define any of the structs usually found in
3602	F<event.h> that are not directly supported by the libev core alone.	4212	F<event.h> that are not directly supported by the libev core alone.
3603		4213
3604	In standalone mode, libev will still try to automatically deduce the	4214	In standalone mode, libev will still try to automatically deduce the
3605	configuration, but has to be more conservative.	4215	configuration, but has to be more conservative.
		4216
		4217	=item EV_USE_FLOOR
		4218
		4219	If defined to be C<1>, libev will use the C<floor ()> function for its
		4220	periodic reschedule calculations, otherwise libev will fall back on a
		4221	portable (slower) implementation. If you enable this, you usually have to
		4222	link against libm or something equivalent. Enabling this when the C<floor>
		4223	function is not available will fail, so the safe default is to not enable
		4224	this.
3606		4225
3607	=item EV_USE_MONOTONIC	4226	=item EV_USE_MONOTONIC
3608		4227
3609	If defined to be C<1>, libev will try to detect the availability of the	4228	If defined to be C<1>, libev will try to detect the availability of the
3610	monotonic clock option at both compile time and runtime. Otherwise no	4229	monotonic clock option at both compile time and runtime. Otherwise no
…		…
3751	as well as for signal and thread safety in C<ev_async> watchers.	4370	as well as for signal and thread safety in C<ev_async> watchers.
3752		4371
3753	In the absence of this define, libev will use C<sig_atomic_t volatile>	4372	In the absence of this define, libev will use C<sig_atomic_t volatile>
3754	(from F<signal.h>), which is usually good enough on most platforms.	4373	(from F<signal.h>), which is usually good enough on most platforms.
3755		4374
3756	=item EV_H	4375	=item EV_H (h)
3757		4376
3758	The name of the F<ev.h> header file used to include it. The default if	4377	The name of the F<ev.h> header file used to include it. The default if
3759	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be	4378	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
3760	used to virtually rename the F<ev.h> header file in case of conflicts.	4379	used to virtually rename the F<ev.h> header file in case of conflicts.
3761		4380
3762	=item EV_CONFIG_H	4381	=item EV_CONFIG_H (h)
3763		4382
3764	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	4383	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
3765	F<ev.c>'s idea of where to find the F<config.h> file, similarly to	4384	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
3766	C<EV_H>, above.	4385	C<EV_H>, above.
3767		4386
3768	=item EV_EVENT_H	4387	=item EV_EVENT_H (h)
3769		4388
3770	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	4389	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
3771	of how the F<event.h> header can be found, the default is C<"event.h">.	4390	of how the F<event.h> header can be found, the default is C<"event.h">.
3772		4391
3773	=item EV_PROTOTYPES	4392	=item EV_PROTOTYPES (h)
3774		4393
3775	If defined to be C<0>, then F<ev.h> will not define any function	4394	If defined to be C<0>, then F<ev.h> will not define any function
3776	prototypes, but still define all the structs and other symbols. This is	4395	prototypes, but still define all the structs and other symbols. This is
3777	occasionally useful if you want to provide your own wrapper functions	4396	occasionally useful if you want to provide your own wrapper functions
3778	around libev functions.	4397	around libev functions.
…		…
3800	fine.	4419	fine.
3801		4420
3802	If your embedding application does not need any priorities, defining these	4421	If your embedding application does not need any priorities, defining these
3803	both to C<0> will save some memory and CPU.	4422	both to C<0> will save some memory and CPU.
3804		4423
3805	=item EV_PERIODIC_ENABLE	4424	=item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE,
		4425	EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
		4426	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3806		4427
3807	If undefined or defined to be C<1>, then periodic timers are supported. If	4428	If undefined or defined to be C<1> (and the platform supports it), then
3808	defined to be C<0>, then they are not. Disabling them saves a few kB of	4429	the respective watcher type is supported. If defined to be C<0>, then it
3809	code.	4430	is not. Disabling watcher types mainly saves code size.
3810		4431
3811	=item EV_IDLE_ENABLE	4432	=item EV_FEATURES
3812
3813	If undefined or defined to be C<1>, then idle watchers are supported. If
3814	defined to be C<0>, then they are not. Disabling them saves a few kB of
3815	code.
3816
3817	=item EV_EMBED_ENABLE
3818
3819	If undefined or defined to be C<1>, then embed watchers are supported. If
3820	defined to be C<0>, then they are not. Embed watchers rely on most other
3821	watcher types, which therefore must not be disabled.
3822
3823	=item EV_STAT_ENABLE
3824
3825	If undefined or defined to be C<1>, then stat watchers are supported. If
3826	defined to be C<0>, then they are not.
3827
3828	=item EV_FORK_ENABLE
3829
3830	If undefined or defined to be C<1>, then fork watchers are supported. If
3831	defined to be C<0>, then they are not.
3832
3833	=item EV_ASYNC_ENABLE
3834
3835	If undefined or defined to be C<1>, then async watchers are supported. If
3836	defined to be C<0>, then they are not.
3837
3838	=item EV_MINIMAL
3839		4433
3840	If you need to shave off some kilobytes of code at the expense of some	4434	If you need to shave off some kilobytes of code at the expense of some
3841	speed (but with the full API), define this symbol to C<1>. Currently this	4435	speed (but with the full API), you can define this symbol to request
3842	is used to override some inlining decisions, saves roughly 30% code size	4436	certain subsets of functionality. The default is to enable all features
3843	on amd64. It also selects a much smaller 2-heap for timer management over	4437	that can be enabled on the platform.
3844	the default 4-heap.
3845		4438
3846	You can save even more by disabling watcher types you do not need	4439	A typical way to use this symbol is to define it to C<0> (or to a bitset
3847	and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>	4440	with some broad features you want) and then selectively re-enable
3848	(C<-DNDEBUG>) will usually reduce code size a lot.	4441	additional parts you want, for example if you want everything minimal,
		4442	but multiple event loop support, async and child watchers and the poll
		4443	backend, use this:
3849		4444
3850	Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to	4445	#define EV_FEATURES 0
3851	provide a bare-bones event library. See C<ev.h> for details on what parts	4446	#define EV_MULTIPLICITY 1
3852	of the API are still available, and do not complain if this subset changes	4447	#define EV_USE_POLL 1
3853	over time.	4448	#define EV_CHILD_ENABLE 1
		4449	#define EV_ASYNC_ENABLE 1
		4450
		4451	The actual value is a bitset, it can be a combination of the following
		4452	values:
		4453
		4454	=over 4
		4455
		4456	=item C<1> - faster/larger code
		4457
		4458	Use larger code to speed up some operations.
		4459
		4460	Currently this is used to override some inlining decisions (enlarging the
		4461	code size by roughly 30% on amd64).
		4462
		4463	When optimising for size, use of compiler flags such as C<-Os> with
		4464	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
		4465	assertions.
		4466
		4467	=item C<2> - faster/larger data structures
		4468
		4469	Replaces the small 2-heap for timer management by a faster 4-heap, larger
		4470	hash table sizes and so on. This will usually further increase code size
		4471	and can additionally have an effect on the size of data structures at
		4472	runtime.
		4473
		4474	=item C<4> - full API configuration
		4475
		4476	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
		4477	enables multiplicity (C<EV_MULTIPLICITY>=1).
		4478
		4479	=item C<8> - full API
		4480
		4481	This enables a lot of the "lesser used" API functions. See C<ev.h> for
		4482	details on which parts of the API are still available without this
		4483	feature, and do not complain if this subset changes over time.
		4484
		4485	=item C<16> - enable all optional watcher types
		4486
		4487	Enables all optional watcher types. If you want to selectively enable
		4488	only some watcher types other than I/O and timers (e.g. prepare,
		4489	embed, async, child...) you can enable them manually by defining
		4490	C<EV_watchertype_ENABLE> to C<1> instead.
		4491
		4492	=item C<32> - enable all backends
		4493
		4494	This enables all backends - without this feature, you need to enable at
		4495	least one backend manually (C<EV_USE_SELECT> is a good choice).
		4496
		4497	=item C<64> - enable OS-specific "helper" APIs
		4498
		4499	Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
		4500	default.
		4501
		4502	=back
		4503
		4504	Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
		4505	reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
		4506	code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
		4507	watchers, timers and monotonic clock support.
		4508
		4509	With an intelligent-enough linker (gcc+binutils are intelligent enough
		4510	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
		4511	your program might be left out as well - a binary starting a timer and an
		4512	I/O watcher then might come out at only 5Kb.
		4513
		4514	=item EV_AVOID_STDIO
		4515
		4516	If this is set to C<1> at compiletime, then libev will avoid using stdio
		4517	functions (printf, scanf, perror etc.). This will increase the code size
		4518	somewhat, but if your program doesn't otherwise depend on stdio and your
		4519	libc allows it, this avoids linking in the stdio library which is quite
		4520	big.
		4521
		4522	Note that error messages might become less precise when this option is
		4523	enabled.
3854		4524
3855	=item EV_NSIG	4525	=item EV_NSIG
3856		4526
3857	The highest supported signal number, +1 (or, the number of	4527	The highest supported signal number, +1 (or, the number of
3858	signals): Normally, libev tries to deduce the maximum number of signals	4528	signals): Normally, libev tries to deduce the maximum number of signals
3859	automatically, but sometimes this fails, in which case it can be	4529	automatically, but sometimes this fails, in which case it can be
3860	specified. Also, using a lower number than detected (C<32> should be	4530	specified. Also, using a lower number than detected (C<32> should be
3861	good for about any system in existance) can save some memory, as libev	4531	good for about any system in existence) can save some memory, as libev
3862	statically allocates some 12-24 bytes per signal number.	4532	statically allocates some 12-24 bytes per signal number.
3863		4533
3864	=item EV_PID_HASHSIZE	4534	=item EV_PID_HASHSIZE
3865		4535
3866	C<ev_child> watchers use a small hash table to distribute workload by	4536	C<ev_child> watchers use a small hash table to distribute workload by
3867	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	4537	pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled),
3868	than enough. If you need to manage thousands of children you might want to	4538	usually more than enough. If you need to manage thousands of children you
3869	increase this value (I<must> be a power of two).	4539	might want to increase this value (I<must> be a power of two).
3870		4540
3871	=item EV_INOTIFY_HASHSIZE	4541	=item EV_INOTIFY_HASHSIZE
3872		4542
3873	C<ev_stat> watchers use a small hash table to distribute workload by	4543	C<ev_stat> watchers use a small hash table to distribute workload by
3874	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	4544	inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES>
3875	usually more than enough. If you need to manage thousands of C<ev_stat>	4545	disabled), usually more than enough. If you need to manage thousands of
3876	watchers you might want to increase this value (I<must> be a power of	4546	C<ev_stat> watchers you might want to increase this value (I<must> be a
3877	two).	4547	power of two).
3878		4548
3879	=item EV_USE_4HEAP	4549	=item EV_USE_4HEAP
3880		4550
3881	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4551	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3882	timer and periodics heaps, libev uses a 4-heap when this symbol is defined	4552	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3883	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably	4553	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3884	faster performance with many (thousands) of watchers.	4554	faster performance with many (thousands) of watchers.
3885		4555
3886	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4556	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3887	(disabled).	4557	will be C<0>.
3888		4558
3889	=item EV_HEAP_CACHE_AT	4559	=item EV_HEAP_CACHE_AT
3890		4560
3891	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4561	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3892	timer and periodics heaps, libev can cache the timestamp (I<at>) within	4562	timer and periodics heaps, libev can cache the timestamp (I<at>) within
3893	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),	4563	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3894	which uses 8-12 bytes more per watcher and a few hundred bytes more code,	4564	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3895	but avoids random read accesses on heap changes. This improves performance	4565	but avoids random read accesses on heap changes. This improves performance
3896	noticeably with many (hundreds) of watchers.	4566	noticeably with many (hundreds) of watchers.
3897		4567
3898	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4568	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3899	(disabled).	4569	will be C<0>.
3900		4570
3901	=item EV_VERIFY	4571	=item EV_VERIFY
3902		4572
3903	Controls how much internal verification (see C<ev_loop_verify ()>) will	4573	Controls how much internal verification (see C<ev_verify ()>) will
3904	be done: If set to C<0>, no internal verification code will be compiled	4574	be done: If set to C<0>, no internal verification code will be compiled
3905	in. If set to C<1>, then verification code will be compiled in, but not	4575	in. If set to C<1>, then verification code will be compiled in, but not
3906	called. If set to C<2>, then the internal verification code will be	4576	called. If set to C<2>, then the internal verification code will be
3907	called once per loop, which can slow down libev. If set to C<3>, then the	4577	called once per loop, which can slow down libev. If set to C<3>, then the
3908	verification code will be called very frequently, which will slow down	4578	verification code will be called very frequently, which will slow down
3909	libev considerably.	4579	libev considerably.
3910		4580
3911	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be	4581	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3912	C<0>.	4582	will be C<0>.
3913		4583
3914	=item EV_COMMON	4584	=item EV_COMMON
3915		4585
3916	By default, all watchers have a C<void *data> member. By redefining	4586	By default, all watchers have a C<void *data> member. By redefining
3917	this macro to a something else you can include more and other types of	4587	this macro to something else you can include more and other types of
3918	members. You have to define it each time you include one of the files,	4588	members. You have to define it each time you include one of the files,
3919	though, and it must be identical each time.	4589	though, and it must be identical each time.
3920		4590
3921	For example, the perl EV module uses something like this:	4591	For example, the perl EV module uses something like this:
3922		4592
…		…
3975	file.	4645	file.
3976		4646
3977	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	4647	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3978	that everybody includes and which overrides some configure choices:	4648	that everybody includes and which overrides some configure choices:
3979		4649
3980	#define EV_MINIMAL 1	4650	#define EV_FEATURES 8
3981	#define EV_USE_POLL 0	4651	#define EV_USE_SELECT 1
3982	#define EV_MULTIPLICITY 0
3983	#define EV_PERIODIC_ENABLE 0	4652	#define EV_PREPARE_ENABLE 1
		4653	#define EV_IDLE_ENABLE 1
3984	#define EV_STAT_ENABLE 0	4654	#define EV_SIGNAL_ENABLE 1
3985	#define EV_FORK_ENABLE 0	4655	#define EV_CHILD_ENABLE 1
		4656	#define EV_USE_STDEXCEPT 0
3986	#define EV_CONFIG_H <config.h>	4657	#define EV_CONFIG_H <config.h>
3987	#define EV_MINPRI 0
3988	#define EV_MAXPRI 0
3989		4658
3990	#include "ev++.h"	4659	#include "ev++.h"
3991		4660
3992	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4661	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3993		4662
3994	#include "ev_cpp.h"	4663	#include "ev_cpp.h"
3995	#include "ev.c"	4664	#include "ev.c"
3996		4665
3997	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	4666	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
3998		4667
3999	=head2 THREADS AND COROUTINES	4668	=head2 THREADS AND COROUTINES
4000		4669
4001	=head3 THREADS	4670	=head3 THREADS
4002		4671
…		…
4053	default loop and triggering an C<ev_async> watcher from the default loop	4722	default loop and triggering an C<ev_async> watcher from the default loop
4054	watcher callback into the event loop interested in the signal.	4723	watcher callback into the event loop interested in the signal.
4055		4724
4056	=back	4725	=back
4057		4726
4058	=head4 THREAD LOCKING EXAMPLE	4727	See also L<THREAD LOCKING EXAMPLE>.
4059
4060	Here is a fictitious example of how to run an event loop in a different
4061	thread than where callbacks are being invoked and watchers are
4062	created/added/removed.
4063
4064	For a real-world example, see the C<EV::Loop::Async> perl module,
4065	which uses exactly this technique (which is suited for many high-level
4066	languages).
4067
4068	The example uses a pthread mutex to protect the loop data, a condition
4069	variable to wait for callback invocations, an async watcher to notify the
4070	event loop thread and an unspecified mechanism to wake up the main thread.
4071
4072	First, you need to associate some data with the event loop:
4073
4074	typedef struct {
4075	mutex_t lock; /* global loop lock */
4076	ev_async async_w;
4077	thread_t tid;
4078	cond_t invoke_cv;
4079	} userdata;
4080
4081	void prepare_loop (EV_P)
4082	{
4083	// for simplicity, we use a static userdata struct.
4084	static userdata u;
4085
4086	ev_async_init (&u->async_w, async_cb);
4087	ev_async_start (EV_A_ &u->async_w);
4088
4089	pthread_mutex_init (&u->lock, 0);
4090	pthread_cond_init (&u->invoke_cv, 0);
4091
4092	// now associate this with the loop
4093	ev_set_userdata (EV_A_ u);
4094	ev_set_invoke_pending_cb (EV_A_ l_invoke);
4095	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4096
4097	// then create the thread running ev_loop
4098	pthread_create (&u->tid, 0, l_run, EV_A);
4099	}
4100
4101	The callback for the C<ev_async> watcher does nothing: the watcher is used
4102	solely to wake up the event loop so it takes notice of any new watchers
4103	that might have been added:
4104
4105	static void
4106	async_cb (EV_P_ ev_async *w, int revents)
4107	{
4108	// just used for the side effects
4109	}
4110
4111	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4112	protecting the loop data, respectively.
4113
4114	static void
4115	l_release (EV_P)
4116	{
4117	userdata *u = ev_userdata (EV_A);
4118	pthread_mutex_unlock (&u->lock);
4119	}
4120
4121	static void
4122	l_acquire (EV_P)
4123	{
4124	userdata *u = ev_userdata (EV_A);
4125	pthread_mutex_lock (&u->lock);
4126	}
4127
4128	The event loop thread first acquires the mutex, and then jumps straight
4129	into C<ev_loop>:
4130
4131	void *
4132	l_run (void *thr_arg)
4133	{
4134	struct ev_loop *loop = (struct ev_loop *)thr_arg;
4135
4136	l_acquire (EV_A);
4137	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4138	ev_loop (EV_A_ 0);
4139	l_release (EV_A);
4140
4141	return 0;
4142	}
4143
4144	Instead of invoking all pending watchers, the C<l_invoke> callback will
4145	signal the main thread via some unspecified mechanism (signals? pipe
4146	writes? C<Async::Interrupt>?) and then waits until all pending watchers
4147	have been called (in a while loop because a) spurious wakeups are possible
4148	and b) skipping inter-thread-communication when there are no pending
4149	watchers is very beneficial):
4150
4151	static void
4152	l_invoke (EV_P)
4153	{
4154	userdata *u = ev_userdata (EV_A);
4155
4156	while (ev_pending_count (EV_A))
4157	{
4158	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4159	pthread_cond_wait (&u->invoke_cv, &u->lock);
4160	}
4161	}
4162
4163	Now, whenever the main thread gets told to invoke pending watchers, it
4164	will grab the lock, call C<ev_invoke_pending> and then signal the loop
4165	thread to continue:
4166
4167	static void
4168	real_invoke_pending (EV_P)
4169	{
4170	userdata *u = ev_userdata (EV_A);
4171
4172	pthread_mutex_lock (&u->lock);
4173	ev_invoke_pending (EV_A);
4174	pthread_cond_signal (&u->invoke_cv);
4175	pthread_mutex_unlock (&u->lock);
4176	}
4177
4178	Whenever you want to start/stop a watcher or do other modifications to an
4179	event loop, you will now have to lock:
4180
4181	ev_timer timeout_watcher;
4182	userdata *u = ev_userdata (EV_A);
4183
4184	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4185
4186	pthread_mutex_lock (&u->lock);
4187	ev_timer_start (EV_A_ &timeout_watcher);
4188	ev_async_send (EV_A_ &u->async_w);
4189	pthread_mutex_unlock (&u->lock);
4190
4191	Note that sending the C<ev_async> watcher is required because otherwise
4192	an event loop currently blocking in the kernel will have no knowledge
4193	about the newly added timer. By waking up the loop it will pick up any new
4194	watchers in the next event loop iteration.
4195		4728
4196	=head3 COROUTINES	4729	=head3 COROUTINES
4197		4730
4198	Libev is very accommodating to coroutines ("cooperative threads"):	4731	Libev is very accommodating to coroutines ("cooperative threads"):
4199	libev fully supports nesting calls to its functions from different	4732	libev fully supports nesting calls to its functions from different
4200	coroutines (e.g. you can call C<ev_loop> on the same loop from two	4733	coroutines (e.g. you can call C<ev_run> on the same loop from two
4201	different coroutines, and switch freely between both coroutines running	4734	different coroutines, and switch freely between both coroutines running
4202	the loop, as long as you don't confuse yourself). The only exception is	4735	the loop, as long as you don't confuse yourself). The only exception is
4203	that you must not do this from C<ev_periodic> reschedule callbacks.	4736	that you must not do this from C<ev_periodic> reschedule callbacks.
4204		4737
4205	Care has been taken to ensure that libev does not keep local state inside	4738	Care has been taken to ensure that libev does not keep local state inside
4206	C<ev_loop>, and other calls do not usually allow for coroutine switches as	4739	C<ev_run>, and other calls do not usually allow for coroutine switches as
4207	they do not call any callbacks.	4740	they do not call any callbacks.
4208		4741
4209	=head2 COMPILER WARNINGS	4742	=head2 COMPILER WARNINGS
4210		4743
4211	Depending on your compiler and compiler settings, you might get no or a	4744	Depending on your compiler and compiler settings, you might get no or a
…		…
4222	maintainable.	4755	maintainable.
4223		4756
4224	And of course, some compiler warnings are just plain stupid, or simply	4757	And of course, some compiler warnings are just plain stupid, or simply
4225	wrong (because they don't actually warn about the condition their message	4758	wrong (because they don't actually warn about the condition their message
4226	seems to warn about). For example, certain older gcc versions had some	4759	seems to warn about). For example, certain older gcc versions had some
4227	warnings that resulted an extreme number of false positives. These have	4760	warnings that resulted in an extreme number of false positives. These have
4228	been fixed, but some people still insist on making code warn-free with	4761	been fixed, but some people still insist on making code warn-free with
4229	such buggy versions.	4762	such buggy versions.
4230		4763
4231	While libev is written to generate as few warnings as possible,	4764	While libev is written to generate as few warnings as possible,
4232	"warn-free" code is not a goal, and it is recommended not to build libev	4765	"warn-free" code is not a goal, and it is recommended not to build libev
…		…
4268	I suggest using suppression lists.	4801	I suggest using suppression lists.
4269		4802
4270		4803
4271	=head1 PORTABILITY NOTES	4804	=head1 PORTABILITY NOTES
4272		4805
		4806	=head2 GNU/LINUX 32 BIT LIMITATIONS
		4807
		4808	GNU/Linux is the only common platform that supports 64 bit file/large file
		4809	interfaces but I<disables> them by default.
		4810
		4811	That means that libev compiled in the default environment doesn't support
		4812	files larger than 2GiB or so, which mainly affects C<ev_stat> watchers.
		4813
		4814	Unfortunately, many programs try to work around this GNU/Linux issue
		4815	by enabling the large file API, which makes them incompatible with the
		4816	standard libev compiled for their system.
		4817
		4818	Likewise, libev cannot enable the large file API itself as this would
		4819	suddenly make it incompatible to the default compile time environment,
		4820	i.e. all programs not using special compile switches.
		4821
		4822	=head2 OS/X AND DARWIN BUGS
		4823
		4824	The whole thing is a bug if you ask me - basically any system interface
		4825	you touch is broken, whether it is locales, poll, kqueue or even the
		4826	OpenGL drivers.
		4827
		4828	=head3 C<kqueue> is buggy
		4829
		4830	The kqueue syscall is broken in all known versions - most versions support
		4831	only sockets, many support pipes.
		4832
		4833	Libev tries to work around this by not using C<kqueue> by default on this
		4834	rotten platform, but of course you can still ask for it when creating a
		4835	loop - embedding a socket-only kqueue loop into a select-based one is
		4836	probably going to work well.
		4837
		4838	=head3 C<poll> is buggy
		4839
		4840	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
		4841	implementation by something calling C<kqueue> internally around the 10.5.6
		4842	release, so now C<kqueue> I<and> C<poll> are broken.
		4843
		4844	Libev tries to work around this by not using C<poll> by default on
		4845	this rotten platform, but of course you can still ask for it when creating
		4846	a loop.
		4847
		4848	=head3 C<select> is buggy
		4849
		4850	All that's left is C<select>, and of course Apple found a way to fuck this
		4851	one up as well: On OS/X, C<select> actively limits the number of file
		4852	descriptors you can pass in to 1024 - your program suddenly crashes when
		4853	you use more.
		4854
		4855	There is an undocumented "workaround" for this - defining
		4856	C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should>
		4857	work on OS/X.
		4858
		4859	=head2 SOLARIS PROBLEMS AND WORKAROUNDS
		4860
		4861	=head3 C<errno> reentrancy
		4862
		4863	The default compile environment on Solaris is unfortunately so
		4864	thread-unsafe that you can't even use components/libraries compiled
		4865	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
		4866	defined by default. A valid, if stupid, implementation choice.
		4867
		4868	If you want to use libev in threaded environments you have to make sure
		4869	it's compiled with C<_REENTRANT> defined.
		4870
		4871	=head3 Event port backend
		4872
		4873	The scalable event interface for Solaris is called "event
		4874	ports". Unfortunately, this mechanism is very buggy in all major
		4875	releases. If you run into high CPU usage, your program freezes or you get
		4876	a large number of spurious wakeups, make sure you have all the relevant
		4877	and latest kernel patches applied. No, I don't know which ones, but there
		4878	are multiple ones to apply, and afterwards, event ports actually work
		4879	great.
		4880
		4881	If you can't get it to work, you can try running the program by setting
		4882	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
		4883	C<select> backends.
		4884
		4885	=head2 AIX POLL BUG
		4886
		4887	AIX unfortunately has a broken C<poll.h> header. Libev works around
		4888	this by trying to avoid the poll backend altogether (i.e. it's not even
		4889	compiled in), which normally isn't a big problem as C<select> works fine
		4890	with large bitsets on AIX, and AIX is dead anyway.
		4891
4273	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	4892	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
		4893
		4894	=head3 General issues
4274		4895
4275	Win32 doesn't support any of the standards (e.g. POSIX) that libev	4896	Win32 doesn't support any of the standards (e.g. POSIX) that libev
4276	requires, and its I/O model is fundamentally incompatible with the POSIX	4897	requires, and its I/O model is fundamentally incompatible with the POSIX
4277	model. Libev still offers limited functionality on this platform in	4898	model. Libev still offers limited functionality on this platform in
4278	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	4899	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4279	descriptors. This only applies when using Win32 natively, not when using	4900	descriptors. This only applies when using Win32 natively, not when using
4280	e.g. cygwin.	4901	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
		4902	as every compielr comes with a slightly differently broken/incompatible
		4903	environment.
4281		4904
4282	Lifting these limitations would basically require the full	4905	Lifting these limitations would basically require the full
4283	re-implementation of the I/O system. If you are into these kinds of	4906	re-implementation of the I/O system. If you are into this kind of thing,
4284	things, then note that glib does exactly that for you in a very portable	4907	then note that glib does exactly that for you in a very portable way (note
4285	way (note also that glib is the slowest event library known to man).	4908	also that glib is the slowest event library known to man).
4286		4909
4287	There is no supported compilation method available on windows except	4910	There is no supported compilation method available on windows except
4288	embedding it into other applications.	4911	embedding it into other applications.
4289		4912
4290	Sensible signal handling is officially unsupported by Microsoft - libev	4913	Sensible signal handling is officially unsupported by Microsoft - libev
…		…
4318	you do I<not> compile the F<ev.c> or any other embedded source files!):	4941	you do I<not> compile the F<ev.c> or any other embedded source files!):
4319		4942
4320	#include "evwrap.h"	4943	#include "evwrap.h"
4321	#include "ev.c"	4944	#include "ev.c"
4322		4945
4323	=over 4
4324
4325	=item The winsocket select function	4946	=head3 The winsocket C<select> function
4326		4947
4327	The winsocket C<select> function doesn't follow POSIX in that it	4948	The winsocket C<select> function doesn't follow POSIX in that it
4328	requires socket I<handles> and not socket I<file descriptors> (it is	4949	requires socket I<handles> and not socket I<file descriptors> (it is
4329	also extremely buggy). This makes select very inefficient, and also	4950	also extremely buggy). This makes select very inefficient, and also
4330	requires a mapping from file descriptors to socket handles (the Microsoft	4951	requires a mapping from file descriptors to socket handles (the Microsoft
…		…
4339	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	4960	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
4340		4961
4341	Note that winsockets handling of fd sets is O(n), so you can easily get a	4962	Note that winsockets handling of fd sets is O(n), so you can easily get a
4342	complexity in the O(n²) range when using win32.	4963	complexity in the O(n²) range when using win32.
4343		4964
4344	=item Limited number of file descriptors	4965	=head3 Limited number of file descriptors
4345		4966
4346	Windows has numerous arbitrary (and low) limits on things.	4967	Windows has numerous arbitrary (and low) limits on things.
4347		4968
4348	Early versions of winsocket's select only supported waiting for a maximum	4969	Early versions of winsocket's select only supported waiting for a maximum
4349	of C<64> handles (probably owning to the fact that all windows kernels	4970	of C<64> handles (probably owning to the fact that all windows kernels
…		…
4364	runtime libraries. This might get you to about C<512> or C<2048> sockets	4985	runtime libraries. This might get you to about C<512> or C<2048> sockets
4365	(depending on windows version and/or the phase of the moon). To get more,	4986	(depending on windows version and/or the phase of the moon). To get more,
4366	you need to wrap all I/O functions and provide your own fd management, but	4987	you need to wrap all I/O functions and provide your own fd management, but
4367	the cost of calling select (O(n²)) will likely make this unworkable.	4988	the cost of calling select (O(n²)) will likely make this unworkable.
4368		4989
4369	=back
4370
4371	=head2 PORTABILITY REQUIREMENTS	4990	=head2 PORTABILITY REQUIREMENTS
4372		4991
4373	In addition to a working ISO-C implementation and of course the	4992	In addition to a working ISO-C implementation and of course the
4374	backend-specific APIs, libev relies on a few additional extensions:	4993	backend-specific APIs, libev relies on a few additional extensions:
4375		4994
…		…
4381	Libev assumes not only that all watcher pointers have the same internal	5000	Libev assumes not only that all watcher pointers have the same internal
4382	structure (guaranteed by POSIX but not by ISO C for example), but it also	5001	structure (guaranteed by POSIX but not by ISO C for example), but it also
4383	assumes that the same (machine) code can be used to call any watcher	5002	assumes that the same (machine) code can be used to call any watcher
4384	callback: The watcher callbacks have different type signatures, but libev	5003	callback: The watcher callbacks have different type signatures, but libev
4385	calls them using an C<ev_watcher *> internally.	5004	calls them using an C<ev_watcher *> internally.
		5005
		5006	=item pointer accesses must be thread-atomic
		5007
		5008	Accessing a pointer value must be atomic, it must both be readable and
		5009	writable in one piece - this is the case on all current architectures.
4386		5010
4387	=item C<sig_atomic_t volatile> must be thread-atomic as well	5011	=item C<sig_atomic_t volatile> must be thread-atomic as well
4388		5012
4389	The type C<sig_atomic_t volatile> (or whatever is defined as	5013	The type C<sig_atomic_t volatile> (or whatever is defined as
4390	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different	5014	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
…		…
4413	watchers.	5037	watchers.
4414		5038
4415	=item C<double> must hold a time value in seconds with enough accuracy	5039	=item C<double> must hold a time value in seconds with enough accuracy
4416		5040
4417	The type C<double> is used to represent timestamps. It is required to	5041	The type C<double> is used to represent timestamps. It is required to
4418	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	5042	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4419	enough for at least into the year 4000. This requirement is fulfilled by	5043	good enough for at least into the year 4000 with millisecond accuracy
		5044	(the design goal for libev). This requirement is overfulfilled by
4420	implementations implementing IEEE 754, which is basically all existing	5045	implementations using IEEE 754, which is basically all existing ones. With
4421	ones. With IEEE 754 doubles, you get microsecond accuracy until at least	5046	IEEE 754 doubles, you get microsecond accuracy until at least 2200.
4422	2200.
4423		5047
4424	=back	5048	=back
4425		5049
4426	If you know of other additional requirements drop me a note.	5050	If you know of other additional requirements drop me a note.
4427		5051
…		…
4495	involves iterating over all running async watchers or all signal numbers.	5119	involves iterating over all running async watchers or all signal numbers.
4496		5120
4497	=back	5121	=back
4498		5122
4499		5123
		5124	=head1 PORTING FROM LIBEV 3.X TO 4.X
		5125
		5126	The major version 4 introduced some incompatible changes to the API.
		5127
		5128	At the moment, the C<ev.h> header file provides compatibility definitions
		5129	for all changes, so most programs should still compile. The compatibility
		5130	layer might be removed in later versions of libev, so better update to the
		5131	new API early than late.
		5132
		5133	=over 4
		5134
		5135	=item C<EV_COMPAT3> backwards compatibility mechanism
		5136
		5137	The backward compatibility mechanism can be controlled by
		5138	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		5139	section.
		5140
		5141	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		5142
		5143	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		5144
		5145	ev_loop_destroy (EV_DEFAULT_UC);
		5146	ev_loop_fork (EV_DEFAULT);
		5147
		5148	=item function/symbol renames
		5149
		5150	A number of functions and symbols have been renamed:
		5151
		5152	ev_loop => ev_run
		5153	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		5154	EVLOOP_ONESHOT => EVRUN_ONCE
		5155
		5156	ev_unloop => ev_break
		5157	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		5158	EVUNLOOP_ONE => EVBREAK_ONE
		5159	EVUNLOOP_ALL => EVBREAK_ALL
		5160
		5161	EV_TIMEOUT => EV_TIMER
		5162
		5163	ev_loop_count => ev_iteration
		5164	ev_loop_depth => ev_depth
		5165	ev_loop_verify => ev_verify
		5166
		5167	Most functions working on C<struct ev_loop> objects don't have an
		5168	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		5169	associated constants have been renamed to not collide with the C<struct
		5170	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		5171	as all other watcher types. Note that C<ev_loop_fork> is still called
		5172	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
		5173	typedef.
		5174
		5175	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
		5176
		5177	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
		5178	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
		5179	and work, but the library code will of course be larger.
		5180
		5181	=back
		5182
		5183
4500	=head1 GLOSSARY	5184	=head1 GLOSSARY
4501		5185
4502	=over 4	5186	=over 4
4503		5187
4504	=item active	5188	=item active
4505		5189
4506	A watcher is active as long as it has been started (has been attached to	5190	A watcher is active as long as it has been started and not yet stopped.
4507	an event loop) but not yet stopped (disassociated from the event loop).	5191	See L<WATCHER STATES> for details.
4508		5192
4509	=item application	5193	=item application
4510		5194
4511	In this document, an application is whatever is using libev.	5195	In this document, an application is whatever is using libev.
		5196
		5197	=item backend
		5198
		5199	The part of the code dealing with the operating system interfaces.
4512		5200
4513	=item callback	5201	=item callback
4514		5202
4515	The address of a function that is called when some event has been	5203	The address of a function that is called when some event has been
4516	detected. Callbacks are being passed the event loop, the watcher that	5204	detected. Callbacks are being passed the event loop, the watcher that
4517	received the event, and the actual event bitset.	5205	received the event, and the actual event bitset.
4518		5206
4519	=item callback invocation	5207	=item callback/watcher invocation
4520		5208
4521	The act of calling the callback associated with a watcher.	5209	The act of calling the callback associated with a watcher.
4522		5210
4523	=item event	5211	=item event
4524		5212
4525	A change of state of some external event, such as data now being available	5213	A change of state of some external event, such as data now being available
4526	for reading on a file descriptor, time having passed or simply not having	5214	for reading on a file descriptor, time having passed or simply not having
4527	any other events happening anymore.	5215	any other events happening anymore.
4528		5216
4529	In libev, events are represented as single bits (such as C<EV_READ> or	5217	In libev, events are represented as single bits (such as C<EV_READ> or
4530	C<EV_TIMEOUT>).	5218	C<EV_TIMER>).
4531		5219
4532	=item event library	5220	=item event library
4533		5221
4534	A software package implementing an event model and loop.	5222	A software package implementing an event model and loop.
4535		5223
…		…
4543	The model used to describe how an event loop handles and processes	5231	The model used to describe how an event loop handles and processes
4544	watchers and events.	5232	watchers and events.
4545		5233
4546	=item pending	5234	=item pending
4547		5235
4548	A watcher is pending as soon as the corresponding event has been detected,	5236	A watcher is pending as soon as the corresponding event has been
4549	and stops being pending as soon as the watcher will be invoked or its	5237	detected. See L<WATCHER STATES> for details.
4550	pending status is explicitly cleared by the application.
4551
4552	A watcher can be pending, but not active. Stopping a watcher also clears
4553	its pending status.
4554		5238
4555	=item real time	5239	=item real time
4556		5240
4557	The physical time that is observed. It is apparently strictly monotonic :)	5241	The physical time that is observed. It is apparently strictly monotonic :)
4558		5242
4559	=item wall-clock time	5243	=item wall-clock time
4560		5244
4561	The time and date as shown on clocks. Unlike real time, it can actually	5245	The time and date as shown on clocks. Unlike real time, it can actually
4562	be wrong and jump forwards and backwards, e.g. when the you adjust your	5246	be wrong and jump forwards and backwards, e.g. when you adjust your
4563	clock.	5247	clock.
4564		5248
4565	=item watcher	5249	=item watcher
4566		5250
4567	A data structure that describes interest in certain events. Watchers need	5251	A data structure that describes interest in certain events. Watchers need
4568	to be started (attached to an event loop) before they can receive events.	5252	to be started (attached to an event loop) before they can receive events.
4569		5253
4570	=item watcher invocation
4571
4572	The act of calling the callback associated with a watcher.
4573
4574	=back	5254	=back
4575		5255
4576	=head1 AUTHOR	5256	=head1 AUTHOR
4577		5257
4578	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5258	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5259	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
4579		5260

Diff Legend

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