ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.351 by root, Mon Jan 10 14:24:26 2011 UTC vs.
Revision 1.403 by sf-exg, Wed Apr 18 06:56:53 2012 UTC

…		…
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_run (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
…		…
174	=item ev_tstamp ev_time ()	174	=item ev_tstamp ev_time ()
175		175
176	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
177	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
178	you actually want to know. Also interesting is the combination of	178	you actually want to know. Also interesting is the combination of
179	C<ev_update_now> and C<ev_now>.	179	C<ev_now_update> and C<ev_now>.
180		180
181	=item ev_sleep (ev_tstamp interval)	181	=item ev_sleep (ev_tstamp interval)
182		182
183	Sleep for the given interval: The current thread will be blocked until	183	Sleep for the given interval: The current thread will be blocked
184	either it is interrupted or the given time interval has passed. Basically	184	until either it is interrupted or the given time interval has
		185	passed (approximately - it might return a bit earlier even if not
		186	interrupted). Returns immediately if C<< interval <= 0 >>.
		187
185	this is a sub-second-resolution C<sleep ()>.	188	Basically this is a sub-second-resolution C<sleep ()>.
		189
		190	The range of the C<interval> is limited - libev only guarantees to work
		191	with sleep times of up to one day (C<< interval <= 86400 >>).
186		192
187	=item int ev_version_major ()	193	=item int ev_version_major ()
188		194
189	=item int ev_version_minor ()	195	=item int ev_version_minor ()
190		196
…		…
241	the current system, you would need to look at C<ev_embeddable_backends ()	247	the current system, you would need to look at C<ev_embeddable_backends ()
242	& ev_supported_backends ()>, likewise for recommended ones.	248	& ev_supported_backends ()>, likewise for recommended ones.
243		249
244	See the description of C<ev_embed> watchers for more info.	250	See the description of C<ev_embed> watchers for more info.
245		251
246	=item ev_set_allocator (void *(*cb)(void *ptr, long size))	252	=item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())
247		253
248	Sets the allocation function to use (the prototype is similar - the	254	Sets the allocation function to use (the prototype is similar - the
249	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is	255	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
250	used to allocate and free memory (no surprises here). If it returns zero	256	used to allocate and free memory (no surprises here). If it returns zero
251	when memory needs to be allocated (C<size != 0>), the library might abort	257	when memory needs to be allocated (C<size != 0>), the library might abort
…		…
277	}	283	}
278		284
279	...	285	...
280	ev_set_allocator (persistent_realloc);	286	ev_set_allocator (persistent_realloc);
281		287
282	=item ev_set_syserr_cb (void (*cb)(const char *msg))	288	=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
283		289
284	Set the callback function to call on a retryable system call error (such	290	Set the callback function to call on a retryable system call error (such
285	as failed select, poll, epoll_wait). The message is a printable string	291	as failed select, poll, epoll_wait). The message is a printable string
286	indicating the system call or subsystem causing the problem. If this	292	indicating the system call or subsystem causing the problem. If this
287	callback is set, then libev will expect it to remedy the situation, no	293	callback is set, then libev will expect it to remedy the situation, no
…		…
435	example) that can't properly initialise their signal masks.	441	example) that can't properly initialise their signal masks.
436		442
437	=item C<EVFLAG_NOSIGMASK>	443	=item C<EVFLAG_NOSIGMASK>
438		444
439	When this flag is specified, then libev will avoid to modify the signal	445	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	446	mask. Specifically, this means you have to make sure signals are unblocked
441	when you want to receive them.	447	when you want to receive them.
442		448
443	This behaviour is useful when you want to do your own signal handling, or	449	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	450	want to handle signals only in specific threads and want to avoid libev
445	unblocking the signals.	451	unblocking the signals.
		452
		453	It's also required by POSIX in a threaded program, as libev calls
		454	C<sigprocmask>, whose behaviour is officially unspecified.
446		455
447	This flag's behaviour will become the default in future versions of libev.	456	This flag's behaviour will become the default in future versions of libev.
448		457
449	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	458	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
450		459
…		…
480	=item C<EVBACKEND_EPOLL> (value 4, Linux)	489	=item C<EVBACKEND_EPOLL> (value 4, Linux)
481		490
482	Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9	491	Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
483	kernels).	492	kernels).
484		493
485	For few fds, this backend is a bit little slower than poll and select,	494	For few fds, this backend is a bit little slower than poll and select, but
486	but it scales phenomenally better. While poll and select usually scale	495	it scales phenomenally better. While poll and select usually scale like
487	like O(total_fds) where n is the total number of fds (or the highest fd),	496	O(total_fds) where total_fds is the total number of fds (or the highest
488	epoll scales either O(1) or O(active_fds).	497	fd), epoll scales either O(1) or O(active_fds).
489		498
490	The epoll mechanism deserves honorable mention as the most misdesigned	499	The epoll mechanism deserves honorable mention as the most misdesigned
491	of the more advanced event mechanisms: mere annoyances include silently	500	of the more advanced event mechanisms: mere annoyances include silently
492	dropping file descriptors, requiring a system call per change per file	501	dropping file descriptors, requiring a system call per change per file
493	descriptor (and unnecessary guessing of parameters), problems with dup,	502	descriptor (and unnecessary guessing of parameters), problems with dup,
…		…
496	0.1ms) and so on. The biggest issue is fork races, however - if a program	505	0.1ms) and so on. The biggest issue is fork races, however - if a program
497	forks then I<both> parent and child process have to recreate the epoll	506	forks then I<both> parent and child process have to recreate the epoll
498	set, which can take considerable time (one syscall per file descriptor)	507	set, which can take considerable time (one syscall per file descriptor)
499	and is of course hard to detect.	508	and is of course hard to detect.
500		509
501	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	510	Epoll is also notoriously buggy - embedding epoll fds I<should> work,
502	of course I<doesn't>, and epoll just loves to report events for totally	511	but of course I<doesn't>, and epoll just loves to report events for
503	I<different> file descriptors (even already closed ones, so one cannot	512	totally I<different> file descriptors (even already closed ones, so
504	even remove them from the set) than registered in the set (especially	513	one cannot even remove them from the set) than registered in the set
505	on SMP systems). Libev tries to counter these spurious notifications by	514	(especially on SMP systems). Libev tries to counter these spurious
506	employing an additional generation counter and comparing that against the	515	notifications by employing an additional generation counter and comparing
507	events to filter out spurious ones, recreating the set when required. Last	516	that against the events to filter out spurious ones, recreating the set
		517	when required. Epoll also erroneously rounds down timeouts, but gives you
		518	no way to know when and by how much, so sometimes you have to busy-wait
		519	because epoll returns immediately despite a nonzero timeout. And last
508	not least, it also refuses to work with some file descriptors which work	520	not least, it also refuses to work with some file descriptors which work
509	perfectly fine with C<select> (files, many character devices...).	521	perfectly fine with C<select> (files, many character devices...).
510		522
511	Epoll is truly the train wreck analog among event poll mechanisms.	523	Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
		524	cobbled together in a hurry, no thought to design or interaction with
		525	others. Oh, the pain, will it ever stop...
512		526
513	While stopping, setting and starting an I/O watcher in the same iteration	527	While stopping, setting and starting an I/O watcher in the same iteration
514	will result in some caching, there is still a system call per such	528	will result in some caching, there is still a system call per such
515	incident (because the same I<file descriptor> could point to a different	529	incident (because the same I<file descriptor> could point to a different
516	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed	530	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
…		…
553		567
554	It scales in the same way as the epoll backend, but the interface to the	568	It scales in the same way as the epoll backend, but the interface to the
555	kernel is more efficient (which says nothing about its actual speed, of	569	kernel is more efficient (which says nothing about its actual speed, of
556	course). While stopping, setting and starting an I/O watcher does never	570	course). While stopping, setting and starting an I/O watcher does never
557	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to	571	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
558	two event changes per incident. Support for C<fork ()> is very bad (but	572	two event changes per incident. Support for C<fork ()> is very bad (you
559	sane, unlike epoll) and it drops fds silently in similarly hard-to-detect	573	might have to leak fd's on fork, but it's more sane than epoll) and it
560	cases	574	drops fds silently in similarly hard-to-detect cases
561		575
562	This backend usually performs well under most conditions.	576	This backend usually performs well under most conditions.
563		577
564	While nominally embeddable in other event loops, this doesn't work	578	While nominally embeddable in other event loops, this doesn't work
565	everywhere, so you might need to test for this. And since it is broken	579	everywhere, so you might need to test for this. And since it is broken
…		…
592	On the positive side, this backend actually performed fully to	606	On the positive side, this backend actually performed fully to
593	specification in all tests and is fully embeddable, which is a rare feat	607	specification in all tests and is fully embeddable, which is a rare feat
594	among the OS-specific backends (I vastly prefer correctness over speed	608	among the OS-specific backends (I vastly prefer correctness over speed
595	hacks).	609	hacks).
596		610
597	On the negative side, the interface is I<bizarre>, with the event polling	611	On the negative side, the interface is I<bizarre> - so bizarre that
		612	even sun itself gets it wrong in their code examples: The event polling
598	function sometimes returning events to the caller even though an error	613	function sometimes returns events to the caller even though an error
599	occured, but with no indication whether it has done so or not (yes, it's	614	occurred, but with no indication whether it has done so or not (yes, it's
600	even documented that way) - deadly for edge-triggered interfaces, but	615	even documented that way) - deadly for edge-triggered interfaces where you
		616	absolutely have to know whether an event occurred or not because you have
		617	to re-arm the watcher.
		618
601	fortunately libev seems to be able to work around it.	619	Fortunately libev seems to be able to work around these idiocies.
602		620
603	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	621	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
604	C<EVBACKEND_POLL>.	622	C<EVBACKEND_POLL>.
605		623
606	=item C<EVBACKEND_ALL>	624	=item C<EVBACKEND_ALL>
…		…
774	without a previous call to C<ev_suspend>.	792	without a previous call to C<ev_suspend>.
775		793
776	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the	794	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
777	event loop time (see C<ev_now_update>).	795	event loop time (see C<ev_now_update>).
778		796
779	=item ev_run (loop, int flags)	797	=item bool ev_run (loop, int flags)
780		798
781	Finally, this is it, the event handler. This function usually is called	799	Finally, this is it, the event handler. This function usually is called
782	after you have initialised all your watchers and you want to start	800	after you have initialised all your watchers and you want to start
783	handling events. It will ask the operating system for any new events, call	801	handling events. It will ask the operating system for any new events, call
784	the watcher callbacks, an then repeat the whole process indefinitely: This	802	the watcher callbacks, and then repeat the whole process indefinitely: This
785	is why event loops are called I<loops>.	803	is why event loops are called I<loops>.
786		804
787	If the flags argument is specified as C<0>, it will keep handling events	805	If the flags argument is specified as C<0>, it will keep handling events
788	until either no event watchers are active anymore or C<ev_break> was	806	until either no event watchers are active anymore or C<ev_break> was
789	called.	807	called.
		808
		809	The return value is false if there are no more active watchers (which
		810	usually means "all jobs done" or "deadlock"), and true in all other cases
		811	(which usually means " you should call C<ev_run> again").
790		812
791	Please note that an explicit C<ev_break> is usually better than	813	Please note that an explicit C<ev_break> is usually better than
792	relying on all watchers to be stopped when deciding when a program has	814	relying on all watchers to be stopped when deciding when a program has
793	finished (especially in interactive programs), but having a program	815	finished (especially in interactive programs), but having a program
794	that automatically loops as long as it has to and no longer by virtue	816	that automatically loops as long as it has to and no longer by virtue
795	of relying on its watchers stopping correctly, that is truly a thing of	817	of relying on its watchers stopping correctly, that is truly a thing of
796	beauty.	818	beauty.
797		819
798	This function is also I<mostly> exception-safe - you can break out of	820	This function is I<mostly> exception-safe - you can break out of a
799	a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++	821	C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
800	exception and so on. This does not decrement the C<ev_depth> value, nor	822	exception and so on. This does not decrement the C<ev_depth> value, nor
801	will it clear any outstanding C<EVBREAK_ONE> breaks.	823	will it clear any outstanding C<EVBREAK_ONE> breaks.
802		824
803	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle	825	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
804	those events and any already outstanding ones, but will not wait and	826	those events and any already outstanding ones, but will not wait and
…		…
816	This is useful if you are waiting for some external event in conjunction	838	This is useful if you are waiting for some external event in conjunction
817	with something not expressible using other libev watchers (i.e. "roll your	839	with something not expressible using other libev watchers (i.e. "roll your
818	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is	840	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
819	usually a better approach for this kind of thing.	841	usually a better approach for this kind of thing.
820		842
821	Here are the gory details of what C<ev_run> does:	843	Here are the gory details of what C<ev_run> does (this is for your
		844	understanding, not a guarantee that things will work exactly like this in
		845	future versions):
822		846
823	- Increment loop depth.	847	- Increment loop depth.
824	- Reset the ev_break status.	848	- Reset the ev_break status.
825	- Before the first iteration, call any pending watchers.	849	- Before the first iteration, call any pending watchers.
826	LOOP:	850	LOOP:
…		…
859	anymore.	883	anymore.
860		884
861	... queue jobs here, make sure they register event watchers as long	885	... queue jobs here, make sure they register event watchers as long
862	... as they still have work to do (even an idle watcher will do..)	886	... as they still have work to do (even an idle watcher will do..)
863	ev_run (my_loop, 0);	887	ev_run (my_loop, 0);
864	... jobs done or somebody called unloop. yeah!	888	... jobs done or somebody called break. yeah!
865		889
866	=item ev_break (loop, how)	890	=item ev_break (loop, how)
867		891
868	Can be used to make a call to C<ev_run> return early (but only after it	892	Can be used to make a call to C<ev_run> return early (but only after it
869	has processed all outstanding events). The C<how> argument must be either	893	has processed all outstanding events). The C<how> argument must be either
…		…
932	overhead for the actual polling but can deliver many events at once.	956	overhead for the actual polling but can deliver many events at once.
933		957
934	By setting a higher I<io collect interval> you allow libev to spend more	958	By setting a higher I<io collect interval> you allow libev to spend more
935	time collecting I/O events, so you can handle more events per iteration,	959	time collecting I/O events, so you can handle more events per iteration,
936	at the cost of increasing latency. Timeouts (both C<ev_periodic> and	960	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
937	C<ev_timer>) will be not affected. Setting this to a non-null value will	961	C<ev_timer>) will not be affected. Setting this to a non-null value will
938	introduce an additional C<ev_sleep ()> call into most loop iterations. The	962	introduce an additional C<ev_sleep ()> call into most loop iterations. The
939	sleep time ensures that libev will not poll for I/O events more often then	963	sleep time ensures that libev will not poll for I/O events more often then
940	once per this interval, on average.	964	once per this interval, on average (as long as the host time resolution is
		965	good enough).
941		966
942	Likewise, by setting a higher I<timeout collect interval> you allow libev	967	Likewise, by setting a higher I<timeout collect interval> you allow libev
943	to spend more time collecting timeouts, at the expense of increased	968	to spend more time collecting timeouts, at the expense of increased
944	latency/jitter/inexactness (the watcher callback will be called	969	latency/jitter/inexactness (the watcher callback will be called
945	later). C<ev_io> watchers will not be affected. Setting this to a non-null	970	later). C<ev_io> watchers will not be affected. Setting this to a non-null
…		…
991	invoke the actual watchers inside another context (another thread etc.).	1016	invoke the actual watchers inside another context (another thread etc.).
992		1017
993	If you want to reset the callback, use C<ev_invoke_pending> as new	1018	If you want to reset the callback, use C<ev_invoke_pending> as new
994	callback.	1019	callback.
995		1020
996	=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))	1021	=item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())
997		1022
998	Sometimes you want to share the same loop between multiple threads. This	1023	Sometimes you want to share the same loop between multiple threads. This
999	can be done relatively simply by putting mutex_lock/unlock calls around	1024	can be done relatively simply by putting mutex_lock/unlock calls around
1000	each call to a libev function.	1025	each call to a libev function.
1001		1026
1002	However, C<ev_run> can run an indefinite time, so it is not feasible	1027	However, C<ev_run> can run an indefinite time, so it is not feasible
1003	to wait for it to return. One way around this is to wake up the event	1028	to wait for it to return. One way around this is to wake up the event
1004	loop via C<ev_break> and C<av_async_send>, another way is to set these	1029	loop via C<ev_break> and C<ev_async_send>, another way is to set these
1005	I<release> and I<acquire> callbacks on the loop.	1030	I<release> and I<acquire> callbacks on the loop.
1006		1031
1007	When set, then C<release> will be called just before the thread is	1032	When set, then C<release> will be called just before the thread is
1008	suspended waiting for new events, and C<acquire> is called just	1033	suspended waiting for new events, and C<acquire> is called just
1009	afterwards.	1034	afterwards.
…		…
1351	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related	1376	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1352	functions that do not need a watcher.	1377	functions that do not need a watcher.
1353		1378
1354	=back	1379	=back
1355		1380
1356	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1381	See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
1357		1382	OWN COMPOSITE WATCHERS> idioms.
1358	Each watcher has, by default, a member C<void *data> that you can change
1359	and read at any time: libev will completely ignore it. This can be used
1360	to associate arbitrary data with your watcher. If you need more data and
1361	don't want to allocate memory and store a pointer to it in that data
1362	member, you can also "subclass" the watcher type and provide your own
1363	data:
1364
1365	struct my_io
1366	{
1367	ev_io io;
1368	int otherfd;
1369	void *somedata;
1370	struct whatever *mostinteresting;
1371	};
1372
1373	...
1374	struct my_io w;
1375	ev_io_init (&w.io, my_cb, fd, EV_READ);
1376
1377	And since your callback will be called with a pointer to the watcher, you
1378	can cast it back to your own type:
1379
1380	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
1381	{
1382	struct my_io *w = (struct my_io *)w_;
1383	...
1384	}
1385
1386	More interesting and less C-conformant ways of casting your callback type
1387	instead have been omitted.
1388
1389	Another common scenario is to use some data structure with multiple
1390	embedded watchers:
1391
1392	struct my_biggy
1393	{
1394	int some_data;
1395	ev_timer t1;
1396	ev_timer t2;
1397	}
1398
1399	In this case getting the pointer to C<my_biggy> is a bit more
1400	complicated: Either you store the address of your C<my_biggy> struct
1401	in the C<data> member of the watcher (for woozies), or you need to use
1402	some pointer arithmetic using C<offsetof> inside your watchers (for real
1403	programmers):
1404
1405	#include <stddef.h>
1406
1407	static void
1408	t1_cb (EV_P_ ev_timer *w, int revents)
1409	{
1410	struct my_biggy big = (struct my_biggy *)
1411	(((char *)w) - offsetof (struct my_biggy, t1));
1412	}
1413
1414	static void
1415	t2_cb (EV_P_ ev_timer *w, int revents)
1416	{
1417	struct my_biggy big = (struct my_biggy *)
1418	(((char *)w) - offsetof (struct my_biggy, t2));
1419	}
1420		1383
1421	=head2 WATCHER STATES	1384	=head2 WATCHER STATES
1422		1385
1423	There are various watcher states mentioned throughout this manual -	1386	There are various watcher states mentioned throughout this manual -
1424	active, pending and so on. In this section these states and the rules to	1387	active, pending and so on. In this section these states and the rules to
…		…
1427		1390
1428	=over 4	1391	=over 4
1429		1392
1430	=item initialiased	1393	=item initialiased
1431		1394
1432	Before a watcher can be registered with the event looop it has to be	1395	Before a watcher can be registered with the event loop it has to be
1433	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to	1396	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1434	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.	1397	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1435		1398
1436	In this state it is simply some block of memory that is suitable for use	1399	In this state it is simply some block of memory that is suitable for
1437	in an event loop. It can be moved around, freed, reused etc. at will.	1400	use in an event loop. It can be moved around, freed, reused etc. at
		1401	will - as long as you either keep the memory contents intact, or call
		1402	C<ev_TYPE_init> again.
1438		1403
1439	=item started/running/active	1404	=item started/running/active
1440		1405
1441	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes	1406	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1442	property of the event loop, and is actively waiting for events. While in	1407	property of the event loop, and is actively waiting for events. While in
…		…
1470	latter will clear any pending state the watcher might be in, regardless	1435	latter will clear any pending state the watcher might be in, regardless
1471	of whether it was active or not, so stopping a watcher explicitly before	1436	of whether it was active or not, so stopping a watcher explicitly before
1472	freeing it is often a good idea.	1437	freeing it is often a good idea.
1473		1438
1474	While stopped (and not pending) the watcher is essentially in the	1439	While stopped (and not pending) the watcher is essentially in the
1475	initialised state, that is it can be reused, moved, modified in any way	1440	initialised state, that is, it can be reused, moved, modified in any way
1476	you wish.	1441	you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
		1442	it again).
1477		1443
1478	=back	1444	=back
1479		1445
1480	=head2 WATCHER PRIORITY MODELS	1446	=head2 WATCHER PRIORITY MODELS
1481		1447
…		…
1610	In general you can register as many read and/or write event watchers per	1576	In general you can register as many read and/or write event watchers per
1611	fd as you want (as long as you don't confuse yourself). Setting all file	1577	fd as you want (as long as you don't confuse yourself). Setting all file
1612	descriptors to non-blocking mode is also usually a good idea (but not	1578	descriptors to non-blocking mode is also usually a good idea (but not
1613	required if you know what you are doing).	1579	required if you know what you are doing).
1614		1580
1615	If you cannot use non-blocking mode, then force the use of a
1616	known-to-be-good backend (at the time of this writing, this includes only
1617	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1618	descriptors for which non-blocking operation makes no sense (such as
1619	files) - libev doesn't guarantee any specific behaviour in that case.
1620
1621	Another thing you have to watch out for is that it is quite easy to	1581	Another thing you have to watch out for is that it is quite easy to
1622	receive "spurious" readiness notifications, that is your callback might	1582	receive "spurious" readiness notifications, that is, your callback might
1623	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1583	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1624	because there is no data. Not only are some backends known to create a	1584	because there is no data. It is very easy to get into this situation even
1625	lot of those (for example Solaris ports), it is very easy to get into	1585	with a relatively standard program structure. Thus it is best to always
1626	this situation even with a relatively standard program structure. Thus	1586	use non-blocking I/O: An extra C<read>(2) returning C<EAGAIN> is far
1627	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1628	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1587	preferable to a program hanging until some data arrives.
1629		1588
1630	If you cannot run the fd in non-blocking mode (for example you should	1589	If you cannot run the fd in non-blocking mode (for example you should
1631	not play around with an Xlib connection), then you have to separately	1590	not play around with an Xlib connection), then you have to separately
1632	re-test whether a file descriptor is really ready with a known-to-be good	1591	re-test whether a file descriptor is really ready with a known-to-be good
1633	interface such as poll (fortunately in our Xlib example, Xlib already	1592	interface such as poll (fortunately in the case of Xlib, it already does
1634	does this on its own, so its quite safe to use). Some people additionally	1593	this on its own, so its quite safe to use). Some people additionally
1635	use C<SIGALRM> and an interval timer, just to be sure you won't block	1594	use C<SIGALRM> and an interval timer, just to be sure you won't block
1636	indefinitely.	1595	indefinitely.
1637		1596
1638	But really, best use non-blocking mode.	1597	But really, best use non-blocking mode.
1639		1598
…		…
1667		1626
1668	There is no workaround possible except not registering events	1627	There is no workaround possible except not registering events
1669	for potentially C<dup ()>'ed file descriptors, or to resort to	1628	for potentially C<dup ()>'ed file descriptors, or to resort to
1670	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1629	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1671		1630
		1631	=head3 The special problem of files
		1632
		1633	Many people try to use C<select> (or libev) on file descriptors
		1634	representing files, and expect it to become ready when their program
		1635	doesn't block on disk accesses (which can take a long time on their own).
		1636
		1637	However, this cannot ever work in the "expected" way - you get a readiness
		1638	notification as soon as the kernel knows whether and how much data is
		1639	there, and in the case of open files, that's always the case, so you
		1640	always get a readiness notification instantly, and your read (or possibly
		1641	write) will still block on the disk I/O.
		1642
		1643	Another way to view it is that in the case of sockets, pipes, character
		1644	devices and so on, there is another party (the sender) that delivers data
		1645	on its own, but in the case of files, there is no such thing: the disk
		1646	will not send data on its own, simply because it doesn't know what you
		1647	wish to read - you would first have to request some data.
		1648
		1649	Since files are typically not-so-well supported by advanced notification
		1650	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1651	to files, even though you should not use it. The reason for this is
		1652	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1653	usually a tty, often a pipe, but also sometimes files or special devices
		1654	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1655	F</dev/urandom>), and even though the file might better be served with
		1656	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1657	it "just works" instead of freezing.
		1658
		1659	So avoid file descriptors pointing to files when you know it (e.g. use
		1660	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1661	when you rarely read from a file instead of from a socket, and want to
		1662	reuse the same code path.
		1663
1672	=head3 The special problem of fork	1664	=head3 The special problem of fork
1673		1665
1674	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1666	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1675	useless behaviour. Libev fully supports fork, but needs to be told about	1667	useless behaviour. Libev fully supports fork, but needs to be told about
1676	it in the child.	1668	it in the child if you want to continue to use it in the child.
1677		1669
1678	To support fork in your programs, you either have to call	1670	To support fork in your child processes, you have to call C<ev_loop_fork
1679	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1671	()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1680	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1672	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1681	C<EVBACKEND_POLL>.
1682		1673
1683	=head3 The special problem of SIGPIPE	1674	=head3 The special problem of SIGPIPE
1684		1675
1685	While not really specific to libev, it is easy to forget about C<SIGPIPE>:	1676	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1686	when writing to a pipe whose other end has been closed, your program gets	1677	when writing to a pipe whose other end has been closed, your program gets
…		…
1784	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1775	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1785	monotonic clock option helps a lot here).	1776	monotonic clock option helps a lot here).
1786		1777
1787	The callback is guaranteed to be invoked only I<after> its timeout has	1778	The callback is guaranteed to be invoked only I<after> its timeout has
1788	passed (not I<at>, so on systems with very low-resolution clocks this	1779	passed (not I<at>, so on systems with very low-resolution clocks this
1789	might introduce a small delay). If multiple timers become ready during the	1780	might introduce a small delay, see "the special problem of being too
		1781	early", below). If multiple timers become ready during the same loop
1790	same loop iteration then the ones with earlier time-out values are invoked	1782	iteration then the ones with earlier time-out values are invoked before
1791	before ones of the same priority with later time-out values (but this is	1783	ones of the same priority with later time-out values (but this is no
1792	no longer true when a callback calls C<ev_run> recursively).	1784	longer true when a callback calls C<ev_run> recursively).
1793		1785
1794	=head3 Be smart about timeouts	1786	=head3 Be smart about timeouts
1795		1787
1796	Many real-world problems involve some kind of timeout, usually for error	1788	Many real-world problems involve some kind of timeout, usually for error
1797	recovery. A typical example is an HTTP request - if the other side hangs,	1789	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1872		1864
1873	In this case, it would be more efficient to leave the C<ev_timer> alone,	1865	In this case, it would be more efficient to leave the C<ev_timer> alone,
1874	but remember the time of last activity, and check for a real timeout only	1866	but remember the time of last activity, and check for a real timeout only
1875	within the callback:	1867	within the callback:
1876		1868
		1869	ev_tstamp timeout = 60.;
1877	ev_tstamp last_activity; // time of last activity	1870	ev_tstamp last_activity; // time of last activity
		1871	ev_timer timer;
1878		1872
1879	static void	1873	static void
1880	callback (EV_P_ ev_timer *w, int revents)	1874	callback (EV_P_ ev_timer *w, int revents)
1881	{	1875	{
1882	ev_tstamp now = ev_now (EV_A);	1876	// calculate when the timeout would happen
1883	ev_tstamp timeout = last_activity + 60.;	1877	ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1884		1878
1885	// if last_activity + 60. is older than now, we did time out	1879	// if negative, it means we the timeout already occurred
1886	if (timeout < now)	1880	if (after < 0.)
1887	{	1881	{
1888	// timeout occurred, take action	1882	// timeout occurred, take action
1889	}	1883	}
1890	else	1884	else
1891	{	1885	{
1892	// callback was invoked, but there was some activity, re-arm	1886	// callback was invoked, but there was some recent
1893	// the watcher to fire in last_activity + 60, which is	1887	// activity. simply restart the timer to time out
1894	// guaranteed to be in the future, so "again" is positive:	1888	// after "after" seconds, which is the earliest time
1895	w->repeat = timeout - now;	1889	// the timeout can occur.
		1890	ev_timer_set (w, after, 0.);
1896	ev_timer_again (EV_A_ w);	1891	ev_timer_start (EV_A_ w);
1897	}	1892	}
1898	}	1893	}
1899		1894
1900	To summarise the callback: first calculate the real timeout (defined	1895	To summarise the callback: first calculate in how many seconds the
1901	as "60 seconds after the last activity"), then check if that time has	1896	timeout will occur (by calculating the absolute time when it would occur,
1902	been reached, which means something I<did>, in fact, time out. Otherwise	1897	C<last_activity + timeout>, and subtracting the current time, C<ev_now
1903	the callback was invoked too early (C<timeout> is in the future), so	1898	(EV_A)> from that).
1904	re-schedule the timer to fire at that future time, to see if maybe we have
1905	a timeout then.
1906		1899
1907	Note how C<ev_timer_again> is used, taking advantage of the	1900	If this value is negative, then we are already past the timeout, i.e. we
1908	C<ev_timer_again> optimisation when the timer is already running.	1901	timed out, and need to do whatever is needed in this case.
		1902
		1903	Otherwise, we now the earliest time at which the timeout would trigger,
		1904	and simply start the timer with this timeout value.
		1905
		1906	In other words, each time the callback is invoked it will check whether
		1907	the timeout occurred. If not, it will simply reschedule itself to check
		1908	again at the earliest time it could time out. Rinse. Repeat.
1909		1909
1910	This scheme causes more callback invocations (about one every 60 seconds	1910	This scheme causes more callback invocations (about one every 60 seconds
1911	minus half the average time between activity), but virtually no calls to	1911	minus half the average time between activity), but virtually no calls to
1912	libev to change the timeout.	1912	libev to change the timeout.
1913		1913
1914	To start the timer, simply initialise the watcher and set C<last_activity>	1914	To start the machinery, simply initialise the watcher and set
1915	to the current time (meaning we just have some activity :), then call the	1915	C<last_activity> to the current time (meaning there was some activity just
1916	callback, which will "do the right thing" and start the timer:	1916	now), then call the callback, which will "do the right thing" and start
		1917	the timer:
1917		1918
		1919	last_activity = ev_now (EV_A);
1918	ev_init (timer, callback);	1920	ev_init (&timer, callback);
1919	last_activity = ev_now (loop);	1921	callback (EV_A_ &timer, 0);
1920	callback (loop, timer, EV_TIMER);
1921		1922
1922	And when there is some activity, simply store the current time in	1923	When there is some activity, simply store the current time in
1923	C<last_activity>, no libev calls at all:	1924	C<last_activity>, no libev calls at all:
1924		1925
		1926	if (activity detected)
1925	last_activity = ev_now (loop);	1927	last_activity = ev_now (EV_A);
		1928
		1929	When your timeout value changes, then the timeout can be changed by simply
		1930	providing a new value, stopping the timer and calling the callback, which
		1931	will again do the right thing (for example, time out immediately :).
		1932
		1933	timeout = new_value;
		1934	ev_timer_stop (EV_A_ &timer);
		1935	callback (EV_A_ &timer, 0);
1926		1936
1927	This technique is slightly more complex, but in most cases where the	1937	This technique is slightly more complex, but in most cases where the
1928	time-out is unlikely to be triggered, much more efficient.	1938	time-out is unlikely to be triggered, much more efficient.
1929
1930	Changing the timeout is trivial as well (if it isn't hard-coded in the
1931	callback :) - just change the timeout and invoke the callback, which will
1932	fix things for you.
1933		1939
1934	=item 4. Wee, just use a double-linked list for your timeouts.	1940	=item 4. Wee, just use a double-linked list for your timeouts.
1935		1941
1936	If there is not one request, but many thousands (millions...), all	1942	If there is not one request, but many thousands (millions...), all
1937	employing some kind of timeout with the same timeout value, then one can	1943	employing some kind of timeout with the same timeout value, then one can
…		…
1964	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is	1970	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1965	rather complicated, but extremely efficient, something that really pays	1971	rather complicated, but extremely efficient, something that really pays
1966	off after the first million or so of active timers, i.e. it's usually	1972	off after the first million or so of active timers, i.e. it's usually
1967	overkill :)	1973	overkill :)
1968		1974
		1975	=head3 The special problem of being too early
		1976
		1977	If you ask a timer to call your callback after three seconds, then
		1978	you expect it to be invoked after three seconds - but of course, this
		1979	cannot be guaranteed to infinite precision. Less obviously, it cannot be
		1980	guaranteed to any precision by libev - imagine somebody suspending the
		1981	process with a STOP signal for a few hours for example.
		1982
		1983	So, libev tries to invoke your callback as soon as possible I<after> the
		1984	delay has occurred, but cannot guarantee this.
		1985
		1986	A less obvious failure mode is calling your callback too early: many event
		1987	loops compare timestamps with a "elapsed delay >= requested delay", but
		1988	this can cause your callback to be invoked much earlier than you would
		1989	expect.
		1990
		1991	To see why, imagine a system with a clock that only offers full second
		1992	resolution (think windows if you can't come up with a broken enough OS
		1993	yourself). If you schedule a one-second timer at the time 500.9, then the
		1994	event loop will schedule your timeout to elapse at a system time of 500
		1995	(500.9 truncated to the resolution) + 1, or 501.
		1996
		1997	If an event library looks at the timeout 0.1s later, it will see "501 >=
		1998	501" and invoke the callback 0.1s after it was started, even though a
		1999	one-second delay was requested - this is being "too early", despite best
		2000	intentions.
		2001
		2002	This is the reason why libev will never invoke the callback if the elapsed
		2003	delay equals the requested delay, but only when the elapsed delay is
		2004	larger than the requested delay. In the example above, libev would only invoke
		2005	the callback at system time 502, or 1.1s after the timer was started.
		2006
		2007	So, while libev cannot guarantee that your callback will be invoked
		2008	exactly when requested, it I<can> and I<does> guarantee that the requested
		2009	delay has actually elapsed, or in other words, it always errs on the "too
		2010	late" side of things.
		2011
1969	=head3 The special problem of time updates	2012	=head3 The special problem of time updates
1970		2013
1971	Establishing the current time is a costly operation (it usually takes at	2014	Establishing the current time is a costly operation (it usually takes
1972	least two system calls): EV therefore updates its idea of the current	2015	at least one system call): EV therefore updates its idea of the current
1973	time only before and after C<ev_run> collects new events, which causes a	2016	time only before and after C<ev_run> collects new events, which causes a
1974	growing difference between C<ev_now ()> and C<ev_time ()> when handling	2017	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1975	lots of events in one iteration.	2018	lots of events in one iteration.
1976		2019
1977	The relative timeouts are calculated relative to the C<ev_now ()>	2020	The relative timeouts are calculated relative to the C<ev_now ()>
…		…
1983	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	2026	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1984		2027
1985	If the event loop is suspended for a long time, you can also force an	2028	If the event loop is suspended for a long time, you can also force an
1986	update of the time returned by C<ev_now ()> by calling C<ev_now_update	2029	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1987	()>.	2030	()>.
		2031
		2032	=head3 The special problem of unsynchronised clocks
		2033
		2034	Modern systems have a variety of clocks - libev itself uses the normal
		2035	"wall clock" clock and, if available, the monotonic clock (to avoid time
		2036	jumps).
		2037
		2038	Neither of these clocks is synchronised with each other or any other clock
		2039	on the system, so C<ev_time ()> might return a considerably different time
		2040	than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
		2041	a call to C<gettimeofday> might return a second count that is one higher
		2042	than a directly following call to C<time>.
		2043
		2044	The moral of this is to only compare libev-related timestamps with
		2045	C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
		2046	a second or so.
		2047
		2048	One more problem arises due to this lack of synchronisation: if libev uses
		2049	the system monotonic clock and you compare timestamps from C<ev_time>
		2050	or C<ev_now> from when you started your timer and when your callback is
		2051	invoked, you will find that sometimes the callback is a bit "early".
		2052
		2053	This is because C<ev_timer>s work in real time, not wall clock time, so
		2054	libev makes sure your callback is not invoked before the delay happened,
		2055	I<measured according to the real time>, not the system clock.
		2056
		2057	If your timeouts are based on a physical timescale (e.g. "time out this
		2058	connection after 100 seconds") then this shouldn't bother you as it is
		2059	exactly the right behaviour.
		2060
		2061	If you want to compare wall clock/system timestamps to your timers, then
		2062	you need to use C<ev_periodic>s, as these are based on the wall clock
		2063	time, where your comparisons will always generate correct results.
1988		2064
1989	=head3 The special problems of suspended animation	2065	=head3 The special problems of suspended animation
1990		2066
1991	When you leave the server world it is quite customary to hit machines that	2067	When you leave the server world it is quite customary to hit machines that
1992	can suspend/hibernate - what happens to the clocks during such a suspend?	2068	can suspend/hibernate - what happens to the clocks during such a suspend?
…		…
2036	keep up with the timer (because it takes longer than those 10 seconds to	2112	keep up with the timer (because it takes longer than those 10 seconds to
2037	do stuff) the timer will not fire more than once per event loop iteration.	2113	do stuff) the timer will not fire more than once per event loop iteration.
2038		2114
2039	=item ev_timer_again (loop, ev_timer *)	2115	=item ev_timer_again (loop, ev_timer *)
2040		2116
2041	This will act as if the timer timed out and restart it again if it is	2117	This will act as if the timer timed out, and restarts it again if it is
2042	repeating. The exact semantics are:	2118	repeating. It basically works like calling C<ev_timer_stop>, updating the
		2119	timeout to the C<repeat> value and calling C<ev_timer_start>.
2043		2120
		2121	The exact semantics are as in the following rules, all of which will be
		2122	applied to the watcher:
		2123
		2124	=over 4
		2125
2044	If the timer is pending, its pending status is cleared.	2126	=item If the timer is pending, the pending status is always cleared.
2045		2127
2046	If the timer is started but non-repeating, stop it (as if it timed out).	2128	=item If the timer is started but non-repeating, stop it (as if it timed
		2129	out, without invoking it).
2047		2130
2048	If the timer is repeating, either start it if necessary (with the	2131	=item If the timer is repeating, make the C<repeat> value the new timeout
2049	C<repeat> value), or reset the running timer to the C<repeat> value.	2132	and start the timer, if necessary.
		2133
		2134	=back
2050		2135
2051	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a	2136	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
2052	usage example.	2137	usage example.
2053		2138
2054	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)	2139	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
…		…
2176		2261
2177	Another way to think about it (for the mathematically inclined) is that	2262	Another way to think about it (for the mathematically inclined) is that
2178	C<ev_periodic> will try to run the callback in this mode at the next possible	2263	C<ev_periodic> will try to run the callback in this mode at the next possible
2179	time where C<time = offset (mod interval)>, regardless of any time jumps.	2264	time where C<time = offset (mod interval)>, regardless of any time jumps.
2180		2265
2181	For numerical stability it is preferable that the C<offset> value is near	2266	The C<interval> I<MUST> be positive, and for numerical stability, the
2182	C<ev_now ()> (the current time), but there is no range requirement for	2267	interval value should be higher than C<1/8192> (which is around 100
2183	this value, and in fact is often specified as zero.	2268	microseconds) and C<offset> should be higher than C<0> and should have
		2269	at most a similar magnitude as the current time (say, within a factor of
		2270	ten). Typical values for offset are, in fact, C<0> or something between
		2271	C<0> and C<interval>, which is also the recommended range.
2184		2272
2185	Note also that there is an upper limit to how often a timer can fire (CPU	2273	Note also that there is an upper limit to how often a timer can fire (CPU
2186	speed for example), so if C<interval> is very small then timing stability	2274	speed for example), so if C<interval> is very small then timing stability
2187	will of course deteriorate. Libev itself tries to be exact to be about one	2275	will of course deteriorate. Libev itself tries to be exact to be about one
2188	millisecond (if the OS supports it and the machine is fast enough).	2276	millisecond (if the OS supports it and the machine is fast enough).
…		…
2331	=head3 The special problem of inheritance over fork/execve/pthread_create	2419	=head3 The special problem of inheritance over fork/execve/pthread_create
2332		2420
2333	Both the signal mask (C<sigprocmask>) and the signal disposition	2421	Both the signal mask (C<sigprocmask>) and the signal disposition
2334	(C<sigaction>) are unspecified after starting a signal watcher (and after	2422	(C<sigaction>) are unspecified after starting a signal watcher (and after
2335	stopping it again), that is, libev might or might not block the signal,	2423	stopping it again), that is, libev might or might not block the signal,
2336	and might or might not set or restore the installed signal handler.	2424	and might or might not set or restore the installed signal handler (but
		2425	see C<EVFLAG_NOSIGMASK>).
2337		2426
2338	While this does not matter for the signal disposition (libev never	2427	While this does not matter for the signal disposition (libev never
2339	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on	2428	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2340	C<execve>), this matters for the signal mask: many programs do not expect	2429	C<execve>), this matters for the signal mask: many programs do not expect
2341	certain signals to be blocked.	2430	certain signals to be blocked.
…		…
3212	atexit (program_exits);	3301	atexit (program_exits);
3213		3302
3214		3303
3215	=head2 C<ev_async> - how to wake up an event loop	3304	=head2 C<ev_async> - how to wake up an event loop
3216		3305
3217	In general, you cannot use an C<ev_run> from multiple threads or other	3306	In general, you cannot use an C<ev_loop> from multiple threads or other
3218	asynchronous sources such as signal handlers (as opposed to multiple event	3307	asynchronous sources such as signal handlers (as opposed to multiple event
3219	loops - those are of course safe to use in different threads).	3308	loops - those are of course safe to use in different threads).
3220		3309
3221	Sometimes, however, you need to wake up an event loop you do not control,	3310	Sometimes, however, you need to wake up an event loop you do not control,
3222	for example because it belongs to another thread. This is what C<ev_async>	3311	for example because it belongs to another thread. This is what C<ev_async>
…		…
3229	C<ev_async_sent> calls). In fact, you could use signal watchers as a kind	3318	C<ev_async_sent> calls). In fact, you could use signal watchers as a kind
3230	of "global async watchers" by using a watcher on an otherwise unused	3319	of "global async watchers" by using a watcher on an otherwise unused
3231	signal, and C<ev_feed_signal> to signal this watcher from another thread,	3320	signal, and C<ev_feed_signal> to signal this watcher from another thread,
3232	even without knowing which loop owns the signal.	3321	even without knowing which loop owns the signal.
3233		3322
3234	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
3235	just the default loop.
3236
3237	=head3 Queueing	3323	=head3 Queueing
3238		3324
3239	C<ev_async> does not support queueing of data in any way. The reason	3325	C<ev_async> does not support queueing of data in any way. The reason
3240	is that the author does not know of a simple (or any) algorithm for a	3326	is that the author does not know of a simple (or any) algorithm for a
3241	multiple-writer-single-reader queue that works in all cases and doesn't	3327	multiple-writer-single-reader queue that works in all cases and doesn't
…		…
3332	trust me.	3418	trust me.
3333		3419
3334	=item ev_async_send (loop, ev_async *)	3420	=item ev_async_send (loop, ev_async *)
3335		3421
3336	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	3422	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
3337	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	3423	an C<EV_ASYNC> event on the watcher into the event loop, and instantly
		3424	returns.
		3425
3338	C<ev_feed_event>, this call is safe to do from other threads, signal or	3426	Unlike C<ev_feed_event>, this call is safe to do from other threads,
3339	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	3427	signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3340	section below on what exactly this means).	3428	embedding section below on what exactly this means).
3341		3429
3342	Note that, as with other watchers in libev, multiple events might get	3430	Note that, as with other watchers in libev, multiple events might get
3343	compressed into a single callback invocation (another way to look at this	3431	compressed into a single callback invocation (another way to look at
3344	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,	3432	this is that C<ev_async> watchers are level-triggered: they are set on
3345	reset when the event loop detects that).	3433	C<ev_async_send>, reset when the event loop detects that).
3346		3434
3347	This call incurs the overhead of a system call only once per event loop	3435	This call incurs the overhead of at most one extra system call per event
3348	iteration, so while the overhead might be noticeable, it doesn't apply to	3436	loop iteration, if the event loop is blocked, and no syscall at all if
3349	repeated calls to C<ev_async_send> for the same event loop.	3437	the event loop (or your program) is processing events. That means that
		3438	repeated calls are basically free (there is no need to avoid calls for
		3439	performance reasons) and that the overhead becomes smaller (typically
		3440	zero) under load.
3350		3441
3351	=item bool = ev_async_pending (ev_async *)	3442	=item bool = ev_async_pending (ev_async *)
3352		3443
3353	Returns a non-zero value when C<ev_async_send> has been called on the	3444	Returns a non-zero value when C<ev_async_send> has been called on the
3354	watcher but the event has not yet been processed (or even noted) by the	3445	watcher but the event has not yet been processed (or even noted) by the
…		…
3409	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3500	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3410		3501
3411	=item ev_feed_fd_event (loop, int fd, int revents)	3502	=item ev_feed_fd_event (loop, int fd, int revents)
3412		3503
3413	Feed an event on the given fd, as if a file descriptor backend detected	3504	Feed an event on the given fd, as if a file descriptor backend detected
3414	the given events it.	3505	the given events.
3415		3506
3416	=item ev_feed_signal_event (loop, int signum)	3507	=item ev_feed_signal_event (loop, int signum)
3417		3508
3418	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,	3509	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3419	which is async-safe.	3510	which is async-safe.
…		…
3425		3516
3426	This section explains some common idioms that are not immediately	3517	This section explains some common idioms that are not immediately
3427	obvious. Note that examples are sprinkled over the whole manual, and this	3518	obvious. Note that examples are sprinkled over the whole manual, and this
3428	section only contains stuff that wouldn't fit anywhere else.	3519	section only contains stuff that wouldn't fit anywhere else.
3429		3520
3430	=over 4	3521	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
3431		3522
3432	=item Model/nested event loop invocations and exit conditions.	3523	Each watcher has, by default, a C<void *data> member that you can read
		3524	or modify at any time: libev will completely ignore it. This can be used
		3525	to associate arbitrary data with your watcher. If you need more data and
		3526	don't want to allocate memory separately and store a pointer to it in that
		3527	data member, you can also "subclass" the watcher type and provide your own
		3528	data:
		3529
		3530	struct my_io
		3531	{
		3532	ev_io io;
		3533	int otherfd;
		3534	void *somedata;
		3535	struct whatever *mostinteresting;
		3536	};
		3537
		3538	...
		3539	struct my_io w;
		3540	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3541
		3542	And since your callback will be called with a pointer to the watcher, you
		3543	can cast it back to your own type:
		3544
		3545	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
		3546	{
		3547	struct my_io *w = (struct my_io *)w_;
		3548	...
		3549	}
		3550
		3551	More interesting and less C-conformant ways of casting your callback
		3552	function type instead have been omitted.
		3553
		3554	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3555
		3556	Another common scenario is to use some data structure with multiple
		3557	embedded watchers, in effect creating your own watcher that combines
		3558	multiple libev event sources into one "super-watcher":
		3559
		3560	struct my_biggy
		3561	{
		3562	int some_data;
		3563	ev_timer t1;
		3564	ev_timer t2;
		3565	}
		3566
		3567	In this case getting the pointer to C<my_biggy> is a bit more
		3568	complicated: Either you store the address of your C<my_biggy> struct in
		3569	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3570	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3571	real programmers):
		3572
		3573	#include <stddef.h>
		3574
		3575	static void
		3576	t1_cb (EV_P_ ev_timer *w, int revents)
		3577	{
		3578	struct my_biggy big = (struct my_biggy *)
		3579	(((char *)w) - offsetof (struct my_biggy, t1));
		3580	}
		3581
		3582	static void
		3583	t2_cb (EV_P_ ev_timer *w, int revents)
		3584	{
		3585	struct my_biggy big = (struct my_biggy *)
		3586	(((char *)w) - offsetof (struct my_biggy, t2));
		3587	}
		3588
		3589	=head2 AVOIDING FINISHING BEFORE RETURNING
		3590
		3591	Often you have structures like this in event-based programs:
		3592
		3593	callback ()
		3594	{
		3595	free (request);
		3596	}
		3597
		3598	request = start_new_request (..., callback);
		3599
		3600	The intent is to start some "lengthy" operation. The C<request> could be
		3601	used to cancel the operation, or do other things with it.
		3602
		3603	It's not uncommon to have code paths in C<start_new_request> that
		3604	immediately invoke the callback, for example, to report errors. Or you add
		3605	some caching layer that finds that it can skip the lengthy aspects of the
		3606	operation and simply invoke the callback with the result.
		3607
		3608	The problem here is that this will happen I<before> C<start_new_request>
		3609	has returned, so C<request> is not set.
		3610
		3611	Even if you pass the request by some safer means to the callback, you
		3612	might want to do something to the request after starting it, such as
		3613	canceling it, which probably isn't working so well when the callback has
		3614	already been invoked.
		3615
		3616	A common way around all these issues is to make sure that
		3617	C<start_new_request> I<always> returns before the callback is invoked. If
		3618	C<start_new_request> immediately knows the result, it can artificially
		3619	delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher
		3620	for example, or more sneakily, by reusing an existing (stopped) watcher
		3621	and pushing it into the pending queue:
		3622
		3623	ev_set_cb (watcher, callback);
		3624	ev_feed_event (EV_A_ watcher, 0);
		3625
		3626	This way, C<start_new_request> can safely return before the callback is
		3627	invoked, while not delaying callback invocation too much.
		3628
		3629	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
3433		3630
3434	Often (especially in GUI toolkits) there are places where you have	3631	Often (especially in GUI toolkits) there are places where you have
3435	I<modal> interaction, which is most easily implemented by recursively	3632	I<modal> interaction, which is most easily implemented by recursively
3436	invoking C<ev_run>.	3633	invoking C<ev_run>.
3437		3634
…		…
3449	int exit_main_loop = 0;	3646	int exit_main_loop = 0;
3450		3647
3451	while (!exit_main_loop)	3648	while (!exit_main_loop)
3452	ev_run (EV_DEFAULT_ EVRUN_ONCE);	3649	ev_run (EV_DEFAULT_ EVRUN_ONCE);
3453		3650
3454	// in a model watcher	3651	// in a modal watcher
3455	int exit_nested_loop = 0;	3652	int exit_nested_loop = 0;
3456		3653
3457	while (!exit_nested_loop)	3654	while (!exit_nested_loop)
3458	ev_run (EV_A_ EVRUN_ONCE);	3655	ev_run (EV_A_ EVRUN_ONCE);
3459		3656
…		…
3466	exit_main_loop = 1;	3663	exit_main_loop = 1;
3467		3664
3468	// exit both	3665	// exit both
3469	exit_main_loop = exit_nested_loop = 1;	3666	exit_main_loop = exit_nested_loop = 1;
3470		3667
3471	=back	3668	=head2 THREAD LOCKING EXAMPLE
		3669
		3670	Here is a fictitious example of how to run an event loop in a different
		3671	thread from where callbacks are being invoked and watchers are
		3672	created/added/removed.
		3673
		3674	For a real-world example, see the C<EV::Loop::Async> perl module,
		3675	which uses exactly this technique (which is suited for many high-level
		3676	languages).
		3677
		3678	The example uses a pthread mutex to protect the loop data, a condition
		3679	variable to wait for callback invocations, an async watcher to notify the
		3680	event loop thread and an unspecified mechanism to wake up the main thread.
		3681
		3682	First, you need to associate some data with the event loop:
		3683
		3684	typedef struct {
		3685	mutex_t lock; /* global loop lock */
		3686	ev_async async_w;
		3687	thread_t tid;
		3688	cond_t invoke_cv;
		3689	} userdata;
		3690
		3691	void prepare_loop (EV_P)
		3692	{
		3693	// for simplicity, we use a static userdata struct.
		3694	static userdata u;
		3695
		3696	ev_async_init (&u->async_w, async_cb);
		3697	ev_async_start (EV_A_ &u->async_w);
		3698
		3699	pthread_mutex_init (&u->lock, 0);
		3700	pthread_cond_init (&u->invoke_cv, 0);
		3701
		3702	// now associate this with the loop
		3703	ev_set_userdata (EV_A_ u);
		3704	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3705	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3706
		3707	// then create the thread running ev_run
		3708	pthread_create (&u->tid, 0, l_run, EV_A);
		3709	}
		3710
		3711	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3712	solely to wake up the event loop so it takes notice of any new watchers
		3713	that might have been added:
		3714
		3715	static void
		3716	async_cb (EV_P_ ev_async *w, int revents)
		3717	{
		3718	// just used for the side effects
		3719	}
		3720
		3721	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3722	protecting the loop data, respectively.
		3723
		3724	static void
		3725	l_release (EV_P)
		3726	{
		3727	userdata *u = ev_userdata (EV_A);
		3728	pthread_mutex_unlock (&u->lock);
		3729	}
		3730
		3731	static void
		3732	l_acquire (EV_P)
		3733	{
		3734	userdata *u = ev_userdata (EV_A);
		3735	pthread_mutex_lock (&u->lock);
		3736	}
		3737
		3738	The event loop thread first acquires the mutex, and then jumps straight
		3739	into C<ev_run>:
		3740
		3741	void *
		3742	l_run (void *thr_arg)
		3743	{
		3744	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		3745
		3746	l_acquire (EV_A);
		3747	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3748	ev_run (EV_A_ 0);
		3749	l_release (EV_A);
		3750
		3751	return 0;
		3752	}
		3753
		3754	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3755	signal the main thread via some unspecified mechanism (signals? pipe
		3756	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3757	have been called (in a while loop because a) spurious wakeups are possible
		3758	and b) skipping inter-thread-communication when there are no pending
		3759	watchers is very beneficial):
		3760
		3761	static void
		3762	l_invoke (EV_P)
		3763	{
		3764	userdata *u = ev_userdata (EV_A);
		3765
		3766	while (ev_pending_count (EV_A))
		3767	{
		3768	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3769	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3770	}
		3771	}
		3772
		3773	Now, whenever the main thread gets told to invoke pending watchers, it
		3774	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3775	thread to continue:
		3776
		3777	static void
		3778	real_invoke_pending (EV_P)
		3779	{
		3780	userdata *u = ev_userdata (EV_A);
		3781
		3782	pthread_mutex_lock (&u->lock);
		3783	ev_invoke_pending (EV_A);
		3784	pthread_cond_signal (&u->invoke_cv);
		3785	pthread_mutex_unlock (&u->lock);
		3786	}
		3787
		3788	Whenever you want to start/stop a watcher or do other modifications to an
		3789	event loop, you will now have to lock:
		3790
		3791	ev_timer timeout_watcher;
		3792	userdata *u = ev_userdata (EV_A);
		3793
		3794	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3795
		3796	pthread_mutex_lock (&u->lock);
		3797	ev_timer_start (EV_A_ &timeout_watcher);
		3798	ev_async_send (EV_A_ &u->async_w);
		3799	pthread_mutex_unlock (&u->lock);
		3800
		3801	Note that sending the C<ev_async> watcher is required because otherwise
		3802	an event loop currently blocking in the kernel will have no knowledge
		3803	about the newly added timer. By waking up the loop it will pick up any new
		3804	watchers in the next event loop iteration.
		3805
		3806	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3807
		3808	While the overhead of a callback that e.g. schedules a thread is small, it
		3809	is still an overhead. If you embed libev, and your main usage is with some
		3810	kind of threads or coroutines, you might want to customise libev so that
		3811	doesn't need callbacks anymore.
		3812
		3813	Imagine you have coroutines that you can switch to using a function
		3814	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3815	and that due to some magic, the currently active coroutine is stored in a
		3816	global called C<current_coro>. Then you can build your own "wait for libev
		3817	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3818	the differing C<;> conventions):
		3819
		3820	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3821	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3822
		3823	That means instead of having a C callback function, you store the
		3824	coroutine to switch to in each watcher, and instead of having libev call
		3825	your callback, you instead have it switch to that coroutine.
		3826
		3827	A coroutine might now wait for an event with a function called
		3828	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		3829	matter when, or whether the watcher is active or not when this function is
		3830	called):
		3831
		3832	void
		3833	wait_for_event (ev_watcher *w)
		3834	{
		3835	ev_cb_set (w) = current_coro;
		3836	switch_to (libev_coro);
		3837	}
		3838
		3839	That basically suspends the coroutine inside C<wait_for_event> and
		3840	continues the libev coroutine, which, when appropriate, switches back to
		3841	this or any other coroutine.
		3842
		3843	You can do similar tricks if you have, say, threads with an event queue -
		3844	instead of storing a coroutine, you store the queue object and instead of
		3845	switching to a coroutine, you push the watcher onto the queue and notify
		3846	any waiters.
		3847
		3848	To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two
		3849	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		3850
		3851	// my_ev.h
		3852	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3853	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
		3854	#include "../libev/ev.h"
		3855
		3856	// my_ev.c
		3857	#define EV_H "my_ev.h"
		3858	#include "../libev/ev.c"
		3859
		3860	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		3861	F<my_ev.c> into your project. When properly specifying include paths, you
		3862	can even use F<ev.h> as header file name directly.
3472		3863
3473		3864
3474	=head1 LIBEVENT EMULATION	3865	=head1 LIBEVENT EMULATION
3475		3866
3476	Libev offers a compatibility emulation layer for libevent. It cannot	3867	Libev offers a compatibility emulation layer for libevent. It cannot
…		…
3505	to use the libev header file and library.	3896	to use the libev header file and library.
3506		3897
3507	=back	3898	=back
3508		3899
3509	=head1 C++ SUPPORT	3900	=head1 C++ SUPPORT
		3901
		3902	=head2 C API
		3903
		3904	The normal C API should work fine when used from C++: both ev.h and the
		3905	libev sources can be compiled as C++. Therefore, code that uses the C API
		3906	will work fine.
		3907
		3908	Proper exception specifications might have to be added to callbacks passed
		3909	to libev: exceptions may be thrown only from watcher callbacks, all
		3910	other callbacks (allocator, syserr, loop acquire/release and periodioc
		3911	reschedule callbacks) must not throw exceptions, and might need a C<throw
		3912	()> specification. If you have code that needs to be compiled as both C
		3913	and C++ you can use the C<EV_THROW> macro for this:
		3914
		3915	static void
		3916	fatal_error (const char *msg) EV_THROW
		3917	{
		3918	perror (msg);
		3919	abort ();
		3920	}
		3921
		3922	...
		3923	ev_set_syserr_cb (fatal_error);
		3924
		3925	The only API functions that can currently throw exceptions are C<ev_run>,
		3926	C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
		3927	because it runs cleanup watchers).
		3928
		3929	Throwing exceptions in watcher callbacks is only supported if libev itself
		3930	is compiled with a C++ compiler or your C and C++ environments allow
		3931	throwing exceptions through C libraries (most do).
		3932
		3933	=head2 C++ API
3510		3934
3511	Libev comes with some simplistic wrapper classes for C++ that mainly allow	3935	Libev comes with some simplistic wrapper classes for C++ that mainly allow
3512	you to use some convenience methods to start/stop watchers and also change	3936	you to use some convenience methods to start/stop watchers and also change
3513	the callback model to a model using method callbacks on objects.	3937	the callback model to a model using method callbacks on objects.
3514		3938
…		…
3530	with C<operator ()> can be used as callbacks. Other types should be easy	3954	with C<operator ()> can be used as callbacks. Other types should be easy
3531	to add as long as they only need one additional pointer for context. If	3955	to add as long as they only need one additional pointer for context. If
3532	you need support for other types of functors please contact the author	3956	you need support for other types of functors please contact the author
3533	(preferably after implementing it).	3957	(preferably after implementing it).
3534		3958
		3959	For all this to work, your C++ compiler either has to use the same calling
		3960	conventions as your C compiler (for static member functions), or you have
		3961	to embed libev and compile libev itself as C++.
		3962
3535	Here is a list of things available in the C<ev> namespace:	3963	Here is a list of things available in the C<ev> namespace:
3536		3964
3537	=over 4	3965	=over 4
3538		3966
3539	=item C<ev::READ>, C<ev::WRITE> etc.	3967	=item C<ev::READ>, C<ev::WRITE> etc.
…		…
3548	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.	3976	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
3549		3977
3550	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of	3978	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
3551	the same name in the C<ev> namespace, with the exception of C<ev_signal>	3979	the same name in the C<ev> namespace, with the exception of C<ev_signal>
3552	which is called C<ev::sig> to avoid clashes with the C<signal> macro	3980	which is called C<ev::sig> to avoid clashes with the C<signal> macro
3553	defines by many implementations.	3981	defined by many implementations.
3554		3982
3555	All of those classes have these methods:	3983	All of those classes have these methods:
3556		3984
3557	=over 4	3985	=over 4
3558		3986
…		…
3691	watchers in the constructor.	4119	watchers in the constructor.
3692		4120
3693	class myclass	4121	class myclass
3694	{	4122	{
3695	ev::io io ; void io_cb (ev::io &w, int revents);	4123	ev::io io ; void io_cb (ev::io &w, int revents);
3696	ev::io2 io2 ; void io2_cb (ev::io &w, int revents);	4124	ev::io io2 ; void io2_cb (ev::io &w, int revents);
3697	ev::idle idle; void idle_cb (ev::idle &w, int revents);	4125	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3698		4126
3699	myclass (int fd)	4127	myclass (int fd)
3700	{	4128	{
3701	io .set <myclass, &myclass::io_cb > (this);	4129	io .set <myclass, &myclass::io_cb > (this);
…		…
3752	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.	4180	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3753		4181
3754	=item D	4182	=item D
3755		4183
3756	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	4184	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3757	be found at L<http://proj.llucax.com.ar/wiki/evd>.	4185	be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
3758		4186
3759	=item Ocaml	4187	=item Ocaml
3760		4188
3761	Erkki Seppala has written Ocaml bindings for libev, to be found at	4189	Erkki Seppala has written Ocaml bindings for libev, to be found at
3762	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	4190	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
…		…
3810	suitable for use with C<EV_A>.	4238	suitable for use with C<EV_A>.
3811		4239
3812	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	4240	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
3813		4241
3814	Similar to the other two macros, this gives you the value of the default	4242	Similar to the other two macros, this gives you the value of the default
3815	loop, if multiple loops are supported ("ev loop default").	4243	loop, if multiple loops are supported ("ev loop default"). The default loop
		4244	will be initialised if it isn't already initialised.
		4245
		4246	For non-multiplicity builds, these macros do nothing, so you always have
		4247	to initialise the loop somewhere.
3816		4248
3817	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>	4249	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
3818		4250
3819	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the	4251	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
3820	default loop has been initialised (C<UC> == unchecked). Their behaviour	4252	default loop has been initialised (C<UC> == unchecked). Their behaviour
…		…
3965	supported). It will also not define any of the structs usually found in	4397	supported). It will also not define any of the structs usually found in
3966	F<event.h> that are not directly supported by the libev core alone.	4398	F<event.h> that are not directly supported by the libev core alone.
3967		4399
3968	In standalone mode, libev will still try to automatically deduce the	4400	In standalone mode, libev will still try to automatically deduce the
3969	configuration, but has to be more conservative.	4401	configuration, but has to be more conservative.
		4402
		4403	=item EV_USE_FLOOR
		4404
		4405	If defined to be C<1>, libev will use the C<floor ()> function for its
		4406	periodic reschedule calculations, otherwise libev will fall back on a
		4407	portable (slower) implementation. If you enable this, you usually have to
		4408	link against libm or something equivalent. Enabling this when the C<floor>
		4409	function is not available will fail, so the safe default is to not enable
		4410	this.
3970		4411
3971	=item EV_USE_MONOTONIC	4412	=item EV_USE_MONOTONIC
3972		4413
3973	If defined to be C<1>, libev will try to detect the availability of the	4414	If defined to be C<1>, libev will try to detect the availability of the
3974	monotonic clock option at both compile time and runtime. Otherwise no	4415	monotonic clock option at both compile time and runtime. Otherwise no
…		…
4104	If defined to be C<1>, libev will compile in support for the Linux inotify	4545	If defined to be C<1>, libev will compile in support for the Linux inotify
4105	interface to speed up C<ev_stat> watchers. Its actual availability will	4546	interface to speed up C<ev_stat> watchers. Its actual availability will
4106	be detected at runtime. If undefined, it will be enabled if the headers	4547	be detected at runtime. If undefined, it will be enabled if the headers
4107	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4548	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
4108		4549
		4550	=item EV_NO_SMP
		4551
		4552	If defined to be C<1>, libev will assume that memory is always coherent
		4553	between threads, that is, threads can be used, but threads never run on
		4554	different cpus (or different cpu cores). This reduces dependencies
		4555	and makes libev faster.
		4556
		4557	=item EV_NO_THREADS
		4558
		4559	If defined to be C<1>, libev will assume that it will never be called
		4560	from different threads, which is a stronger assumption than C<EV_NO_SMP>,
		4561	above. This reduces dependencies and makes libev faster.
		4562
4109	=item EV_ATOMIC_T	4563	=item EV_ATOMIC_T
4110		4564
4111	Libev requires an integer type (suitable for storing C<0> or C<1>) whose	4565	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4112	access is atomic with respect to other threads or signal contexts. No such	4566	access is atomic and serialised with respect to other threads or signal
4113	type is easily found in the C language, so you can provide your own type	4567	contexts. No such type is easily found in the C language, so you can
4114	that you know is safe for your purposes. It is used both for signal handler "locking"	4568	provide your own type that you know is safe for your purposes. It is used
4115	as well as for signal and thread safety in C<ev_async> watchers.	4569	both for signal handler "locking" as well as for signal and thread safety
		4570	in C<ev_async> watchers.
4116		4571
4117	In the absence of this define, libev will use C<sig_atomic_t volatile>	4572	In the absence of this define, libev will use C<sig_atomic_t volatile>
4118	(from F<signal.h>), which is usually good enough on most platforms.	4573	(from F<signal.h>), which is usually good enough on most platforms,
		4574	although strictly speaking using a type that also implies a memory fence
		4575	is required.
4119		4576
4120	=item EV_H (h)	4577	=item EV_H (h)
4121		4578
4122	The name of the F<ev.h> header file used to include it. The default if	4579	The name of the F<ev.h> header file used to include it. The default if
4123	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be	4580	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
…		…
4147	will have the C<struct ev_loop *> as first argument, and you can create	4604	will have the C<struct ev_loop *> as first argument, and you can create
4148	additional independent event loops. Otherwise there will be no support	4605	additional independent event loops. Otherwise there will be no support
4149	for multiple event loops and there is no first event loop pointer	4606	for multiple event loops and there is no first event loop pointer
4150	argument. Instead, all functions act on the single default loop.	4607	argument. Instead, all functions act on the single default loop.
4151		4608
		4609	Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
		4610	default loop when multiplicity is switched off - you always have to
		4611	initialise the loop manually in this case.
		4612
4152	=item EV_MINPRI	4613	=item EV_MINPRI
4153		4614
4154	=item EV_MAXPRI	4615	=item EV_MAXPRI
4155		4616
4156	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to	4617	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
…		…
4192	#define EV_USE_POLL 1	4653	#define EV_USE_POLL 1
4193	#define EV_CHILD_ENABLE 1	4654	#define EV_CHILD_ENABLE 1
4194	#define EV_ASYNC_ENABLE 1	4655	#define EV_ASYNC_ENABLE 1
4195		4656
4196	The actual value is a bitset, it can be a combination of the following	4657	The actual value is a bitset, it can be a combination of the following
4197	values:	4658	values (by default, all of these are enabled):
4198		4659
4199	=over 4	4660	=over 4
4200		4661
4201	=item C<1> - faster/larger code	4662	=item C<1> - faster/larger code
4202		4663
…		…
4206	code size by roughly 30% on amd64).	4667	code size by roughly 30% on amd64).
4207		4668
4208	When optimising for size, use of compiler flags such as C<-Os> with	4669	When optimising for size, use of compiler flags such as C<-Os> with
4209	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of	4670	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
4210	assertions.	4671	assertions.
		4672
		4673	The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
		4674	(e.g. gcc with C<-Os>).
4211		4675
4212	=item C<2> - faster/larger data structures	4676	=item C<2> - faster/larger data structures
4213		4677
4214	Replaces the small 2-heap for timer management by a faster 4-heap, larger	4678	Replaces the small 2-heap for timer management by a faster 4-heap, larger
4215	hash table sizes and so on. This will usually further increase code size	4679	hash table sizes and so on. This will usually further increase code size
4216	and can additionally have an effect on the size of data structures at	4680	and can additionally have an effect on the size of data structures at
4217	runtime.	4681	runtime.
4218		4682
		4683	The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
		4684	(e.g. gcc with C<-Os>).
		4685
4219	=item C<4> - full API configuration	4686	=item C<4> - full API configuration
4220		4687
4221	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and	4688	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
4222	enables multiplicity (C<EV_MULTIPLICITY>=1).	4689	enables multiplicity (C<EV_MULTIPLICITY>=1).
4223		4690
…		…
4253		4720
4254	With an intelligent-enough linker (gcc+binutils are intelligent enough	4721	With an intelligent-enough linker (gcc+binutils are intelligent enough
4255	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by	4722	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
4256	your program might be left out as well - a binary starting a timer and an	4723	your program might be left out as well - a binary starting a timer and an
4257	I/O watcher then might come out at only 5Kb.	4724	I/O watcher then might come out at only 5Kb.
		4725
		4726	=item EV_API_STATIC
		4727
		4728	If this symbol is defined (by default it is not), then all identifiers
		4729	will have static linkage. This means that libev will not export any
		4730	identifiers, and you cannot link against libev anymore. This can be useful
		4731	when you embed libev, only want to use libev functions in a single file,
		4732	and do not want its identifiers to be visible.
		4733
		4734	To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
		4735	wants to use libev.
		4736
		4737	This option only works when libev is compiled with a C compiler, as C++
		4738	doesn't support the required declaration syntax.
4258		4739
4259	=item EV_AVOID_STDIO	4740	=item EV_AVOID_STDIO
4260		4741
4261	If this is set to C<1> at compiletime, then libev will avoid using stdio	4742	If this is set to C<1> at compiletime, then libev will avoid using stdio
4262	functions (printf, scanf, perror etc.). This will increase the code size	4743	functions (printf, scanf, perror etc.). This will increase the code size
…		…
4406	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4887	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
4407		4888
4408	#include "ev_cpp.h"	4889	#include "ev_cpp.h"
4409	#include "ev.c"	4890	#include "ev.c"
4410		4891
4411	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	4892	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
4412		4893
4413	=head2 THREADS AND COROUTINES	4894	=head2 THREADS AND COROUTINES
4414		4895
4415	=head3 THREADS	4896	=head3 THREADS
4416		4897
…		…
4467	default loop and triggering an C<ev_async> watcher from the default loop	4948	default loop and triggering an C<ev_async> watcher from the default loop
4468	watcher callback into the event loop interested in the signal.	4949	watcher callback into the event loop interested in the signal.
4469		4950
4470	=back	4951	=back
4471		4952
4472	=head4 THREAD LOCKING EXAMPLE	4953	See also L<THREAD LOCKING EXAMPLE>.
4473
4474	Here is a fictitious example of how to run an event loop in a different
4475	thread than where callbacks are being invoked and watchers are
4476	created/added/removed.
4477
4478	For a real-world example, see the C<EV::Loop::Async> perl module,
4479	which uses exactly this technique (which is suited for many high-level
4480	languages).
4481
4482	The example uses a pthread mutex to protect the loop data, a condition
4483	variable to wait for callback invocations, an async watcher to notify the
4484	event loop thread and an unspecified mechanism to wake up the main thread.
4485
4486	First, you need to associate some data with the event loop:
4487
4488	typedef struct {
4489	mutex_t lock; /* global loop lock */
4490	ev_async async_w;
4491	thread_t tid;
4492	cond_t invoke_cv;
4493	} userdata;
4494
4495	void prepare_loop (EV_P)
4496	{
4497	// for simplicity, we use a static userdata struct.
4498	static userdata u;
4499
4500	ev_async_init (&u->async_w, async_cb);
4501	ev_async_start (EV_A_ &u->async_w);
4502
4503	pthread_mutex_init (&u->lock, 0);
4504	pthread_cond_init (&u->invoke_cv, 0);
4505
4506	// now associate this with the loop
4507	ev_set_userdata (EV_A_ u);
4508	ev_set_invoke_pending_cb (EV_A_ l_invoke);
4509	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4510
4511	// then create the thread running ev_loop
4512	pthread_create (&u->tid, 0, l_run, EV_A);
4513	}
4514
4515	The callback for the C<ev_async> watcher does nothing: the watcher is used
4516	solely to wake up the event loop so it takes notice of any new watchers
4517	that might have been added:
4518
4519	static void
4520	async_cb (EV_P_ ev_async *w, int revents)
4521	{
4522	// just used for the side effects
4523	}
4524
4525	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4526	protecting the loop data, respectively.
4527
4528	static void
4529	l_release (EV_P)
4530	{
4531	userdata *u = ev_userdata (EV_A);
4532	pthread_mutex_unlock (&u->lock);
4533	}
4534
4535	static void
4536	l_acquire (EV_P)
4537	{
4538	userdata *u = ev_userdata (EV_A);
4539	pthread_mutex_lock (&u->lock);
4540	}
4541
4542	The event loop thread first acquires the mutex, and then jumps straight
4543	into C<ev_run>:
4544
4545	void *
4546	l_run (void *thr_arg)
4547	{
4548	struct ev_loop *loop = (struct ev_loop *)thr_arg;
4549
4550	l_acquire (EV_A);
4551	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4552	ev_run (EV_A_ 0);
4553	l_release (EV_A);
4554
4555	return 0;
4556	}
4557
4558	Instead of invoking all pending watchers, the C<l_invoke> callback will
4559	signal the main thread via some unspecified mechanism (signals? pipe
4560	writes? C<Async::Interrupt>?) and then waits until all pending watchers
4561	have been called (in a while loop because a) spurious wakeups are possible
4562	and b) skipping inter-thread-communication when there are no pending
4563	watchers is very beneficial):
4564
4565	static void
4566	l_invoke (EV_P)
4567	{
4568	userdata *u = ev_userdata (EV_A);
4569
4570	while (ev_pending_count (EV_A))
4571	{
4572	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4573	pthread_cond_wait (&u->invoke_cv, &u->lock);
4574	}
4575	}
4576
4577	Now, whenever the main thread gets told to invoke pending watchers, it
4578	will grab the lock, call C<ev_invoke_pending> and then signal the loop
4579	thread to continue:
4580
4581	static void
4582	real_invoke_pending (EV_P)
4583	{
4584	userdata *u = ev_userdata (EV_A);
4585
4586	pthread_mutex_lock (&u->lock);
4587	ev_invoke_pending (EV_A);
4588	pthread_cond_signal (&u->invoke_cv);
4589	pthread_mutex_unlock (&u->lock);
4590	}
4591
4592	Whenever you want to start/stop a watcher or do other modifications to an
4593	event loop, you will now have to lock:
4594
4595	ev_timer timeout_watcher;
4596	userdata *u = ev_userdata (EV_A);
4597
4598	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4599
4600	pthread_mutex_lock (&u->lock);
4601	ev_timer_start (EV_A_ &timeout_watcher);
4602	ev_async_send (EV_A_ &u->async_w);
4603	pthread_mutex_unlock (&u->lock);
4604
4605	Note that sending the C<ev_async> watcher is required because otherwise
4606	an event loop currently blocking in the kernel will have no knowledge
4607	about the newly added timer. By waking up the loop it will pick up any new
4608	watchers in the next event loop iteration.
4609		4954
4610	=head3 COROUTINES	4955	=head3 COROUTINES
4611		4956
4612	Libev is very accommodating to coroutines ("cooperative threads"):	4957	Libev is very accommodating to coroutines ("cooperative threads"):
4613	libev fully supports nesting calls to its functions from different	4958	libev fully supports nesting calls to its functions from different
…		…
4778	requires, and its I/O model is fundamentally incompatible with the POSIX	5123	requires, and its I/O model is fundamentally incompatible with the POSIX
4779	model. Libev still offers limited functionality on this platform in	5124	model. Libev still offers limited functionality on this platform in
4780	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	5125	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4781	descriptors. This only applies when using Win32 natively, not when using	5126	descriptors. This only applies when using Win32 natively, not when using
4782	e.g. cygwin. Actually, it only applies to the microsofts own compilers,	5127	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4783	as every compielr comes with a slightly differently broken/incompatible	5128	as every compiler comes with a slightly differently broken/incompatible
4784	environment.	5129	environment.
4785		5130
4786	Lifting these limitations would basically require the full	5131	Lifting these limitations would basically require the full
4787	re-implementation of the I/O system. If you are into this kind of thing,	5132	re-implementation of the I/O system. If you are into this kind of thing,
4788	then note that glib does exactly that for you in a very portable way (note	5133	then note that glib does exactly that for you in a very portable way (note
…		…
4921		5266
4922	The type C<double> is used to represent timestamps. It is required to	5267	The type C<double> is used to represent timestamps. It is required to
4923	have at least 51 bits of mantissa (and 9 bits of exponent), which is	5268	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4924	good enough for at least into the year 4000 with millisecond accuracy	5269	good enough for at least into the year 4000 with millisecond accuracy
4925	(the design goal for libev). This requirement is overfulfilled by	5270	(the design goal for libev). This requirement is overfulfilled by
4926	implementations using IEEE 754, which is basically all existing ones. With	5271	implementations using IEEE 754, which is basically all existing ones.
		5272
4927	IEEE 754 doubles, you get microsecond accuracy until at least 2200.	5273	With IEEE 754 doubles, you get microsecond accuracy until at least the
		5274	year 2255 (and millisecond accuracy till the year 287396 - by then, libev
		5275	is either obsolete or somebody patched it to use C<long double> or
		5276	something like that, just kidding).
4928		5277
4929	=back	5278	=back
4930		5279
4931	If you know of other additional requirements drop me a note.	5280	If you know of other additional requirements drop me a note.
4932		5281
…		…
4994	=item Processing ev_async_send: O(number_of_async_watchers)	5343	=item Processing ev_async_send: O(number_of_async_watchers)
4995		5344
4996	=item Processing signals: O(max_signal_number)	5345	=item Processing signals: O(max_signal_number)
4997		5346
4998	Sending involves a system call I<iff> there were no other C<ev_async_send>	5347	Sending involves a system call I<iff> there were no other C<ev_async_send>
4999	calls in the current loop iteration. Checking for async and signal events	5348	calls in the current loop iteration and the loop is currently
		5349	blocked. Checking for async and signal events involves iterating over all
5000	involves iterating over all running async watchers or all signal numbers.	5350	running async watchers or all signal numbers.
5001		5351
5002	=back	5352	=back
5003		5353
5004		5354
5005	=head1 PORTING FROM LIBEV 3.X TO 4.X	5355	=head1 PORTING FROM LIBEV 3.X TO 4.X
…		…
5122	The physical time that is observed. It is apparently strictly monotonic :)	5472	The physical time that is observed. It is apparently strictly monotonic :)
5123		5473
5124	=item wall-clock time	5474	=item wall-clock time
5125		5475
5126	The time and date as shown on clocks. Unlike real time, it can actually	5476	The time and date as shown on clocks. Unlike real time, it can actually
5127	be wrong and jump forwards and backwards, e.g. when the you adjust your	5477	be wrong and jump forwards and backwards, e.g. when you adjust your
5128	clock.	5478	clock.
5129		5479
5130	=item watcher	5480	=item watcher
5131		5481
5132	A data structure that describes interest in certain events. Watchers need	5482	A data structure that describes interest in certain events. Watchers need
…		…
5135	=back	5485	=back
5136		5486
5137	=head1 AUTHOR	5487	=head1 AUTHOR
5138		5488
5139	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael	5489	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5140	Magnusson and Emanuele Giaquinta.	5490	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
5141		5491

Diff Legend

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