ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.326 by root, Sun Oct 24 19:44:27 2010 UTC vs.
Revision 1.388 by root, Tue Dec 20 04:08:35 2011 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
…		…
77	on event-based programming, nor will it introduce event-based programming	77	on event-based programming, nor will it introduce event-based programming
78	with libev.	78	with libev.
79		79
80	Familiarity with event based programming techniques in general is assumed	80	Familiarity with event based programming techniques in general is assumed
81	throughout this document.	81	throughout this document.
		82
		83	=head1 WHAT TO READ WHEN IN A HURRY
		84
		85	This manual tries to be very detailed, but unfortunately, this also makes
		86	it very long. If you just want to know the basics of libev, I suggest
		87	reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and
		88	look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and
		89	C<ev_timer> sections in L<WATCHER TYPES>.
82		90
83	=head1 ABOUT LIBEV	91	=head1 ABOUT LIBEV
84		92
85	Libev is an event loop: you register interest in certain events (such as a	93	Libev is an event loop: you register interest in certain events (such as a
86	file descriptor being readable or a timeout occurring), and it will manage	94	file descriptor being readable or a timeout occurring), and it will manage
…		…
166	=item ev_tstamp ev_time ()	174	=item ev_tstamp ev_time ()
167		175
168	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
169	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
170	you actually want to know. Also interesting is the combination of	178	you actually want to know. Also interesting is the combination of
171	C<ev_update_now> and C<ev_now>.	179	C<ev_now_update> and C<ev_now>.
172		180
173	=item ev_sleep (ev_tstamp interval)	181	=item ev_sleep (ev_tstamp interval)
174		182
175	Sleep for the given interval: The current thread will be blocked until	183	Sleep for the given interval: The current thread will be blocked
176	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
177	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 >>).
178		192
179	=item int ev_version_major ()	193	=item int ev_version_major ()
180		194
181	=item int ev_version_minor ()	195	=item int ev_version_minor ()
182		196
…		…
233	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 ()
234	& ev_supported_backends ()>, likewise for recommended ones.	248	& ev_supported_backends ()>, likewise for recommended ones.
235		249
236	See the description of C<ev_embed> watchers for more info.	250	See the description of C<ev_embed> watchers for more info.
237		251
238	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]	252	=item ev_set_allocator (void *(*cb)(void *ptr, long size))
239		253
240	Sets the allocation function to use (the prototype is similar - the	254	Sets the allocation function to use (the prototype is similar - the
241	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
242	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
243	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
…		…
269	}	283	}
270		284
271	...	285	...
272	ev_set_allocator (persistent_realloc);	286	ev_set_allocator (persistent_realloc);
273		287
274	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]	288	=item ev_set_syserr_cb (void (*cb)(const char *msg))
275		289
276	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
277	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
278	indicating the system call or subsystem causing the problem. If this	292	indicating the system call or subsystem causing the problem. If this
279	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
…		…
291	}	305	}
292		306
293	...	307	...
294	ev_set_syserr_cb (fatal_error);	308	ev_set_syserr_cb (fatal_error);
295		309
		310	=item ev_feed_signal (int signum)
		311
		312	This function can be used to "simulate" a signal receive. It is completely
		313	safe to call this function at any time, from any context, including signal
		314	handlers or random threads.
		315
		316	Its main use is to customise signal handling in your process, especially
		317	in the presence of threads. For example, you could block signals
		318	by default in all threads (and specifying C<EVFLAG_NOSIGMASK> when
		319	creating any loops), and in one thread, use C<sigwait> or any other
		320	mechanism to wait for signals, then "deliver" them to libev by calling
		321	C<ev_feed_signal>.
		322
296	=back	323	=back
297		324
298	=head1 FUNCTIONS CONTROLLING EVENT LOOPS	325	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
299		326
300	An event loop is described by a C<struct ev_loop *> (the C<struct> is	327	An event loop is described by a C<struct ev_loop *> (the C<struct> is
301	I<not> optional in this case unless libev 3 compatibility is disabled, as	328	I<not> optional in this case unless libev 3 compatibility is disabled, as
302	libev 3 had an C<ev_loop> function colliding with the struct name).	329	libev 3 had an C<ev_loop> function colliding with the struct name).
303		330
304	The library knows two types of such loops, the I<default> loop, which	331	The library knows two types of such loops, the I<default> loop, which
305	supports signals and child events, and dynamically created event loops	332	supports child process events, and dynamically created event loops which
306	which do not.	333	do not.
307		334
308	=over 4	335	=over 4
309		336
310	=item struct ev_loop *ev_default_loop (unsigned int flags)	337	=item struct ev_loop *ev_default_loop (unsigned int flags)
311		338
…		…
347	=item struct ev_loop *ev_loop_new (unsigned int flags)	374	=item struct ev_loop *ev_loop_new (unsigned int flags)
348		375
349	This will create and initialise a new event loop object. If the loop	376	This will create and initialise a new event loop object. If the loop
350	could not be initialised, returns false.	377	could not be initialised, returns false.
351		378
352	Note that this function I<is> thread-safe, and one common way to use	379	This function is thread-safe, and one common way to use libev with
353	libev with threads is indeed to create one loop per thread, and using the	380	threads is indeed to create one loop per thread, and using the default
354	default loop in the "main" or "initial" thread.	381	loop in the "main" or "initial" thread.
355		382
356	The flags argument can be used to specify special behaviour or specific	383	The flags argument can be used to specify special behaviour or specific
357	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).	384	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
358		385
359	The following flags are supported:	386	The following flags are supported:
…		…
394	environment variable.	421	environment variable.
395		422
396	=item C<EVFLAG_NOINOTIFY>	423	=item C<EVFLAG_NOINOTIFY>
397		424
398	When this flag is specified, then libev will not attempt to use the	425	When this flag is specified, then libev will not attempt to use the
399	I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and	426	I<inotify> API for its C<ev_stat> watchers. Apart from debugging and
400	testing, this flag can be useful to conserve inotify file descriptors, as	427	testing, this flag can be useful to conserve inotify file descriptors, as
401	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.	428	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
402		429
403	=item C<EVFLAG_SIGNALFD>	430	=item C<EVFLAG_SIGNALFD>
404		431
405	When this flag is specified, then libev will attempt to use the	432	When this flag is specified, then libev will attempt to use the
406	I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This API	433	I<signalfd> API for its C<ev_signal> (and C<ev_child>) watchers. This API
407	delivers signals synchronously, which makes it both faster and might make	434	delivers signals synchronously, which makes it both faster and might make
408	it possible to get the queued signal data. It can also simplify signal	435	it possible to get the queued signal data. It can also simplify signal
409	handling with threads, as long as you properly block signals in your	436	handling with threads, as long as you properly block signals in your
410	threads that are not interested in handling them.	437	threads that are not interested in handling them.
411		438
412	Signalfd will not be used by default as this changes your signal mask, and	439	Signalfd will not be used by default as this changes your signal mask, and
413	there are a lot of shoddy libraries and programs (glib's threadpool for	440	there are a lot of shoddy libraries and programs (glib's threadpool for
414	example) that can't properly initialise their signal masks.	441	example) that can't properly initialise their signal masks.
		442
		443	=item C<EVFLAG_NOSIGMASK>
		444
		445	When this flag is specified, then libev will avoid to modify the signal
		446	mask. Specifically, this means you have to make sure signals are unblocked
		447	when you want to receive them.
		448
		449	This behaviour is useful when you want to do your own signal handling, or
		450	want to handle signals only in specific threads and want to avoid libev
		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.
		455
		456	This flag's behaviour will become the default in future versions of libev.
415		457
416	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	458	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
417		459
418	This is your standard select(2) backend. Not I<completely> standard, as	460	This is your standard select(2) backend. Not I<completely> standard, as
419	libev tries to roll its own fd_set with no limits on the number of fds,	461	libev tries to roll its own fd_set with no limits on the number of fds,
…		…
447	=item C<EVBACKEND_EPOLL> (value 4, Linux)	489	=item C<EVBACKEND_EPOLL> (value 4, Linux)
448		490
449	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
450	kernels).	492	kernels).
451		493
452	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
453	but it scales phenomenally better. While poll and select usually scale	495	it scales phenomenally better. While poll and select usually scale like
454	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
455	epoll scales either O(1) or O(active_fds).	497	fd), epoll scales either O(1) or O(active_fds).
456		498
457	The epoll mechanism deserves honorable mention as the most misdesigned	499	The epoll mechanism deserves honorable mention as the most misdesigned
458	of the more advanced event mechanisms: mere annoyances include silently	500	of the more advanced event mechanisms: mere annoyances include silently
459	dropping file descriptors, requiring a system call per change per file	501	dropping file descriptors, requiring a system call per change per file
460	descriptor (and unnecessary guessing of parameters), problems with dup and	502	descriptor (and unnecessary guessing of parameters), problems with dup,
		503	returning before the timeout value, resulting in additional iterations
		504	(and only giving 5ms accuracy while select on the same platform gives
461	so on. The biggest issue is fork races, however - if a program forks then	505	0.1ms) and so on. The biggest issue is fork races, however - if a program
462	I<both> parent and child process have to recreate the epoll set, which can	506	forks then I<both> parent and child process have to recreate the epoll
463	take considerable time (one syscall per file descriptor) and is of course	507	set, which can take considerable time (one syscall per file descriptor)
464	hard to detect.	508	and is of course hard to detect.
465		509
466	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	510	Epoll is also notoriously buggy - embedding epoll fds I<should> work,
467	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
468	I<different> file descriptors (even already closed ones, so one cannot	512	totally I<different> file descriptors (even already closed ones, so
469	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
470	on SMP systems). Libev tries to counter these spurious notifications by	514	(especially on SMP systems). Libev tries to counter these spurious
471	employing an additional generation counter and comparing that against the	515	notifications by employing an additional generation counter and comparing
472	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
473	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
474	perfectly fine with C<select> (files, many character devices...).	521	perfectly fine with C<select> (files, many character devices...).
		522
		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...
475		526
476	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
477	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
478	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
479	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
…		…
545	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	596	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
546		597
547	This uses the Solaris 10 event port mechanism. As with everything on Solaris,	598	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
548	it's really slow, but it still scales very well (O(active_fds)).	599	it's really slow, but it still scales very well (O(active_fds)).
549		600
550	Please note that Solaris event ports can deliver a lot of spurious
551	notifications, so you need to use non-blocking I/O or other means to avoid
552	blocking when no data (or space) is available.
553
554	While this backend scales well, it requires one system call per active	601	While this backend scales well, it requires one system call per active
555	file descriptor per loop iteration. For small and medium numbers of file	602	file descriptor per loop iteration. For small and medium numbers of file
556	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	603	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
557	might perform better.	604	might perform better.
558		605
559	On the positive side, with the exception of the spurious readiness	606	On the positive side, this backend actually performed fully to
560	notifications, this backend actually performed fully to specification
561	in all tests and is fully embeddable, which is a rare feat among the	607	specification in all tests and is fully embeddable, which is a rare feat
562	OS-specific backends (I vastly prefer correctness over speed hacks).	608	among the OS-specific backends (I vastly prefer correctness over speed
		609	hacks).
		610
		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
		613	function sometimes returns events to the caller even though an error
		614	occurred, but with no indication whether it has done so or not (yes, it's
		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
		619	Fortunately libev seems to be able to work around these idiocies.
563		620
564	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
565	C<EVBACKEND_POLL>.	622	C<EVBACKEND_POLL>.
566		623
567	=item C<EVBACKEND_ALL>	624	=item C<EVBACKEND_ALL>
568		625
569	Try all backends (even potentially broken ones that wouldn't be tried	626	Try all backends (even potentially broken ones that wouldn't be tried
570	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	627	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
571	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	628	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
572		629
573	It is definitely not recommended to use this flag.	630	It is definitely not recommended to use this flag, use whatever
		631	C<ev_recommended_backends ()> returns, or simply do not specify a backend
		632	at all.
		633
		634	=item C<EVBACKEND_MASK>
		635
		636	Not a backend at all, but a mask to select all backend bits from a
		637	C<flags> value, in case you want to mask out any backends from a flags
		638	value (e.g. when modifying the C<LIBEV_FLAGS> environment variable).
574		639
575	=back	640	=back
576		641
577	If one or more of the backend flags are or'ed into the flags value,	642	If one or more of the backend flags are or'ed into the flags value,
578	then only these backends will be tried (in the reverse order as listed	643	then only these backends will be tried (in the reverse order as listed
…		…
607	This function is normally used on loop objects allocated by	672	This function is normally used on loop objects allocated by
608	C<ev_loop_new>, but it can also be used on the default loop returned by	673	C<ev_loop_new>, but it can also be used on the default loop returned by
609	C<ev_default_loop>, in which case it is not thread-safe.	674	C<ev_default_loop>, in which case it is not thread-safe.
610		675
611	Note that it is not advisable to call this function on the default loop	676	Note that it is not advisable to call this function on the default loop
612	except in the rare occasion where you really need to free it's resources.	677	except in the rare occasion where you really need to free its resources.
613	If you need dynamically allocated loops it is better to use C<ev_loop_new>	678	If you need dynamically allocated loops it is better to use C<ev_loop_new>
614	and C<ev_loop_destroy>.	679	and C<ev_loop_destroy>.
615		680
616	=item ev_loop_fork (loop)	681	=item ev_loop_fork (loop)
617		682
…		…
665	prepare and check phases.	730	prepare and check phases.
666		731
667	=item unsigned int ev_depth (loop)	732	=item unsigned int ev_depth (loop)
668		733
669	Returns the number of times C<ev_run> was entered minus the number of	734	Returns the number of times C<ev_run> was entered minus the number of
670	times C<ev_run> was exited, in other words, the recursion depth.	735	times C<ev_run> was exited normally, in other words, the recursion depth.
671		736
672	Outside C<ev_run>, this number is zero. In a callback, this number is	737	Outside C<ev_run>, this number is zero. In a callback, this number is
673	C<1>, unless C<ev_run> was invoked recursively (or from another thread),	738	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
674	in which case it is higher.	739	in which case it is higher.
675		740
676	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread	741	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread,
677	etc.), doesn't count as "exit" - consider this as a hint to avoid such	742	throwing an exception etc.), doesn't count as "exit" - consider this
678	ungentleman-like behaviour unless it's really convenient.	743	as a hint to avoid such ungentleman-like behaviour unless it's really
		744	convenient, in which case it is fully supported.
679		745
680	=item unsigned int ev_backend (loop)	746	=item unsigned int ev_backend (loop)
681		747
682	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	748	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
683	use.	749	use.
…		…
745	finished (especially in interactive programs), but having a program	811	finished (especially in interactive programs), but having a program
746	that automatically loops as long as it has to and no longer by virtue	812	that automatically loops as long as it has to and no longer by virtue
747	of relying on its watchers stopping correctly, that is truly a thing of	813	of relying on its watchers stopping correctly, that is truly a thing of
748	beauty.	814	beauty.
749		815
		816	This function is also I<mostly> exception-safe - you can break out of
		817	a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
		818	exception and so on. This does not decrement the C<ev_depth> value, nor
		819	will it clear any outstanding C<EVBREAK_ONE> breaks.
		820
750	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle	821	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
751	those events and any already outstanding ones, but will not wait and	822	those events and any already outstanding ones, but will not wait and
752	block your process in case there are no events and will return after one	823	block your process in case there are no events and will return after one
753	iteration of the loop. This is sometimes useful to poll and handle new	824	iteration of the loop. This is sometimes useful to poll and handle new
754	events while doing lengthy calculations, to keep the program responsive.	825	events while doing lengthy calculations, to keep the program responsive.
…		…
763	This is useful if you are waiting for some external event in conjunction	834	This is useful if you are waiting for some external event in conjunction
764	with something not expressible using other libev watchers (i.e. "roll your	835	with something not expressible using other libev watchers (i.e. "roll your
765	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is	836	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
766	usually a better approach for this kind of thing.	837	usually a better approach for this kind of thing.
767		838
768	Here are the gory details of what C<ev_run> does:	839	Here are the gory details of what C<ev_run> does (this is for your
		840	understanding, not a guarantee that things will work exactly like this in
		841	future versions):
769		842
770	- Increment loop depth.	843	- Increment loop depth.
771	- Reset the ev_break status.	844	- Reset the ev_break status.
772	- Before the first iteration, call any pending watchers.	845	- Before the first iteration, call any pending watchers.
773	LOOP:	846	LOOP:
…		…
806	anymore.	879	anymore.
807		880
808	... queue jobs here, make sure they register event watchers as long	881	... queue jobs here, make sure they register event watchers as long
809	... as they still have work to do (even an idle watcher will do..)	882	... as they still have work to do (even an idle watcher will do..)
810	ev_run (my_loop, 0);	883	ev_run (my_loop, 0);
811	... jobs done or somebody called unloop. yeah!	884	... jobs done or somebody called break. yeah!
812		885
813	=item ev_break (loop, how)	886	=item ev_break (loop, how)
814		887
815	Can be used to make a call to C<ev_run> return early (but only after it	888	Can be used to make a call to C<ev_run> return early (but only after it
816	has processed all outstanding events). The C<how> argument must be either	889	has processed all outstanding events). The C<how> argument must be either
817	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or	890	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
818	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.	891	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
819		892
820	This "unloop state" will be cleared when entering C<ev_run> again.	893	This "break state" will be cleared on the next call to C<ev_run>.
821		894
822	It is safe to call C<ev_break> from outside any C<ev_run> calls. ##TODO##	895	It is safe to call C<ev_break> from outside any C<ev_run> calls, too, in
		896	which case it will have no effect.
823		897
824	=item ev_ref (loop)	898	=item ev_ref (loop)
825		899
826	=item ev_unref (loop)	900	=item ev_unref (loop)
827		901
…		…
848	running when nothing else is active.	922	running when nothing else is active.
849		923
850	ev_signal exitsig;	924	ev_signal exitsig;
851	ev_signal_init (&exitsig, sig_cb, SIGINT);	925	ev_signal_init (&exitsig, sig_cb, SIGINT);
852	ev_signal_start (loop, &exitsig);	926	ev_signal_start (loop, &exitsig);
853	evf_unref (loop);	927	ev_unref (loop);
854		928
855	Example: For some weird reason, unregister the above signal handler again.	929	Example: For some weird reason, unregister the above signal handler again.
856		930
857	ev_ref (loop);	931	ev_ref (loop);
858	ev_signal_stop (loop, &exitsig);	932	ev_signal_stop (loop, &exitsig);
…		…
878	overhead for the actual polling but can deliver many events at once.	952	overhead for the actual polling but can deliver many events at once.
879		953
880	By setting a higher I<io collect interval> you allow libev to spend more	954	By setting a higher I<io collect interval> you allow libev to spend more
881	time collecting I/O events, so you can handle more events per iteration,	955	time collecting I/O events, so you can handle more events per iteration,
882	at the cost of increasing latency. Timeouts (both C<ev_periodic> and	956	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
883	C<ev_timer>) will be not affected. Setting this to a non-null value will	957	C<ev_timer>) will not be affected. Setting this to a non-null value will
884	introduce an additional C<ev_sleep ()> call into most loop iterations. The	958	introduce an additional C<ev_sleep ()> call into most loop iterations. The
885	sleep time ensures that libev will not poll for I/O events more often then	959	sleep time ensures that libev will not poll for I/O events more often then
886	once per this interval, on average.	960	once per this interval, on average (as long as the host time resolution is
		961	good enough).
887		962
888	Likewise, by setting a higher I<timeout collect interval> you allow libev	963	Likewise, by setting a higher I<timeout collect interval> you allow libev
889	to spend more time collecting timeouts, at the expense of increased	964	to spend more time collecting timeouts, at the expense of increased
890	latency/jitter/inexactness (the watcher callback will be called	965	latency/jitter/inexactness (the watcher callback will be called
891	later). C<ev_io> watchers will not be affected. Setting this to a non-null	966	later). C<ev_io> watchers will not be affected. Setting this to a non-null
…		…
945	can be done relatively simply by putting mutex_lock/unlock calls around	1020	can be done relatively simply by putting mutex_lock/unlock calls around
946	each call to a libev function.	1021	each call to a libev function.
947		1022
948	However, C<ev_run> can run an indefinite time, so it is not feasible	1023	However, C<ev_run> can run an indefinite time, so it is not feasible
949	to wait for it to return. One way around this is to wake up the event	1024	to wait for it to return. One way around this is to wake up the event
950	loop via C<ev_break> and C<av_async_send>, another way is to set these	1025	loop via C<ev_break> and C<ev_async_send>, another way is to set these
951	I<release> and I<acquire> callbacks on the loop.	1026	I<release> and I<acquire> callbacks on the loop.
952		1027
953	When set, then C<release> will be called just before the thread is	1028	When set, then C<release> will be called just before the thread is
954	suspended waiting for new events, and C<acquire> is called just	1029	suspended waiting for new events, and C<acquire> is called just
955	afterwards.	1030	afterwards.
…		…
970	See also the locking example in the C<THREADS> section later in this	1045	See also the locking example in the C<THREADS> section later in this
971	document.	1046	document.
972		1047
973	=item ev_set_userdata (loop, void *data)	1048	=item ev_set_userdata (loop, void *data)
974		1049
975	=item ev_userdata (loop)	1050	=item void *ev_userdata (loop)
976		1051
977	Set and retrieve a single C<void *> associated with a loop. When	1052	Set and retrieve a single C<void *> associated with a loop. When
978	C<ev_set_userdata> has never been called, then C<ev_userdata> returns	1053	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
979	C<0.>	1054	C<0>.
980		1055
981	These two functions can be used to associate arbitrary data with a loop,	1056	These two functions can be used to associate arbitrary data with a loop,
982	and are intended solely for the C<invoke_pending_cb>, C<release> and	1057	and are intended solely for the C<invoke_pending_cb>, C<release> and
983	C<acquire> callbacks described above, but of course can be (ab-)used for	1058	C<acquire> callbacks described above, but of course can be (ab-)used for
984	any other purpose as well.	1059	any other purpose as well.
…		…
1114	The event loop has been resumed in the child process after fork (see	1189	The event loop has been resumed in the child process after fork (see
1115	C<ev_fork>).	1190	C<ev_fork>).
1116		1191
1117	=item C<EV_CLEANUP>	1192	=item C<EV_CLEANUP>
1118		1193
1119	The event loop is abotu to be destroyed (see C<ev_cleanup>).	1194	The event loop is about to be destroyed (see C<ev_cleanup>).
1120		1195
1121	=item C<EV_ASYNC>	1196	=item C<EV_ASYNC>
1122		1197
1123	The given async watcher has been asynchronously notified (see C<ev_async>).	1198	The given async watcher has been asynchronously notified (see C<ev_async>).
1124		1199
…		…
1146	programs, though, as the fd could already be closed and reused for another	1221	programs, though, as the fd could already be closed and reused for another
1147	thing, so beware.	1222	thing, so beware.
1148		1223
1149	=back	1224	=back
1150		1225
		1226	=head2 GENERIC WATCHER FUNCTIONS
		1227
		1228	=over 4
		1229
		1230	=item C<ev_init> (ev_TYPE *watcher, callback)
		1231
		1232	This macro initialises the generic portion of a watcher. The contents
		1233	of the watcher object can be arbitrary (so C<malloc> will do). Only
		1234	the generic parts of the watcher are initialised, you I<need> to call
		1235	the type-specific C<ev_TYPE_set> macro afterwards to initialise the
		1236	type-specific parts. For each type there is also a C<ev_TYPE_init> macro
		1237	which rolls both calls into one.
		1238
		1239	You can reinitialise a watcher at any time as long as it has been stopped
		1240	(or never started) and there are no pending events outstanding.
		1241
		1242	The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
		1243	int revents)>.
		1244
		1245	Example: Initialise an C<ev_io> watcher in two steps.
		1246
		1247	ev_io w;
		1248	ev_init (&w, my_cb);
		1249	ev_io_set (&w, STDIN_FILENO, EV_READ);
		1250
		1251	=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
		1252
		1253	This macro initialises the type-specific parts of a watcher. You need to
		1254	call C<ev_init> at least once before you call this macro, but you can
		1255	call C<ev_TYPE_set> any number of times. You must not, however, call this
		1256	macro on a watcher that is active (it can be pending, however, which is a
		1257	difference to the C<ev_init> macro).
		1258
		1259	Although some watcher types do not have type-specific arguments
		1260	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
		1261
		1262	See C<ev_init>, above, for an example.
		1263
		1264	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
		1265
		1266	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
		1267	calls into a single call. This is the most convenient method to initialise
		1268	a watcher. The same limitations apply, of course.
		1269
		1270	Example: Initialise and set an C<ev_io> watcher in one step.
		1271
		1272	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
		1273
		1274	=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
		1275
		1276	Starts (activates) the given watcher. Only active watchers will receive
		1277	events. If the watcher is already active nothing will happen.
		1278
		1279	Example: Start the C<ev_io> watcher that is being abused as example in this
		1280	whole section.
		1281
		1282	ev_io_start (EV_DEFAULT_UC, &w);
		1283
		1284	=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
		1285
		1286	Stops the given watcher if active, and clears the pending status (whether
		1287	the watcher was active or not).
		1288
		1289	It is possible that stopped watchers are pending - for example,
		1290	non-repeating timers are being stopped when they become pending - but
		1291	calling C<ev_TYPE_stop> ensures that the watcher is neither active nor
		1292	pending. If you want to free or reuse the memory used by the watcher it is
		1293	therefore a good idea to always call its C<ev_TYPE_stop> function.
		1294
		1295	=item bool ev_is_active (ev_TYPE *watcher)
		1296
		1297	Returns a true value iff the watcher is active (i.e. it has been started
		1298	and not yet been stopped). As long as a watcher is active you must not modify
		1299	it.
		1300
		1301	=item bool ev_is_pending (ev_TYPE *watcher)
		1302
		1303	Returns a true value iff the watcher is pending, (i.e. it has outstanding
		1304	events but its callback has not yet been invoked). As long as a watcher
		1305	is pending (but not active) you must not call an init function on it (but
		1306	C<ev_TYPE_set> is safe), you must not change its priority, and you must
		1307	make sure the watcher is available to libev (e.g. you cannot C<free ()>
		1308	it).
		1309
		1310	=item callback ev_cb (ev_TYPE *watcher)
		1311
		1312	Returns the callback currently set on the watcher.
		1313
		1314	=item ev_cb_set (ev_TYPE *watcher, callback)
		1315
		1316	Change the callback. You can change the callback at virtually any time
		1317	(modulo threads).
		1318
		1319	=item ev_set_priority (ev_TYPE *watcher, int priority)
		1320
		1321	=item int ev_priority (ev_TYPE *watcher)
		1322
		1323	Set and query the priority of the watcher. The priority is a small
		1324	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
		1325	(default: C<-2>). Pending watchers with higher priority will be invoked
		1326	before watchers with lower priority, but priority will not keep watchers
		1327	from being executed (except for C<ev_idle> watchers).
		1328
		1329	If you need to suppress invocation when higher priority events are pending
		1330	you need to look at C<ev_idle> watchers, which provide this functionality.
		1331
		1332	You I<must not> change the priority of a watcher as long as it is active or
		1333	pending.
		1334
		1335	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		1336	fine, as long as you do not mind that the priority value you query might
		1337	or might not have been clamped to the valid range.
		1338
		1339	The default priority used by watchers when no priority has been set is
		1340	always C<0>, which is supposed to not be too high and not be too low :).
		1341
		1342	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
		1343	priorities.
		1344
		1345	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
		1346
		1347	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
		1348	C<loop> nor C<revents> need to be valid as long as the watcher callback
		1349	can deal with that fact, as both are simply passed through to the
		1350	callback.
		1351
		1352	=item int ev_clear_pending (loop, ev_TYPE *watcher)
		1353
		1354	If the watcher is pending, this function clears its pending status and
		1355	returns its C<revents> bitset (as if its callback was invoked). If the
		1356	watcher isn't pending it does nothing and returns C<0>.
		1357
		1358	Sometimes it can be useful to "poll" a watcher instead of waiting for its
		1359	callback to be invoked, which can be accomplished with this function.
		1360
		1361	=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
		1362
		1363	Feeds the given event set into the event loop, as if the specified event
		1364	had happened for the specified watcher (which must be a pointer to an
		1365	initialised but not necessarily started event watcher). Obviously you must
		1366	not free the watcher as long as it has pending events.
		1367
		1368	Stopping the watcher, letting libev invoke it, or calling
		1369	C<ev_clear_pending> will clear the pending event, even if the watcher was
		1370	not started in the first place.
		1371
		1372	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
		1373	functions that do not need a watcher.
		1374
		1375	=back
		1376
		1377	See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
		1378	OWN COMPOSITE WATCHERS> idioms.
		1379
1151	=head2 WATCHER STATES	1380	=head2 WATCHER STATES
1152		1381
1153	There are various watcher states mentioned throughout this manual -	1382	There are various watcher states mentioned throughout this manual -
1154	active, pending and so on. In this section these states and the rules to	1383	active, pending and so on. In this section these states and the rules to
1155	transition between them will be described in more detail - and while these	1384	transition between them will be described in more detail - and while these
…		…
1157		1386
1158	=over 4	1387	=over 4
1159		1388
1160	=item initialiased	1389	=item initialiased
1161		1390
1162	Before a watcher can be registered with the event looop it has to be	1391	Before a watcher can be registered with the event loop it has to be
1163	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to	1392	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1164	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.	1393	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1165		1394
1166	In this state it is simply some block of memory that is suitable for use	1395	In this state it is simply some block of memory that is suitable for
1167	in an event loop. It can be moved around, freed, reused etc. at will.	1396	use in an event loop. It can be moved around, freed, reused etc. at
		1397	will - as long as you either keep the memory contents intact, or call
		1398	C<ev_TYPE_init> again.
1168		1399
1169	=item started/running/active	1400	=item started/running/active
1170		1401
1171	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes	1402	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1172	property of the event loop, and is actively waiting for events. While in	1403	property of the event loop, and is actively waiting for events. While in
…		…
1200	latter will clear any pending state the watcher might be in, regardless	1431	latter will clear any pending state the watcher might be in, regardless
1201	of whether it was active or not, so stopping a watcher explicitly before	1432	of whether it was active or not, so stopping a watcher explicitly before
1202	freeing it is often a good idea.	1433	freeing it is often a good idea.
1203		1434
1204	While stopped (and not pending) the watcher is essentially in the	1435	While stopped (and not pending) the watcher is essentially in the
1205	initialised state, that is it can be reused, moved, modified in any way	1436	initialised state, that is, it can be reused, moved, modified in any way
1206	you wish.	1437	you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
		1438	it again).
1207		1439
1208	=back	1440	=back
1209
1210	=head2 GENERIC WATCHER FUNCTIONS
1211
1212	=over 4
1213
1214	=item C<ev_init> (ev_TYPE *watcher, callback)
1215
1216	This macro initialises the generic portion of a watcher. The contents
1217	of the watcher object can be arbitrary (so C<malloc> will do). Only
1218	the generic parts of the watcher are initialised, you I<need> to call
1219	the type-specific C<ev_TYPE_set> macro afterwards to initialise the
1220	type-specific parts. For each type there is also a C<ev_TYPE_init> macro
1221	which rolls both calls into one.
1222
1223	You can reinitialise a watcher at any time as long as it has been stopped
1224	(or never started) and there are no pending events outstanding.
1225
1226	The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
1227	int revents)>.
1228
1229	Example: Initialise an C<ev_io> watcher in two steps.
1230
1231	ev_io w;
1232	ev_init (&w, my_cb);
1233	ev_io_set (&w, STDIN_FILENO, EV_READ);
1234
1235	=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
1236
1237	This macro initialises the type-specific parts of a watcher. You need to
1238	call C<ev_init> at least once before you call this macro, but you can
1239	call C<ev_TYPE_set> any number of times. You must not, however, call this
1240	macro on a watcher that is active (it can be pending, however, which is a
1241	difference to the C<ev_init> macro).
1242
1243	Although some watcher types do not have type-specific arguments
1244	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
1245
1246	See C<ev_init>, above, for an example.
1247
1248	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
1249
1250	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
1251	calls into a single call. This is the most convenient method to initialise
1252	a watcher. The same limitations apply, of course.
1253
1254	Example: Initialise and set an C<ev_io> watcher in one step.
1255
1256	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1257
1258	=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1259
1260	Starts (activates) the given watcher. Only active watchers will receive
1261	events. If the watcher is already active nothing will happen.
1262
1263	Example: Start the C<ev_io> watcher that is being abused as example in this
1264	whole section.
1265
1266	ev_io_start (EV_DEFAULT_UC, &w);
1267
1268	=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1269
1270	Stops the given watcher if active, and clears the pending status (whether
1271	the watcher was active or not).
1272
1273	It is possible that stopped watchers are pending - for example,
1274	non-repeating timers are being stopped when they become pending - but
1275	calling C<ev_TYPE_stop> ensures that the watcher is neither active nor
1276	pending. If you want to free or reuse the memory used by the watcher it is
1277	therefore a good idea to always call its C<ev_TYPE_stop> function.
1278
1279	=item bool ev_is_active (ev_TYPE *watcher)
1280
1281	Returns a true value iff the watcher is active (i.e. it has been started
1282	and not yet been stopped). As long as a watcher is active you must not modify
1283	it.
1284
1285	=item bool ev_is_pending (ev_TYPE *watcher)
1286
1287	Returns a true value iff the watcher is pending, (i.e. it has outstanding
1288	events but its callback has not yet been invoked). As long as a watcher
1289	is pending (but not active) you must not call an init function on it (but
1290	C<ev_TYPE_set> is safe), you must not change its priority, and you must
1291	make sure the watcher is available to libev (e.g. you cannot C<free ()>
1292	it).
1293
1294	=item callback ev_cb (ev_TYPE *watcher)
1295
1296	Returns the callback currently set on the watcher.
1297
1298	=item ev_cb_set (ev_TYPE *watcher, callback)
1299
1300	Change the callback. You can change the callback at virtually any time
1301	(modulo threads).
1302
1303	=item ev_set_priority (ev_TYPE *watcher, int priority)
1304
1305	=item int ev_priority (ev_TYPE *watcher)
1306
1307	Set and query the priority of the watcher. The priority is a small
1308	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1309	(default: C<-2>). Pending watchers with higher priority will be invoked
1310	before watchers with lower priority, but priority will not keep watchers
1311	from being executed (except for C<ev_idle> watchers).
1312
1313	If you need to suppress invocation when higher priority events are pending
1314	you need to look at C<ev_idle> watchers, which provide this functionality.
1315
1316	You I<must not> change the priority of a watcher as long as it is active or
1317	pending.
1318
1319	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
1320	fine, as long as you do not mind that the priority value you query might
1321	or might not have been clamped to the valid range.
1322
1323	The default priority used by watchers when no priority has been set is
1324	always C<0>, which is supposed to not be too high and not be too low :).
1325
1326	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1327	priorities.
1328
1329	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1330
1331	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1332	C<loop> nor C<revents> need to be valid as long as the watcher callback
1333	can deal with that fact, as both are simply passed through to the
1334	callback.
1335
1336	=item int ev_clear_pending (loop, ev_TYPE *watcher)
1337
1338	If the watcher is pending, this function clears its pending status and
1339	returns its C<revents> bitset (as if its callback was invoked). If the
1340	watcher isn't pending it does nothing and returns C<0>.
1341
1342	Sometimes it can be useful to "poll" a watcher instead of waiting for its
1343	callback to be invoked, which can be accomplished with this function.
1344
1345	=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
1346
1347	Feeds the given event set into the event loop, as if the specified event
1348	had happened for the specified watcher (which must be a pointer to an
1349	initialised but not necessarily started event watcher). Obviously you must
1350	not free the watcher as long as it has pending events.
1351
1352	Stopping the watcher, letting libev invoke it, or calling
1353	C<ev_clear_pending> will clear the pending event, even if the watcher was
1354	not started in the first place.
1355
1356	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1357	functions that do not need a watcher.
1358
1359	=back
1360
1361
1362	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
1363
1364	Each watcher has, by default, a member C<void *data> that you can change
1365	and read at any time: libev will completely ignore it. This can be used
1366	to associate arbitrary data with your watcher. If you need more data and
1367	don't want to allocate memory and store a pointer to it in that data
1368	member, you can also "subclass" the watcher type and provide your own
1369	data:
1370
1371	struct my_io
1372	{
1373	ev_io io;
1374	int otherfd;
1375	void *somedata;
1376	struct whatever *mostinteresting;
1377	};
1378
1379	...
1380	struct my_io w;
1381	ev_io_init (&w.io, my_cb, fd, EV_READ);
1382
1383	And since your callback will be called with a pointer to the watcher, you
1384	can cast it back to your own type:
1385
1386	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
1387	{
1388	struct my_io *w = (struct my_io *)w_;
1389	...
1390	}
1391
1392	More interesting and less C-conformant ways of casting your callback type
1393	instead have been omitted.
1394
1395	Another common scenario is to use some data structure with multiple
1396	embedded watchers:
1397
1398	struct my_biggy
1399	{
1400	int some_data;
1401	ev_timer t1;
1402	ev_timer t2;
1403	}
1404
1405	In this case getting the pointer to C<my_biggy> is a bit more
1406	complicated: Either you store the address of your C<my_biggy> struct
1407	in the C<data> member of the watcher (for woozies), or you need to use
1408	some pointer arithmetic using C<offsetof> inside your watchers (for real
1409	programmers):
1410
1411	#include <stddef.h>
1412
1413	static void
1414	t1_cb (EV_P_ ev_timer *w, int revents)
1415	{
1416	struct my_biggy big = (struct my_biggy *)
1417	(((char *)w) - offsetof (struct my_biggy, t1));
1418	}
1419
1420	static void
1421	t2_cb (EV_P_ ev_timer *w, int revents)
1422	{
1423	struct my_biggy big = (struct my_biggy *)
1424	(((char *)w) - offsetof (struct my_biggy, t2));
1425	}
1426		1441
1427	=head2 WATCHER PRIORITY MODELS	1442	=head2 WATCHER PRIORITY MODELS
1428		1443
1429	Many event loops support I<watcher priorities>, which are usually small	1444	Many event loops support I<watcher priorities>, which are usually small
1430	integers that influence the ordering of event callback invocation	1445	integers that influence the ordering of event callback invocation
…		…
1557	In general you can register as many read and/or write event watchers per	1572	In general you can register as many read and/or write event watchers per
1558	fd as you want (as long as you don't confuse yourself). Setting all file	1573	fd as you want (as long as you don't confuse yourself). Setting all file
1559	descriptors to non-blocking mode is also usually a good idea (but not	1574	descriptors to non-blocking mode is also usually a good idea (but not
1560	required if you know what you are doing).	1575	required if you know what you are doing).
1561		1576
1562	If you cannot use non-blocking mode, then force the use of a
1563	known-to-be-good backend (at the time of this writing, this includes only
1564	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1565	descriptors for which non-blocking operation makes no sense (such as
1566	files) - libev doesn't guarantee any specific behaviour in that case.
1567
1568	Another thing you have to watch out for is that it is quite easy to	1577	Another thing you have to watch out for is that it is quite easy to
1569	receive "spurious" readiness notifications, that is your callback might	1578	receive "spurious" readiness notifications, that is, your callback might
1570	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1579	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1571	because there is no data. Not only are some backends known to create a	1580	because there is no data. It is very easy to get into this situation even
1572	lot of those (for example Solaris ports), it is very easy to get into	1581	with a relatively standard program structure. Thus it is best to always
1573	this situation even with a relatively standard program structure. Thus	1582	use non-blocking I/O: An extra C<read>(2) returning C<EAGAIN> is far
1574	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1575	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1583	preferable to a program hanging until some data arrives.
1576		1584
1577	If you cannot run the fd in non-blocking mode (for example you should	1585	If you cannot run the fd in non-blocking mode (for example you should
1578	not play around with an Xlib connection), then you have to separately	1586	not play around with an Xlib connection), then you have to separately
1579	re-test whether a file descriptor is really ready with a known-to-be good	1587	re-test whether a file descriptor is really ready with a known-to-be good
1580	interface such as poll (fortunately in our Xlib example, Xlib already	1588	interface such as poll (fortunately in the case of Xlib, it already does
1581	does this on its own, so its quite safe to use). Some people additionally	1589	this on its own, so its quite safe to use). Some people additionally
1582	use C<SIGALRM> and an interval timer, just to be sure you won't block	1590	use C<SIGALRM> and an interval timer, just to be sure you won't block
1583	indefinitely.	1591	indefinitely.
1584		1592
1585	But really, best use non-blocking mode.	1593	But really, best use non-blocking mode.
1586		1594
…		…
1614		1622
1615	There is no workaround possible except not registering events	1623	There is no workaround possible except not registering events
1616	for potentially C<dup ()>'ed file descriptors, or to resort to	1624	for potentially C<dup ()>'ed file descriptors, or to resort to
1617	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1625	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1618		1626
		1627	=head3 The special problem of files
		1628
		1629	Many people try to use C<select> (or libev) on file descriptors
		1630	representing files, and expect it to become ready when their program
		1631	doesn't block on disk accesses (which can take a long time on their own).
		1632
		1633	However, this cannot ever work in the "expected" way - you get a readiness
		1634	notification as soon as the kernel knows whether and how much data is
		1635	there, and in the case of open files, that's always the case, so you
		1636	always get a readiness notification instantly, and your read (or possibly
		1637	write) will still block on the disk I/O.
		1638
		1639	Another way to view it is that in the case of sockets, pipes, character
		1640	devices and so on, there is another party (the sender) that delivers data
		1641	on its own, but in the case of files, there is no such thing: the disk
		1642	will not send data on its own, simply because it doesn't know what you
		1643	wish to read - you would first have to request some data.
		1644
		1645	Since files are typically not-so-well supported by advanced notification
		1646	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1647	to files, even though you should not use it. The reason for this is
		1648	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1649	usually a tty, often a pipe, but also sometimes files or special devices
		1650	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1651	F</dev/urandom>), and even though the file might better be served with
		1652	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1653	it "just works" instead of freezing.
		1654
		1655	So avoid file descriptors pointing to files when you know it (e.g. use
		1656	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1657	when you rarely read from a file instead of from a socket, and want to
		1658	reuse the same code path.
		1659
1619	=head3 The special problem of fork	1660	=head3 The special problem of fork
1620		1661
1621	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1662	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1622	useless behaviour. Libev fully supports fork, but needs to be told about	1663	useless behaviour. Libev fully supports fork, but needs to be told about
1623	it in the child.	1664	it in the child if you want to continue to use it in the child.
1624		1665
1625	To support fork in your programs, you either have to call	1666	To support fork in your child processes, you have to call C<ev_loop_fork
1626	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1667	()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1627	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1668	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1628	C<EVBACKEND_POLL>.
1629		1669
1630	=head3 The special problem of SIGPIPE	1670	=head3 The special problem of SIGPIPE
1631		1671
1632	While not really specific to libev, it is easy to forget about C<SIGPIPE>:	1672	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1633	when writing to a pipe whose other end has been closed, your program gets	1673	when writing to a pipe whose other end has been closed, your program gets
…		…
1731	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1771	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1732	monotonic clock option helps a lot here).	1772	monotonic clock option helps a lot here).
1733		1773
1734	The callback is guaranteed to be invoked only I<after> its timeout has	1774	The callback is guaranteed to be invoked only I<after> its timeout has
1735	passed (not I<at>, so on systems with very low-resolution clocks this	1775	passed (not I<at>, so on systems with very low-resolution clocks this
1736	might introduce a small delay). If multiple timers become ready during the	1776	might introduce a small delay, see "the special problem of being too
		1777	early", below). If multiple timers become ready during the same loop
1737	same loop iteration then the ones with earlier time-out values are invoked	1778	iteration then the ones with earlier time-out values are invoked before
1738	before ones of the same priority with later time-out values (but this is	1779	ones of the same priority with later time-out values (but this is no
1739	no longer true when a callback calls C<ev_run> recursively).	1780	longer true when a callback calls C<ev_run> recursively).
1740		1781
1741	=head3 Be smart about timeouts	1782	=head3 Be smart about timeouts
1742		1783
1743	Many real-world problems involve some kind of timeout, usually for error	1784	Many real-world problems involve some kind of timeout, usually for error
1744	recovery. A typical example is an HTTP request - if the other side hangs,	1785	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1819		1860
1820	In this case, it would be more efficient to leave the C<ev_timer> alone,	1861	In this case, it would be more efficient to leave the C<ev_timer> alone,
1821	but remember the time of last activity, and check for a real timeout only	1862	but remember the time of last activity, and check for a real timeout only
1822	within the callback:	1863	within the callback:
1823		1864
		1865	ev_tstamp timeout = 60.;
1824	ev_tstamp last_activity; // time of last activity	1866	ev_tstamp last_activity; // time of last activity
		1867	ev_timer timer;
1825		1868
1826	static void	1869	static void
1827	callback (EV_P_ ev_timer *w, int revents)	1870	callback (EV_P_ ev_timer *w, int revents)
1828	{	1871	{
1829	ev_tstamp now = ev_now (EV_A);	1872	// calculate when the timeout would happen
1830	ev_tstamp timeout = last_activity + 60.;	1873	ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1831		1874
1832	// if last_activity + 60. is older than now, we did time out	1875	// if negative, it means we the timeout already occured
1833	if (timeout < now)	1876	if (after < 0.)
1834	{	1877	{
1835	// timeout occurred, take action	1878	// timeout occurred, take action
1836	}	1879	}
1837	else	1880	else
1838	{	1881	{
1839	// callback was invoked, but there was some activity, re-arm	1882	// callback was invoked, but there was some recent
1840	// the watcher to fire in last_activity + 60, which is	1883	// activity. simply restart the timer to time out
1841	// guaranteed to be in the future, so "again" is positive:	1884	// after "after" seconds, which is the earliest time
1842	w->repeat = timeout - now;	1885	// the timeout can occur.
		1886	ev_timer_set (w, after, 0.);
1843	ev_timer_again (EV_A_ w);	1887	ev_timer_start (EV_A_ w);
1844	}	1888	}
1845	}	1889	}
1846		1890
1847	To summarise the callback: first calculate the real timeout (defined	1891	To summarise the callback: first calculate in how many seconds the
1848	as "60 seconds after the last activity"), then check if that time has	1892	timeout will occur (by calculating the absolute time when it would occur,
1849	been reached, which means something I<did>, in fact, time out. Otherwise	1893	C<last_activity + timeout>, and subtracting the current time, C<ev_now
1850	the callback was invoked too early (C<timeout> is in the future), so	1894	(EV_A)> from that).
1851	re-schedule the timer to fire at that future time, to see if maybe we have
1852	a timeout then.
1853		1895
1854	Note how C<ev_timer_again> is used, taking advantage of the	1896	If this value is negative, then we are already past the timeout, i.e. we
1855	C<ev_timer_again> optimisation when the timer is already running.	1897	timed out, and need to do whatever is needed in this case.
		1898
		1899	Otherwise, we now the earliest time at which the timeout would trigger,
		1900	and simply start the timer with this timeout value.
		1901
		1902	In other words, each time the callback is invoked it will check whether
		1903	the timeout cocured. If not, it will simply reschedule itself to check
		1904	again at the earliest time it could time out. Rinse. Repeat.
1856		1905
1857	This scheme causes more callback invocations (about one every 60 seconds	1906	This scheme causes more callback invocations (about one every 60 seconds
1858	minus half the average time between activity), but virtually no calls to	1907	minus half the average time between activity), but virtually no calls to
1859	libev to change the timeout.	1908	libev to change the timeout.
1860		1909
1861	To start the timer, simply initialise the watcher and set C<last_activity>	1910	To start the machinery, simply initialise the watcher and set
1862	to the current time (meaning we just have some activity :), then call the	1911	C<last_activity> to the current time (meaning there was some activity just
1863	callback, which will "do the right thing" and start the timer:	1912	now), then call the callback, which will "do the right thing" and start
		1913	the timer:
1864		1914
		1915	last_activity = ev_now (EV_A);
1865	ev_init (timer, callback);	1916	ev_init (&timer, callback);
1866	last_activity = ev_now (loop);	1917	callback (EV_A_ &timer, 0);
1867	callback (loop, timer, EV_TIMER);
1868		1918
1869	And when there is some activity, simply store the current time in	1919	When there is some activity, simply store the current time in
1870	C<last_activity>, no libev calls at all:	1920	C<last_activity>, no libev calls at all:
1871		1921
		1922	if (activity detected)
1872	last_activity = ev_now (loop);	1923	last_activity = ev_now (EV_A);
		1924
		1925	When your timeout value changes, then the timeout can be changed by simply
		1926	providing a new value, stopping the timer and calling the callback, which
		1927	will agaion do the right thing (for example, time out immediately :).
		1928
		1929	timeout = new_value;
		1930	ev_timer_stop (EV_A_ &timer);
		1931	callback (EV_A_ &timer, 0);
1873		1932
1874	This technique is slightly more complex, but in most cases where the	1933	This technique is slightly more complex, but in most cases where the
1875	time-out is unlikely to be triggered, much more efficient.	1934	time-out is unlikely to be triggered, much more efficient.
1876
1877	Changing the timeout is trivial as well (if it isn't hard-coded in the
1878	callback :) - just change the timeout and invoke the callback, which will
1879	fix things for you.
1880		1935
1881	=item 4. Wee, just use a double-linked list for your timeouts.	1936	=item 4. Wee, just use a double-linked list for your timeouts.
1882		1937
1883	If there is not one request, but many thousands (millions...), all	1938	If there is not one request, but many thousands (millions...), all
1884	employing some kind of timeout with the same timeout value, then one can	1939	employing some kind of timeout with the same timeout value, then one can
…		…
1911	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is	1966	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1912	rather complicated, but extremely efficient, something that really pays	1967	rather complicated, but extremely efficient, something that really pays
1913	off after the first million or so of active timers, i.e. it's usually	1968	off after the first million or so of active timers, i.e. it's usually
1914	overkill :)	1969	overkill :)
1915		1970
		1971	=head3 The special problem of being too early
		1972
		1973	If you ask a timer to call your callback after three seconds, then
		1974	you expect it to be invoked after three seconds - but of course, this
		1975	cannot be guaranteed to infinite precision. Less obviously, it cannot be
		1976	guaranteed to any precision by libev - imagine somebody suspending the
		1977	process with a STOP signal for a few hours for example.
		1978
		1979	So, libev tries to invoke your callback as soon as possible I<after> the
		1980	delay has occurred, but cannot guarantee this.
		1981
		1982	A less obvious failure mode is calling your callback too early: many event
		1983	loops compare timestamps with a "elapsed delay >= requested delay", but
		1984	this can cause your callback to be invoked much earlier than you would
		1985	expect.
		1986
		1987	To see why, imagine a system with a clock that only offers full second
		1988	resolution (think windows if you can't come up with a broken enough OS
		1989	yourself). If you schedule a one-second timer at the time 500.9, then the
		1990	event loop will schedule your timeout to elapse at a system time of 500
		1991	(500.9 truncated to the resolution) + 1, or 501.
		1992
		1993	If an event library looks at the timeout 0.1s later, it will see "501 >=
		1994	501" and invoke the callback 0.1s after it was started, even though a
		1995	one-second delay was requested - this is being "too early", despite best
		1996	intentions.
		1997
		1998	This is the reason why libev will never invoke the callback if the elapsed
		1999	delay equals the requested delay, but only when the elapsed delay is
		2000	larger than the requested delay. In the example above, libev would only invoke
		2001	the callback at system time 502, or 1.1s after the timer was started.
		2002
		2003	So, while libev cannot guarantee that your callback will be invoked
		2004	exactly when requested, it I<can> and I<does> guarantee that the requested
		2005	delay has actually elapsed, or in other words, it always errs on the "too
		2006	late" side of things.
		2007
1916	=head3 The special problem of time updates	2008	=head3 The special problem of time updates
1917		2009
1918	Establishing the current time is a costly operation (it usually takes at	2010	Establishing the current time is a costly operation (it usually takes
1919	least two system calls): EV therefore updates its idea of the current	2011	at least one system call): EV therefore updates its idea of the current
1920	time only before and after C<ev_run> collects new events, which causes a	2012	time only before and after C<ev_run> collects new events, which causes a
1921	growing difference between C<ev_now ()> and C<ev_time ()> when handling	2013	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1922	lots of events in one iteration.	2014	lots of events in one iteration.
1923		2015
1924	The relative timeouts are calculated relative to the C<ev_now ()>	2016	The relative timeouts are calculated relative to the C<ev_now ()>
…		…
1930	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	2022	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1931		2023
1932	If the event loop is suspended for a long time, you can also force an	2024	If the event loop is suspended for a long time, you can also force an
1933	update of the time returned by C<ev_now ()> by calling C<ev_now_update	2025	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1934	()>.	2026	()>.
		2027
		2028	=head3 The special problem of unsynchronised clocks
		2029
		2030	Modern systems have a variety of clocks - libev itself uses the normal
		2031	"wall clock" clock and, if available, the monotonic clock (to avoid time
		2032	jumps).
		2033
		2034	Neither of these clocks is synchronised with each other or any other clock
		2035	on the system, so C<ev_time ()> might return a considerably different time
		2036	than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
		2037	a call to C<gettimeofday> might return a second count that is one higher
		2038	than a directly following call to C<time>.
		2039
		2040	The moral of this is to only compare libev-related timestamps with
		2041	C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
		2042	a second or so.
		2043
		2044	One more problem arises due to this lack of synchronisation: if libev uses
		2045	the system monotonic clock and you compare timestamps from C<ev_time>
		2046	or C<ev_now> from when you started your timer and when your callback is
		2047	invoked, you will find that sometimes the callback is a bit "early".
		2048
		2049	This is because C<ev_timer>s work in real time, not wall clock time, so
		2050	libev makes sure your callback is not invoked before the delay happened,
		2051	I<measured according to the real time>, not the system clock.
		2052
		2053	If your timeouts are based on a physical timescale (e.g. "time out this
		2054	connection after 100 seconds") then this shouldn't bother you as it is
		2055	exactly the right behaviour.
		2056
		2057	If you want to compare wall clock/system timestamps to your timers, then
		2058	you need to use C<ev_periodic>s, as these are based on the wall clock
		2059	time, where your comparisons will always generate correct results.
1935		2060
1936	=head3 The special problems of suspended animation	2061	=head3 The special problems of suspended animation
1937		2062
1938	When you leave the server world it is quite customary to hit machines that	2063	When you leave the server world it is quite customary to hit machines that
1939	can suspend/hibernate - what happens to the clocks during such a suspend?	2064	can suspend/hibernate - what happens to the clocks during such a suspend?
…		…
1983	keep up with the timer (because it takes longer than those 10 seconds to	2108	keep up with the timer (because it takes longer than those 10 seconds to
1984	do stuff) the timer will not fire more than once per event loop iteration.	2109	do stuff) the timer will not fire more than once per event loop iteration.
1985		2110
1986	=item ev_timer_again (loop, ev_timer *)	2111	=item ev_timer_again (loop, ev_timer *)
1987		2112
1988	This will act as if the timer timed out and restart it again if it is	2113	This will act as if the timer timed out and restarts it again if it is
1989	repeating. The exact semantics are:	2114	repeating. The exact semantics are:
1990		2115
1991	If the timer is pending, its pending status is cleared.	2116	If the timer is pending, its pending status is cleared.
1992		2117
1993	If the timer is started but non-repeating, stop it (as if it timed out).	2118	If the timer is started but non-repeating, stop it (as if it timed out).
…		…
2123		2248
2124	Another way to think about it (for the mathematically inclined) is that	2249	Another way to think about it (for the mathematically inclined) is that
2125	C<ev_periodic> will try to run the callback in this mode at the next possible	2250	C<ev_periodic> will try to run the callback in this mode at the next possible
2126	time where C<time = offset (mod interval)>, regardless of any time jumps.	2251	time where C<time = offset (mod interval)>, regardless of any time jumps.
2127		2252
2128	For numerical stability it is preferable that the C<offset> value is near	2253	The C<interval> I<MUST> be positive, and for numerical stability, the
2129	C<ev_now ()> (the current time), but there is no range requirement for	2254	interval value should be higher than C<1/8192> (which is around 100
2130	this value, and in fact is often specified as zero.	2255	microseconds) and C<offset> should be higher than C<0> and should have
		2256	at most a similar magnitude as the current time (say, within a factor of
		2257	ten). Typical values for offset are, in fact, C<0> or something between
		2258	C<0> and C<interval>, which is also the recommended range.
2131		2259
2132	Note also that there is an upper limit to how often a timer can fire (CPU	2260	Note also that there is an upper limit to how often a timer can fire (CPU
2133	speed for example), so if C<interval> is very small then timing stability	2261	speed for example), so if C<interval> is very small then timing stability
2134	will of course deteriorate. Libev itself tries to be exact to be about one	2262	will of course deteriorate. Libev itself tries to be exact to be about one
2135	millisecond (if the OS supports it and the machine is fast enough).	2263	millisecond (if the OS supports it and the machine is fast enough).
…		…
2249		2377
2250	=head2 C<ev_signal> - signal me when a signal gets signalled!	2378	=head2 C<ev_signal> - signal me when a signal gets signalled!
2251		2379
2252	Signal watchers will trigger an event when the process receives a specific	2380	Signal watchers will trigger an event when the process receives a specific
2253	signal one or more times. Even though signals are very asynchronous, libev	2381	signal one or more times. Even though signals are very asynchronous, libev
2254	will try it's best to deliver signals synchronously, i.e. as part of the	2382	will try its best to deliver signals synchronously, i.e. as part of the
2255	normal event processing, like any other event.	2383	normal event processing, like any other event.
2256		2384
2257	If you want signals to be delivered truly asynchronously, just use	2385	If you want signals to be delivered truly asynchronously, just use
2258	C<sigaction> as you would do without libev and forget about sharing	2386	C<sigaction> as you would do without libev and forget about sharing
2259	the signal. You can even use C<ev_async> from a signal handler to	2387	the signal. You can even use C<ev_async> from a signal handler to
…		…
2278	=head3 The special problem of inheritance over fork/execve/pthread_create	2406	=head3 The special problem of inheritance over fork/execve/pthread_create
2279		2407
2280	Both the signal mask (C<sigprocmask>) and the signal disposition	2408	Both the signal mask (C<sigprocmask>) and the signal disposition
2281	(C<sigaction>) are unspecified after starting a signal watcher (and after	2409	(C<sigaction>) are unspecified after starting a signal watcher (and after
2282	stopping it again), that is, libev might or might not block the signal,	2410	stopping it again), that is, libev might or might not block the signal,
2283	and might or might not set or restore the installed signal handler.	2411	and might or might not set or restore the installed signal handler (but
		2412	see C<EVFLAG_NOSIGMASK>).
2284		2413
2285	While this does not matter for the signal disposition (libev never	2414	While this does not matter for the signal disposition (libev never
2286	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on	2415	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2287	C<execve>), this matters for the signal mask: many programs do not expect	2416	C<execve>), this matters for the signal mask: many programs do not expect
2288	certain signals to be blocked.	2417	certain signals to be blocked.
…		…
2301	I<has> to modify the signal mask, at least temporarily.	2430	I<has> to modify the signal mask, at least temporarily.
2302		2431
2303	So I can't stress this enough: I<If you do not reset your signal mask when	2432	So I can't stress this enough: I<If you do not reset your signal mask when
2304	you expect it to be empty, you have a race condition in your code>. This	2433	you expect it to be empty, you have a race condition in your code>. This
2305	is not a libev-specific thing, this is true for most event libraries.	2434	is not a libev-specific thing, this is true for most event libraries.
		2435
		2436	=head3 The special problem of threads signal handling
		2437
		2438	POSIX threads has problematic signal handling semantics, specifically,
		2439	a lot of functionality (sigfd, sigwait etc.) only really works if all
		2440	threads in a process block signals, which is hard to achieve.
		2441
		2442	When you want to use sigwait (or mix libev signal handling with your own
		2443	for the same signals), you can tackle this problem by globally blocking
		2444	all signals before creating any threads (or creating them with a fully set
		2445	sigprocmask) and also specifying the C<EVFLAG_NOSIGMASK> when creating
		2446	loops. Then designate one thread as "signal receiver thread" which handles
		2447	these signals. You can pass on any signals that libev might be interested
		2448	in by calling C<ev_feed_signal>.
2306		2449
2307	=head3 Watcher-Specific Functions and Data Members	2450	=head3 Watcher-Specific Functions and Data Members
2308		2451
2309	=over 4	2452	=over 4
2310		2453
…		…
3098		3241
3099	=item ev_fork_init (ev_fork *, callback)	3242	=item ev_fork_init (ev_fork *, callback)
3100		3243
3101	Initialises and configures the fork watcher - it has no parameters of any	3244	Initialises and configures the fork watcher - it has no parameters of any
3102	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3245	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
3103	believe me.	3246	really.
3104		3247
3105	=back	3248	=back
3106		3249
3107		3250
3108	=head2 C<ev_cleanup> - even the best things end	3251	=head2 C<ev_cleanup> - even the best things end
3109		3252
3110	Cleanup watchers are called just before the event loop they are registered	3253	Cleanup watchers are called just before the event loop is being destroyed
3111	with is being destroyed.	3254	by a call to C<ev_loop_destroy>.
3112		3255
3113	While there is no guarantee that the event loop gets destroyed, cleanup	3256	While there is no guarantee that the event loop gets destroyed, cleanup
3114	watchers provide a convenient method to install cleanup hooks for your	3257	watchers provide a convenient method to install cleanup hooks for your
3115	program, worker threads and so on - you just to make sure to destroy the	3258	program, worker threads and so on - you just to make sure to destroy the
3116	loop when you want them to be invoked.	3259	loop when you want them to be invoked.
3117		3260
		3261	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3262	all other watchers, they do not keep a reference to the event loop (which
		3263	makes a lot of sense if you think about it). Like all other watchers, you
		3264	can call libev functions in the callback, except C<ev_cleanup_start>.
		3265
3118	=head3 Watcher-Specific Functions and Data Members	3266	=head3 Watcher-Specific Functions and Data Members
3119		3267
3120	=over 4	3268	=over 4
3121		3269
3122	=item ev_cleanup_init (ev_cleanup *, callback)	3270	=item ev_cleanup_init (ev_cleanup *, callback)
3123		3271
3124	Initialises and configures the cleanup watcher - it has no parameters of	3272	Initialises and configures the cleanup watcher - it has no parameters of
3125	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly	3273	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
3126	pointless, believe me.	3274	pointless, I assure you.
3127		3275
3128	=back	3276	=back
3129		3277
3130	Example: Register an atexit handler to destroy the default loop, so any	3278	Example: Register an atexit handler to destroy the default loop, so any
3131	cleanup functions are called.	3279	cleanup functions are called.
…		…
3140	atexit (program_exits);	3288	atexit (program_exits);
3141		3289
3142		3290
3143	=head2 C<ev_async> - how to wake up an event loop	3291	=head2 C<ev_async> - how to wake up an event loop
3144		3292
3145	In general, you cannot use an C<ev_run> from multiple threads or other	3293	In general, you cannot use an C<ev_loop> from multiple threads or other
3146	asynchronous sources such as signal handlers (as opposed to multiple event	3294	asynchronous sources such as signal handlers (as opposed to multiple event
3147	loops - those are of course safe to use in different threads).	3295	loops - those are of course safe to use in different threads).
3148		3296
3149	Sometimes, however, you need to wake up an event loop you do not control,	3297	Sometimes, however, you need to wake up an event loop you do not control,
3150	for example because it belongs to another thread. This is what C<ev_async>	3298	for example because it belongs to another thread. This is what C<ev_async>
…		…
3152	it by calling C<ev_async_send>, which is thread- and signal safe.	3300	it by calling C<ev_async_send>, which is thread- and signal safe.
3153		3301
3154	This functionality is very similar to C<ev_signal> watchers, as signals,	3302	This functionality is very similar to C<ev_signal> watchers, as signals,
3155	too, are asynchronous in nature, and signals, too, will be compressed	3303	too, are asynchronous in nature, and signals, too, will be compressed
3156	(i.e. the number of callback invocations may be less than the number of	3304	(i.e. the number of callback invocations may be less than the number of
3157	C<ev_async_sent> calls).	3305	C<ev_async_sent> calls). In fact, you could use signal watchers as a kind
3158		3306	of "global async watchers" by using a watcher on an otherwise unused
3159	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not	3307	signal, and C<ev_feed_signal> to signal this watcher from another thread,
3160	just the default loop.	3308	even without knowing which loop owns the signal.
3161		3309
3162	=head3 Queueing	3310	=head3 Queueing
3163		3311
3164	C<ev_async> does not support queueing of data in any way. The reason	3312	C<ev_async> does not support queueing of data in any way. The reason
3165	is that the author does not know of a simple (or any) algorithm for a	3313	is that the author does not know of a simple (or any) algorithm for a
…		…
3257	trust me.	3405	trust me.
3258		3406
3259	=item ev_async_send (loop, ev_async *)	3407	=item ev_async_send (loop, ev_async *)
3260		3408
3261	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	3409	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
3262	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	3410	an C<EV_ASYNC> event on the watcher into the event loop, and instantly
		3411	returns.
		3412
3263	C<ev_feed_event>, this call is safe to do from other threads, signal or	3413	Unlike C<ev_feed_event>, this call is safe to do from other threads,
3264	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	3414	signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3265	section below on what exactly this means).	3415	embedding section below on what exactly this means).
3266		3416
3267	Note that, as with other watchers in libev, multiple events might get	3417	Note that, as with other watchers in libev, multiple events might get
3268	compressed into a single callback invocation (another way to look at this	3418	compressed into a single callback invocation (another way to look at
3269	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,	3419	this is that C<ev_async> watchers are level-triggered: they are set on
3270	reset when the event loop detects that).	3420	C<ev_async_send>, reset when the event loop detects that).
3271		3421
3272	This call incurs the overhead of a system call only once per event loop	3422	This call incurs the overhead of at most one extra system call per event
3273	iteration, so while the overhead might be noticeable, it doesn't apply to	3423	loop iteration, if the event loop is blocked, and no syscall at all if
3274	repeated calls to C<ev_async_send> for the same event loop.	3424	the event loop (or your program) is processing events. That means that
		3425	repeated calls are basically free (there is no need to avoid calls for
		3426	performance reasons) and that the overhead becomes smaller (typically
		3427	zero) under load.
3275		3428
3276	=item bool = ev_async_pending (ev_async *)	3429	=item bool = ev_async_pending (ev_async *)
3277		3430
3278	Returns a non-zero value when C<ev_async_send> has been called on the	3431	Returns a non-zero value when C<ev_async_send> has been called on the
3279	watcher but the event has not yet been processed (or even noted) by the	3432	watcher but the event has not yet been processed (or even noted) by the
…		…
3334	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3487	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3335		3488
3336	=item ev_feed_fd_event (loop, int fd, int revents)	3489	=item ev_feed_fd_event (loop, int fd, int revents)
3337		3490
3338	Feed an event on the given fd, as if a file descriptor backend detected	3491	Feed an event on the given fd, as if a file descriptor backend detected
3339	the given events it.	3492	the given events.
3340		3493
3341	=item ev_feed_signal_event (loop, int signum)	3494	=item ev_feed_signal_event (loop, int signum)
3342		3495
3343	Feed an event as if the given signal occurred (C<loop> must be the default	3496	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3344	loop!).	3497	which is async-safe.
3345		3498
3346	=back	3499	=back
		3500
		3501
		3502	=head1 COMMON OR USEFUL IDIOMS (OR BOTH)
		3503
		3504	This section explains some common idioms that are not immediately
		3505	obvious. Note that examples are sprinkled over the whole manual, and this
		3506	section only contains stuff that wouldn't fit anywhere else.
		3507
		3508	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
		3509
		3510	Each watcher has, by default, a C<void *data> member that you can read
		3511	or modify at any time: libev will completely ignore it. This can be used
		3512	to associate arbitrary data with your watcher. If you need more data and
		3513	don't want to allocate memory separately and store a pointer to it in that
		3514	data member, you can also "subclass" the watcher type and provide your own
		3515	data:
		3516
		3517	struct my_io
		3518	{
		3519	ev_io io;
		3520	int otherfd;
		3521	void *somedata;
		3522	struct whatever *mostinteresting;
		3523	};
		3524
		3525	...
		3526	struct my_io w;
		3527	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3528
		3529	And since your callback will be called with a pointer to the watcher, you
		3530	can cast it back to your own type:
		3531
		3532	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
		3533	{
		3534	struct my_io *w = (struct my_io *)w_;
		3535	...
		3536	}
		3537
		3538	More interesting and less C-conformant ways of casting your callback
		3539	function type instead have been omitted.
		3540
		3541	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3542
		3543	Another common scenario is to use some data structure with multiple
		3544	embedded watchers, in effect creating your own watcher that combines
		3545	multiple libev event sources into one "super-watcher":
		3546
		3547	struct my_biggy
		3548	{
		3549	int some_data;
		3550	ev_timer t1;
		3551	ev_timer t2;
		3552	}
		3553
		3554	In this case getting the pointer to C<my_biggy> is a bit more
		3555	complicated: Either you store the address of your C<my_biggy> struct in
		3556	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3557	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3558	real programmers):
		3559
		3560	#include <stddef.h>
		3561
		3562	static void
		3563	t1_cb (EV_P_ ev_timer *w, int revents)
		3564	{
		3565	struct my_biggy big = (struct my_biggy *)
		3566	(((char *)w) - offsetof (struct my_biggy, t1));
		3567	}
		3568
		3569	static void
		3570	t2_cb (EV_P_ ev_timer *w, int revents)
		3571	{
		3572	struct my_biggy big = (struct my_biggy *)
		3573	(((char *)w) - offsetof (struct my_biggy, t2));
		3574	}
		3575
		3576	=head2 AVOIDING FINISHING BEFORE RETURNING
		3577
		3578	Often you have structures like this in event-based programs:
		3579
		3580	callback ()
		3581	{
		3582	free (request);
		3583	}
		3584
		3585	request = start_new_request (..., callback);
		3586
		3587	The intent is to start some "lengthy" operation. The C<request> could be
		3588	used to cancel the operation, or do other things with it.
		3589
		3590	It's not uncommon to have code paths in C<start_new_request> that
		3591	immediately invoke the callback, for example, to report errors. Or you add
		3592	some caching layer that finds that it can skip the lengthy aspects of the
		3593	operation and simply invoke the callback with the result.
		3594
		3595	The problem here is that this will happen I<before> C<start_new_request>
		3596	has returned, so C<request> is not set.
		3597
		3598	Even if you pass the request by some safer means to the callback, you
		3599	might want to do something to the request after starting it, such as
		3600	canceling it, which probably isn't working so well when the callback has
		3601	already been invoked.
		3602
		3603	A common way around all these issues is to make sure that
		3604	C<start_new_request> I<always> returns before the callback is invoked. If
		3605	C<start_new_request> immediately knows the result, it can artificially
		3606	delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher
		3607	for example, or more sneakily, by reusing an existing (stopped) watcher
		3608	and pushing it into the pending queue:
		3609
		3610	ev_set_cb (watcher, callback);
		3611	ev_feed_event (EV_A_ watcher, 0);
		3612
		3613	This way, C<start_new_request> can safely return before the callback is
		3614	invoked, while not delaying callback invocation too much.
		3615
		3616	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
		3617
		3618	Often (especially in GUI toolkits) there are places where you have
		3619	I<modal> interaction, which is most easily implemented by recursively
		3620	invoking C<ev_run>.
		3621
		3622	This brings the problem of exiting - a callback might want to finish the
		3623	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
		3624	a modal "Are you sure?" dialog is still waiting), or just the nested one
		3625	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
		3626	other combination: In these cases, C<ev_break> will not work alone.
		3627
		3628	The solution is to maintain "break this loop" variable for each C<ev_run>
		3629	invocation, and use a loop around C<ev_run> until the condition is
		3630	triggered, using C<EVRUN_ONCE>:
		3631
		3632	// main loop
		3633	int exit_main_loop = 0;
		3634
		3635	while (!exit_main_loop)
		3636	ev_run (EV_DEFAULT_ EVRUN_ONCE);
		3637
		3638	// in a model watcher
		3639	int exit_nested_loop = 0;
		3640
		3641	while (!exit_nested_loop)
		3642	ev_run (EV_A_ EVRUN_ONCE);
		3643
		3644	To exit from any of these loops, just set the corresponding exit variable:
		3645
		3646	// exit modal loop
		3647	exit_nested_loop = 1;
		3648
		3649	// exit main program, after modal loop is finished
		3650	exit_main_loop = 1;
		3651
		3652	// exit both
		3653	exit_main_loop = exit_nested_loop = 1;
		3654
		3655	=head2 THREAD LOCKING EXAMPLE
		3656
		3657	Here is a fictitious example of how to run an event loop in a different
		3658	thread from where callbacks are being invoked and watchers are
		3659	created/added/removed.
		3660
		3661	For a real-world example, see the C<EV::Loop::Async> perl module,
		3662	which uses exactly this technique (which is suited for many high-level
		3663	languages).
		3664
		3665	The example uses a pthread mutex to protect the loop data, a condition
		3666	variable to wait for callback invocations, an async watcher to notify the
		3667	event loop thread and an unspecified mechanism to wake up the main thread.
		3668
		3669	First, you need to associate some data with the event loop:
		3670
		3671	typedef struct {
		3672	mutex_t lock; /* global loop lock */
		3673	ev_async async_w;
		3674	thread_t tid;
		3675	cond_t invoke_cv;
		3676	} userdata;
		3677
		3678	void prepare_loop (EV_P)
		3679	{
		3680	// for simplicity, we use a static userdata struct.
		3681	static userdata u;
		3682
		3683	ev_async_init (&u->async_w, async_cb);
		3684	ev_async_start (EV_A_ &u->async_w);
		3685
		3686	pthread_mutex_init (&u->lock, 0);
		3687	pthread_cond_init (&u->invoke_cv, 0);
		3688
		3689	// now associate this with the loop
		3690	ev_set_userdata (EV_A_ u);
		3691	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3692	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3693
		3694	// then create the thread running ev_run
		3695	pthread_create (&u->tid, 0, l_run, EV_A);
		3696	}
		3697
		3698	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3699	solely to wake up the event loop so it takes notice of any new watchers
		3700	that might have been added:
		3701
		3702	static void
		3703	async_cb (EV_P_ ev_async *w, int revents)
		3704	{
		3705	// just used for the side effects
		3706	}
		3707
		3708	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3709	protecting the loop data, respectively.
		3710
		3711	static void
		3712	l_release (EV_P)
		3713	{
		3714	userdata *u = ev_userdata (EV_A);
		3715	pthread_mutex_unlock (&u->lock);
		3716	}
		3717
		3718	static void
		3719	l_acquire (EV_P)
		3720	{
		3721	userdata *u = ev_userdata (EV_A);
		3722	pthread_mutex_lock (&u->lock);
		3723	}
		3724
		3725	The event loop thread first acquires the mutex, and then jumps straight
		3726	into C<ev_run>:
		3727
		3728	void *
		3729	l_run (void *thr_arg)
		3730	{
		3731	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		3732
		3733	l_acquire (EV_A);
		3734	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3735	ev_run (EV_A_ 0);
		3736	l_release (EV_A);
		3737
		3738	return 0;
		3739	}
		3740
		3741	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3742	signal the main thread via some unspecified mechanism (signals? pipe
		3743	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3744	have been called (in a while loop because a) spurious wakeups are possible
		3745	and b) skipping inter-thread-communication when there are no pending
		3746	watchers is very beneficial):
		3747
		3748	static void
		3749	l_invoke (EV_P)
		3750	{
		3751	userdata *u = ev_userdata (EV_A);
		3752
		3753	while (ev_pending_count (EV_A))
		3754	{
		3755	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3756	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3757	}
		3758	}
		3759
		3760	Now, whenever the main thread gets told to invoke pending watchers, it
		3761	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3762	thread to continue:
		3763
		3764	static void
		3765	real_invoke_pending (EV_P)
		3766	{
		3767	userdata *u = ev_userdata (EV_A);
		3768
		3769	pthread_mutex_lock (&u->lock);
		3770	ev_invoke_pending (EV_A);
		3771	pthread_cond_signal (&u->invoke_cv);
		3772	pthread_mutex_unlock (&u->lock);
		3773	}
		3774
		3775	Whenever you want to start/stop a watcher or do other modifications to an
		3776	event loop, you will now have to lock:
		3777
		3778	ev_timer timeout_watcher;
		3779	userdata *u = ev_userdata (EV_A);
		3780
		3781	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3782
		3783	pthread_mutex_lock (&u->lock);
		3784	ev_timer_start (EV_A_ &timeout_watcher);
		3785	ev_async_send (EV_A_ &u->async_w);
		3786	pthread_mutex_unlock (&u->lock);
		3787
		3788	Note that sending the C<ev_async> watcher is required because otherwise
		3789	an event loop currently blocking in the kernel will have no knowledge
		3790	about the newly added timer. By waking up the loop it will pick up any new
		3791	watchers in the next event loop iteration.
		3792
		3793	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3794
		3795	While the overhead of a callback that e.g. schedules a thread is small, it
		3796	is still an overhead. If you embed libev, and your main usage is with some
		3797	kind of threads or coroutines, you might want to customise libev so that
		3798	doesn't need callbacks anymore.
		3799
		3800	Imagine you have coroutines that you can switch to using a function
		3801	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3802	and that due to some magic, the currently active coroutine is stored in a
		3803	global called C<current_coro>. Then you can build your own "wait for libev
		3804	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3805	the differing C<;> conventions):
		3806
		3807	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3808	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3809
		3810	That means instead of having a C callback function, you store the
		3811	coroutine to switch to in each watcher, and instead of having libev call
		3812	your callback, you instead have it switch to that coroutine.
		3813
		3814	A coroutine might now wait for an event with a function called
		3815	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		3816	matter when, or whether the watcher is active or not when this function is
		3817	called):
		3818
		3819	void
		3820	wait_for_event (ev_watcher *w)
		3821	{
		3822	ev_cb_set (w) = current_coro;
		3823	switch_to (libev_coro);
		3824	}
		3825
		3826	That basically suspends the coroutine inside C<wait_for_event> and
		3827	continues the libev coroutine, which, when appropriate, switches back to
		3828	this or any other coroutine. I am sure if you sue this your own :)
		3829
		3830	You can do similar tricks if you have, say, threads with an event queue -
		3831	instead of storing a coroutine, you store the queue object and instead of
		3832	switching to a coroutine, you push the watcher onto the queue and notify
		3833	any waiters.
		3834
		3835	To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two
		3836	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		3837
		3838	// my_ev.h
		3839	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3840	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
		3841	#include "../libev/ev.h"
		3842
		3843	// my_ev.c
		3844	#define EV_H "my_ev.h"
		3845	#include "../libev/ev.c"
		3846
		3847	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		3848	F<my_ev.c> into your project. When properly specifying include paths, you
		3849	can even use F<ev.h> as header file name directly.
3347		3850
3348		3851
3349	=head1 LIBEVENT EMULATION	3852	=head1 LIBEVENT EMULATION
3350		3853
3351	Libev offers a compatibility emulation layer for libevent. It cannot	3854	Libev offers a compatibility emulation layer for libevent. It cannot
3352	emulate the internals of libevent, so here are some usage hints:	3855	emulate the internals of libevent, so here are some usage hints:
3353		3856
3354	=over 4	3857	=over 4
		3858
		3859	=item * Only the libevent-1.4.1-beta API is being emulated.
		3860
		3861	This was the newest libevent version available when libev was implemented,
		3862	and is still mostly unchanged in 2010.
3355		3863
3356	=item * Use it by including <event.h>, as usual.	3864	=item * Use it by including <event.h>, as usual.
3357		3865
3358	=item * The following members are fully supported: ev_base, ev_callback,	3866	=item * The following members are fully supported: ev_base, ev_callback,
3359	ev_arg, ev_fd, ev_res, ev_events.	3867	ev_arg, ev_fd, ev_res, ev_events.
…		…
3365	=item * Priorities are not currently supported. Initialising priorities	3873	=item * Priorities are not currently supported. Initialising priorities
3366	will fail and all watchers will have the same priority, even though there	3874	will fail and all watchers will have the same priority, even though there
3367	is an ev_pri field.	3875	is an ev_pri field.
3368		3876
3369	=item * In libevent, the last base created gets the signals, in libev, the	3877	=item * In libevent, the last base created gets the signals, in libev, the
3370	first base created (== the default loop) gets the signals.	3878	base that registered the signal gets the signals.
3371		3879
3372	=item * Other members are not supported.	3880	=item * Other members are not supported.
3373		3881
3374	=item * The libev emulation is I<not> ABI compatible to libevent, you need	3882	=item * The libev emulation is I<not> ABI compatible to libevent, you need
3375	to use the libev header file and library.	3883	to use the libev header file and library.
…		…
3394	Care has been taken to keep the overhead low. The only data member the C++	3902	Care has been taken to keep the overhead low. The only data member the C++
3395	classes add (compared to plain C-style watchers) is the event loop pointer	3903	classes add (compared to plain C-style watchers) is the event loop pointer
3396	that the watcher is associated with (or no additional members at all if	3904	that the watcher is associated with (or no additional members at all if
3397	you disable C<EV_MULTIPLICITY> when embedding libev).	3905	you disable C<EV_MULTIPLICITY> when embedding libev).
3398		3906
3399	Currently, functions, and static and non-static member functions can be	3907	Currently, functions, static and non-static member functions and classes
3400	used as callbacks. Other types should be easy to add as long as they only	3908	with C<operator ()> can be used as callbacks. Other types should be easy
3401	need one additional pointer for context. If you need support for other	3909	to add as long as they only need one additional pointer for context. If
3402	types of functors please contact the author (preferably after implementing	3910	you need support for other types of functors please contact the author
3403	it).	3911	(preferably after implementing it).
3404		3912
3405	Here is a list of things available in the C<ev> namespace:	3913	Here is a list of things available in the C<ev> namespace:
3406		3914
3407	=over 4	3915	=over 4
3408		3916
…		…
3561	watchers in the constructor.	4069	watchers in the constructor.
3562		4070
3563	class myclass	4071	class myclass
3564	{	4072	{
3565	ev::io io ; void io_cb (ev::io &w, int revents);	4073	ev::io io ; void io_cb (ev::io &w, int revents);
3566	ev::io2 io2 ; void io2_cb (ev::io &w, int revents);	4074	ev::io io2 ; void io2_cb (ev::io &w, int revents);
3567	ev::idle idle; void idle_cb (ev::idle &w, int revents);	4075	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3568		4076
3569	myclass (int fd)	4077	myclass (int fd)
3570	{	4078	{
3571	io .set <myclass, &myclass::io_cb > (this);	4079	io .set <myclass, &myclass::io_cb > (this);
…		…
3622	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.	4130	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3623		4131
3624	=item D	4132	=item D
3625		4133
3626	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	4134	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3627	be found at L<http://proj.llucax.com.ar/wiki/evd>.	4135	be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
3628		4136
3629	=item Ocaml	4137	=item Ocaml
3630		4138
3631	Erkki Seppala has written Ocaml bindings for libev, to be found at	4139	Erkki Seppala has written Ocaml bindings for libev, to be found at
3632	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	4140	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
…		…
3680	suitable for use with C<EV_A>.	4188	suitable for use with C<EV_A>.
3681		4189
3682	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	4190	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
3683		4191
3684	Similar to the other two macros, this gives you the value of the default	4192	Similar to the other two macros, this gives you the value of the default
3685	loop, if multiple loops are supported ("ev loop default").	4193	loop, if multiple loops are supported ("ev loop default"). The default loop
		4194	will be initialised if it isn't already initialised.
		4195
		4196	For non-multiplicity builds, these macros do nothing, so you always have
		4197	to initialise the loop somewhere.
3686		4198
3687	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>	4199	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
3688		4200
3689	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the	4201	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
3690	default loop has been initialised (C<UC> == unchecked). Their behaviour	4202	default loop has been initialised (C<UC> == unchecked). Their behaviour
…		…
3835	supported). It will also not define any of the structs usually found in	4347	supported). It will also not define any of the structs usually found in
3836	F<event.h> that are not directly supported by the libev core alone.	4348	F<event.h> that are not directly supported by the libev core alone.
3837		4349
3838	In standalone mode, libev will still try to automatically deduce the	4350	In standalone mode, libev will still try to automatically deduce the
3839	configuration, but has to be more conservative.	4351	configuration, but has to be more conservative.
		4352
		4353	=item EV_USE_FLOOR
		4354
		4355	If defined to be C<1>, libev will use the C<floor ()> function for its
		4356	periodic reschedule calculations, otherwise libev will fall back on a
		4357	portable (slower) implementation. If you enable this, you usually have to
		4358	link against libm or something equivalent. Enabling this when the C<floor>
		4359	function is not available will fail, so the safe default is to not enable
		4360	this.
3840		4361
3841	=item EV_USE_MONOTONIC	4362	=item EV_USE_MONOTONIC
3842		4363
3843	If defined to be C<1>, libev will try to detect the availability of the	4364	If defined to be C<1>, libev will try to detect the availability of the
3844	monotonic clock option at both compile time and runtime. Otherwise no	4365	monotonic clock option at both compile time and runtime. Otherwise no
…		…
3977	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4498	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
3978		4499
3979	=item EV_ATOMIC_T	4500	=item EV_ATOMIC_T
3980		4501
3981	Libev requires an integer type (suitable for storing C<0> or C<1>) whose	4502	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
3982	access is atomic with respect to other threads or signal contexts. No such	4503	access is atomic and serialised with respect to other threads or signal
3983	type is easily found in the C language, so you can provide your own type	4504	contexts. No such type is easily found in the C language, so you can
3984	that you know is safe for your purposes. It is used both for signal handler "locking"	4505	provide your own type that you know is safe for your purposes. It is used
3985	as well as for signal and thread safety in C<ev_async> watchers.	4506	both for signal handler "locking" as well as for signal and thread safety
		4507	in C<ev_async> watchers.
3986		4508
3987	In the absence of this define, libev will use C<sig_atomic_t volatile>	4509	In the absence of this define, libev will use C<sig_atomic_t volatile>
3988	(from F<signal.h>), which is usually good enough on most platforms.	4510	(from F<signal.h>), which is usually good enough on most platforms,
		4511	although strictly speaking using a type that also implies a memory fence
		4512	is required.
3989		4513
3990	=item EV_H (h)	4514	=item EV_H (h)
3991		4515
3992	The name of the F<ev.h> header file used to include it. The default if	4516	The name of the F<ev.h> header file used to include it. The default if
3993	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be	4517	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
…		…
4017	will have the C<struct ev_loop *> as first argument, and you can create	4541	will have the C<struct ev_loop *> as first argument, and you can create
4018	additional independent event loops. Otherwise there will be no support	4542	additional independent event loops. Otherwise there will be no support
4019	for multiple event loops and there is no first event loop pointer	4543	for multiple event loops and there is no first event loop pointer
4020	argument. Instead, all functions act on the single default loop.	4544	argument. Instead, all functions act on the single default loop.
4021		4545
		4546	Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
		4547	default loop when multiplicity is switched off - you always have to
		4548	initialise the loop manually in this case.
		4549
4022	=item EV_MINPRI	4550	=item EV_MINPRI
4023		4551
4024	=item EV_MAXPRI	4552	=item EV_MAXPRI
4025		4553
4026	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to	4554	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
…		…
4123		4651
4124	With an intelligent-enough linker (gcc+binutils are intelligent enough	4652	With an intelligent-enough linker (gcc+binutils are intelligent enough
4125	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by	4653	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
4126	your program might be left out as well - a binary starting a timer and an	4654	your program might be left out as well - a binary starting a timer and an
4127	I/O watcher then might come out at only 5Kb.	4655	I/O watcher then might come out at only 5Kb.
		4656
		4657	=item EV_API_STATIC
		4658
		4659	If this symbol is defined (by default it is not), then all identifiers
		4660	will have static linkage. This means that libev will not export any
		4661	identifiers, and you cannot link against libev anymore. This can be useful
		4662	when you embed libev, only want to use libev functions in a single file,
		4663	and do not want its identifiers to be visible.
		4664
		4665	To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
		4666	wants to use libev.
4128		4667
4129	=item EV_AVOID_STDIO	4668	=item EV_AVOID_STDIO
4130		4669
4131	If this is set to C<1> at compiletime, then libev will avoid using stdio	4670	If this is set to C<1> at compiletime, then libev will avoid using stdio
4132	functions (printf, scanf, perror etc.). This will increase the code size	4671	functions (printf, scanf, perror etc.). This will increase the code size
…		…
4276	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4815	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
4277		4816
4278	#include "ev_cpp.h"	4817	#include "ev_cpp.h"
4279	#include "ev.c"	4818	#include "ev.c"
4280		4819
4281	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	4820	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
4282		4821
4283	=head2 THREADS AND COROUTINES	4822	=head2 THREADS AND COROUTINES
4284		4823
4285	=head3 THREADS	4824	=head3 THREADS
4286		4825
…		…
4337	default loop and triggering an C<ev_async> watcher from the default loop	4876	default loop and triggering an C<ev_async> watcher from the default loop
4338	watcher callback into the event loop interested in the signal.	4877	watcher callback into the event loop interested in the signal.
4339		4878
4340	=back	4879	=back
4341		4880
4342	=head4 THREAD LOCKING EXAMPLE	4881	See also L<THREAD LOCKING EXAMPLE>.
4343
4344	Here is a fictitious example of how to run an event loop in a different
4345	thread than where callbacks are being invoked and watchers are
4346	created/added/removed.
4347
4348	For a real-world example, see the C<EV::Loop::Async> perl module,
4349	which uses exactly this technique (which is suited for many high-level
4350	languages).
4351
4352	The example uses a pthread mutex to protect the loop data, a condition
4353	variable to wait for callback invocations, an async watcher to notify the
4354	event loop thread and an unspecified mechanism to wake up the main thread.
4355
4356	First, you need to associate some data with the event loop:
4357
4358	typedef struct {
4359	mutex_t lock; /* global loop lock */
4360	ev_async async_w;
4361	thread_t tid;
4362	cond_t invoke_cv;
4363	} userdata;
4364
4365	void prepare_loop (EV_P)
4366	{
4367	// for simplicity, we use a static userdata struct.
4368	static userdata u;
4369
4370	ev_async_init (&u->async_w, async_cb);
4371	ev_async_start (EV_A_ &u->async_w);
4372
4373	pthread_mutex_init (&u->lock, 0);
4374	pthread_cond_init (&u->invoke_cv, 0);
4375
4376	// now associate this with the loop
4377	ev_set_userdata (EV_A_ u);
4378	ev_set_invoke_pending_cb (EV_A_ l_invoke);
4379	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4380
4381	// then create the thread running ev_loop
4382	pthread_create (&u->tid, 0, l_run, EV_A);
4383	}
4384
4385	The callback for the C<ev_async> watcher does nothing: the watcher is used
4386	solely to wake up the event loop so it takes notice of any new watchers
4387	that might have been added:
4388
4389	static void
4390	async_cb (EV_P_ ev_async *w, int revents)
4391	{
4392	// just used for the side effects
4393	}
4394
4395	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4396	protecting the loop data, respectively.
4397
4398	static void
4399	l_release (EV_P)
4400	{
4401	userdata *u = ev_userdata (EV_A);
4402	pthread_mutex_unlock (&u->lock);
4403	}
4404
4405	static void
4406	l_acquire (EV_P)
4407	{
4408	userdata *u = ev_userdata (EV_A);
4409	pthread_mutex_lock (&u->lock);
4410	}
4411
4412	The event loop thread first acquires the mutex, and then jumps straight
4413	into C<ev_run>:
4414
4415	void *
4416	l_run (void *thr_arg)
4417	{
4418	struct ev_loop *loop = (struct ev_loop *)thr_arg;
4419
4420	l_acquire (EV_A);
4421	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4422	ev_run (EV_A_ 0);
4423	l_release (EV_A);
4424
4425	return 0;
4426	}
4427
4428	Instead of invoking all pending watchers, the C<l_invoke> callback will
4429	signal the main thread via some unspecified mechanism (signals? pipe
4430	writes? C<Async::Interrupt>?) and then waits until all pending watchers
4431	have been called (in a while loop because a) spurious wakeups are possible
4432	and b) skipping inter-thread-communication when there are no pending
4433	watchers is very beneficial):
4434
4435	static void
4436	l_invoke (EV_P)
4437	{
4438	userdata *u = ev_userdata (EV_A);
4439
4440	while (ev_pending_count (EV_A))
4441	{
4442	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4443	pthread_cond_wait (&u->invoke_cv, &u->lock);
4444	}
4445	}
4446
4447	Now, whenever the main thread gets told to invoke pending watchers, it
4448	will grab the lock, call C<ev_invoke_pending> and then signal the loop
4449	thread to continue:
4450
4451	static void
4452	real_invoke_pending (EV_P)
4453	{
4454	userdata *u = ev_userdata (EV_A);
4455
4456	pthread_mutex_lock (&u->lock);
4457	ev_invoke_pending (EV_A);
4458	pthread_cond_signal (&u->invoke_cv);
4459	pthread_mutex_unlock (&u->lock);
4460	}
4461
4462	Whenever you want to start/stop a watcher or do other modifications to an
4463	event loop, you will now have to lock:
4464
4465	ev_timer timeout_watcher;
4466	userdata *u = ev_userdata (EV_A);
4467
4468	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4469
4470	pthread_mutex_lock (&u->lock);
4471	ev_timer_start (EV_A_ &timeout_watcher);
4472	ev_async_send (EV_A_ &u->async_w);
4473	pthread_mutex_unlock (&u->lock);
4474
4475	Note that sending the C<ev_async> watcher is required because otherwise
4476	an event loop currently blocking in the kernel will have no knowledge
4477	about the newly added timer. By waking up the loop it will pick up any new
4478	watchers in the next event loop iteration.
4479		4882
4480	=head3 COROUTINES	4883	=head3 COROUTINES
4481		4884
4482	Libev is very accommodating to coroutines ("cooperative threads"):	4885	Libev is very accommodating to coroutines ("cooperative threads"):
4483	libev fully supports nesting calls to its functions from different	4886	libev fully supports nesting calls to its functions from different
…		…
4648	requires, and its I/O model is fundamentally incompatible with the POSIX	5051	requires, and its I/O model is fundamentally incompatible with the POSIX
4649	model. Libev still offers limited functionality on this platform in	5052	model. Libev still offers limited functionality on this platform in
4650	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	5053	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4651	descriptors. This only applies when using Win32 natively, not when using	5054	descriptors. This only applies when using Win32 natively, not when using
4652	e.g. cygwin. Actually, it only applies to the microsofts own compilers,	5055	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4653	as every compielr comes with a slightly differently broken/incompatible	5056	as every compiler comes with a slightly differently broken/incompatible
4654	environment.	5057	environment.
4655		5058
4656	Lifting these limitations would basically require the full	5059	Lifting these limitations would basically require the full
4657	re-implementation of the I/O system. If you are into this kind of thing,	5060	re-implementation of the I/O system. If you are into this kind of thing,
4658	then note that glib does exactly that for you in a very portable way (note	5061	then note that glib does exactly that for you in a very portable way (note
…		…
4752	structure (guaranteed by POSIX but not by ISO C for example), but it also	5155	structure (guaranteed by POSIX but not by ISO C for example), but it also
4753	assumes that the same (machine) code can be used to call any watcher	5156	assumes that the same (machine) code can be used to call any watcher
4754	callback: The watcher callbacks have different type signatures, but libev	5157	callback: The watcher callbacks have different type signatures, but libev
4755	calls them using an C<ev_watcher *> internally.	5158	calls them using an C<ev_watcher *> internally.
4756		5159
		5160	=item pointer accesses must be thread-atomic
		5161
		5162	Accessing a pointer value must be atomic, it must both be readable and
		5163	writable in one piece - this is the case on all current architectures.
		5164
4757	=item C<sig_atomic_t volatile> must be thread-atomic as well	5165	=item C<sig_atomic_t volatile> must be thread-atomic as well
4758		5166
4759	The type C<sig_atomic_t volatile> (or whatever is defined as	5167	The type C<sig_atomic_t volatile> (or whatever is defined as
4760	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different	5168	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
4761	threads. This is not part of the specification for C<sig_atomic_t>, but is	5169	threads. This is not part of the specification for C<sig_atomic_t>, but is
…		…
4786		5194
4787	The type C<double> is used to represent timestamps. It is required to	5195	The type C<double> is used to represent timestamps. It is required to
4788	have at least 51 bits of mantissa (and 9 bits of exponent), which is	5196	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4789	good enough for at least into the year 4000 with millisecond accuracy	5197	good enough for at least into the year 4000 with millisecond accuracy
4790	(the design goal for libev). This requirement is overfulfilled by	5198	(the design goal for libev). This requirement is overfulfilled by
4791	implementations using IEEE 754, which is basically all existing ones. With	5199	implementations using IEEE 754, which is basically all existing ones.
		5200
4792	IEEE 754 doubles, you get microsecond accuracy until at least 2200.	5201	With IEEE 754 doubles, you get microsecond accuracy until at least the
		5202	year 2255 (and millisecond accuracy till the year 287396 - by then, libev
		5203	is either obsolete or somebody patched it to use C<long double> or
		5204	something like that, just kidding).
4793		5205
4794	=back	5206	=back
4795		5207
4796	If you know of other additional requirements drop me a note.	5208	If you know of other additional requirements drop me a note.
4797		5209
…		…
4859	=item Processing ev_async_send: O(number_of_async_watchers)	5271	=item Processing ev_async_send: O(number_of_async_watchers)
4860		5272
4861	=item Processing signals: O(max_signal_number)	5273	=item Processing signals: O(max_signal_number)
4862		5274
4863	Sending involves a system call I<iff> there were no other C<ev_async_send>	5275	Sending involves a system call I<iff> there were no other C<ev_async_send>
4864	calls in the current loop iteration. Checking for async and signal events	5276	calls in the current loop iteration and the loop is currently
		5277	blocked. Checking for async and signal events involves iterating over all
4865	involves iterating over all running async watchers or all signal numbers.	5278	running async watchers or all signal numbers.
4866		5279
4867	=back	5280	=back
4868		5281
4869		5282
4870	=head1 PORTING FROM LIBEV 3.X TO 4.X	5283	=head1 PORTING FROM LIBEV 3.X TO 4.X
4871		5284
4872	The major version 4 introduced some minor incompatible changes to the API.	5285	The major version 4 introduced some incompatible changes to the API.
4873		5286
4874	At the moment, the C<ev.h> header file tries to implement superficial	5287	At the moment, the C<ev.h> header file provides compatibility definitions
4875	compatibility, so most programs should still compile. Those might be	5288	for all changes, so most programs should still compile. The compatibility
4876	removed in later versions of libev, so better update early than late.	5289	layer might be removed in later versions of libev, so better update to the
		5290	new API early than late.
4877		5291
4878	=over 4	5292	=over 4
		5293
		5294	=item C<EV_COMPAT3> backwards compatibility mechanism
		5295
		5296	The backward compatibility mechanism can be controlled by
		5297	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		5298	section.
4879		5299
4880	=item C<ev_default_destroy> and C<ev_default_fork> have been removed	5300	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
4881		5301
4882	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:	5302	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
4883		5303
…		…
4909	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme	5329	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
4910	as all other watcher types. Note that C<ev_loop_fork> is still called	5330	as all other watcher types. Note that C<ev_loop_fork> is still called
4911	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>	5331	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
4912	typedef.	5332	typedef.
4913		5333
4914	=item C<EV_COMPAT3> backwards compatibility mechanism
4915
4916	The backward compatibility mechanism can be controlled by
4917	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
4918	section.
4919
4920	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>	5334	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
4921		5335
4922	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different	5336	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
4923	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile	5337	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
4924	and work, but the library code will of course be larger.	5338	and work, but the library code will of course be larger.
…		…
4986	The physical time that is observed. It is apparently strictly monotonic :)	5400	The physical time that is observed. It is apparently strictly monotonic :)
4987		5401
4988	=item wall-clock time	5402	=item wall-clock time
4989		5403
4990	The time and date as shown on clocks. Unlike real time, it can actually	5404	The time and date as shown on clocks. Unlike real time, it can actually
4991	be wrong and jump forwards and backwards, e.g. when the you adjust your	5405	be wrong and jump forwards and backwards, e.g. when you adjust your
4992	clock.	5406	clock.
4993		5407
4994	=item watcher	5408	=item watcher
4995		5409
4996	A data structure that describes interest in certain events. Watchers need	5410	A data structure that describes interest in certain events. Watchers need
…		…
4998		5412
4999	=back	5413	=back
5000		5414
5001	=head1 AUTHOR	5415	=head1 AUTHOR
5002		5416
5003	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5417	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5418	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
5004		5419

Diff Legend

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