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

Comparing libev/ev.pod (file contents):
Revision 1.121 by root, Mon Jan 28 12:13:54 2008 UTC vs.
Revision 1.154 by root, Sun May 11 11:47:27 2008 UTC

…		…
6		6
7	#include <ev.h>	7	#include <ev.h>
8		8
9	=head2 EXAMPLE PROGRAM	9	=head2 EXAMPLE PROGRAM
10		10
		11	// a single header file is required
11	#include <ev.h>	12	#include <ev.h>
12		13
		14	// every watcher type has its own typedef'd struct
		15	// with the name ev_<type>
13	ev_io stdin_watcher;	16	ev_io stdin_watcher;
14	ev_timer timeout_watcher;	17	ev_timer timeout_watcher;
15		18
		19	// all watcher callbacks have a similar signature
16	/* called when data readable on stdin */	20	// this callback is called when data is readable on stdin
17	static void	21	static void
18	stdin_cb (EV_P_ struct ev_io *w, int revents)	22	stdin_cb (EV_P_ struct ev_io *w, int revents)
19	{	23	{
20	/* puts ("stdin ready"); */	24	puts ("stdin ready");
21	ev_io_stop (EV_A_ w); /* just a syntax example */	25	// for one-shot events, one must manually stop the watcher
22	ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */	26	// with its corresponding stop function.
		27	ev_io_stop (EV_A_ w);
		28
		29	// this causes all nested ev_loop's to stop iterating
		30	ev_unloop (EV_A_ EVUNLOOP_ALL);
23	}	31	}
24		32
		33	// another callback, this time for a time-out
25	static void	34	static void
26	timeout_cb (EV_P_ struct ev_timer *w, int revents)	35	timeout_cb (EV_P_ struct ev_timer *w, int revents)
27	{	36	{
28	/* puts ("timeout"); */	37	puts ("timeout");
29	ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */	38	// this causes the innermost ev_loop to stop iterating
		39	ev_unloop (EV_A_ EVUNLOOP_ONE);
30	}	40	}
31		41
32	int	42	int
33	main (void)	43	main (void)
34	{	44	{
		45	// use the default event loop unless you have special needs
35	struct ev_loop *loop = ev_default_loop (0);	46	struct ev_loop *loop = ev_default_loop (0);
36		47
37	/* initialise an io watcher, then start it */	48	// initialise an io watcher, then start it
		49	// this one will watch for stdin to become readable
38	ev_io_init (&stdin_watcher, stdin_cb, /STDIN_FILENO/ 0, EV_READ);	50	ev_io_init (&stdin_watcher, stdin_cb, /STDIN_FILENO/ 0, EV_READ);
39	ev_io_start (loop, &stdin_watcher);	51	ev_io_start (loop, &stdin_watcher);
40		52
		53	// initialise a timer watcher, then start it
41	/* simple non-repeating 5.5 second timeout */	54	// simple non-repeating 5.5 second timeout
42	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	55	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
43	ev_timer_start (loop, &timeout_watcher);	56	ev_timer_start (loop, &timeout_watcher);
44		57
45	/* loop till timeout or data ready */	58	// now wait for events to arrive
46	ev_loop (loop, 0);	59	ev_loop (loop, 0);
47		60
		61	// unloop was called, so exit
48	return 0;	62	return 0;
49	}	63	}
50		64
51	=head1 DESCRIPTION	65	=head1 DESCRIPTION
52		66
53	The newest version of this document is also available as a html-formatted	67	The newest version of this document is also available as an html-formatted
54	web page you might find easier to navigate when reading it for the first	68	web page you might find easier to navigate when reading it for the first
55	time: L<http://cvs.schmorp.de/libev/ev.html>.	69	time: L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod>.
56		70
57	Libev is an event loop: you register interest in certain events (such as a	71	Libev is an event loop: you register interest in certain events (such as a
58	file descriptor being readable or a timeout occurring), and it will manage	72	file descriptor being readable or a timeout occurring), and it will manage
59	these event sources and provide your program with events.	73	these event sources and provide your program with events.
60		74
…		…
84	L<benchmark\|http://libev.schmorp.de/bench.html> comparing it to libevent	98	L<benchmark\|http://libev.schmorp.de/bench.html> comparing it to libevent
85	for example).	99	for example).
86		100
87	=head2 CONVENTIONS	101	=head2 CONVENTIONS
88		102
89	Libev is very configurable. In this manual the default configuration will	103	Libev is very configurable. In this manual the default (and most common)
90	be described, which supports multiple event loops. For more info about	104	configuration will be described, which supports multiple event loops. For
91	various configuration options please have a look at B<EMBED> section in	105	more info about various configuration options please have a look at
92	this manual. If libev was configured without support for multiple event	106	B<EMBED> section in this manual. If libev was configured without support
93	loops, then all functions taking an initial argument of name C<loop>	107	for multiple event loops, then all functions taking an initial argument of
94	(which is always of type C<struct ev_loop *>) will not have this argument.	108	name C<loop> (which is always of type C<struct ev_loop *>) will not have
		109	this argument.
95		110
96	=head2 TIME REPRESENTATION	111	=head2 TIME REPRESENTATION
97		112
98	Libev represents time as a single floating point number, representing the	113	Libev represents time as a single floating point number, representing the
99	(fractional) number of seconds since the (POSIX) epoch (somewhere near	114	(fractional) number of seconds since the (POSIX) epoch (somewhere near
…		…
181	See the description of C<ev_embed> watchers for more info.	196	See the description of C<ev_embed> watchers for more info.
182		197
183	=item ev_set_allocator (void (cb)(void *ptr, long size))	198	=item ev_set_allocator (void (cb)(void *ptr, long size))
184		199
185	Sets the allocation function to use (the prototype is similar - the	200	Sets the allocation function to use (the prototype is similar - the
186	semantics is identical - to the realloc C function). It is used to	201	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
187	allocate and free memory (no surprises here). If it returns zero when	202	used to allocate and free memory (no surprises here). If it returns zero
188	memory needs to be allocated, the library might abort or take some	203	when memory needs to be allocated (C<size != 0>), the library might abort
189	potentially destructive action. The default is your system realloc	204	or take some potentially destructive action.
190	function.	205
		206	Since some systems (at least OpenBSD and Darwin) fail to implement
		207	correct C<realloc> semantics, libev will use a wrapper around the system
		208	C<realloc> and C<free> functions by default.
191		209
192	You could override this function in high-availability programs to, say,	210	You could override this function in high-availability programs to, say,
193	free some memory if it cannot allocate memory, to use a special allocator,	211	free some memory if it cannot allocate memory, to use a special allocator,
194	or even to sleep a while and retry until some memory is available.	212	or even to sleep a while and retry until some memory is available.
195		213
196	Example: Replace the libev allocator with one that waits a bit and then	214	Example: Replace the libev allocator with one that waits a bit and then
197	retries).	215	retries (example requires a standards-compliant C<realloc>).
198		216
199	static void *	217	static void *
200	persistent_realloc (void *ptr, size_t size)	218	persistent_realloc (void *ptr, size_t size)
201	{	219	{
202	for (;;)	220	for (;;)
…		…
241		259
242	An event loop is described by a C<struct ev_loop *>. The library knows two	260	An event loop is described by a C<struct ev_loop *>. The library knows two
243	types of such loops, the I<default> loop, which supports signals and child	261	types of such loops, the I<default> loop, which supports signals and child
244	events, and dynamically created loops which do not.	262	events, and dynamically created loops which do not.
245		263
246	If you use threads, a common model is to run the default event loop
247	in your main thread (or in a separate thread) and for each thread you
248	create, you also create another event loop. Libev itself does no locking
249	whatsoever, so if you mix calls to the same event loop in different
250	threads, make sure you lock (this is usually a bad idea, though, even if
251	done correctly, because it's hideous and inefficient).
252
253	=over 4	264	=over 4
254		265
255	=item struct ev_loop *ev_default_loop (unsigned int flags)	266	=item struct ev_loop *ev_default_loop (unsigned int flags)
256		267
257	This will initialise the default event loop if it hasn't been initialised	268	This will initialise the default event loop if it hasn't been initialised
…		…
259	false. If it already was initialised it simply returns it (and ignores the	270	false. If it already was initialised it simply returns it (and ignores the
260	flags. If that is troubling you, check C<ev_backend ()> afterwards).	271	flags. If that is troubling you, check C<ev_backend ()> afterwards).
261		272
262	If you don't know what event loop to use, use the one returned from this	273	If you don't know what event loop to use, use the one returned from this
263	function.	274	function.
		275
		276	Note that this function is I<not> thread-safe, so if you want to use it
		277	from multiple threads, you have to lock (note also that this is unlikely,
		278	as loops cannot bes hared easily between threads anyway).
264		279
265	The default loop is the only loop that can handle C<ev_signal> and	280	The default loop is the only loop that can handle C<ev_signal> and
266	C<ev_child> watchers, and to do this, it always registers a handler	281	C<ev_child> watchers, and to do this, it always registers a handler
267	for C<SIGCHLD>. If this is a problem for your app you can either	282	for C<SIGCHLD>. If this is a problem for your app you can either
268	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	283	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
…		…
297	enabling this flag.	312	enabling this flag.
298		313
299	This works by calling C<getpid ()> on every iteration of the loop,	314	This works by calling C<getpid ()> on every iteration of the loop,
300	and thus this might slow down your event loop if you do a lot of loop	315	and thus this might slow down your event loop if you do a lot of loop
301	iterations and little real work, but is usually not noticeable (on my	316	iterations and little real work, but is usually not noticeable (on my
302	Linux system for example, C<getpid> is actually a simple 5-insn sequence	317	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
303	without a syscall and thus I<very> fast, but my Linux system also has	318	without a syscall and thus I<very> fast, but my GNU/Linux system also has
304	C<pthread_atfork> which is even faster).	319	C<pthread_atfork> which is even faster).
305		320
306	The big advantage of this flag is that you can forget about fork (and	321	The big advantage of this flag is that you can forget about fork (and
307	forget about forgetting to tell libev about forking) when you use this	322	forget about forgetting to tell libev about forking) when you use this
308	flag.	323	flag.
…		…
339	For few fds, this backend is a bit little slower than poll and select,	354	For few fds, this backend is a bit little slower than poll and select,
340	but it scales phenomenally better. While poll and select usually scale	355	but it scales phenomenally better. While poll and select usually scale
341	like O(total_fds) where n is the total number of fds (or the highest fd),	356	like O(total_fds) where n is the total number of fds (or the highest fd),
342	epoll scales either O(1) or O(active_fds). The epoll design has a number	357	epoll scales either O(1) or O(active_fds). The epoll design has a number
343	of shortcomings, such as silently dropping events in some hard-to-detect	358	of shortcomings, such as silently dropping events in some hard-to-detect
344	cases and rewiring a syscall per fd change, no fork support and bad	359	cases and requiring a syscall per fd change, no fork support and bad
345	support for dup.	360	support for dup.
346		361
347	While stopping, setting and starting an I/O watcher in the same iteration	362	While stopping, setting and starting an I/O watcher in the same iteration
348	will result in some caching, there is still a syscall per such incident	363	will result in some caching, there is still a syscall per such incident
349	(because the fd could point to a different file description now), so its	364	(because the fd could point to a different file description now), so its
…		…
451	Similar to C<ev_default_loop>, but always creates a new event loop that is	466	Similar to C<ev_default_loop>, but always creates a new event loop that is
452	always distinct from the default loop. Unlike the default loop, it cannot	467	always distinct from the default loop. Unlike the default loop, it cannot
453	handle signal and child watchers, and attempts to do so will be greeted by	468	handle signal and child watchers, and attempts to do so will be greeted by
454	undefined behaviour (or a failed assertion if assertions are enabled).	469	undefined behaviour (or a failed assertion if assertions are enabled).
455		470
		471	Note that this function I<is> thread-safe, and the recommended way to use
		472	libev with threads is indeed to create one loop per thread, and using the
		473	default loop in the "main" or "initial" thread.
		474
456	Example: Try to create a event loop that uses epoll and nothing else.	475	Example: Try to create a event loop that uses epoll and nothing else.
457		476
458	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);	477	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);
459	if (!epoller)	478	if (!epoller)
460	fatal ("no epoll found here, maybe it hides under your chair");	479	fatal ("no epoll found here, maybe it hides under your chair");
…		…
505	=item ev_loop_fork (loop)	524	=item ev_loop_fork (loop)
506		525
507	Like C<ev_default_fork>, but acts on an event loop created by	526	Like C<ev_default_fork>, but acts on an event loop created by
508	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	527	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
509	after fork, and how you do this is entirely your own problem.	528	after fork, and how you do this is entirely your own problem.
		529
		530	=item int ev_is_default_loop (loop)
		531
		532	Returns true when the given loop actually is the default loop, false otherwise.
510		533
511	=item unsigned int ev_loop_count (loop)	534	=item unsigned int ev_loop_count (loop)
512		535
513	Returns the count of loop iterations for the loop, which is identical to	536	Returns the count of loop iterations for the loop, which is identical to
514	the number of times libev did poll for new events. It starts at C<0> and	537	the number of times libev did poll for new events. It starts at C<0> and
…		…
774	=item C<EV_FORK>	797	=item C<EV_FORK>
775		798
776	The event loop has been resumed in the child process after fork (see	799	The event loop has been resumed in the child process after fork (see
777	C<ev_fork>).	800	C<ev_fork>).
778		801
		802	=item C<EV_ASYNC>
		803
		804	The given async watcher has been asynchronously notified (see C<ev_async>).
		805
779	=item C<EV_ERROR>	806	=item C<EV_ERROR>
780		807
781	An unspecified error has occured, the watcher has been stopped. This might	808	An unspecified error has occured, the watcher has been stopped. This might
782	happen because the watcher could not be properly started because libev	809	happen because the watcher could not be properly started because libev
783	ran out of memory, a file descriptor was found to be closed or any other	810	ran out of memory, a file descriptor was found to be closed or any other
…		…
1062	To support fork in your programs, you either have to call	1089	To support fork in your programs, you either have to call
1063	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1090	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
1064	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1091	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1065	C<EVBACKEND_POLL>.	1092	C<EVBACKEND_POLL>.
1066		1093
		1094	=head3 The special problem of SIGPIPE
		1095
		1096	While not really specific to libev, it is easy to forget about SIGPIPE:
		1097	when reading from a pipe whose other end has been closed, your program
		1098	gets send a SIGPIPE, which, by default, aborts your program. For most
		1099	programs this is sensible behaviour, for daemons, this is usually
		1100	undesirable.
		1101
		1102	So when you encounter spurious, unexplained daemon exits, make sure you
		1103	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
		1104	somewhere, as that would have given you a big clue).
		1105
1067		1106
1068	=head3 Watcher-Specific Functions	1107	=head3 Watcher-Specific Functions
1069		1108
1070	=over 4	1109	=over 4
1071		1110
…		…
1148	configure a timer to trigger every 10 seconds, then it will trigger at	1187	configure a timer to trigger every 10 seconds, then it will trigger at
1149	exactly 10 second intervals. If, however, your program cannot keep up with	1188	exactly 10 second intervals. If, however, your program cannot keep up with
1150	the timer (because it takes longer than those 10 seconds to do stuff) the	1189	the timer (because it takes longer than those 10 seconds to do stuff) the
1151	timer will not fire more than once per event loop iteration.	1190	timer will not fire more than once per event loop iteration.
1152		1191
1153	=item ev_timer_again (loop)	1192	=item ev_timer_again (loop, ev_timer *)
1154		1193
1155	This will act as if the timer timed out and restart it again if it is	1194	This will act as if the timer timed out and restart it again if it is
1156	repeating. The exact semantics are:	1195	repeating. The exact semantics are:
1157		1196
1158	If the timer is pending, its pending status is cleared.	1197	If the timer is pending, its pending status is cleared.
…		…
1267	In this configuration the watcher triggers an event at the wallclock time	1306	In this configuration the watcher triggers an event at the wallclock time
1268	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1307	C<at> and doesn't repeat. It will not adjust when a time jump occurs,
1269	that is, if it is to be run at January 1st 2011 then it will run when the	1308	that is, if it is to be run at January 1st 2011 then it will run when the
1270	system time reaches or surpasses this time.	1309	system time reaches or surpasses this time.
1271		1310
1272	=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)	1311	=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1273		1312
1274	In this mode the watcher will always be scheduled to time out at the next	1313	In this mode the watcher will always be scheduled to time out at the next
1275	C<at + N * interval> time (for some integer N, which can also be negative)	1314	C<at + N * interval> time (for some integer N, which can also be negative)
1276	and then repeat, regardless of any time jumps.	1315	and then repeat, regardless of any time jumps.
1277		1316
…		…
1334	Simply stops and restarts the periodic watcher again. This is only useful	1373	Simply stops and restarts the periodic watcher again. This is only useful
1335	when you changed some parameters or the reschedule callback would return	1374	when you changed some parameters or the reschedule callback would return
1336	a different time than the last time it was called (e.g. in a crond like	1375	a different time than the last time it was called (e.g. in a crond like
1337	program when the crontabs have changed).	1376	program when the crontabs have changed).
1338		1377
		1378	=item ev_tstamp ev_periodic_at (ev_periodic *)
		1379
		1380	When active, returns the absolute time that the watcher is supposed to
		1381	trigger next.
		1382
1339	=item ev_tstamp offset [read-write]	1383	=item ev_tstamp offset [read-write]
1340		1384
1341	When repeating, this contains the offset value, otherwise this is the	1385	When repeating, this contains the offset value, otherwise this is the
1342	absolute point in time (the C<at> value passed to C<ev_periodic_set>).	1386	absolute point in time (the C<at> value passed to C<ev_periodic_set>).
1343		1387
…		…
1353	=item ev_tstamp (reschedule_cb)(struct ev_periodic w, ev_tstamp now) [read-write]	1397	=item ev_tstamp (reschedule_cb)(struct ev_periodic w, ev_tstamp now) [read-write]
1354		1398
1355	The current reschedule callback, or C<0>, if this functionality is	1399	The current reschedule callback, or C<0>, if this functionality is
1356	switched off. Can be changed any time, but changes only take effect when	1400	switched off. Can be changed any time, but changes only take effect when
1357	the periodic timer fires or C<ev_periodic_again> is being called.	1401	the periodic timer fires or C<ev_periodic_again> is being called.
1358
1359	=item ev_tstamp at [read-only]
1360
1361	When active, contains the absolute time that the watcher is supposed to
1362	trigger next.
1363		1402
1364	=back	1403	=back
1365		1404
1366	=head3 Examples	1405	=head3 Examples
1367		1406
…		…
1411	with the kernel (thus it coexists with your own signal handlers as long	1450	with the kernel (thus it coexists with your own signal handlers as long
1412	as you don't register any with libev). Similarly, when the last signal	1451	as you don't register any with libev). Similarly, when the last signal
1413	watcher for a signal is stopped libev will reset the signal handler to	1452	watcher for a signal is stopped libev will reset the signal handler to
1414	SIG_DFL (regardless of what it was set to before).	1453	SIG_DFL (regardless of what it was set to before).
1415		1454
		1455	If possible and supported, libev will install its handlers with
		1456	C<SA_RESTART> behaviour enabled, so syscalls should not be unduly
		1457	interrupted. If you have a problem with syscalls getting interrupted by
		1458	signals you can block all signals in an C<ev_check> watcher and unblock
		1459	them in an C<ev_prepare> watcher.
		1460
1416	=head3 Watcher-Specific Functions and Data Members	1461	=head3 Watcher-Specific Functions and Data Members
1417		1462
1418	=over 4	1463	=over 4
1419		1464
1420	=item ev_signal_init (ev_signal *, callback, int signum)	1465	=item ev_signal_init (ev_signal *, callback, int signum)
…		…
1428		1473
1429	The signal the watcher watches out for.	1474	The signal the watcher watches out for.
1430		1475
1431	=back	1476	=back
1432		1477
		1478	=head3 Examples
		1479
		1480	Example: Try to exit cleanly on SIGINT and SIGTERM.
		1481
		1482	static void
		1483	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)
		1484	{
		1485	ev_unloop (loop, EVUNLOOP_ALL);
		1486	}
		1487
		1488	struct ev_signal signal_watcher;
		1489	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
		1490	ev_signal_start (loop, &sigint_cb);
		1491
1433		1492
1434	=head2 C<ev_child> - watch out for process status changes	1493	=head2 C<ev_child> - watch out for process status changes
1435		1494
1436	Child watchers trigger when your process receives a SIGCHLD in response to	1495	Child watchers trigger when your process receives a SIGCHLD in response to
1437	some child status changes (most typically when a child of yours dies).	1496	some child status changes (most typically when a child of yours dies). It
		1497	is permissible to install a child watcher I<after> the child has been
		1498	forked (which implies it might have already exited), as long as the event
		1499	loop isn't entered (or is continued from a watcher).
		1500
		1501	Only the default event loop is capable of handling signals, and therefore
		1502	you can only rgeister child watchers in the default event loop.
		1503
		1504	=head3 Process Interaction
		1505
		1506	Libev grabs C<SIGCHLD> as soon as the default event loop is
		1507	initialised. This is necessary to guarantee proper behaviour even if
		1508	the first child watcher is started after the child exits. The occurance
		1509	of C<SIGCHLD> is recorded asynchronously, but child reaping is done
		1510	synchronously as part of the event loop processing. Libev always reaps all
		1511	children, even ones not watched.
		1512
		1513	=head3 Overriding the Built-In Processing
		1514
		1515	Libev offers no special support for overriding the built-in child
		1516	processing, but if your application collides with libev's default child
		1517	handler, you can override it easily by installing your own handler for
		1518	C<SIGCHLD> after initialising the default loop, and making sure the
		1519	default loop never gets destroyed. You are encouraged, however, to use an
		1520	event-based approach to child reaping and thus use libev's support for
		1521	that, so other libev users can use C<ev_child> watchers freely.
1438		1522
1439	=head3 Watcher-Specific Functions and Data Members	1523	=head3 Watcher-Specific Functions and Data Members
1440		1524
1441	=over 4	1525	=over 4
1442		1526
…		…
1468		1552
1469	=back	1553	=back
1470		1554
1471	=head3 Examples	1555	=head3 Examples
1472		1556
1473	Example: Try to exit cleanly on SIGINT and SIGTERM.	1557	Example: C<fork()> a new process and install a child handler to wait for
		1558	its completion.
		1559
		1560	ev_child cw;
1474		1561
1475	static void	1562	static void
1476	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)	1563	child_cb (EV_P_ struct ev_child *w, int revents)
1477	{	1564	{
1478	ev_unloop (loop, EVUNLOOP_ALL);	1565	ev_child_stop (EV_A_ w);
		1566	printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1479	}	1567	}
1480		1568
1481	struct ev_signal signal_watcher;	1569	pid_t pid = fork ();
1482	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	1570
1483	ev_signal_start (loop, &sigint_cb);	1571	if (pid < 0)
		1572	// error
		1573	else if (pid == 0)
		1574	{
		1575	// the forked child executes here
		1576	exit (1);
		1577	}
		1578	else
		1579	{
		1580	ev_child_init (&cw, child_cb, pid, 0);
		1581	ev_child_start (EV_DEFAULT_ &cw);
		1582	}
1484		1583
1485		1584
1486	=head2 C<ev_stat> - did the file attributes just change?	1585	=head2 C<ev_stat> - did the file attributes just change?
1487		1586
1488	This watches a filesystem path for attribute changes. That is, it calls	1587	This watches a filesystem path for attribute changes. That is, it calls
…		…
1511	as even with OS-supported change notifications, this can be	1610	as even with OS-supported change notifications, this can be
1512	resource-intensive.	1611	resource-intensive.
1513		1612
1514	At the time of this writing, only the Linux inotify interface is	1613	At the time of this writing, only the Linux inotify interface is
1515	implemented (implementing kqueue support is left as an exercise for the	1614	implemented (implementing kqueue support is left as an exercise for the
		1615	reader, note, however, that the author sees no way of implementing ev_stat
1516	reader). Inotify will be used to give hints only and should not change the	1616	semantics with kqueue). Inotify will be used to give hints only and should
1517	semantics of C<ev_stat> watchers, which means that libev sometimes needs	1617	not change the semantics of C<ev_stat> watchers, which means that libev
1518	to fall back to regular polling again even with inotify, but changes are	1618	sometimes needs to fall back to regular polling again even with inotify,
1519	usually detected immediately, and if the file exists there will be no	1619	but changes are usually detected immediately, and if the file exists there
1520	polling.	1620	will be no polling.
		1621
		1622	=head3 ABI Issues (Largefile Support)
		1623
		1624	Libev by default (unless the user overrides this) uses the default
		1625	compilation environment, which means that on systems with optionally
		1626	disabled large file support, you get the 32 bit version of the stat
		1627	structure. When using the library from programs that change the ABI to
		1628	use 64 bit file offsets the programs will fail. In that case you have to
		1629	compile libev with the same flags to get binary compatibility. This is
		1630	obviously the case with any flags that change the ABI, but the problem is
		1631	most noticably with ev_stat and largefile support.
1521		1632
1522	=head3 Inotify	1633	=head3 Inotify
1523		1634
1524	When C<inotify (7)> support has been compiled into libev (generally only	1635	When C<inotify (7)> support has been compiled into libev (generally only
1525	available on Linux) and present at runtime, it will be used to speed up	1636	available on Linux) and present at runtime, it will be used to speed up
1526	change detection where possible. The inotify descriptor will be created lazily	1637	change detection where possible. The inotify descriptor will be created lazily
1527	when the first C<ev_stat> watcher is being started.	1638	when the first C<ev_stat> watcher is being started.
1528		1639
1529	Inotify presense does not change the semantics of C<ev_stat> watchers	1640	Inotify presence does not change the semantics of C<ev_stat> watchers
1530	except that changes might be detected earlier, and in some cases, to avoid	1641	except that changes might be detected earlier, and in some cases, to avoid
1531	making regular C<stat> calls. Even in the presense of inotify support	1642	making regular C<stat> calls. Even in the presence of inotify support
1532	there are many cases where libev has to resort to regular C<stat> polling.	1643	there are many cases where libev has to resort to regular C<stat> polling.
1533		1644
1534	(There is no support for kqueue, as apparently it cannot be used to	1645	(There is no support for kqueue, as apparently it cannot be used to
1535	implement this functionality, due to the requirement of having a file	1646	implement this functionality, due to the requirement of having a file
1536	descriptor open on the object at all times).	1647	descriptor open on the object at all times).
…		…
1539		1650
1540	The C<stat ()> syscall only supports full-second resolution portably, and	1651	The C<stat ()> syscall only supports full-second resolution portably, and
1541	even on systems where the resolution is higher, many filesystems still	1652	even on systems where the resolution is higher, many filesystems still
1542	only support whole seconds.	1653	only support whole seconds.
1543		1654
1544	That means that, if the time is the only thing that changes, you might	1655	That means that, if the time is the only thing that changes, you can
1545	miss updates: on the first update, C<ev_stat> detects a change and calls	1656	easily miss updates: on the first update, C<ev_stat> detects a change and
1546	your callback, which does something. When there is another update within	1657	calls your callback, which does something. When there is another update
1547	the same second, C<ev_stat> will be unable to detect it.	1658	within the same second, C<ev_stat> will be unable to detect it as the stat
		1659	data does not change.
1548		1660
1549	The solution to this is to delay acting on a change for a second (or till	1661	The solution to this is to delay acting on a change for slightly more
1550	the next second boundary), using a roughly one-second delay C<ev_timer>	1662	than second (or till slightly after the next full second boundary), using
1551	(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>	1663	a roughly one-second-delay C<ev_timer> (e.g. C<ev_timer_set (w, 0., 1.02);
1552	is added to work around small timing inconsistencies of some operating	1664	ev_timer_again (loop, w)>).
1553	systems.	1665
		1666	The C<.02> offset is added to work around small timing inconsistencies
		1667	of some operating systems (where the second counter of the current time
		1668	might be be delayed. One such system is the Linux kernel, where a call to
		1669	C<gettimeofday> might return a timestamp with a full second later than
		1670	a subsequent C<time> call - if the equivalent of C<time ()> is used to
		1671	update file times then there will be a small window where the kernel uses
		1672	the previous second to update file times but libev might already execute
		1673	the timer callback).
1554		1674
1555	=head3 Watcher-Specific Functions and Data Members	1675	=head3 Watcher-Specific Functions and Data Members
1556		1676
1557	=over 4	1677	=over 4
1558		1678
…		…
1564	C<path>. The C<interval> is a hint on how quickly a change is expected to	1684	C<path>. The C<interval> is a hint on how quickly a change is expected to
1565	be detected and should normally be specified as C<0> to let libev choose	1685	be detected and should normally be specified as C<0> to let libev choose
1566	a suitable value. The memory pointed to by C<path> must point to the same	1686	a suitable value. The memory pointed to by C<path> must point to the same
1567	path for as long as the watcher is active.	1687	path for as long as the watcher is active.
1568		1688
1569	The callback will be receive C<EV_STAT> when a change was detected,	1689	The callback will receive C<EV_STAT> when a change was detected, relative
1570	relative to the attributes at the time the watcher was started (or the	1690	to the attributes at the time the watcher was started (or the last change
1571	last change was detected).	1691	was detected).
1572		1692
1573	=item ev_stat_stat (ev_stat *)	1693	=item ev_stat_stat (loop, ev_stat *)
1574		1694
1575	Updates the stat buffer immediately with new values. If you change the	1695	Updates the stat buffer immediately with new values. If you change the
1576	watched path in your callback, you could call this fucntion to avoid	1696	watched path in your callback, you could call this function to avoid
1577	detecting this change (while introducing a race condition). Can also be	1697	detecting this change (while introducing a race condition if you are not
1578	useful simply to find out the new values.	1698	the only one changing the path). Can also be useful simply to find out the
		1699	new values.
1579		1700
1580	=item ev_statdata attr [read-only]	1701	=item ev_statdata attr [read-only]
1581		1702
1582	The most-recently detected attributes of the file. Although the type is of	1703	The most-recently detected attributes of the file. Although the type is
1583	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types	1704	C<ev_statdata>, this is usually the (or one of the) C<struct stat> types
1584	suitable for your system. If the C<st_nlink> member is C<0>, then there	1705	suitable for your system, but you can only rely on the POSIX-standardised
		1706	members to be present. If the C<st_nlink> member is C<0>, then there was
1585	was some error while C<stat>ing the file.	1707	some error while C<stat>ing the file.
1586		1708
1587	=item ev_statdata prev [read-only]	1709	=item ev_statdata prev [read-only]
1588		1710
1589	The previous attributes of the file. The callback gets invoked whenever	1711	The previous attributes of the file. The callback gets invoked whenever
1590	C<prev> != C<attr>.	1712	C<prev> != C<attr>, or, more precisely, one or more of these members
		1713	differ: C<st_dev>, C<st_ino>, C<st_mode>, C<st_nlink>, C<st_uid>,
		1714	C<st_gid>, C<st_rdev>, C<st_size>, C<st_atime>, C<st_mtime>, C<st_ctime>.
1591		1715
1592	=item ev_tstamp interval [read-only]	1716	=item ev_tstamp interval [read-only]
1593		1717
1594	The specified interval.	1718	The specified interval.
1595		1719
…		…
1649	}	1773	}
1650		1774
1651	...	1775	...
1652	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);	1776	ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1653	ev_stat_start (loop, &passwd);	1777	ev_stat_start (loop, &passwd);
1654	ev_timer_init (&timer, timer_cb, 0., 1.01);	1778	ev_timer_init (&timer, timer_cb, 0., 1.02);
1655		1779
1656		1780
1657	=head2 C<ev_idle> - when you've got nothing better to do...	1781	=head2 C<ev_idle> - when you've got nothing better to do...
1658		1782
1659	Idle watchers trigger events when no other events of the same or higher	1783	Idle watchers trigger events when no other events of the same or higher
…		…
1747		1871
1748	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)	1872	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1749	priority, to ensure that they are being run before any other watchers	1873	priority, to ensure that they are being run before any other watchers
1750	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,	1874	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1751	too) should not activate ("feed") events into libev. While libev fully	1875	too) should not activate ("feed") events into libev. While libev fully
1752	supports this, they will be called before other C<ev_check> watchers	1876	supports this, they might get executed before other C<ev_check> watchers
1753	did their job. As C<ev_check> watchers are often used to embed other	1877	did their job. As C<ev_check> watchers are often used to embed other
1754	(non-libev) event loops those other event loops might be in an unusable	1878	(non-libev) event loops those other event loops might be in an unusable
1755	state until their C<ev_check> watcher ran (always remind yourself to	1879	state until their C<ev_check> watcher ran (always remind yourself to
1756	coexist peacefully with others).	1880	coexist peacefully with others).
1757		1881
…		…
1772	=head3 Examples	1896	=head3 Examples
1773		1897
1774	There are a number of principal ways to embed other event loops or modules	1898	There are a number of principal ways to embed other event loops or modules
1775	into libev. Here are some ideas on how to include libadns into libev	1899	into libev. Here are some ideas on how to include libadns into libev
1776	(there is a Perl module named C<EV::ADNS> that does this, which you could	1900	(there is a Perl module named C<EV::ADNS> that does this, which you could
1777	use for an actually working example. Another Perl module named C<EV::Glib>	1901	use as a working example. Another Perl module named C<EV::Glib> embeds a
1778	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV	1902	Glib main context into libev, and finally, C<Glib::EV> embeds EV into the
1779	into the Glib event loop).	1903	Glib event loop).
1780		1904
1781	Method 1: Add IO watchers and a timeout watcher in a prepare handler,	1905	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1782	and in a check watcher, destroy them and call into libadns. What follows	1906	and in a check watcher, destroy them and call into libadns. What follows
1783	is pseudo-code only of course. This requires you to either use a low	1907	is pseudo-code only of course. This requires you to either use a low
1784	priority for the check watcher or use C<ev_clear_pending> explicitly, as	1908	priority for the check watcher or use C<ev_clear_pending> explicitly, as
…		…
2046	believe me.	2170	believe me.
2047		2171
2048	=back	2172	=back
2049		2173
2050		2174
		2175	=head2 C<ev_async> - how to wake up another event loop
		2176
		2177	In general, you cannot use an C<ev_loop> from multiple threads or other
		2178	asynchronous sources such as signal handlers (as opposed to multiple event
		2179	loops - those are of course safe to use in different threads).
		2180
		2181	Sometimes, however, you need to wake up another event loop you do not
		2182	control, for example because it belongs to another thread. This is what
		2183	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you
		2184	can signal it by calling C<ev_async_send>, which is thread- and signal
		2185	safe.
		2186
		2187	This functionality is very similar to C<ev_signal> watchers, as signals,
		2188	too, are asynchronous in nature, and signals, too, will be compressed
		2189	(i.e. the number of callback invocations may be less than the number of
		2190	C<ev_async_sent> calls).
		2191
		2192	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
		2193	just the default loop.
		2194
		2195	=head3 Queueing
		2196
		2197	C<ev_async> does not support queueing of data in any way. The reason
		2198	is that the author does not know of a simple (or any) algorithm for a
		2199	multiple-writer-single-reader queue that works in all cases and doesn't
		2200	need elaborate support such as pthreads.
		2201
		2202	That means that if you want to queue data, you have to provide your own
		2203	queue. But at least I can tell you would implement locking around your
		2204	queue:
		2205
		2206	=over 4
		2207
		2208	=item queueing from a signal handler context
		2209
		2210	To implement race-free queueing, you simply add to the queue in the signal
		2211	handler but you block the signal handler in the watcher callback. Here is an example that does that for
		2212	some fictitiuous SIGUSR1 handler:
		2213
		2214	static ev_async mysig;
		2215
		2216	static void
		2217	sigusr1_handler (void)
		2218	{
		2219	sometype data;
		2220
		2221	// no locking etc.
		2222	queue_put (data);
		2223	ev_async_send (EV_DEFAULT_ &mysig);
		2224	}
		2225
		2226	static void
		2227	mysig_cb (EV_P_ ev_async *w, int revents)
		2228	{
		2229	sometype data;
		2230	sigset_t block, prev;
		2231
		2232	sigemptyset (&block);
		2233	sigaddset (&block, SIGUSR1);
		2234	sigprocmask (SIG_BLOCK, &block, &prev);
		2235
		2236	while (queue_get (&data))
		2237	process (data);
		2238
		2239	if (sigismember (&prev, SIGUSR1)
		2240	sigprocmask (SIG_UNBLOCK, &block, 0);
		2241	}
		2242
		2243	(Note: pthreads in theory requires you to use C<pthread_setmask>
		2244	instead of C<sigprocmask> when you use threads, but libev doesn't do it
		2245	either...).
		2246
		2247	=item queueing from a thread context
		2248
		2249	The strategy for threads is different, as you cannot (easily) block
		2250	threads but you can easily preempt them, so to queue safely you need to
		2251	employ a traditional mutex lock, such as in this pthread example:
		2252
		2253	static ev_async mysig;
		2254	static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
		2255
		2256	static void
		2257	otherthread (void)
		2258	{
		2259	// only need to lock the actual queueing operation
		2260	pthread_mutex_lock (&mymutex);
		2261	queue_put (data);
		2262	pthread_mutex_unlock (&mymutex);
		2263
		2264	ev_async_send (EV_DEFAULT_ &mysig);
		2265	}
		2266
		2267	static void
		2268	mysig_cb (EV_P_ ev_async *w, int revents)
		2269	{
		2270	pthread_mutex_lock (&mymutex);
		2271
		2272	while (queue_get (&data))
		2273	process (data);
		2274
		2275	pthread_mutex_unlock (&mymutex);
		2276	}
		2277
		2278	=back
		2279
		2280
		2281	=head3 Watcher-Specific Functions and Data Members
		2282
		2283	=over 4
		2284
		2285	=item ev_async_init (ev_async *, callback)
		2286
		2287	Initialises and configures the async watcher - it has no parameters of any
		2288	kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,
		2289	believe me.
		2290
		2291	=item ev_async_send (loop, ev_async *)
		2292
		2293	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
		2294	an C<EV_ASYNC> event on the watcher into the event loop. Unlike
		2295	C<ev_feed_event>, this call is safe to do in other threads, signal or
		2296	similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding
		2297	section below on what exactly this means).
		2298
		2299	This call incurs the overhead of a syscall only once per loop iteration,
		2300	so while the overhead might be noticable, it doesn't apply to repeated
		2301	calls to C<ev_async_send>.
		2302
		2303	=item bool = ev_async_pending (ev_async *)
		2304
		2305	Returns a non-zero value when C<ev_async_send> has been called on the
		2306	watcher but the event has not yet been processed (or even noted) by the
		2307	event loop.
		2308
		2309	C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
		2310	the loop iterates next and checks for the watcher to have become active,
		2311	it will reset the flag again. C<ev_async_pending> can be used to very
		2312	quickly check wether invoking the loop might be a good idea.
		2313
		2314	Not that this does I<not> check wether the watcher itself is pending, only
		2315	wether it has been requested to make this watcher pending.
		2316
		2317	=back
		2318
		2319
2051	=head1 OTHER FUNCTIONS	2320	=head1 OTHER FUNCTIONS
2052		2321
2053	There are some other functions of possible interest. Described. Here. Now.	2322	There are some other functions of possible interest. Described. Here. Now.
2054		2323
2055	=over 4	2324	=over 4
…		…
2123		2392
2124	=item * Priorities are not currently supported. Initialising priorities	2393	=item * Priorities are not currently supported. Initialising priorities
2125	will fail and all watchers will have the same priority, even though there	2394	will fail and all watchers will have the same priority, even though there
2126	is an ev_pri field.	2395	is an ev_pri field.
2127		2396
		2397	=item * In libevent, the last base created gets the signals, in libev, the
		2398	first base created (== the default loop) gets the signals.
		2399
2128	=item * Other members are not supported.	2400	=item * Other members are not supported.
2129		2401
2130	=item * The libev emulation is I<not> ABI compatible to libevent, you need	2402	=item * The libev emulation is I<not> ABI compatible to libevent, you need
2131	to use the libev header file and library.	2403	to use the libev header file and library.
2132		2404
…		…
2295	io.start (fd, ev::READ);	2567	io.start (fd, ev::READ);
2296	}	2568	}
2297	};	2569	};
2298		2570
2299		2571
		2572	=head1 OTHER LANGUAGE BINDINGS
		2573
		2574	Libev does not offer other language bindings itself, but bindings for a
		2575	numbe rof languages exist in the form of third-party packages. If you know
		2576	any interesting language binding in addition to the ones listed here, drop
		2577	me a note.
		2578
		2579	=over 4
		2580
		2581	=item Perl
		2582
		2583	The EV module implements the full libev API and is actually used to test
		2584	libev. EV is developed together with libev. Apart from the EV core module,
		2585	there are additional modules that implement libev-compatible interfaces
		2586	to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the
		2587	C<libglib> event core (C<Glib::EV> and C<EV::Glib>).
		2588
		2589	It can be found and installed via CPAN, its homepage is found at
		2590	L<http://software.schmorp.de/pkg/EV>.
		2591
		2592	=item Ruby
		2593
		2594	Tony Arcieri has written a ruby extension that offers access to a subset
		2595	of the libev API and adds filehandle abstractions, asynchronous DNS and
		2596	more on top of it. It can be found via gem servers. Its homepage is at
		2597	L<http://rev.rubyforge.org/>.
		2598
		2599	=item D
		2600
		2601	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
		2602	be found at L<http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>.
		2603
		2604	=back
		2605
		2606
2300	=head1 MACRO MAGIC	2607	=head1 MACRO MAGIC
2301		2608
2302	Libev can be compiled with a variety of options, the most fundamantal	2609	Libev can be compiled with a variety of options, the most fundamantal
2303	of which is C<EV_MULTIPLICITY>. This option determines whether (most)	2610	of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2304	functions and callbacks have an initial C<struct ev_loop *> argument.	2611	functions and callbacks have an initial C<struct ev_loop *> argument.
…		…
2338		2645
2339	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	2646	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
2340		2647
2341	Similar to the other two macros, this gives you the value of the default	2648	Similar to the other two macros, this gives you the value of the default
2342	loop, if multiple loops are supported ("ev loop default").	2649	loop, if multiple loops are supported ("ev loop default").
		2650
		2651	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
		2652
		2653	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
		2654	default loop has been initialised (C<UC> == unchecked). Their behaviour
		2655	is undefined when the default loop has not been initialised by a previous
		2656	execution of C<EV_DEFAULT>, C<EV_DEFAULT_> or C<ev_default_init (...)>.
		2657
		2658	It is often prudent to use C<EV_DEFAULT> when initialising the first
		2659	watcher in a function but use C<EV_DEFAULT_UC> afterwards.
2343		2660
2344	=back	2661	=back
2345		2662
2346	Example: Declare and initialise a check watcher, utilising the above	2663	Example: Declare and initialise a check watcher, utilising the above
2347	macros so it will work regardless of whether multiple loops are supported	2664	macros so it will work regardless of whether multiple loops are supported
…		…
2443		2760
2444	libev.m4	2761	libev.m4
2445		2762
2446	=head2 PREPROCESSOR SYMBOLS/MACROS	2763	=head2 PREPROCESSOR SYMBOLS/MACROS
2447		2764
2448	Libev can be configured via a variety of preprocessor symbols you have to define	2765	Libev can be configured via a variety of preprocessor symbols you have to
2449	before including any of its files. The default is not to build for multiplicity	2766	define before including any of its files. The default in the absense of
2450	and only include the select backend.	2767	autoconf is noted for every option.
2451		2768
2452	=over 4	2769	=over 4
2453		2770
2454	=item EV_STANDALONE	2771	=item EV_STANDALONE
2455		2772
…		…
2481	=item EV_USE_NANOSLEEP	2798	=item EV_USE_NANOSLEEP
2482		2799
2483	If defined to be C<1>, libev will assume that C<nanosleep ()> is available	2800	If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2484	and will use it for delays. Otherwise it will use C<select ()>.	2801	and will use it for delays. Otherwise it will use C<select ()>.
2485		2802
		2803	=item EV_USE_EVENTFD
		2804
		2805	If defined to be C<1>, then libev will assume that C<eventfd ()> is
		2806	available and will probe for kernel support at runtime. This will improve
		2807	C<ev_signal> and C<ev_async> performance and reduce resource consumption.
		2808	If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
		2809	2.7 or newer, otherwise disabled.
		2810
2486	=item EV_USE_SELECT	2811	=item EV_USE_SELECT
2487		2812
2488	If undefined or defined to be C<1>, libev will compile in support for the	2813	If undefined or defined to be C<1>, libev will compile in support for the
2489	C<select>(2) backend. No attempt at autodetection will be done: if no	2814	C<select>(2) backend. No attempt at autodetection will be done: if no
2490	other method takes over, select will be it. Otherwise the select backend	2815	other method takes over, select will be it. Otherwise the select backend
…		…
2526		2851
2527	=item EV_USE_EPOLL	2852	=item EV_USE_EPOLL
2528		2853
2529	If defined to be C<1>, libev will compile in support for the Linux	2854	If defined to be C<1>, libev will compile in support for the Linux
2530	C<epoll>(7) backend. Its availability will be detected at runtime,	2855	C<epoll>(7) backend. Its availability will be detected at runtime,
2531	otherwise another method will be used as fallback. This is the	2856	otherwise another method will be used as fallback. This is the preferred
2532	preferred backend for GNU/Linux systems.	2857	backend for GNU/Linux systems. If undefined, it will be enabled if the
		2858	headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2533		2859
2534	=item EV_USE_KQUEUE	2860	=item EV_USE_KQUEUE
2535		2861
2536	If defined to be C<1>, libev will compile in support for the BSD style	2862	If defined to be C<1>, libev will compile in support for the BSD style
2537	C<kqueue>(2) backend. Its actual availability will be detected at runtime,	2863	C<kqueue>(2) backend. Its actual availability will be detected at runtime,
…		…
2556		2882
2557	=item EV_USE_INOTIFY	2883	=item EV_USE_INOTIFY
2558		2884
2559	If defined to be C<1>, libev will compile in support for the Linux inotify	2885	If defined to be C<1>, libev will compile in support for the Linux inotify
2560	interface to speed up C<ev_stat> watchers. Its actual availability will	2886	interface to speed up C<ev_stat> watchers. Its actual availability will
2561	be detected at runtime.	2887	be detected at runtime. If undefined, it will be enabled if the headers
		2888	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
		2889
		2890	=item EV_ATOMIC_T
		2891
		2892	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
		2893	access is atomic with respect to other threads or signal contexts. No such
		2894	type is easily found in the C language, so you can provide your own type
		2895	that you know is safe for your purposes. It is used both for signal handler "locking"
		2896	as well as for signal and thread safety in C<ev_async> watchers.
		2897
		2898	In the absense of this define, libev will use C<sig_atomic_t volatile>
		2899	(from F<signal.h>), which is usually good enough on most platforms.
2562		2900
2563	=item EV_H	2901	=item EV_H
2564		2902
2565	The name of the F<ev.h> header file used to include it. The default if	2903	The name of the F<ev.h> header file used to include it. The default if
2566	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be	2904	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
…		…
2634	=item EV_FORK_ENABLE	2972	=item EV_FORK_ENABLE
2635		2973
2636	If undefined or defined to be C<1>, then fork watchers are supported. If	2974	If undefined or defined to be C<1>, then fork watchers are supported. If
2637	defined to be C<0>, then they are not.	2975	defined to be C<0>, then they are not.
2638		2976
		2977	=item EV_ASYNC_ENABLE
		2978
		2979	If undefined or defined to be C<1>, then async watchers are supported. If
		2980	defined to be C<0>, then they are not.
		2981
2639	=item EV_MINIMAL	2982	=item EV_MINIMAL
2640		2983
2641	If you need to shave off some kilobytes of code at the expense of some	2984	If you need to shave off some kilobytes of code at the expense of some
2642	speed, define this symbol to C<1>. Currently only used for gcc to override	2985	speed, define this symbol to C<1>. Currently this is used to override some
2643	some inlining decisions, saves roughly 30% codesize of amd64.	2986	inlining decisions, saves roughly 30% codesize of amd64. It also selects a
		2987	much smaller 2-heap for timer management over the default 4-heap.
2644		2988
2645	=item EV_PID_HASHSIZE	2989	=item EV_PID_HASHSIZE
2646		2990
2647	C<ev_child> watchers use a small hash table to distribute workload by	2991	C<ev_child> watchers use a small hash table to distribute workload by
2648	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	2992	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more
…		…
2654	C<ev_stat> watchers use a small hash table to distribute workload by	2998	C<ev_stat> watchers use a small hash table to distribute workload by
2655	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	2999	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2656	usually more than enough. If you need to manage thousands of C<ev_stat>	3000	usually more than enough. If you need to manage thousands of C<ev_stat>
2657	watchers you might want to increase this value (I<must> be a power of	3001	watchers you might want to increase this value (I<must> be a power of
2658	two).	3002	two).
		3003
		3004	=item EV_USE_4HEAP
		3005
		3006	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3007	timer and periodics heap, libev uses a 4-heap when this symbol is defined
		3008	to C<1>. The 4-heap uses more complicated (longer) code but has a
		3009	noticable after performance with many (thousands) of watchers.
		3010
		3011	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3012	(disabled).
		3013
		3014	=item EV_HEAP_CACHE_AT
		3015
		3016	Heaps are not very cache-efficient. To improve the cache-efficiency of the
		3017	timer and periodics heap, libev can cache the timestamp (I<at>) within
		3018	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
		3019	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
		3020	but avoids random read accesses on heap changes. This noticably improves
		3021	performance noticably with with many (hundreds) of watchers.
		3022
		3023	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>
		3024	(disabled).
2659		3025
2660	=item EV_COMMON	3026	=item EV_COMMON
2661		3027
2662	By default, all watchers have a C<void *data> member. By redefining	3028	By default, all watchers have a C<void *data> member. By redefining
2663	this macro to a something else you can include more and other types of	3029	this macro to a something else you can include more and other types of
…		…
2737		3103
2738	#include "ev_cpp.h"	3104	#include "ev_cpp.h"
2739	#include "ev.c"	3105	#include "ev.c"
2740		3106
2741		3107
		3108	=head1 THREADS AND COROUTINES
		3109
		3110	=head2 THREADS
		3111
		3112	Libev itself is completely threadsafe, but it uses no locking. This
		3113	means that you can use as many loops as you want in parallel, as long as
		3114	only one thread ever calls into one libev function with the same loop
		3115	parameter.
		3116
		3117	Or put differently: calls with different loop parameters can be done in
		3118	parallel from multiple threads, calls with the same loop parameter must be
		3119	done serially (but can be done from different threads, as long as only one
		3120	thread ever is inside a call at any point in time, e.g. by using a mutex
		3121	per loop).
		3122
		3123	If you want to know which design is best for your problem, then I cannot
		3124	help you but by giving some generic advice:
		3125
		3126	=over 4
		3127
		3128	=item * most applications have a main thread: use the default libev loop
		3129	in that thread, or create a seperate thread running only the default loop.
		3130
		3131	This helps integrating other libraries or software modules that use libev
		3132	themselves and don't care/know about threading.
		3133
		3134	=item * one loop per thread is usually a good model.
		3135
		3136	Doing this is almost never wrong, sometimes a better-performance model
		3137	exists, but it is always a good start.
		3138
		3139	=item * other models exist, such as the leader/follower pattern, where one
		3140	loop is handed through multiple threads in a kind of round-robbin fashion.
		3141
		3142	Chosing a model is hard - look around, learn, know that usually you cna do
		3143	better than you currently do :-)
		3144
		3145	=item * often you need to talk to some other thread which blocks in the
		3146	event loop - C<ev_async> watchers can be used to wake them up from other
		3147	threads safely (or from signal contexts...).
		3148
		3149	=back
		3150
		3151	=head2 COROUTINES
		3152
		3153	Libev is much more accomodating to coroutines ("cooperative threads"):
		3154	libev fully supports nesting calls to it's functions from different
		3155	coroutines (e.g. you can call C<ev_loop> on the same loop from two
		3156	different coroutines and switch freely between both coroutines running the
		3157	loop, as long as you don't confuse yourself). The only exception is that
		3158	you must not do this from C<ev_periodic> reschedule callbacks.
		3159
		3160	Care has been invested into making sure that libev does not keep local
		3161	state inside C<ev_loop>, and other calls do not usually allow coroutine
		3162	switches.
		3163
		3164
2742	=head1 COMPLEXITIES	3165	=head1 COMPLEXITIES
2743		3166
2744	In this section the complexities of (many of) the algorithms used inside	3167	In this section the complexities of (many of) the algorithms used inside
2745	libev will be explained. For complexity discussions about backends see the	3168	libev will be explained. For complexity discussions about backends see the
2746	documentation for C<ev_default_init>.	3169	documentation for C<ev_default_init>.
…		…
2762	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)	3185	=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
2763		3186
2764	That means that changing a timer costs less than removing/adding them	3187	That means that changing a timer costs less than removing/adding them
2765	as only the relative motion in the event queue has to be paid for.	3188	as only the relative motion in the event queue has to be paid for.
2766		3189
2767	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	3190	=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
2768		3191
2769	These just add the watcher into an array or at the head of a list.	3192	These just add the watcher into an array or at the head of a list.
2770		3193
2771	=item Stopping check/prepare/idle watchers: O(1)	3194	=item Stopping check/prepare/idle/fork/async watchers: O(1)
2772		3195
2773	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	3196	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2774		3197
2775	These watchers are stored in lists then need to be walked to find the	3198	These watchers are stored in lists then need to be walked to find the
2776	correct watcher to remove. The lists are usually short (you don't usually	3199	correct watcher to remove. The lists are usually short (you don't usually
2777	have many watchers waiting for the same fd or signal).	3200	have many watchers waiting for the same fd or signal).
2778		3201
2779	=item Finding the next timer in each loop iteration: O(1)	3202	=item Finding the next timer in each loop iteration: O(1)
2780		3203
2781	By virtue of using a binary heap, the next timer is always found at the	3204	By virtue of using a binary or 4-heap, the next timer is always found at a
2782	beginning of the storage array.	3205	fixed position in the storage array.
2783		3206
2784	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	3207	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2785		3208
2786	A change means an I/O watcher gets started or stopped, which requires	3209	A change means an I/O watcher gets started or stopped, which requires
2787	libev to recalculate its status (and possibly tell the kernel, depending	3210	libev to recalculate its status (and possibly tell the kernel, depending
…		…
2792	=item Priority handling: O(number_of_priorities)	3215	=item Priority handling: O(number_of_priorities)
2793		3216
2794	Priorities are implemented by allocating some space for each	3217	Priorities are implemented by allocating some space for each
2795	priority. When doing priority-based operations, libev usually has to	3218	priority. When doing priority-based operations, libev usually has to
2796	linearly search all the priorities, but starting/stopping and activating	3219	linearly search all the priorities, but starting/stopping and activating
2797	watchers becomes O(1) w.r.t. prioritiy handling.	3220	watchers becomes O(1) w.r.t. priority handling.
		3221
		3222	=item Sending an ev_async: O(1)
		3223
		3224	=item Processing ev_async_send: O(number_of_async_watchers)
		3225
		3226	=item Processing signals: O(max_signal_number)
		3227
		3228	Sending involves a syscall I<iff> there were no other C<ev_async_send>
		3229	calls in the current loop iteration. Checking for async and signal events
		3230	involves iterating over all running async watchers or all signal numbers.
2798		3231
2799	=back	3232	=back
2800		3233
2801		3234
2802	=head1 Win32 platform limitations and workarounds	3235	=head1 Win32 platform limitations and workarounds
…		…
2806	model. Libev still offers limited functionality on this platform in	3239	model. Libev still offers limited functionality on this platform in
2807	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	3240	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
2808	descriptors. This only applies when using Win32 natively, not when using	3241	descriptors. This only applies when using Win32 natively, not when using
2809	e.g. cygwin.	3242	e.g. cygwin.
2810		3243
		3244	Lifting these limitations would basically require the full
		3245	re-implementation of the I/O system. If you are into these kinds of
		3246	things, then note that glib does exactly that for you in a very portable
		3247	way (note also that glib is the slowest event library known to man).
		3248
2811	There is no supported compilation method available on windows except	3249	There is no supported compilation method available on windows except
2812	embedding it into other applications.	3250	embedding it into other applications.
2813		3251
2814	Due to the many, low, and arbitrary limits on the win32 platform and the	3252	Due to the many, low, and arbitrary limits on the win32 platform and
2815	abysmal performance of winsockets, using a large number of sockets is not	3253	the abysmal performance of winsockets, using a large number of sockets
2816	recommended (and not reasonable). If your program needs to use more than	3254	is not recommended (and not reasonable). If your program needs to use
2817	a hundred or so sockets, then likely it needs to use a totally different	3255	more than a hundred or so sockets, then likely it needs to use a totally
2818	implementation for windows, as libev offers the POSIX model, which cannot	3256	different implementation for windows, as libev offers the POSIX readyness
2819	be implemented efficiently on windows (microsoft monopoly games).	3257	notification model, which cannot be implemented efficiently on windows
		3258	(microsoft monopoly games).
2820		3259
2821	=over 4	3260	=over 4
2822		3261
2823	=item The winsocket select function	3262	=item The winsocket select function
2824		3263
…		…
2838	Note that winsockets handling of fd sets is O(n), so you can easily get a	3277	Note that winsockets handling of fd sets is O(n), so you can easily get a
2839	complexity in the O(n²) range when using win32.	3278	complexity in the O(n²) range when using win32.
2840		3279
2841	=item Limited number of file descriptors	3280	=item Limited number of file descriptors
2842		3281
2843	Windows has numerous arbitrary (and low) limits on things. Early versions	3282	Windows has numerous arbitrary (and low) limits on things.
2844	of winsocket's select only supported waiting for a max. of C<64> handles	3283
		3284	Early versions of winsocket's select only supported waiting for a maximum
2845	(probably owning to the fact that all windows kernels can only wait for	3285	of C<64> handles (probably owning to the fact that all windows kernels
2846	C<64> things at the same time internally; microsoft recommends spawning a	3286	can only wait for C<64> things at the same time internally; microsoft
2847	chain of threads and wait for 63 handles and the previous thread in each).	3287	recommends spawning a chain of threads and wait for 63 handles and the
		3288	previous thread in each. Great).
2848		3289
2849	Newer versions support more handles, but you need to define C<FD_SETSIZE>	3290	Newer versions support more handles, but you need to define C<FD_SETSIZE>
2850	to some high number (e.g. C<2048>) before compiling the winsocket select	3291	to some high number (e.g. C<2048>) before compiling the winsocket select
2851	call (which might be in libev or elsewhere, for example, perl does its own	3292	call (which might be in libev or elsewhere, for example, perl does its own
2852	select emulation on windows).	3293	select emulation on windows).
…		…
2864	calling select (O(n²)) will likely make this unworkable.	3305	calling select (O(n²)) will likely make this unworkable.
2865		3306
2866	=back	3307	=back
2867		3308
2868		3309
		3310	=head1 PORTABILITY REQUIREMENTS
		3311
		3312	In addition to a working ISO-C implementation, libev relies on a few
		3313	additional extensions:
		3314
		3315	=over 4
		3316
		3317	=item C<sig_atomic_t volatile> must be thread-atomic as well
		3318
		3319	The type C<sig_atomic_t volatile> (or whatever is defined as
		3320	C<EV_ATOMIC_T>) must be atomic w.r.t. accesses from different
		3321	threads. This is not part of the specification for C<sig_atomic_t>, but is
		3322	believed to be sufficiently portable.
		3323
		3324	=item C<sigprocmask> must work in a threaded environment
		3325
		3326	Libev uses C<sigprocmask> to temporarily block signals. This is not
		3327	allowed in a threaded program (C<pthread_sigmask> has to be used). Typical
		3328	pthread implementations will either allow C<sigprocmask> in the "main
		3329	thread" or will block signals process-wide, both behaviours would
		3330	be compatible with libev. Interaction between C<sigprocmask> and
		3331	C<pthread_sigmask> could complicate things, however.
		3332
		3333	The most portable way to handle signals is to block signals in all threads
		3334	except the initial one, and run the default loop in the initial thread as
		3335	well.
		3336
		3337	=item C<long> must be large enough for common memory allocation sizes
		3338
		3339	To improve portability and simplify using libev, libev uses C<long>
		3340	internally instead of C<size_t> when allocating its data structures. On
		3341	non-POSIX systems (Microsoft...) this might be unexpectedly low, but
		3342	is still at least 31 bits everywhere, which is enough for hundreds of
		3343	millions of watchers.
		3344
		3345	=item C<double> must hold a time value in seconds with enough accuracy
		3346
		3347	The type C<double> is used to represent timestamps. It is required to
		3348	have at least 51 bits of mantissa (and 9 bits of exponent), which is good
		3349	enough for at least into the year 4000. This requirement is fulfilled by
		3350	implementations implementing IEEE 754 (basically all existing ones).
		3351
		3352	=back
		3353
		3354	If you know of other additional requirements drop me a note.
		3355
		3356
2869	=head1 AUTHOR	3357	=head1 AUTHOR
2870		3358
2871	Marc Lehmann <libev@schmorp.de>.	3359	Marc Lehmann <libev@schmorp.de>.
2872		3360

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.121 by root, Mon Jan 28 12:13:54 2008 UTC vs. Revision 1.154 by root, Sun May 11 11:47:27 2008 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.121 by root, Mon Jan 28 12:13:54 2008 UTC vs.
Revision 1.154 by root, Sun May 11 11:47:27 2008 UTC