ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.318 by root, Fri Oct 22 09:40:22 2010 UTC vs.
Revision 1.405 by root, Thu May 3 15:07:15 2012 UTC

…		…
43		43
44	int	44	int
45	main (void)	45	main (void)
46	{	46	{
47	// use the default event loop unless you have special needs	47	// use the default event loop unless you have special needs
48	struct ev_loop *loop = ev_default_loop (0);	48	struct ev_loop *loop = EV_DEFAULT;
49		49
50	// initialise an io watcher, then start it	50	// initialise an io watcher, then start it
51	// this one will watch for stdin to become readable	51	// this one will watch for stdin to become readable
52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
53	ev_io_start (loop, &stdin_watcher);	53	ev_io_start (loop, &stdin_watcher);
…		…
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
…		…
165		173
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 interetsing 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
…		…
193	as this indicates an incompatible change. Minor versions are usually	207	as this indicates an incompatible change. Minor versions are usually
194	compatible to older versions, so a larger minor version alone is usually	208	compatible to older versions, so a larger minor version alone is usually
195	not a problem.	209	not a problem.
196		210
197	Example: Make sure we haven't accidentally been linked against the wrong	211	Example: Make sure we haven't accidentally been linked against the wrong
198	version (note, however, that this will not detect ABI mismatches :).	212	version (note, however, that this will not detect other ABI mismatches,
		213	such as LFS or reentrancy).
199		214
200	assert (("libev version mismatch",	215	assert (("libev version mismatch",
201	ev_version_major () == EV_VERSION_MAJOR	216	ev_version_major () == EV_VERSION_MAJOR
202	&& ev_version_minor () >= EV_VERSION_MINOR));	217	&& ev_version_minor () >= EV_VERSION_MINOR));
203		218
…		…
225	probe for if you specify no backends explicitly.	240	probe for if you specify no backends explicitly.
226		241
227	=item unsigned int ev_embeddable_backends ()	242	=item unsigned int ev_embeddable_backends ()
228		243
229	Returns the set of backends that are embeddable in other event loops. This	244	Returns the set of backends that are embeddable in other event loops. This
230	is the theoretical, all-platform, value. To find which backends	245	value is platform-specific but can include backends not available on the
231	might be supported on the current system, you would need to look at	246	current system. To find which embeddable backends might be supported on
232	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	247	the current system, you would need to look at C<ev_embeddable_backends ()
233	recommended ones.	248	& ev_supported_backends ()>, likewise for recommended ones.
234		249
235	See the description of C<ev_embed> watchers for more info.	250	See the description of C<ev_embed> watchers for more info.
236		251
237	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]	252	=item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())
238		253
239	Sets the allocation function to use (the prototype is similar - the	254	Sets the allocation function to use (the prototype is similar - the
240	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
241	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
242	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
…		…
268	}	283	}
269		284
270	...	285	...
271	ev_set_allocator (persistent_realloc);	286	ev_set_allocator (persistent_realloc);
272		287
273	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]	288	=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
274		289
275	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
276	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
277	indicating the system call or subsystem causing the problem. If this	292	indicating the system call or subsystem causing the problem. If this
278	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
…		…
290	}	305	}
291		306
292	...	307	...
293	ev_set_syserr_cb (fatal_error);	308	ev_set_syserr_cb (fatal_error);
294		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
295	=back	323	=back
296		324
297	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	325	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
298		326
299	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
300	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
301	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).
302		330
303	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
304	supports signals and child events, and dynamically created event loops	332	supports child process events, and dynamically created event loops which
305	which do not.	333	do not.
306		334
307	=over 4	335	=over 4
308		336
309	=item struct ev_loop *ev_default_loop (unsigned int flags)	337	=item struct ev_loop *ev_default_loop (unsigned int flags)
310		338
311	This will initialise the default event loop if it hasn't been initialised	339	This returns the "default" event loop object, which is what you should
312	yet and return it. If the default loop could not be initialised, returns	340	normally use when you just need "the event loop". Event loop objects and
313	false. If it already was initialised it simply returns it (and ignores the	341	the C<flags> parameter are described in more detail in the entry for
314	flags. If that is troubling you, check C<ev_backend ()> afterwards).	342	C<ev_loop_new>.
		343
		344	If the default loop is already initialised then this function simply
		345	returns it (and ignores the flags. If that is troubling you, check
		346	C<ev_backend ()> afterwards). Otherwise it will create it with the given
		347	flags, which should almost always be C<0>, unless the caller is also the
		348	one calling C<ev_run> or otherwise qualifies as "the main program".
315		349
316	If you don't know what event loop to use, use the one returned from this	350	If you don't know what event loop to use, use the one returned from this
317	function.	351	function (or via the C<EV_DEFAULT> macro).
318		352
319	Note that this function is I<not> thread-safe, so if you want to use it	353	Note that this function is I<not> thread-safe, so if you want to use it
320	from multiple threads, you have to lock (note also that this is unlikely,	354	from multiple threads, you have to employ some kind of mutex (note also
321	as loops cannot be shared easily between threads anyway).	355	that this case is unlikely, as loops cannot be shared easily between
		356	threads anyway).
322		357
323	The default loop is the only loop that can handle C<ev_signal> and	358	The default loop is the only loop that can handle C<ev_child> watchers,
324	C<ev_child> watchers, and to do this, it always registers a handler	359	and to do this, it always registers a handler for C<SIGCHLD>. If this is
325	for C<SIGCHLD>. If this is a problem for your application you can either	360	a problem for your application you can either create a dynamic loop with
326	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	361	C<ev_loop_new> which doesn't do that, or you can simply overwrite the
327	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	362	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
328	C<ev_default_init>.	363
		364	Example: This is the most typical usage.
		365
		366	if (!ev_default_loop (0))
		367	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
		368
		369	Example: Restrict libev to the select and poll backends, and do not allow
		370	environment settings to be taken into account:
		371
		372	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
		373
		374	=item struct ev_loop *ev_loop_new (unsigned int flags)
		375
		376	This will create and initialise a new event loop object. If the loop
		377	could not be initialised, returns false.
		378
		379	This function is thread-safe, and one common way to use libev with
		380	threads is indeed to create one loop per thread, and using the default
		381	loop in the "main" or "initial" thread.
329		382
330	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
331	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>).
332		385
333	The following flags are supported:	386	The following flags are supported:
…		…
368	environment variable.	421	environment variable.
369		422
370	=item C<EVFLAG_NOINOTIFY>	423	=item C<EVFLAG_NOINOTIFY>
371		424
372	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
373	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
374	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
375	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.
376		429
377	=item C<EVFLAG_SIGNALFD>	430	=item C<EVFLAG_SIGNALFD>
378		431
379	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
380	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
381	delivers signals synchronously, which makes it both faster and might make	434	delivers signals synchronously, which makes it both faster and might make
382	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
383	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
384	threads that are not interested in handling them.	437	threads that are not interested in handling them.
385		438
386	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
387	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
388	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.
389		457
390	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	458	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
391		459
392	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
393	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,
…		…
421	=item C<EVBACKEND_EPOLL> (value 4, Linux)	489	=item C<EVBACKEND_EPOLL> (value 4, Linux)
422		490
423	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
424	kernels).	492	kernels).
425		493
426	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
427	but it scales phenomenally better. While poll and select usually scale	495	it scales phenomenally better. While poll and select usually scale like
428	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
429	epoll scales either O(1) or O(active_fds).	497	fd), epoll scales either O(1) or O(active_fds).
430		498
431	The epoll mechanism deserves honorable mention as the most misdesigned	499	The epoll mechanism deserves honorable mention as the most misdesigned
432	of the more advanced event mechanisms: mere annoyances include silently	500	of the more advanced event mechanisms: mere annoyances include silently
433	dropping file descriptors, requiring a system call per change per file	501	dropping file descriptors, requiring a system call per change per file
434	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
435	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
436	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
437	take considerable time (one syscall per file descriptor) and is of course	507	set, which can take considerable time (one syscall per file descriptor)
438	hard to detect.	508	and is of course hard to detect.
439		509
440	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	510	Epoll is also notoriously buggy - embedding epoll fds I<should> work,
441	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
442	I<different> file descriptors (even already closed ones, so one cannot	512	totally I<different> file descriptors (even already closed ones, so
443	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
444	on SMP systems). Libev tries to counter these spurious notifications by	514	(especially on SMP systems). Libev tries to counter these spurious
445	employing an additional generation counter and comparing that against the	515	notifications by employing an additional generation counter and comparing
446	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
447	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
448	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...
449		526
450	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
451	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
452	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
453	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
…		…
490		567
491	It scales in the same way as the epoll backend, but the interface to the	568	It scales in the same way as the epoll backend, but the interface to the
492	kernel is more efficient (which says nothing about its actual speed, of	569	kernel is more efficient (which says nothing about its actual speed, of
493	course). While stopping, setting and starting an I/O watcher does never	570	course). While stopping, setting and starting an I/O watcher does never
494	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to	571	cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
495	two event changes per incident. Support for C<fork ()> is very bad (but	572	two event changes per incident. Support for C<fork ()> is very bad (you
496	sane, unlike epoll) and it drops fds silently in similarly hard-to-detect	573	might have to leak fd's on fork, but it's more sane than epoll) and it
497	cases	574	drops fds silently in similarly hard-to-detect cases
498		575
499	This backend usually performs well under most conditions.	576	This backend usually performs well under most conditions.
500		577
501	While nominally embeddable in other event loops, this doesn't work	578	While nominally embeddable in other event loops, this doesn't work
502	everywhere, so you might need to test for this. And since it is broken	579	everywhere, so you might need to test for this. And since it is broken
…		…
519	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	596	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
520		597
521	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,
522	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)).
523		600
524	Please note that Solaris event ports can deliver a lot of spurious
525	notifications, so you need to use non-blocking I/O or other means to avoid
526	blocking when no data (or space) is available.
527
528	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
529	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
530	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	603	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
531	might perform better.	604	might perform better.
532		605
533	On the positive side, with the exception of the spurious readiness	606	On the positive side, this backend actually performed fully to
534	notifications, this backend actually performed fully to specification
535	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
536	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.
537		620
538	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
539	C<EVBACKEND_POLL>.	622	C<EVBACKEND_POLL>.
540		623
541	=item C<EVBACKEND_ALL>	624	=item C<EVBACKEND_ALL>
542		625
543	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
544	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
545	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	628	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
546		629
547	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).
548		639
549	=back	640	=back
550		641
551	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,
552	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
553	here). If none are specified, all backends in C<ev_recommended_backends	644	here). If none are specified, all backends in C<ev_recommended_backends
554	()> will be tried.	645	()> will be tried.
555		646
556	Example: This is the most typical usage.
557
558	if (!ev_default_loop (0))
559	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
560
561	Example: Restrict libev to the select and poll backends, and do not allow
562	environment settings to be taken into account:
563
564	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
565
566	Example: Use whatever libev has to offer, but make sure that kqueue is
567	used if available (warning, breaks stuff, best use only with your own
568	private event loop and only if you know the OS supports your types of
569	fds):
570
571	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
572
573	=item struct ev_loop *ev_loop_new (unsigned int flags)
574
575	Similar to C<ev_default_loop>, but always creates a new event loop that is
576	always distinct from the default loop.
577
578	Note that this function I<is> thread-safe, and one common way to use
579	libev with threads is indeed to create one loop per thread, and using the
580	default loop in the "main" or "initial" thread.
581
582	Example: Try to create a event loop that uses epoll and nothing else.	647	Example: Try to create a event loop that uses epoll and nothing else.
583		648
584	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	649	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
585	if (!epoller)	650	if (!epoller)
586	fatal ("no epoll found here, maybe it hides under your chair");	651	fatal ("no epoll found here, maybe it hides under your chair");
587		652
		653	Example: Use whatever libev has to offer, but make sure that kqueue is
		654	used if available.
		655
		656	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
		657
588	=item ev_default_destroy ()	658	=item ev_loop_destroy (loop)
589		659
590	Destroys the default loop (frees all memory and kernel state etc.). None	660	Destroys an event loop object (frees all memory and kernel state
591	of the active event watchers will be stopped in the normal sense, so	661	etc.). None of the active event watchers will be stopped in the normal
592	e.g. C<ev_is_active> might still return true. It is your responsibility to	662	sense, so e.g. C<ev_is_active> might still return true. It is your
593	either stop all watchers cleanly yourself I<before> calling this function,	663	responsibility to either stop all watchers cleanly yourself I<before>
594	or cope with the fact afterwards (which is usually the easiest thing, you	664	calling this function, or cope with the fact afterwards (which is usually
595	can just ignore the watchers and/or C<free ()> them for example).	665	the easiest thing, you can just ignore the watchers and/or C<free ()> them
		666	for example).
596		667
597	Note that certain global state, such as signal state (and installed signal	668	Note that certain global state, such as signal state (and installed signal
598	handlers), will not be freed by this function, and related watchers (such	669	handlers), will not be freed by this function, and related watchers (such
599	as signal and child watchers) would need to be stopped manually.	670	as signal and child watchers) would need to be stopped manually.
600		671
601	In general it is not advisable to call this function except in the	672	This function is normally used on loop objects allocated by
602	rare occasion where you really need to free e.g. the signal handling	673	C<ev_loop_new>, but it can also be used on the default loop returned by
		674	C<ev_default_loop>, in which case it is not thread-safe.
		675
		676	Note that it is not advisable to call this function on the default loop
		677	except in the rare occasion where you really need to free its resources.
603	pipe fds. If you need dynamically allocated loops it is better to use	678	If you need dynamically allocated loops it is better to use C<ev_loop_new>
604	C<ev_loop_new> and C<ev_loop_destroy>.	679	and C<ev_loop_destroy>.
605		680
606	=item ev_loop_destroy (loop)	681	=item ev_loop_fork (loop)
607		682
608	Like C<ev_default_destroy>, but destroys an event loop created by an
609	earlier call to C<ev_loop_new>.
610
611	=item ev_default_fork ()
612
613	This function sets a flag that causes subsequent C<ev_run> iterations	683	This function sets a flag that causes subsequent C<ev_run> iterations to
614	to reinitialise the kernel state for backends that have one. Despite the	684	reinitialise the kernel state for backends that have one. Despite the
615	name, you can call it anytime, but it makes most sense after forking, in	685	name, you can call it anytime, but it makes most sense after forking, in
616	the child process (or both child and parent, but that again makes little	686	the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the
617	sense). You I<must> call it in the child before using any of the libev	687	child before resuming or calling C<ev_run>.
618	functions, and it will only take effect at the next C<ev_run> iteration.
619		688
620	Again, you I<have> to call it on I<any> loop that you want to re-use after	689	Again, you I<have> to call it on I<any> loop that you want to re-use after
621	a fork, I<even if you do not plan to use the loop in the parent>. This is	690	a fork, I<even if you do not plan to use the loop in the parent>. This is
622	because some kernel interfaces *cough* I<kqueue> *cough* do funny things	691	because some kernel interfaces *cough* I<kqueue> *cough* do funny things
623	during fork.	692	during fork.
…		…
628	call it at all (in fact, C<epoll> is so badly broken that it makes a	697	call it at all (in fact, C<epoll> is so badly broken that it makes a
629	difference, but libev will usually detect this case on its own and do a	698	difference, but libev will usually detect this case on its own and do a
630	costly reset of the backend).	699	costly reset of the backend).
631		700
632	The function itself is quite fast and it's usually not a problem to call	701	The function itself is quite fast and it's usually not a problem to call
633	it just in case after a fork. To make this easy, the function will fit in	702	it just in case after a fork.
634	quite nicely into a call to C<pthread_atfork>:
635		703
		704	Example: Automate calling C<ev_loop_fork> on the default loop when
		705	using pthreads.
		706
		707	static void
		708	post_fork_child (void)
		709	{
		710	ev_loop_fork (EV_DEFAULT);
		711	}
		712
		713	...
636	pthread_atfork (0, 0, ev_default_fork);	714	pthread_atfork (0, 0, post_fork_child);
637
638	=item ev_loop_fork (loop)
639
640	Like C<ev_default_fork>, but acts on an event loop created by
641	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
642	after fork that you want to re-use in the child, and how you keep track of
643	them is entirely your own problem.
644		715
645	=item int ev_is_default_loop (loop)	716	=item int ev_is_default_loop (loop)
646		717
647	Returns true when the given loop is, in fact, the default loop, and false	718	Returns true when the given loop is, in fact, the default loop, and false
648	otherwise.	719	otherwise.
…		…
659	prepare and check phases.	730	prepare and check phases.
660		731
661	=item unsigned int ev_depth (loop)	732	=item unsigned int ev_depth (loop)
662		733
663	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
664	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.
665		736
666	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
667	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),
668	in which case it is higher.	739	in which case it is higher.
669		740
670	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread	741	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread,
671	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
672	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.
673		745
674	=item unsigned int ev_backend (loop)	746	=item unsigned int ev_backend (loop)
675		747
676	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
677	use.	749	use.
…		…
720	without a previous call to C<ev_suspend>.	792	without a previous call to C<ev_suspend>.
721		793
722	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the	794	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
723	event loop time (see C<ev_now_update>).	795	event loop time (see C<ev_now_update>).
724		796
725	=item ev_run (loop, int flags)	797	=item bool ev_run (loop, int flags)
726		798
727	Finally, this is it, the event handler. This function usually is called	799	Finally, this is it, the event handler. This function usually is called
728	after you have initialised all your watchers and you want to start	800	after you have initialised all your watchers and you want to start
729	handling events. It will ask the operating system for any new events, call	801	handling events. It will ask the operating system for any new events, call
730	the watcher callbacks, an then repeat the whole process indefinitely: This	802	the watcher callbacks, and then repeat the whole process indefinitely: This
731	is why event loops are called I<loops>.	803	is why event loops are called I<loops>.
732		804
733	If the flags argument is specified as C<0>, it will keep handling events	805	If the flags argument is specified as C<0>, it will keep handling events
734	until either no event watchers are active anymore or C<ev_break> was	806	until either no event watchers are active anymore or C<ev_break> was
735	called.	807	called.
		808
		809	The return value is false if there are no more active watchers (which
		810	usually means "all jobs done" or "deadlock"), and true in all other cases
		811	(which usually means " you should call C<ev_run> again").
736		812
737	Please note that an explicit C<ev_break> is usually better than	813	Please note that an explicit C<ev_break> is usually better than
738	relying on all watchers to be stopped when deciding when a program has	814	relying on all watchers to be stopped when deciding when a program has
739	finished (especially in interactive programs), but having a program	815	finished (especially in interactive programs), but having a program
740	that automatically loops as long as it has to and no longer by virtue	816	that automatically loops as long as it has to and no longer by virtue
741	of relying on its watchers stopping correctly, that is truly a thing of	817	of relying on its watchers stopping correctly, that is truly a thing of
742	beauty.	818	beauty.
743		819
		820	This function is I<mostly> exception-safe - you can break out of a
		821	C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
		822	exception and so on. This does not decrement the C<ev_depth> value, nor
		823	will it clear any outstanding C<EVBREAK_ONE> breaks.
		824
744	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle	825	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
745	those events and any already outstanding ones, but will not wait and	826	those events and any already outstanding ones, but will not wait and
746	block your process in case there are no events and will return after one	827	block your process in case there are no events and will return after one
747	iteration of the loop. This is sometimes useful to poll and handle new	828	iteration of the loop. This is sometimes useful to poll and handle new
748	events while doing lengthy calculations, to keep the program responsive.	829	events while doing lengthy calculations, to keep the program responsive.
…		…
757	This is useful if you are waiting for some external event in conjunction	838	This is useful if you are waiting for some external event in conjunction
758	with something not expressible using other libev watchers (i.e. "roll your	839	with something not expressible using other libev watchers (i.e. "roll your
759	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is	840	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
760	usually a better approach for this kind of thing.	841	usually a better approach for this kind of thing.
761		842
762	Here are the gory details of what C<ev_run> does:	843	Here are the gory details of what C<ev_run> does (this is for your
		844	understanding, not a guarantee that things will work exactly like this in
		845	future versions):
763		846
764	- Increment loop depth.	847	- Increment loop depth.
765	- Reset the ev_break status.	848	- Reset the ev_break status.
766	- Before the first iteration, call any pending watchers.	849	- Before the first iteration, call any pending watchers.
767	LOOP:	850	LOOP:
…		…
800	anymore.	883	anymore.
801		884
802	... queue jobs here, make sure they register event watchers as long	885	... queue jobs here, make sure they register event watchers as long
803	... as they still have work to do (even an idle watcher will do..)	886	... as they still have work to do (even an idle watcher will do..)
804	ev_run (my_loop, 0);	887	ev_run (my_loop, 0);
805	... jobs done or somebody called unloop. yeah!	888	... jobs done or somebody called break. yeah!
806		889
807	=item ev_break (loop, how)	890	=item ev_break (loop, how)
808		891
809	Can be used to make a call to C<ev_run> return early (but only after it	892	Can be used to make a call to C<ev_run> return early (but only after it
810	has processed all outstanding events). The C<how> argument must be either	893	has processed all outstanding events). The C<how> argument must be either
811	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or	894	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
812	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.	895	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
813		896
814	This "unloop state" will be cleared when entering C<ev_run> again.	897	This "break state" will be cleared on the next call to C<ev_run>.
815		898
816	It is safe to call C<ev_break> from outside any C<ev_run> calls. ##TODO##	899	It is safe to call C<ev_break> from outside any C<ev_run> calls, too, in
		900	which case it will have no effect.
817		901
818	=item ev_ref (loop)	902	=item ev_ref (loop)
819		903
820	=item ev_unref (loop)	904	=item ev_unref (loop)
821		905
…		…
842	running when nothing else is active.	926	running when nothing else is active.
843		927
844	ev_signal exitsig;	928	ev_signal exitsig;
845	ev_signal_init (&exitsig, sig_cb, SIGINT);	929	ev_signal_init (&exitsig, sig_cb, SIGINT);
846	ev_signal_start (loop, &exitsig);	930	ev_signal_start (loop, &exitsig);
847	evf_unref (loop);	931	ev_unref (loop);
848		932
849	Example: For some weird reason, unregister the above signal handler again.	933	Example: For some weird reason, unregister the above signal handler again.
850		934
851	ev_ref (loop);	935	ev_ref (loop);
852	ev_signal_stop (loop, &exitsig);	936	ev_signal_stop (loop, &exitsig);
…		…
872	overhead for the actual polling but can deliver many events at once.	956	overhead for the actual polling but can deliver many events at once.
873		957
874	By setting a higher I<io collect interval> you allow libev to spend more	958	By setting a higher I<io collect interval> you allow libev to spend more
875	time collecting I/O events, so you can handle more events per iteration,	959	time collecting I/O events, so you can handle more events per iteration,
876	at the cost of increasing latency. Timeouts (both C<ev_periodic> and	960	at the cost of increasing latency. Timeouts (both C<ev_periodic> and
877	C<ev_timer>) will be not affected. Setting this to a non-null value will	961	C<ev_timer>) will not be affected. Setting this to a non-null value will
878	introduce an additional C<ev_sleep ()> call into most loop iterations. The	962	introduce an additional C<ev_sleep ()> call into most loop iterations. The
879	sleep time ensures that libev will not poll for I/O events more often then	963	sleep time ensures that libev will not poll for I/O events more often then
880	once per this interval, on average.	964	once per this interval, on average (as long as the host time resolution is
		965	good enough).
881		966
882	Likewise, by setting a higher I<timeout collect interval> you allow libev	967	Likewise, by setting a higher I<timeout collect interval> you allow libev
883	to spend more time collecting timeouts, at the expense of increased	968	to spend more time collecting timeouts, at the expense of increased
884	latency/jitter/inexactness (the watcher callback will be called	969	latency/jitter/inexactness (the watcher callback will be called
885	later). C<ev_io> watchers will not be affected. Setting this to a non-null	970	later). C<ev_io> watchers will not be affected. Setting this to a non-null
…		…
931	invoke the actual watchers inside another context (another thread etc.).	1016	invoke the actual watchers inside another context (another thread etc.).
932		1017
933	If you want to reset the callback, use C<ev_invoke_pending> as new	1018	If you want to reset the callback, use C<ev_invoke_pending> as new
934	callback.	1019	callback.
935		1020
936	=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))	1021	=item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())
937		1022
938	Sometimes you want to share the same loop between multiple threads. This	1023	Sometimes you want to share the same loop between multiple threads. This
939	can be done relatively simply by putting mutex_lock/unlock calls around	1024	can be done relatively simply by putting mutex_lock/unlock calls around
940	each call to a libev function.	1025	each call to a libev function.
941		1026
942	However, C<ev_run> can run an indefinite time, so it is not feasible	1027	However, C<ev_run> can run an indefinite time, so it is not feasible
943	to wait for it to return. One way around this is to wake up the event	1028	to wait for it to return. One way around this is to wake up the event
944	loop via C<ev_break> and C<av_async_send>, another way is to set these	1029	loop via C<ev_break> and C<ev_async_send>, another way is to set these
945	I<release> and I<acquire> callbacks on the loop.	1030	I<release> and I<acquire> callbacks on the loop.
946		1031
947	When set, then C<release> will be called just before the thread is	1032	When set, then C<release> will be called just before the thread is
948	suspended waiting for new events, and C<acquire> is called just	1033	suspended waiting for new events, and C<acquire> is called just
949	afterwards.	1034	afterwards.
…		…
964	See also the locking example in the C<THREADS> section later in this	1049	See also the locking example in the C<THREADS> section later in this
965	document.	1050	document.
966		1051
967	=item ev_set_userdata (loop, void *data)	1052	=item ev_set_userdata (loop, void *data)
968		1053
969	=item ev_userdata (loop)	1054	=item void *ev_userdata (loop)
970		1055
971	Set and retrieve a single C<void *> associated with a loop. When	1056	Set and retrieve a single C<void *> associated with a loop. When
972	C<ev_set_userdata> has never been called, then C<ev_userdata> returns	1057	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
973	C<0.>	1058	C<0>.
974		1059
975	These two functions can be used to associate arbitrary data with a loop,	1060	These two functions can be used to associate arbitrary data with a loop,
976	and are intended solely for the C<invoke_pending_cb>, C<release> and	1061	and are intended solely for the C<invoke_pending_cb>, C<release> and
977	C<acquire> callbacks described above, but of course can be (ab-)used for	1062	C<acquire> callbacks described above, but of course can be (ab-)used for
978	any other purpose as well.	1063	any other purpose as well.
…		…
1089		1174
1090	=item C<EV_PREPARE>	1175	=item C<EV_PREPARE>
1091		1176
1092	=item C<EV_CHECK>	1177	=item C<EV_CHECK>
1093		1178
1094	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts	1179	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to
1095	to gather new events, and all C<ev_check> watchers are invoked just after	1180	gather new events, and all C<ev_check> watchers are queued (not invoked)
1096	C<ev_run> has gathered them, but before it invokes any callbacks for any	1181	just after C<ev_run> has gathered them, but before it queues any callbacks
		1182	for any received events. That means C<ev_prepare> watchers are the last
		1183	watchers invoked before the event loop sleeps or polls for new events, and
		1184	C<ev_check> watchers will be invoked before any other watchers of the same
		1185	or lower priority within an event loop iteration.
		1186
1097	received events. Callbacks of both watcher types can start and stop as	1187	Callbacks of both watcher types can start and stop as many watchers as
1098	many watchers as they want, and all of them will be taken into account	1188	they want, and all of them will be taken into account (for example, a
1099	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	1189	C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1100	C<ev_run> from blocking).	1190	blocking).
1101		1191
1102	=item C<EV_EMBED>	1192	=item C<EV_EMBED>
1103		1193
1104	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1194	The embedded event loop specified in the C<ev_embed> watcher needs attention.
1105		1195
1106	=item C<EV_FORK>	1196	=item C<EV_FORK>
1107		1197
1108	The event loop has been resumed in the child process after fork (see	1198	The event loop has been resumed in the child process after fork (see
1109	C<ev_fork>).	1199	C<ev_fork>).
		1200
		1201	=item C<EV_CLEANUP>
		1202
		1203	The event loop is about to be destroyed (see C<ev_cleanup>).
1110		1204
1111	=item C<EV_ASYNC>	1205	=item C<EV_ASYNC>
1112		1206
1113	The given async watcher has been asynchronously notified (see C<ev_async>).	1207	The given async watcher has been asynchronously notified (see C<ev_async>).
1114		1208
…		…
1136	programs, though, as the fd could already be closed and reused for another	1230	programs, though, as the fd could already be closed and reused for another
1137	thing, so beware.	1231	thing, so beware.
1138		1232
1139	=back	1233	=back
1140		1234
		1235	=head2 GENERIC WATCHER FUNCTIONS
		1236
		1237	=over 4
		1238
		1239	=item C<ev_init> (ev_TYPE *watcher, callback)
		1240
		1241	This macro initialises the generic portion of a watcher. The contents
		1242	of the watcher object can be arbitrary (so C<malloc> will do). Only
		1243	the generic parts of the watcher are initialised, you I<need> to call
		1244	the type-specific C<ev_TYPE_set> macro afterwards to initialise the
		1245	type-specific parts. For each type there is also a C<ev_TYPE_init> macro
		1246	which rolls both calls into one.
		1247
		1248	You can reinitialise a watcher at any time as long as it has been stopped
		1249	(or never started) and there are no pending events outstanding.
		1250
		1251	The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
		1252	int revents)>.
		1253
		1254	Example: Initialise an C<ev_io> watcher in two steps.
		1255
		1256	ev_io w;
		1257	ev_init (&w, my_cb);
		1258	ev_io_set (&w, STDIN_FILENO, EV_READ);
		1259
		1260	=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
		1261
		1262	This macro initialises the type-specific parts of a watcher. You need to
		1263	call C<ev_init> at least once before you call this macro, but you can
		1264	call C<ev_TYPE_set> any number of times. You must not, however, call this
		1265	macro on a watcher that is active (it can be pending, however, which is a
		1266	difference to the C<ev_init> macro).
		1267
		1268	Although some watcher types do not have type-specific arguments
		1269	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
		1270
		1271	See C<ev_init>, above, for an example.
		1272
		1273	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
		1274
		1275	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
		1276	calls into a single call. This is the most convenient method to initialise
		1277	a watcher. The same limitations apply, of course.
		1278
		1279	Example: Initialise and set an C<ev_io> watcher in one step.
		1280
		1281	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
		1282
		1283	=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
		1284
		1285	Starts (activates) the given watcher. Only active watchers will receive
		1286	events. If the watcher is already active nothing will happen.
		1287
		1288	Example: Start the C<ev_io> watcher that is being abused as example in this
		1289	whole section.
		1290
		1291	ev_io_start (EV_DEFAULT_UC, &w);
		1292
		1293	=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
		1294
		1295	Stops the given watcher if active, and clears the pending status (whether
		1296	the watcher was active or not).
		1297
		1298	It is possible that stopped watchers are pending - for example,
		1299	non-repeating timers are being stopped when they become pending - but
		1300	calling C<ev_TYPE_stop> ensures that the watcher is neither active nor
		1301	pending. If you want to free or reuse the memory used by the watcher it is
		1302	therefore a good idea to always call its C<ev_TYPE_stop> function.
		1303
		1304	=item bool ev_is_active (ev_TYPE *watcher)
		1305
		1306	Returns a true value iff the watcher is active (i.e. it has been started
		1307	and not yet been stopped). As long as a watcher is active you must not modify
		1308	it.
		1309
		1310	=item bool ev_is_pending (ev_TYPE *watcher)
		1311
		1312	Returns a true value iff the watcher is pending, (i.e. it has outstanding
		1313	events but its callback has not yet been invoked). As long as a watcher
		1314	is pending (but not active) you must not call an init function on it (but
		1315	C<ev_TYPE_set> is safe), you must not change its priority, and you must
		1316	make sure the watcher is available to libev (e.g. you cannot C<free ()>
		1317	it).
		1318
		1319	=item callback ev_cb (ev_TYPE *watcher)
		1320
		1321	Returns the callback currently set on the watcher.
		1322
		1323	=item ev_cb_set (ev_TYPE *watcher, callback)
		1324
		1325	Change the callback. You can change the callback at virtually any time
		1326	(modulo threads).
		1327
		1328	=item ev_set_priority (ev_TYPE *watcher, int priority)
		1329
		1330	=item int ev_priority (ev_TYPE *watcher)
		1331
		1332	Set and query the priority of the watcher. The priority is a small
		1333	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
		1334	(default: C<-2>). Pending watchers with higher priority will be invoked
		1335	before watchers with lower priority, but priority will not keep watchers
		1336	from being executed (except for C<ev_idle> watchers).
		1337
		1338	If you need to suppress invocation when higher priority events are pending
		1339	you need to look at C<ev_idle> watchers, which provide this functionality.
		1340
		1341	You I<must not> change the priority of a watcher as long as it is active or
		1342	pending.
		1343
		1344	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		1345	fine, as long as you do not mind that the priority value you query might
		1346	or might not have been clamped to the valid range.
		1347
		1348	The default priority used by watchers when no priority has been set is
		1349	always C<0>, which is supposed to not be too high and not be too low :).
		1350
		1351	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
		1352	priorities.
		1353
		1354	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
		1355
		1356	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
		1357	C<loop> nor C<revents> need to be valid as long as the watcher callback
		1358	can deal with that fact, as both are simply passed through to the
		1359	callback.
		1360
		1361	=item int ev_clear_pending (loop, ev_TYPE *watcher)
		1362
		1363	If the watcher is pending, this function clears its pending status and
		1364	returns its C<revents> bitset (as if its callback was invoked). If the
		1365	watcher isn't pending it does nothing and returns C<0>.
		1366
		1367	Sometimes it can be useful to "poll" a watcher instead of waiting for its
		1368	callback to be invoked, which can be accomplished with this function.
		1369
		1370	=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
		1371
		1372	Feeds the given event set into the event loop, as if the specified event
		1373	had happened for the specified watcher (which must be a pointer to an
		1374	initialised but not necessarily started event watcher). Obviously you must
		1375	not free the watcher as long as it has pending events.
		1376
		1377	Stopping the watcher, letting libev invoke it, or calling
		1378	C<ev_clear_pending> will clear the pending event, even if the watcher was
		1379	not started in the first place.
		1380
		1381	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
		1382	functions that do not need a watcher.
		1383
		1384	=back
		1385
		1386	See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
		1387	OWN COMPOSITE WATCHERS> idioms.
		1388
1141	=head2 WATCHER STATES	1389	=head2 WATCHER STATES
1142		1390
1143	There are various watcher states mentioned throughout this manual -	1391	There are various watcher states mentioned throughout this manual -
1144	active, pending and so on. In this section these states and the rules to	1392	active, pending and so on. In this section these states and the rules to
1145	transition between them will be described in more detail - and while these	1393	transition between them will be described in more detail - and while these
…		…
1147		1395
1148	=over 4	1396	=over 4
1149		1397
1150	=item initialiased	1398	=item initialiased
1151		1399
1152	Before a watcher can be registered with the event looop it has to be	1400	Before a watcher can be registered with the event loop it has to be
1153	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to	1401	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1154	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.	1402	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1155		1403
1156	In this state it is simply some block of memory that is suitable for use	1404	In this state it is simply some block of memory that is suitable for
1157	in an event loop. It can be moved around, freed, reused etc. at will.	1405	use in an event loop. It can be moved around, freed, reused etc. at
		1406	will - as long as you either keep the memory contents intact, or call
		1407	C<ev_TYPE_init> again.
1158		1408
1159	=item started/running/active	1409	=item started/running/active
1160		1410
1161	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes	1411	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1162	property of the event loop, and is actively waiting for events. While in	1412	property of the event loop, and is actively waiting for events. While in
…		…
1190	latter will clear any pending state the watcher might be in, regardless	1440	latter will clear any pending state the watcher might be in, regardless
1191	of whether it was active or not, so stopping a watcher explicitly before	1441	of whether it was active or not, so stopping a watcher explicitly before
1192	freeing it is often a good idea.	1442	freeing it is often a good idea.
1193		1443
1194	While stopped (and not pending) the watcher is essentially in the	1444	While stopped (and not pending) the watcher is essentially in the
1195	initialised state, that is it can be reused, moved, modified in any way	1445	initialised state, that is, it can be reused, moved, modified in any way
1196	you wish.	1446	you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
		1447	it again).
1197		1448
1198	=back	1449	=back
1199
1200	=head2 GENERIC WATCHER FUNCTIONS
1201
1202	=over 4
1203
1204	=item C<ev_init> (ev_TYPE *watcher, callback)
1205
1206	This macro initialises the generic portion of a watcher. The contents
1207	of the watcher object can be arbitrary (so C<malloc> will do). Only
1208	the generic parts of the watcher are initialised, you I<need> to call
1209	the type-specific C<ev_TYPE_set> macro afterwards to initialise the
1210	type-specific parts. For each type there is also a C<ev_TYPE_init> macro
1211	which rolls both calls into one.
1212
1213	You can reinitialise a watcher at any time as long as it has been stopped
1214	(or never started) and there are no pending events outstanding.
1215
1216	The callback is always of type C<void (*)(struct ev_loop *loop, ev_TYPE *watcher,
1217	int revents)>.
1218
1219	Example: Initialise an C<ev_io> watcher in two steps.
1220
1221	ev_io w;
1222	ev_init (&w, my_cb);
1223	ev_io_set (&w, STDIN_FILENO, EV_READ);
1224
1225	=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
1226
1227	This macro initialises the type-specific parts of a watcher. You need to
1228	call C<ev_init> at least once before you call this macro, but you can
1229	call C<ev_TYPE_set> any number of times. You must not, however, call this
1230	macro on a watcher that is active (it can be pending, however, which is a
1231	difference to the C<ev_init> macro).
1232
1233	Although some watcher types do not have type-specific arguments
1234	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
1235
1236	See C<ev_init>, above, for an example.
1237
1238	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
1239
1240	This convenience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
1241	calls into a single call. This is the most convenient method to initialise
1242	a watcher. The same limitations apply, of course.
1243
1244	Example: Initialise and set an C<ev_io> watcher in one step.
1245
1246	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1247
1248	=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1249
1250	Starts (activates) the given watcher. Only active watchers will receive
1251	events. If the watcher is already active nothing will happen.
1252
1253	Example: Start the C<ev_io> watcher that is being abused as example in this
1254	whole section.
1255
1256	ev_io_start (EV_DEFAULT_UC, &w);
1257
1258	=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1259
1260	Stops the given watcher if active, and clears the pending status (whether
1261	the watcher was active or not).
1262
1263	It is possible that stopped watchers are pending - for example,
1264	non-repeating timers are being stopped when they become pending - but
1265	calling C<ev_TYPE_stop> ensures that the watcher is neither active nor
1266	pending. If you want to free or reuse the memory used by the watcher it is
1267	therefore a good idea to always call its C<ev_TYPE_stop> function.
1268
1269	=item bool ev_is_active (ev_TYPE *watcher)
1270
1271	Returns a true value iff the watcher is active (i.e. it has been started
1272	and not yet been stopped). As long as a watcher is active you must not modify
1273	it.
1274
1275	=item bool ev_is_pending (ev_TYPE *watcher)
1276
1277	Returns a true value iff the watcher is pending, (i.e. it has outstanding
1278	events but its callback has not yet been invoked). As long as a watcher
1279	is pending (but not active) you must not call an init function on it (but
1280	C<ev_TYPE_set> is safe), you must not change its priority, and you must
1281	make sure the watcher is available to libev (e.g. you cannot C<free ()>
1282	it).
1283
1284	=item callback ev_cb (ev_TYPE *watcher)
1285
1286	Returns the callback currently set on the watcher.
1287
1288	=item ev_cb_set (ev_TYPE *watcher, callback)
1289
1290	Change the callback. You can change the callback at virtually any time
1291	(modulo threads).
1292
1293	=item ev_set_priority (ev_TYPE *watcher, int priority)
1294
1295	=item int ev_priority (ev_TYPE *watcher)
1296
1297	Set and query the priority of the watcher. The priority is a small
1298	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1299	(default: C<-2>). Pending watchers with higher priority will be invoked
1300	before watchers with lower priority, but priority will not keep watchers
1301	from being executed (except for C<ev_idle> watchers).
1302
1303	If you need to suppress invocation when higher priority events are pending
1304	you need to look at C<ev_idle> watchers, which provide this functionality.
1305
1306	You I<must not> change the priority of a watcher as long as it is active or
1307	pending.
1308
1309	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
1310	fine, as long as you do not mind that the priority value you query might
1311	or might not have been clamped to the valid range.
1312
1313	The default priority used by watchers when no priority has been set is
1314	always C<0>, which is supposed to not be too high and not be too low :).
1315
1316	See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1317	priorities.
1318
1319	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1320
1321	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1322	C<loop> nor C<revents> need to be valid as long as the watcher callback
1323	can deal with that fact, as both are simply passed through to the
1324	callback.
1325
1326	=item int ev_clear_pending (loop, ev_TYPE *watcher)
1327
1328	If the watcher is pending, this function clears its pending status and
1329	returns its C<revents> bitset (as if its callback was invoked). If the
1330	watcher isn't pending it does nothing and returns C<0>.
1331
1332	Sometimes it can be useful to "poll" a watcher instead of waiting for its
1333	callback to be invoked, which can be accomplished with this function.
1334
1335	=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
1336
1337	Feeds the given event set into the event loop, as if the specified event
1338	had happened for the specified watcher (which must be a pointer to an
1339	initialised but not necessarily started event watcher). Obviously you must
1340	not free the watcher as long as it has pending events.
1341
1342	Stopping the watcher, letting libev invoke it, or calling
1343	C<ev_clear_pending> will clear the pending event, even if the watcher was
1344	not started in the first place.
1345
1346	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1347	functions that do not need a watcher.
1348
1349	=back
1350
1351
1352	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
1353
1354	Each watcher has, by default, a member C<void *data> that you can change
1355	and read at any time: libev will completely ignore it. This can be used
1356	to associate arbitrary data with your watcher. If you need more data and
1357	don't want to allocate memory and store a pointer to it in that data
1358	member, you can also "subclass" the watcher type and provide your own
1359	data:
1360
1361	struct my_io
1362	{
1363	ev_io io;
1364	int otherfd;
1365	void *somedata;
1366	struct whatever *mostinteresting;
1367	};
1368
1369	...
1370	struct my_io w;
1371	ev_io_init (&w.io, my_cb, fd, EV_READ);
1372
1373	And since your callback will be called with a pointer to the watcher, you
1374	can cast it back to your own type:
1375
1376	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
1377	{
1378	struct my_io *w = (struct my_io *)w_;
1379	...
1380	}
1381
1382	More interesting and less C-conformant ways of casting your callback type
1383	instead have been omitted.
1384
1385	Another common scenario is to use some data structure with multiple
1386	embedded watchers:
1387
1388	struct my_biggy
1389	{
1390	int some_data;
1391	ev_timer t1;
1392	ev_timer t2;
1393	}
1394
1395	In this case getting the pointer to C<my_biggy> is a bit more
1396	complicated: Either you store the address of your C<my_biggy> struct
1397	in the C<data> member of the watcher (for woozies), or you need to use
1398	some pointer arithmetic using C<offsetof> inside your watchers (for real
1399	programmers):
1400
1401	#include <stddef.h>
1402
1403	static void
1404	t1_cb (EV_P_ ev_timer *w, int revents)
1405	{
1406	struct my_biggy big = (struct my_biggy *)
1407	(((char *)w) - offsetof (struct my_biggy, t1));
1408	}
1409
1410	static void
1411	t2_cb (EV_P_ ev_timer *w, int revents)
1412	{
1413	struct my_biggy big = (struct my_biggy *)
1414	(((char *)w) - offsetof (struct my_biggy, t2));
1415	}
1416		1450
1417	=head2 WATCHER PRIORITY MODELS	1451	=head2 WATCHER PRIORITY MODELS
1418		1452
1419	Many event loops support I<watcher priorities>, which are usually small	1453	Many event loops support I<watcher priorities>, which are usually small
1420	integers that influence the ordering of event callback invocation	1454	integers that influence the ordering of event callback invocation
…		…
1547	In general you can register as many read and/or write event watchers per	1581	In general you can register as many read and/or write event watchers per
1548	fd as you want (as long as you don't confuse yourself). Setting all file	1582	fd as you want (as long as you don't confuse yourself). Setting all file
1549	descriptors to non-blocking mode is also usually a good idea (but not	1583	descriptors to non-blocking mode is also usually a good idea (but not
1550	required if you know what you are doing).	1584	required if you know what you are doing).
1551		1585
1552	If you cannot use non-blocking mode, then force the use of a
1553	known-to-be-good backend (at the time of this writing, this includes only
1554	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1555	descriptors for which non-blocking operation makes no sense (such as
1556	files) - libev doesn't guarantee any specific behaviour in that case.
1557
1558	Another thing you have to watch out for is that it is quite easy to	1586	Another thing you have to watch out for is that it is quite easy to
1559	receive "spurious" readiness notifications, that is your callback might	1587	receive "spurious" readiness notifications, that is, your callback might
1560	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1588	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1561	because there is no data. Not only are some backends known to create a	1589	because there is no data. It is very easy to get into this situation even
1562	lot of those (for example Solaris ports), it is very easy to get into	1590	with a relatively standard program structure. Thus it is best to always
1563	this situation even with a relatively standard program structure. Thus	1591	use non-blocking I/O: An extra C<read>(2) returning C<EAGAIN> is far
1564	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1565	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1592	preferable to a program hanging until some data arrives.
1566		1593
1567	If you cannot run the fd in non-blocking mode (for example you should	1594	If you cannot run the fd in non-blocking mode (for example you should
1568	not play around with an Xlib connection), then you have to separately	1595	not play around with an Xlib connection), then you have to separately
1569	re-test whether a file descriptor is really ready with a known-to-be good	1596	re-test whether a file descriptor is really ready with a known-to-be good
1570	interface such as poll (fortunately in our Xlib example, Xlib already	1597	interface such as poll (fortunately in the case of Xlib, it already does
1571	does this on its own, so its quite safe to use). Some people additionally	1598	this on its own, so its quite safe to use). Some people additionally
1572	use C<SIGALRM> and an interval timer, just to be sure you won't block	1599	use C<SIGALRM> and an interval timer, just to be sure you won't block
1573	indefinitely.	1600	indefinitely.
1574		1601
1575	But really, best use non-blocking mode.	1602	But really, best use non-blocking mode.
1576		1603
…		…
1604		1631
1605	There is no workaround possible except not registering events	1632	There is no workaround possible except not registering events
1606	for potentially C<dup ()>'ed file descriptors, or to resort to	1633	for potentially C<dup ()>'ed file descriptors, or to resort to
1607	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1634	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1608		1635
		1636	=head3 The special problem of files
		1637
		1638	Many people try to use C<select> (or libev) on file descriptors
		1639	representing files, and expect it to become ready when their program
		1640	doesn't block on disk accesses (which can take a long time on their own).
		1641
		1642	However, this cannot ever work in the "expected" way - you get a readiness
		1643	notification as soon as the kernel knows whether and how much data is
		1644	there, and in the case of open files, that's always the case, so you
		1645	always get a readiness notification instantly, and your read (or possibly
		1646	write) will still block on the disk I/O.
		1647
		1648	Another way to view it is that in the case of sockets, pipes, character
		1649	devices and so on, there is another party (the sender) that delivers data
		1650	on its own, but in the case of files, there is no such thing: the disk
		1651	will not send data on its own, simply because it doesn't know what you
		1652	wish to read - you would first have to request some data.
		1653
		1654	Since files are typically not-so-well supported by advanced notification
		1655	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1656	to files, even though you should not use it. The reason for this is
		1657	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1658	usually a tty, often a pipe, but also sometimes files or special devices
		1659	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1660	F</dev/urandom>), and even though the file might better be served with
		1661	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1662	it "just works" instead of freezing.
		1663
		1664	So avoid file descriptors pointing to files when you know it (e.g. use
		1665	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1666	when you rarely read from a file instead of from a socket, and want to
		1667	reuse the same code path.
		1668
1609	=head3 The special problem of fork	1669	=head3 The special problem of fork
1610		1670
1611	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1671	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1612	useless behaviour. Libev fully supports fork, but needs to be told about	1672	useless behaviour. Libev fully supports fork, but needs to be told about
1613	it in the child.	1673	it in the child if you want to continue to use it in the child.
1614		1674
1615	To support fork in your programs, you either have to call	1675	To support fork in your child processes, you have to call C<ev_loop_fork
1616	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1676	()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1617	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1677	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1618	C<EVBACKEND_POLL>.
1619		1678
1620	=head3 The special problem of SIGPIPE	1679	=head3 The special problem of SIGPIPE
1621		1680
1622	While not really specific to libev, it is easy to forget about C<SIGPIPE>:	1681	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1623	when writing to a pipe whose other end has been closed, your program gets	1682	when writing to a pipe whose other end has been closed, your program gets
…		…
1721	detecting time jumps is hard, and some inaccuracies are unavoidable (the	1780	detecting time jumps is hard, and some inaccuracies are unavoidable (the
1722	monotonic clock option helps a lot here).	1781	monotonic clock option helps a lot here).
1723		1782
1724	The callback is guaranteed to be invoked only I<after> its timeout has	1783	The callback is guaranteed to be invoked only I<after> its timeout has
1725	passed (not I<at>, so on systems with very low-resolution clocks this	1784	passed (not I<at>, so on systems with very low-resolution clocks this
1726	might introduce a small delay). If multiple timers become ready during the	1785	might introduce a small delay, see "the special problem of being too
		1786	early", below). If multiple timers become ready during the same loop
1727	same loop iteration then the ones with earlier time-out values are invoked	1787	iteration then the ones with earlier time-out values are invoked before
1728	before ones of the same priority with later time-out values (but this is	1788	ones of the same priority with later time-out values (but this is no
1729	no longer true when a callback calls C<ev_run> recursively).	1789	longer true when a callback calls C<ev_run> recursively).
1730		1790
1731	=head3 Be smart about timeouts	1791	=head3 Be smart about timeouts
1732		1792
1733	Many real-world problems involve some kind of timeout, usually for error	1793	Many real-world problems involve some kind of timeout, usually for error
1734	recovery. A typical example is an HTTP request - if the other side hangs,	1794	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1809		1869
1810	In this case, it would be more efficient to leave the C<ev_timer> alone,	1870	In this case, it would be more efficient to leave the C<ev_timer> alone,
1811	but remember the time of last activity, and check for a real timeout only	1871	but remember the time of last activity, and check for a real timeout only
1812	within the callback:	1872	within the callback:
1813		1873
		1874	ev_tstamp timeout = 60.;
1814	ev_tstamp last_activity; // time of last activity	1875	ev_tstamp last_activity; // time of last activity
		1876	ev_timer timer;
1815		1877
1816	static void	1878	static void
1817	callback (EV_P_ ev_timer *w, int revents)	1879	callback (EV_P_ ev_timer *w, int revents)
1818	{	1880	{
1819	ev_tstamp now = ev_now (EV_A);	1881	// calculate when the timeout would happen
1820	ev_tstamp timeout = last_activity + 60.;	1882	ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1821		1883
1822	// if last_activity + 60. is older than now, we did time out	1884	// if negative, it means we the timeout already occurred
1823	if (timeout < now)	1885	if (after < 0.)
1824	{	1886	{
1825	// timeout occurred, take action	1887	// timeout occurred, take action
1826	}	1888	}
1827	else	1889	else
1828	{	1890	{
1829	// callback was invoked, but there was some activity, re-arm	1891	// callback was invoked, but there was some recent
1830	// the watcher to fire in last_activity + 60, which is	1892	// activity. simply restart the timer to time out
1831	// guaranteed to be in the future, so "again" is positive:	1893	// after "after" seconds, which is the earliest time
1832	w->repeat = timeout - now;	1894	// the timeout can occur.
		1895	ev_timer_set (w, after, 0.);
1833	ev_timer_again (EV_A_ w);	1896	ev_timer_start (EV_A_ w);
1834	}	1897	}
1835	}	1898	}
1836		1899
1837	To summarise the callback: first calculate the real timeout (defined	1900	To summarise the callback: first calculate in how many seconds the
1838	as "60 seconds after the last activity"), then check if that time has	1901	timeout will occur (by calculating the absolute time when it would occur,
1839	been reached, which means something I<did>, in fact, time out. Otherwise	1902	C<last_activity + timeout>, and subtracting the current time, C<ev_now
1840	the callback was invoked too early (C<timeout> is in the future), so	1903	(EV_A)> from that).
1841	re-schedule the timer to fire at that future time, to see if maybe we have
1842	a timeout then.
1843		1904
1844	Note how C<ev_timer_again> is used, taking advantage of the	1905	If this value is negative, then we are already past the timeout, i.e. we
1845	C<ev_timer_again> optimisation when the timer is already running.	1906	timed out, and need to do whatever is needed in this case.
		1907
		1908	Otherwise, we now the earliest time at which the timeout would trigger,
		1909	and simply start the timer with this timeout value.
		1910
		1911	In other words, each time the callback is invoked it will check whether
		1912	the timeout occurred. If not, it will simply reschedule itself to check
		1913	again at the earliest time it could time out. Rinse. Repeat.
1846		1914
1847	This scheme causes more callback invocations (about one every 60 seconds	1915	This scheme causes more callback invocations (about one every 60 seconds
1848	minus half the average time between activity), but virtually no calls to	1916	minus half the average time between activity), but virtually no calls to
1849	libev to change the timeout.	1917	libev to change the timeout.
1850		1918
1851	To start the timer, simply initialise the watcher and set C<last_activity>	1919	To start the machinery, simply initialise the watcher and set
1852	to the current time (meaning we just have some activity :), then call the	1920	C<last_activity> to the current time (meaning there was some activity just
1853	callback, which will "do the right thing" and start the timer:	1921	now), then call the callback, which will "do the right thing" and start
		1922	the timer:
1854		1923
		1924	last_activity = ev_now (EV_A);
1855	ev_init (timer, callback);	1925	ev_init (&timer, callback);
1856	last_activity = ev_now (loop);	1926	callback (EV_A_ &timer, 0);
1857	callback (loop, timer, EV_TIMER);
1858		1927
1859	And when there is some activity, simply store the current time in	1928	When there is some activity, simply store the current time in
1860	C<last_activity>, no libev calls at all:	1929	C<last_activity>, no libev calls at all:
1861		1930
		1931	if (activity detected)
1862	last_activity = ev_now (loop);	1932	last_activity = ev_now (EV_A);
		1933
		1934	When your timeout value changes, then the timeout can be changed by simply
		1935	providing a new value, stopping the timer and calling the callback, which
		1936	will again do the right thing (for example, time out immediately :).
		1937
		1938	timeout = new_value;
		1939	ev_timer_stop (EV_A_ &timer);
		1940	callback (EV_A_ &timer, 0);
1863		1941
1864	This technique is slightly more complex, but in most cases where the	1942	This technique is slightly more complex, but in most cases where the
1865	time-out is unlikely to be triggered, much more efficient.	1943	time-out is unlikely to be triggered, much more efficient.
1866
1867	Changing the timeout is trivial as well (if it isn't hard-coded in the
1868	callback :) - just change the timeout and invoke the callback, which will
1869	fix things for you.
1870		1944
1871	=item 4. Wee, just use a double-linked list for your timeouts.	1945	=item 4. Wee, just use a double-linked list for your timeouts.
1872		1946
1873	If there is not one request, but many thousands (millions...), all	1947	If there is not one request, but many thousands (millions...), all
1874	employing some kind of timeout with the same timeout value, then one can	1948	employing some kind of timeout with the same timeout value, then one can
…		…
1901	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is	1975	Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1902	rather complicated, but extremely efficient, something that really pays	1976	rather complicated, but extremely efficient, something that really pays
1903	off after the first million or so of active timers, i.e. it's usually	1977	off after the first million or so of active timers, i.e. it's usually
1904	overkill :)	1978	overkill :)
1905		1979
		1980	=head3 The special problem of being too early
		1981
		1982	If you ask a timer to call your callback after three seconds, then
		1983	you expect it to be invoked after three seconds - but of course, this
		1984	cannot be guaranteed to infinite precision. Less obviously, it cannot be
		1985	guaranteed to any precision by libev - imagine somebody suspending the
		1986	process with a STOP signal for a few hours for example.
		1987
		1988	So, libev tries to invoke your callback as soon as possible I<after> the
		1989	delay has occurred, but cannot guarantee this.
		1990
		1991	A less obvious failure mode is calling your callback too early: many event
		1992	loops compare timestamps with a "elapsed delay >= requested delay", but
		1993	this can cause your callback to be invoked much earlier than you would
		1994	expect.
		1995
		1996	To see why, imagine a system with a clock that only offers full second
		1997	resolution (think windows if you can't come up with a broken enough OS
		1998	yourself). If you schedule a one-second timer at the time 500.9, then the
		1999	event loop will schedule your timeout to elapse at a system time of 500
		2000	(500.9 truncated to the resolution) + 1, or 501.
		2001
		2002	If an event library looks at the timeout 0.1s later, it will see "501 >=
		2003	501" and invoke the callback 0.1s after it was started, even though a
		2004	one-second delay was requested - this is being "too early", despite best
		2005	intentions.
		2006
		2007	This is the reason why libev will never invoke the callback if the elapsed
		2008	delay equals the requested delay, but only when the elapsed delay is
		2009	larger than the requested delay. In the example above, libev would only invoke
		2010	the callback at system time 502, or 1.1s after the timer was started.
		2011
		2012	So, while libev cannot guarantee that your callback will be invoked
		2013	exactly when requested, it I<can> and I<does> guarantee that the requested
		2014	delay has actually elapsed, or in other words, it always errs on the "too
		2015	late" side of things.
		2016
1906	=head3 The special problem of time updates	2017	=head3 The special problem of time updates
1907		2018
1908	Establishing the current time is a costly operation (it usually takes at	2019	Establishing the current time is a costly operation (it usually takes
1909	least two system calls): EV therefore updates its idea of the current	2020	at least one system call): EV therefore updates its idea of the current
1910	time only before and after C<ev_run> collects new events, which causes a	2021	time only before and after C<ev_run> collects new events, which causes a
1911	growing difference between C<ev_now ()> and C<ev_time ()> when handling	2022	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1912	lots of events in one iteration.	2023	lots of events in one iteration.
1913		2024
1914	The relative timeouts are calculated relative to the C<ev_now ()>	2025	The relative timeouts are calculated relative to the C<ev_now ()>
…		…
1920	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	2031	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
1921		2032
1922	If the event loop is suspended for a long time, you can also force an	2033	If the event loop is suspended for a long time, you can also force an
1923	update of the time returned by C<ev_now ()> by calling C<ev_now_update	2034	update of the time returned by C<ev_now ()> by calling C<ev_now_update
1924	()>.	2035	()>.
		2036
		2037	=head3 The special problem of unsynchronised clocks
		2038
		2039	Modern systems have a variety of clocks - libev itself uses the normal
		2040	"wall clock" clock and, if available, the monotonic clock (to avoid time
		2041	jumps).
		2042
		2043	Neither of these clocks is synchronised with each other or any other clock
		2044	on the system, so C<ev_time ()> might return a considerably different time
		2045	than C<gettimeofday ()> or C<time ()>. On a GNU/Linux system, for example,
		2046	a call to C<gettimeofday> might return a second count that is one higher
		2047	than a directly following call to C<time>.
		2048
		2049	The moral of this is to only compare libev-related timestamps with
		2050	C<ev_time ()> and C<ev_now ()>, at least if you want better precision than
		2051	a second or so.
		2052
		2053	One more problem arises due to this lack of synchronisation: if libev uses
		2054	the system monotonic clock and you compare timestamps from C<ev_time>
		2055	or C<ev_now> from when you started your timer and when your callback is
		2056	invoked, you will find that sometimes the callback is a bit "early".
		2057
		2058	This is because C<ev_timer>s work in real time, not wall clock time, so
		2059	libev makes sure your callback is not invoked before the delay happened,
		2060	I<measured according to the real time>, not the system clock.
		2061
		2062	If your timeouts are based on a physical timescale (e.g. "time out this
		2063	connection after 100 seconds") then this shouldn't bother you as it is
		2064	exactly the right behaviour.
		2065
		2066	If you want to compare wall clock/system timestamps to your timers, then
		2067	you need to use C<ev_periodic>s, as these are based on the wall clock
		2068	time, where your comparisons will always generate correct results.
1925		2069
1926	=head3 The special problems of suspended animation	2070	=head3 The special problems of suspended animation
1927		2071
1928	When you leave the server world it is quite customary to hit machines that	2072	When you leave the server world it is quite customary to hit machines that
1929	can suspend/hibernate - what happens to the clocks during such a suspend?	2073	can suspend/hibernate - what happens to the clocks during such a suspend?
…		…
1973	keep up with the timer (because it takes longer than those 10 seconds to	2117	keep up with the timer (because it takes longer than those 10 seconds to
1974	do stuff) the timer will not fire more than once per event loop iteration.	2118	do stuff) the timer will not fire more than once per event loop iteration.
1975		2119
1976	=item ev_timer_again (loop, ev_timer *)	2120	=item ev_timer_again (loop, ev_timer *)
1977		2121
1978	This will act as if the timer timed out and restart it again if it is	2122	This will act as if the timer timed out, and restarts it again if it is
1979	repeating. The exact semantics are:	2123	repeating. It basically works like calling C<ev_timer_stop>, updating the
		2124	timeout to the C<repeat> value and calling C<ev_timer_start>.
1980		2125
		2126	The exact semantics are as in the following rules, all of which will be
		2127	applied to the watcher:
		2128
		2129	=over 4
		2130
1981	If the timer is pending, its pending status is cleared.	2131	=item If the timer is pending, the pending status is always cleared.
1982		2132
1983	If the timer is started but non-repeating, stop it (as if it timed out).	2133	=item If the timer is started but non-repeating, stop it (as if it timed
		2134	out, without invoking it).
1984		2135
1985	If the timer is repeating, either start it if necessary (with the	2136	=item If the timer is repeating, make the C<repeat> value the new timeout
1986	C<repeat> value), or reset the running timer to the C<repeat> value.	2137	and start the timer, if necessary.
		2138
		2139	=back
1987		2140
1988	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a	2141	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1989	usage example.	2142	usage example.
1990		2143
1991	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)	2144	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
…		…
2113		2266
2114	Another way to think about it (for the mathematically inclined) is that	2267	Another way to think about it (for the mathematically inclined) is that
2115	C<ev_periodic> will try to run the callback in this mode at the next possible	2268	C<ev_periodic> will try to run the callback in this mode at the next possible
2116	time where C<time = offset (mod interval)>, regardless of any time jumps.	2269	time where C<time = offset (mod interval)>, regardless of any time jumps.
2117		2270
2118	For numerical stability it is preferable that the C<offset> value is near	2271	The C<interval> I<MUST> be positive, and for numerical stability, the
2119	C<ev_now ()> (the current time), but there is no range requirement for	2272	interval value should be higher than C<1/8192> (which is around 100
2120	this value, and in fact is often specified as zero.	2273	microseconds) and C<offset> should be higher than C<0> and should have
		2274	at most a similar magnitude as the current time (say, within a factor of
		2275	ten). Typical values for offset are, in fact, C<0> or something between
		2276	C<0> and C<interval>, which is also the recommended range.
2121		2277
2122	Note also that there is an upper limit to how often a timer can fire (CPU	2278	Note also that there is an upper limit to how often a timer can fire (CPU
2123	speed for example), so if C<interval> is very small then timing stability	2279	speed for example), so if C<interval> is very small then timing stability
2124	will of course deteriorate. Libev itself tries to be exact to be about one	2280	will of course deteriorate. Libev itself tries to be exact to be about one
2125	millisecond (if the OS supports it and the machine is fast enough).	2281	millisecond (if the OS supports it and the machine is fast enough).
…		…
2239		2395
2240	=head2 C<ev_signal> - signal me when a signal gets signalled!	2396	=head2 C<ev_signal> - signal me when a signal gets signalled!
2241		2397
2242	Signal watchers will trigger an event when the process receives a specific	2398	Signal watchers will trigger an event when the process receives a specific
2243	signal one or more times. Even though signals are very asynchronous, libev	2399	signal one or more times. Even though signals are very asynchronous, libev
2244	will try it's best to deliver signals synchronously, i.e. as part of the	2400	will try its best to deliver signals synchronously, i.e. as part of the
2245	normal event processing, like any other event.	2401	normal event processing, like any other event.
2246		2402
2247	If you want signals to be delivered truly asynchronously, just use	2403	If you want signals to be delivered truly asynchronously, just use
2248	C<sigaction> as you would do without libev and forget about sharing	2404	C<sigaction> as you would do without libev and forget about sharing
2249	the signal. You can even use C<ev_async> from a signal handler to	2405	the signal. You can even use C<ev_async> from a signal handler to
…		…
2268	=head3 The special problem of inheritance over fork/execve/pthread_create	2424	=head3 The special problem of inheritance over fork/execve/pthread_create
2269		2425
2270	Both the signal mask (C<sigprocmask>) and the signal disposition	2426	Both the signal mask (C<sigprocmask>) and the signal disposition
2271	(C<sigaction>) are unspecified after starting a signal watcher (and after	2427	(C<sigaction>) are unspecified after starting a signal watcher (and after
2272	stopping it again), that is, libev might or might not block the signal,	2428	stopping it again), that is, libev might or might not block the signal,
2273	and might or might not set or restore the installed signal handler.	2429	and might or might not set or restore the installed signal handler (but
		2430	see C<EVFLAG_NOSIGMASK>).
2274		2431
2275	While this does not matter for the signal disposition (libev never	2432	While this does not matter for the signal disposition (libev never
2276	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on	2433	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2277	C<execve>), this matters for the signal mask: many programs do not expect	2434	C<execve>), this matters for the signal mask: many programs do not expect
2278	certain signals to be blocked.	2435	certain signals to be blocked.
…		…
2291	I<has> to modify the signal mask, at least temporarily.	2448	I<has> to modify the signal mask, at least temporarily.
2292		2449
2293	So I can't stress this enough: I<If you do not reset your signal mask when	2450	So I can't stress this enough: I<If you do not reset your signal mask when
2294	you expect it to be empty, you have a race condition in your code>. This	2451	you expect it to be empty, you have a race condition in your code>. This
2295	is not a libev-specific thing, this is true for most event libraries.	2452	is not a libev-specific thing, this is true for most event libraries.
		2453
		2454	=head3 The special problem of threads signal handling
		2455
		2456	POSIX threads has problematic signal handling semantics, specifically,
		2457	a lot of functionality (sigfd, sigwait etc.) only really works if all
		2458	threads in a process block signals, which is hard to achieve.
		2459
		2460	When you want to use sigwait (or mix libev signal handling with your own
		2461	for the same signals), you can tackle this problem by globally blocking
		2462	all signals before creating any threads (or creating them with a fully set
		2463	sigprocmask) and also specifying the C<EVFLAG_NOSIGMASK> when creating
		2464	loops. Then designate one thread as "signal receiver thread" which handles
		2465	these signals. You can pass on any signals that libev might be interested
		2466	in by calling C<ev_feed_signal>.
2296		2467
2297	=head3 Watcher-Specific Functions and Data Members	2468	=head3 Watcher-Specific Functions and Data Members
2298		2469
2299	=over 4	2470	=over 4
2300		2471
…		…
3074	disadvantage of having to use multiple event loops (which do not support	3245	disadvantage of having to use multiple event loops (which do not support
3075	signal watchers).	3246	signal watchers).
3076		3247
3077	When this is not possible, or you want to use the default loop for	3248	When this is not possible, or you want to use the default loop for
3078	other reasons, then in the process that wants to start "fresh", call	3249	other reasons, then in the process that wants to start "fresh", call
3079	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3250	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
3080	the default loop will "orphan" (not stop) all registered watchers, so you	3251	Destroying the default loop will "orphan" (not stop) all registered
3081	have to be careful not to execute code that modifies those watchers. Note	3252	watchers, so you have to be careful not to execute code that modifies
3082	also that in that case, you have to re-register any signal watchers.	3253	those watchers. Note also that in that case, you have to re-register any
		3254	signal watchers.
3083		3255
3084	=head3 Watcher-Specific Functions and Data Members	3256	=head3 Watcher-Specific Functions and Data Members
3085		3257
3086	=over 4	3258	=over 4
3087		3259
3088	=item ev_fork_init (ev_signal *, callback)	3260	=item ev_fork_init (ev_fork *, callback)
3089		3261
3090	Initialises and configures the fork watcher - it has no parameters of any	3262	Initialises and configures the fork watcher - it has no parameters of any
3091	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3263	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
3092	believe me.	3264	really.
3093		3265
3094	=back	3266	=back
3095		3267
3096		3268
		3269	=head2 C<ev_cleanup> - even the best things end
		3270
		3271	Cleanup watchers are called just before the event loop is being destroyed
		3272	by a call to C<ev_loop_destroy>.
		3273
		3274	While there is no guarantee that the event loop gets destroyed, cleanup
		3275	watchers provide a convenient method to install cleanup hooks for your
		3276	program, worker threads and so on - you just to make sure to destroy the
		3277	loop when you want them to be invoked.
		3278
		3279	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3280	all other watchers, they do not keep a reference to the event loop (which
		3281	makes a lot of sense if you think about it). Like all other watchers, you
		3282	can call libev functions in the callback, except C<ev_cleanup_start>.
		3283
		3284	=head3 Watcher-Specific Functions and Data Members
		3285
		3286	=over 4
		3287
		3288	=item ev_cleanup_init (ev_cleanup *, callback)
		3289
		3290	Initialises and configures the cleanup watcher - it has no parameters of
		3291	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3292	pointless, I assure you.
		3293
		3294	=back
		3295
		3296	Example: Register an atexit handler to destroy the default loop, so any
		3297	cleanup functions are called.
		3298
		3299	static void
		3300	program_exits (void)
		3301	{
		3302	ev_loop_destroy (EV_DEFAULT_UC);
		3303	}
		3304
		3305	...
		3306	atexit (program_exits);
		3307
		3308
3097	=head2 C<ev_async> - how to wake up an event loop	3309	=head2 C<ev_async> - how to wake up an event loop
3098		3310
3099	In general, you cannot use an C<ev_run> from multiple threads or other	3311	In general, you cannot use an C<ev_loop> from multiple threads or other
3100	asynchronous sources such as signal handlers (as opposed to multiple event	3312	asynchronous sources such as signal handlers (as opposed to multiple event
3101	loops - those are of course safe to use in different threads).	3313	loops - those are of course safe to use in different threads).
3102		3314
3103	Sometimes, however, you need to wake up an event loop you do not control,	3315	Sometimes, however, you need to wake up an event loop you do not control,
3104	for example because it belongs to another thread. This is what C<ev_async>	3316	for example because it belongs to another thread. This is what C<ev_async>
…		…
3106	it by calling C<ev_async_send>, which is thread- and signal safe.	3318	it by calling C<ev_async_send>, which is thread- and signal safe.
3107		3319
3108	This functionality is very similar to C<ev_signal> watchers, as signals,	3320	This functionality is very similar to C<ev_signal> watchers, as signals,
3109	too, are asynchronous in nature, and signals, too, will be compressed	3321	too, are asynchronous in nature, and signals, too, will be compressed
3110	(i.e. the number of callback invocations may be less than the number of	3322	(i.e. the number of callback invocations may be less than the number of
3111	C<ev_async_sent> calls).	3323	C<ev_async_send> calls). In fact, you could use signal watchers as a kind
3112		3324	of "global async watchers" by using a watcher on an otherwise unused
3113	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not	3325	signal, and C<ev_feed_signal> to signal this watcher from another thread,
3114	just the default loop.	3326	even without knowing which loop owns the signal.
3115		3327
3116	=head3 Queueing	3328	=head3 Queueing
3117		3329
3118	C<ev_async> does not support queueing of data in any way. The reason	3330	C<ev_async> does not support queueing of data in any way. The reason
3119	is that the author does not know of a simple (or any) algorithm for a	3331	is that the author does not know of a simple (or any) algorithm for a
…		…
3211	trust me.	3423	trust me.
3212		3424
3213	=item ev_async_send (loop, ev_async *)	3425	=item ev_async_send (loop, ev_async *)
3214		3426
3215	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	3427	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
3216	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	3428	an C<EV_ASYNC> event on the watcher into the event loop, and instantly
		3429	returns.
		3430
3217	C<ev_feed_event>, this call is safe to do from other threads, signal or	3431	Unlike C<ev_feed_event>, this call is safe to do from other threads,
3218	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	3432	signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3219	section below on what exactly this means).	3433	embedding section below on what exactly this means).
3220		3434
3221	Note that, as with other watchers in libev, multiple events might get	3435	Note that, as with other watchers in libev, multiple events might get
3222	compressed into a single callback invocation (another way to look at this	3436	compressed into a single callback invocation (another way to look at
3223	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,	3437	this is that C<ev_async> watchers are level-triggered: they are set on
3224	reset when the event loop detects that).	3438	C<ev_async_send>, reset when the event loop detects that).
3225		3439
3226	This call incurs the overhead of a system call only once per event loop	3440	This call incurs the overhead of at most one extra system call per event
3227	iteration, so while the overhead might be noticeable, it doesn't apply to	3441	loop iteration, if the event loop is blocked, and no syscall at all if
3228	repeated calls to C<ev_async_send> for the same event loop.	3442	the event loop (or your program) is processing events. That means that
		3443	repeated calls are basically free (there is no need to avoid calls for
		3444	performance reasons) and that the overhead becomes smaller (typically
		3445	zero) under load.
3229		3446
3230	=item bool = ev_async_pending (ev_async *)	3447	=item bool = ev_async_pending (ev_async *)
3231		3448
3232	Returns a non-zero value when C<ev_async_send> has been called on the	3449	Returns a non-zero value when C<ev_async_send> has been called on the
3233	watcher but the event has not yet been processed (or even noted) by the	3450	watcher but the event has not yet been processed (or even noted) by the
…		…
3288	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3505	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3289		3506
3290	=item ev_feed_fd_event (loop, int fd, int revents)	3507	=item ev_feed_fd_event (loop, int fd, int revents)
3291		3508
3292	Feed an event on the given fd, as if a file descriptor backend detected	3509	Feed an event on the given fd, as if a file descriptor backend detected
3293	the given events it.	3510	the given events.
3294		3511
3295	=item ev_feed_signal_event (loop, int signum)	3512	=item ev_feed_signal_event (loop, int signum)
3296		3513
3297	Feed an event as if the given signal occurred (C<loop> must be the default	3514	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3298	loop!).	3515	which is async-safe.
3299		3516
3300	=back	3517	=back
		3518
		3519
		3520	=head1 COMMON OR USEFUL IDIOMS (OR BOTH)
		3521
		3522	This section explains some common idioms that are not immediately
		3523	obvious. Note that examples are sprinkled over the whole manual, and this
		3524	section only contains stuff that wouldn't fit anywhere else.
		3525
		3526	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
		3527
		3528	Each watcher has, by default, a C<void *data> member that you can read
		3529	or modify at any time: libev will completely ignore it. This can be used
		3530	to associate arbitrary data with your watcher. If you need more data and
		3531	don't want to allocate memory separately and store a pointer to it in that
		3532	data member, you can also "subclass" the watcher type and provide your own
		3533	data:
		3534
		3535	struct my_io
		3536	{
		3537	ev_io io;
		3538	int otherfd;
		3539	void *somedata;
		3540	struct whatever *mostinteresting;
		3541	};
		3542
		3543	...
		3544	struct my_io w;
		3545	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3546
		3547	And since your callback will be called with a pointer to the watcher, you
		3548	can cast it back to your own type:
		3549
		3550	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
		3551	{
		3552	struct my_io *w = (struct my_io *)w_;
		3553	...
		3554	}
		3555
		3556	More interesting and less C-conformant ways of casting your callback
		3557	function type instead have been omitted.
		3558
		3559	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3560
		3561	Another common scenario is to use some data structure with multiple
		3562	embedded watchers, in effect creating your own watcher that combines
		3563	multiple libev event sources into one "super-watcher":
		3564
		3565	struct my_biggy
		3566	{
		3567	int some_data;
		3568	ev_timer t1;
		3569	ev_timer t2;
		3570	}
		3571
		3572	In this case getting the pointer to C<my_biggy> is a bit more
		3573	complicated: Either you store the address of your C<my_biggy> struct in
		3574	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3575	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3576	real programmers):
		3577
		3578	#include <stddef.h>
		3579
		3580	static void
		3581	t1_cb (EV_P_ ev_timer *w, int revents)
		3582	{
		3583	struct my_biggy big = (struct my_biggy *)
		3584	(((char *)w) - offsetof (struct my_biggy, t1));
		3585	}
		3586
		3587	static void
		3588	t2_cb (EV_P_ ev_timer *w, int revents)
		3589	{
		3590	struct my_biggy big = (struct my_biggy *)
		3591	(((char *)w) - offsetof (struct my_biggy, t2));
		3592	}
		3593
		3594	=head2 AVOIDING FINISHING BEFORE RETURNING
		3595
		3596	Often you have structures like this in event-based programs:
		3597
		3598	callback ()
		3599	{
		3600	free (request);
		3601	}
		3602
		3603	request = start_new_request (..., callback);
		3604
		3605	The intent is to start some "lengthy" operation. The C<request> could be
		3606	used to cancel the operation, or do other things with it.
		3607
		3608	It's not uncommon to have code paths in C<start_new_request> that
		3609	immediately invoke the callback, for example, to report errors. Or you add
		3610	some caching layer that finds that it can skip the lengthy aspects of the
		3611	operation and simply invoke the callback with the result.
		3612
		3613	The problem here is that this will happen I<before> C<start_new_request>
		3614	has returned, so C<request> is not set.
		3615
		3616	Even if you pass the request by some safer means to the callback, you
		3617	might want to do something to the request after starting it, such as
		3618	canceling it, which probably isn't working so well when the callback has
		3619	already been invoked.
		3620
		3621	A common way around all these issues is to make sure that
		3622	C<start_new_request> I<always> returns before the callback is invoked. If
		3623	C<start_new_request> immediately knows the result, it can artificially
		3624	delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher
		3625	for example, or more sneakily, by reusing an existing (stopped) watcher
		3626	and pushing it into the pending queue:
		3627
		3628	ev_set_cb (watcher, callback);
		3629	ev_feed_event (EV_A_ watcher, 0);
		3630
		3631	This way, C<start_new_request> can safely return before the callback is
		3632	invoked, while not delaying callback invocation too much.
		3633
		3634	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
		3635
		3636	Often (especially in GUI toolkits) there are places where you have
		3637	I<modal> interaction, which is most easily implemented by recursively
		3638	invoking C<ev_run>.
		3639
		3640	This brings the problem of exiting - a callback might want to finish the
		3641	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
		3642	a modal "Are you sure?" dialog is still waiting), or just the nested one
		3643	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
		3644	other combination: In these cases, C<ev_break> will not work alone.
		3645
		3646	The solution is to maintain "break this loop" variable for each C<ev_run>
		3647	invocation, and use a loop around C<ev_run> until the condition is
		3648	triggered, using C<EVRUN_ONCE>:
		3649
		3650	// main loop
		3651	int exit_main_loop = 0;
		3652
		3653	while (!exit_main_loop)
		3654	ev_run (EV_DEFAULT_ EVRUN_ONCE);
		3655
		3656	// in a modal watcher
		3657	int exit_nested_loop = 0;
		3658
		3659	while (!exit_nested_loop)
		3660	ev_run (EV_A_ EVRUN_ONCE);
		3661
		3662	To exit from any of these loops, just set the corresponding exit variable:
		3663
		3664	// exit modal loop
		3665	exit_nested_loop = 1;
		3666
		3667	// exit main program, after modal loop is finished
		3668	exit_main_loop = 1;
		3669
		3670	// exit both
		3671	exit_main_loop = exit_nested_loop = 1;
		3672
		3673	=head2 THREAD LOCKING EXAMPLE
		3674
		3675	Here is a fictitious example of how to run an event loop in a different
		3676	thread from where callbacks are being invoked and watchers are
		3677	created/added/removed.
		3678
		3679	For a real-world example, see the C<EV::Loop::Async> perl module,
		3680	which uses exactly this technique (which is suited for many high-level
		3681	languages).
		3682
		3683	The example uses a pthread mutex to protect the loop data, a condition
		3684	variable to wait for callback invocations, an async watcher to notify the
		3685	event loop thread and an unspecified mechanism to wake up the main thread.
		3686
		3687	First, you need to associate some data with the event loop:
		3688
		3689	typedef struct {
		3690	mutex_t lock; /* global loop lock */
		3691	ev_async async_w;
		3692	thread_t tid;
		3693	cond_t invoke_cv;
		3694	} userdata;
		3695
		3696	void prepare_loop (EV_P)
		3697	{
		3698	// for simplicity, we use a static userdata struct.
		3699	static userdata u;
		3700
		3701	ev_async_init (&u->async_w, async_cb);
		3702	ev_async_start (EV_A_ &u->async_w);
		3703
		3704	pthread_mutex_init (&u->lock, 0);
		3705	pthread_cond_init (&u->invoke_cv, 0);
		3706
		3707	// now associate this with the loop
		3708	ev_set_userdata (EV_A_ u);
		3709	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3710	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3711
		3712	// then create the thread running ev_run
		3713	pthread_create (&u->tid, 0, l_run, EV_A);
		3714	}
		3715
		3716	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3717	solely to wake up the event loop so it takes notice of any new watchers
		3718	that might have been added:
		3719
		3720	static void
		3721	async_cb (EV_P_ ev_async *w, int revents)
		3722	{
		3723	// just used for the side effects
		3724	}
		3725
		3726	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3727	protecting the loop data, respectively.
		3728
		3729	static void
		3730	l_release (EV_P)
		3731	{
		3732	userdata *u = ev_userdata (EV_A);
		3733	pthread_mutex_unlock (&u->lock);
		3734	}
		3735
		3736	static void
		3737	l_acquire (EV_P)
		3738	{
		3739	userdata *u = ev_userdata (EV_A);
		3740	pthread_mutex_lock (&u->lock);
		3741	}
		3742
		3743	The event loop thread first acquires the mutex, and then jumps straight
		3744	into C<ev_run>:
		3745
		3746	void *
		3747	l_run (void *thr_arg)
		3748	{
		3749	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		3750
		3751	l_acquire (EV_A);
		3752	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3753	ev_run (EV_A_ 0);
		3754	l_release (EV_A);
		3755
		3756	return 0;
		3757	}
		3758
		3759	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3760	signal the main thread via some unspecified mechanism (signals? pipe
		3761	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3762	have been called (in a while loop because a) spurious wakeups are possible
		3763	and b) skipping inter-thread-communication when there are no pending
		3764	watchers is very beneficial):
		3765
		3766	static void
		3767	l_invoke (EV_P)
		3768	{
		3769	userdata *u = ev_userdata (EV_A);
		3770
		3771	while (ev_pending_count (EV_A))
		3772	{
		3773	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3774	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3775	}
		3776	}
		3777
		3778	Now, whenever the main thread gets told to invoke pending watchers, it
		3779	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3780	thread to continue:
		3781
		3782	static void
		3783	real_invoke_pending (EV_P)
		3784	{
		3785	userdata *u = ev_userdata (EV_A);
		3786
		3787	pthread_mutex_lock (&u->lock);
		3788	ev_invoke_pending (EV_A);
		3789	pthread_cond_signal (&u->invoke_cv);
		3790	pthread_mutex_unlock (&u->lock);
		3791	}
		3792
		3793	Whenever you want to start/stop a watcher or do other modifications to an
		3794	event loop, you will now have to lock:
		3795
		3796	ev_timer timeout_watcher;
		3797	userdata *u = ev_userdata (EV_A);
		3798
		3799	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3800
		3801	pthread_mutex_lock (&u->lock);
		3802	ev_timer_start (EV_A_ &timeout_watcher);
		3803	ev_async_send (EV_A_ &u->async_w);
		3804	pthread_mutex_unlock (&u->lock);
		3805
		3806	Note that sending the C<ev_async> watcher is required because otherwise
		3807	an event loop currently blocking in the kernel will have no knowledge
		3808	about the newly added timer. By waking up the loop it will pick up any new
		3809	watchers in the next event loop iteration.
		3810
		3811	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3812
		3813	While the overhead of a callback that e.g. schedules a thread is small, it
		3814	is still an overhead. If you embed libev, and your main usage is with some
		3815	kind of threads or coroutines, you might want to customise libev so that
		3816	doesn't need callbacks anymore.
		3817
		3818	Imagine you have coroutines that you can switch to using a function
		3819	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3820	and that due to some magic, the currently active coroutine is stored in a
		3821	global called C<current_coro>. Then you can build your own "wait for libev
		3822	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3823	the differing C<;> conventions):
		3824
		3825	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3826	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3827
		3828	That means instead of having a C callback function, you store the
		3829	coroutine to switch to in each watcher, and instead of having libev call
		3830	your callback, you instead have it switch to that coroutine.
		3831
		3832	A coroutine might now wait for an event with a function called
		3833	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		3834	matter when, or whether the watcher is active or not when this function is
		3835	called):
		3836
		3837	void
		3838	wait_for_event (ev_watcher *w)
		3839	{
		3840	ev_cb_set (w) = current_coro;
		3841	switch_to (libev_coro);
		3842	}
		3843
		3844	That basically suspends the coroutine inside C<wait_for_event> and
		3845	continues the libev coroutine, which, when appropriate, switches back to
		3846	this or any other coroutine.
		3847
		3848	You can do similar tricks if you have, say, threads with an event queue -
		3849	instead of storing a coroutine, you store the queue object and instead of
		3850	switching to a coroutine, you push the watcher onto the queue and notify
		3851	any waiters.
		3852
		3853	To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two
		3854	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		3855
		3856	// my_ev.h
		3857	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3858	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
		3859	#include "../libev/ev.h"
		3860
		3861	// my_ev.c
		3862	#define EV_H "my_ev.h"
		3863	#include "../libev/ev.c"
		3864
		3865	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		3866	F<my_ev.c> into your project. When properly specifying include paths, you
		3867	can even use F<ev.h> as header file name directly.
3301		3868
3302		3869
3303	=head1 LIBEVENT EMULATION	3870	=head1 LIBEVENT EMULATION
3304		3871
3305	Libev offers a compatibility emulation layer for libevent. It cannot	3872	Libev offers a compatibility emulation layer for libevent. It cannot
3306	emulate the internals of libevent, so here are some usage hints:	3873	emulate the internals of libevent, so here are some usage hints:
3307		3874
3308	=over 4	3875	=over 4
		3876
		3877	=item * Only the libevent-1.4.1-beta API is being emulated.
		3878
		3879	This was the newest libevent version available when libev was implemented,
		3880	and is still mostly unchanged in 2010.
3309		3881
3310	=item * Use it by including <event.h>, as usual.	3882	=item * Use it by including <event.h>, as usual.
3311		3883
3312	=item * The following members are fully supported: ev_base, ev_callback,	3884	=item * The following members are fully supported: ev_base, ev_callback,
3313	ev_arg, ev_fd, ev_res, ev_events.	3885	ev_arg, ev_fd, ev_res, ev_events.
…		…
3319	=item * Priorities are not currently supported. Initialising priorities	3891	=item * Priorities are not currently supported. Initialising priorities
3320	will fail and all watchers will have the same priority, even though there	3892	will fail and all watchers will have the same priority, even though there
3321	is an ev_pri field.	3893	is an ev_pri field.
3322		3894
3323	=item * In libevent, the last base created gets the signals, in libev, the	3895	=item * In libevent, the last base created gets the signals, in libev, the
3324	first base created (== the default loop) gets the signals.	3896	base that registered the signal gets the signals.
3325		3897
3326	=item * Other members are not supported.	3898	=item * Other members are not supported.
3327		3899
3328	=item * The libev emulation is I<not> ABI compatible to libevent, you need	3900	=item * The libev emulation is I<not> ABI compatible to libevent, you need
3329	to use the libev header file and library.	3901	to use the libev header file and library.
3330		3902
3331	=back	3903	=back
3332		3904
3333	=head1 C++ SUPPORT	3905	=head1 C++ SUPPORT
		3906
		3907	=head2 C API
		3908
		3909	The normal C API should work fine when used from C++: both ev.h and the
		3910	libev sources can be compiled as C++. Therefore, code that uses the C API
		3911	will work fine.
		3912
		3913	Proper exception specifications might have to be added to callbacks passed
		3914	to libev: exceptions may be thrown only from watcher callbacks, all
		3915	other callbacks (allocator, syserr, loop acquire/release and periodioc
		3916	reschedule callbacks) must not throw exceptions, and might need a C<throw
		3917	()> specification. If you have code that needs to be compiled as both C
		3918	and C++ you can use the C<EV_THROW> macro for this:
		3919
		3920	static void
		3921	fatal_error (const char *msg) EV_THROW
		3922	{
		3923	perror (msg);
		3924	abort ();
		3925	}
		3926
		3927	...
		3928	ev_set_syserr_cb (fatal_error);
		3929
		3930	The only API functions that can currently throw exceptions are C<ev_run>,
		3931	C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
		3932	because it runs cleanup watchers).
		3933
		3934	Throwing exceptions in watcher callbacks is only supported if libev itself
		3935	is compiled with a C++ compiler or your C and C++ environments allow
		3936	throwing exceptions through C libraries (most do).
		3937
		3938	=head2 C++ API
3334		3939
3335	Libev comes with some simplistic wrapper classes for C++ that mainly allow	3940	Libev comes with some simplistic wrapper classes for C++ that mainly allow
3336	you to use some convenience methods to start/stop watchers and also change	3941	you to use some convenience methods to start/stop watchers and also change
3337	the callback model to a model using method callbacks on objects.	3942	the callback model to a model using method callbacks on objects.
3338		3943
…		…
3348	Care has been taken to keep the overhead low. The only data member the C++	3953	Care has been taken to keep the overhead low. The only data member the C++
3349	classes add (compared to plain C-style watchers) is the event loop pointer	3954	classes add (compared to plain C-style watchers) is the event loop pointer
3350	that the watcher is associated with (or no additional members at all if	3955	that the watcher is associated with (or no additional members at all if
3351	you disable C<EV_MULTIPLICITY> when embedding libev).	3956	you disable C<EV_MULTIPLICITY> when embedding libev).
3352		3957
3353	Currently, functions, and static and non-static member functions can be	3958	Currently, functions, static and non-static member functions and classes
3354	used as callbacks. Other types should be easy to add as long as they only	3959	with C<operator ()> can be used as callbacks. Other types should be easy
3355	need one additional pointer for context. If you need support for other	3960	to add as long as they only need one additional pointer for context. If
3356	types of functors please contact the author (preferably after implementing	3961	you need support for other types of functors please contact the author
3357	it).	3962	(preferably after implementing it).
		3963
		3964	For all this to work, your C++ compiler either has to use the same calling
		3965	conventions as your C compiler (for static member functions), or you have
		3966	to embed libev and compile libev itself as C++.
3358		3967
3359	Here is a list of things available in the C<ev> namespace:	3968	Here is a list of things available in the C<ev> namespace:
3360		3969
3361	=over 4	3970	=over 4
3362		3971
…		…
3372	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.	3981	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
3373		3982
3374	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of	3983	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
3375	the same name in the C<ev> namespace, with the exception of C<ev_signal>	3984	the same name in the C<ev> namespace, with the exception of C<ev_signal>
3376	which is called C<ev::sig> to avoid clashes with the C<signal> macro	3985	which is called C<ev::sig> to avoid clashes with the C<signal> macro
3377	defines by many implementations.	3986	defined by many implementations.
3378		3987
3379	All of those classes have these methods:	3988	All of those classes have these methods:
3380		3989
3381	=over 4	3990	=over 4
3382		3991
…		…
3515	watchers in the constructor.	4124	watchers in the constructor.
3516		4125
3517	class myclass	4126	class myclass
3518	{	4127	{
3519	ev::io io ; void io_cb (ev::io &w, int revents);	4128	ev::io io ; void io_cb (ev::io &w, int revents);
3520	ev::io2 io2 ; void io2_cb (ev::io &w, int revents);	4129	ev::io io2 ; void io2_cb (ev::io &w, int revents);
3521	ev::idle idle; void idle_cb (ev::idle &w, int revents);	4130	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3522		4131
3523	myclass (int fd)	4132	myclass (int fd)
3524	{	4133	{
3525	io .set <myclass, &myclass::io_cb > (this);	4134	io .set <myclass, &myclass::io_cb > (this);
…		…
3576	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.	4185	L<http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hlibev>.
3577		4186
3578	=item D	4187	=item D
3579		4188
3580	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to	4189	Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3581	be found at L<http://proj.llucax.com.ar/wiki/evd>.	4190	be found at L<http://www.llucax.com.ar/proj/ev.d/index.html>.
3582		4191
3583	=item Ocaml	4192	=item Ocaml
3584		4193
3585	Erkki Seppala has written Ocaml bindings for libev, to be found at	4194	Erkki Seppala has written Ocaml bindings for libev, to be found at
3586	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	4195	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
…		…
3634	suitable for use with C<EV_A>.	4243	suitable for use with C<EV_A>.
3635		4244
3636	=item C<EV_DEFAULT>, C<EV_DEFAULT_>	4245	=item C<EV_DEFAULT>, C<EV_DEFAULT_>
3637		4246
3638	Similar to the other two macros, this gives you the value of the default	4247	Similar to the other two macros, this gives you the value of the default
3639	loop, if multiple loops are supported ("ev loop default").	4248	loop, if multiple loops are supported ("ev loop default"). The default loop
		4249	will be initialised if it isn't already initialised.
		4250
		4251	For non-multiplicity builds, these macros do nothing, so you always have
		4252	to initialise the loop somewhere.
3640		4253
3641	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>	4254	=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
3642		4255
3643	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the	4256	Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
3644	default loop has been initialised (C<UC> == unchecked). Their behaviour	4257	default loop has been initialised (C<UC> == unchecked). Their behaviour
…		…
3789	supported). It will also not define any of the structs usually found in	4402	supported). It will also not define any of the structs usually found in
3790	F<event.h> that are not directly supported by the libev core alone.	4403	F<event.h> that are not directly supported by the libev core alone.
3791		4404
3792	In standalone mode, libev will still try to automatically deduce the	4405	In standalone mode, libev will still try to automatically deduce the
3793	configuration, but has to be more conservative.	4406	configuration, but has to be more conservative.
		4407
		4408	=item EV_USE_FLOOR
		4409
		4410	If defined to be C<1>, libev will use the C<floor ()> function for its
		4411	periodic reschedule calculations, otherwise libev will fall back on a
		4412	portable (slower) implementation. If you enable this, you usually have to
		4413	link against libm or something equivalent. Enabling this when the C<floor>
		4414	function is not available will fail, so the safe default is to not enable
		4415	this.
3794		4416
3795	=item EV_USE_MONOTONIC	4417	=item EV_USE_MONOTONIC
3796		4418
3797	If defined to be C<1>, libev will try to detect the availability of the	4419	If defined to be C<1>, libev will try to detect the availability of the
3798	monotonic clock option at both compile time and runtime. Otherwise no	4420	monotonic clock option at both compile time and runtime. Otherwise no
…		…
3928	If defined to be C<1>, libev will compile in support for the Linux inotify	4550	If defined to be C<1>, libev will compile in support for the Linux inotify
3929	interface to speed up C<ev_stat> watchers. Its actual availability will	4551	interface to speed up C<ev_stat> watchers. Its actual availability will
3930	be detected at runtime. If undefined, it will be enabled if the headers	4552	be detected at runtime. If undefined, it will be enabled if the headers
3931	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.	4553	indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
3932		4554
		4555	=item EV_NO_SMP
		4556
		4557	If defined to be C<1>, libev will assume that memory is always coherent
		4558	between threads, that is, threads can be used, but threads never run on
		4559	different cpus (or different cpu cores). This reduces dependencies
		4560	and makes libev faster.
		4561
		4562	=item EV_NO_THREADS
		4563
		4564	If defined to be C<1>, libev will assume that it will never be called
		4565	from different threads, which is a stronger assumption than C<EV_NO_SMP>,
		4566	above. This reduces dependencies and makes libev faster.
		4567
3933	=item EV_ATOMIC_T	4568	=item EV_ATOMIC_T
3934		4569
3935	Libev requires an integer type (suitable for storing C<0> or C<1>) whose	4570	Libev requires an integer type (suitable for storing C<0> or C<1>) whose
3936	access is atomic with respect to other threads or signal contexts. No such	4571	access is atomic and serialised with respect to other threads or signal
3937	type is easily found in the C language, so you can provide your own type	4572	contexts. No such type is easily found in the C language, so you can
3938	that you know is safe for your purposes. It is used both for signal handler "locking"	4573	provide your own type that you know is safe for your purposes. It is used
3939	as well as for signal and thread safety in C<ev_async> watchers.	4574	both for signal handler "locking" as well as for signal and thread safety
		4575	in C<ev_async> watchers.
3940		4576
3941	In the absence of this define, libev will use C<sig_atomic_t volatile>	4577	In the absence of this define, libev will use C<sig_atomic_t volatile>
3942	(from F<signal.h>), which is usually good enough on most platforms.	4578	(from F<signal.h>), which is usually good enough on most platforms,
		4579	although strictly speaking using a type that also implies a memory fence
		4580	is required.
3943		4581
3944	=item EV_H (h)	4582	=item EV_H (h)
3945		4583
3946	The name of the F<ev.h> header file used to include it. The default if	4584	The name of the F<ev.h> header file used to include it. The default if
3947	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be	4585	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
…		…
3971	will have the C<struct ev_loop *> as first argument, and you can create	4609	will have the C<struct ev_loop *> as first argument, and you can create
3972	additional independent event loops. Otherwise there will be no support	4610	additional independent event loops. Otherwise there will be no support
3973	for multiple event loops and there is no first event loop pointer	4611	for multiple event loops and there is no first event loop pointer
3974	argument. Instead, all functions act on the single default loop.	4612	argument. Instead, all functions act on the single default loop.
3975		4613
		4614	Note that C<EV_DEFAULT> and C<EV_DEFAULT_> will no longer provide a
		4615	default loop when multiplicity is switched off - you always have to
		4616	initialise the loop manually in this case.
		4617
3976	=item EV_MINPRI	4618	=item EV_MINPRI
3977		4619
3978	=item EV_MAXPRI	4620	=item EV_MAXPRI
3979		4621
3980	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to	4622	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
…		…
4016	#define EV_USE_POLL 1	4658	#define EV_USE_POLL 1
4017	#define EV_CHILD_ENABLE 1	4659	#define EV_CHILD_ENABLE 1
4018	#define EV_ASYNC_ENABLE 1	4660	#define EV_ASYNC_ENABLE 1
4019		4661
4020	The actual value is a bitset, it can be a combination of the following	4662	The actual value is a bitset, it can be a combination of the following
4021	values:	4663	values (by default, all of these are enabled):
4022		4664
4023	=over 4	4665	=over 4
4024		4666
4025	=item C<1> - faster/larger code	4667	=item C<1> - faster/larger code
4026		4668
…		…
4030	code size by roughly 30% on amd64).	4672	code size by roughly 30% on amd64).
4031		4673
4032	When optimising for size, use of compiler flags such as C<-Os> with	4674	When optimising for size, use of compiler flags such as C<-Os> with
4033	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of	4675	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
4034	assertions.	4676	assertions.
		4677
		4678	The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
		4679	(e.g. gcc with C<-Os>).
4035		4680
4036	=item C<2> - faster/larger data structures	4681	=item C<2> - faster/larger data structures
4037		4682
4038	Replaces the small 2-heap for timer management by a faster 4-heap, larger	4683	Replaces the small 2-heap for timer management by a faster 4-heap, larger
4039	hash table sizes and so on. This will usually further increase code size	4684	hash table sizes and so on. This will usually further increase code size
4040	and can additionally have an effect on the size of data structures at	4685	and can additionally have an effect on the size of data structures at
4041	runtime.	4686	runtime.
4042		4687
		4688	The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
		4689	(e.g. gcc with C<-Os>).
		4690
4043	=item C<4> - full API configuration	4691	=item C<4> - full API configuration
4044		4692
4045	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and	4693	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
4046	enables multiplicity (C<EV_MULTIPLICITY>=1).	4694	enables multiplicity (C<EV_MULTIPLICITY>=1).
4047		4695
…		…
4077		4725
4078	With an intelligent-enough linker (gcc+binutils are intelligent enough	4726	With an intelligent-enough linker (gcc+binutils are intelligent enough
4079	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by	4727	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
4080	your program might be left out as well - a binary starting a timer and an	4728	your program might be left out as well - a binary starting a timer and an
4081	I/O watcher then might come out at only 5Kb.	4729	I/O watcher then might come out at only 5Kb.
		4730
		4731	=item EV_API_STATIC
		4732
		4733	If this symbol is defined (by default it is not), then all identifiers
		4734	will have static linkage. This means that libev will not export any
		4735	identifiers, and you cannot link against libev anymore. This can be useful
		4736	when you embed libev, only want to use libev functions in a single file,
		4737	and do not want its identifiers to be visible.
		4738
		4739	To use this, define C<EV_API_STATIC> and include F<ev.c> in the file that
		4740	wants to use libev.
		4741
		4742	This option only works when libev is compiled with a C compiler, as C++
		4743	doesn't support the required declaration syntax.
4082		4744
4083	=item EV_AVOID_STDIO	4745	=item EV_AVOID_STDIO
4084		4746
4085	If this is set to C<1> at compiletime, then libev will avoid using stdio	4747	If this is set to C<1> at compiletime, then libev will avoid using stdio
4086	functions (printf, scanf, perror etc.). This will increase the code size	4748	functions (printf, scanf, perror etc.). This will increase the code size
…		…
4230	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4892	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
4231		4893
4232	#include "ev_cpp.h"	4894	#include "ev_cpp.h"
4233	#include "ev.c"	4895	#include "ev.c"
4234		4896
4235	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	4897	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
4236		4898
4237	=head2 THREADS AND COROUTINES	4899	=head2 THREADS AND COROUTINES
4238		4900
4239	=head3 THREADS	4901	=head3 THREADS
4240		4902
…		…
4291	default loop and triggering an C<ev_async> watcher from the default loop	4953	default loop and triggering an C<ev_async> watcher from the default loop
4292	watcher callback into the event loop interested in the signal.	4954	watcher callback into the event loop interested in the signal.
4293		4955
4294	=back	4956	=back
4295		4957
4296	=head4 THREAD LOCKING EXAMPLE	4958	See also L<THREAD LOCKING EXAMPLE>.
4297
4298	Here is a fictitious example of how to run an event loop in a different
4299	thread than where callbacks are being invoked and watchers are
4300	created/added/removed.
4301
4302	For a real-world example, see the C<EV::Loop::Async> perl module,
4303	which uses exactly this technique (which is suited for many high-level
4304	languages).
4305
4306	The example uses a pthread mutex to protect the loop data, a condition
4307	variable to wait for callback invocations, an async watcher to notify the
4308	event loop thread and an unspecified mechanism to wake up the main thread.
4309
4310	First, you need to associate some data with the event loop:
4311
4312	typedef struct {
4313	mutex_t lock; /* global loop lock */
4314	ev_async async_w;
4315	thread_t tid;
4316	cond_t invoke_cv;
4317	} userdata;
4318
4319	void prepare_loop (EV_P)
4320	{
4321	// for simplicity, we use a static userdata struct.
4322	static userdata u;
4323
4324	ev_async_init (&u->async_w, async_cb);
4325	ev_async_start (EV_A_ &u->async_w);
4326
4327	pthread_mutex_init (&u->lock, 0);
4328	pthread_cond_init (&u->invoke_cv, 0);
4329
4330	// now associate this with the loop
4331	ev_set_userdata (EV_A_ u);
4332	ev_set_invoke_pending_cb (EV_A_ l_invoke);
4333	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4334
4335	// then create the thread running ev_loop
4336	pthread_create (&u->tid, 0, l_run, EV_A);
4337	}
4338
4339	The callback for the C<ev_async> watcher does nothing: the watcher is used
4340	solely to wake up the event loop so it takes notice of any new watchers
4341	that might have been added:
4342
4343	static void
4344	async_cb (EV_P_ ev_async *w, int revents)
4345	{
4346	// just used for the side effects
4347	}
4348
4349	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4350	protecting the loop data, respectively.
4351
4352	static void
4353	l_release (EV_P)
4354	{
4355	userdata *u = ev_userdata (EV_A);
4356	pthread_mutex_unlock (&u->lock);
4357	}
4358
4359	static void
4360	l_acquire (EV_P)
4361	{
4362	userdata *u = ev_userdata (EV_A);
4363	pthread_mutex_lock (&u->lock);
4364	}
4365
4366	The event loop thread first acquires the mutex, and then jumps straight
4367	into C<ev_run>:
4368
4369	void *
4370	l_run (void *thr_arg)
4371	{
4372	struct ev_loop *loop = (struct ev_loop *)thr_arg;
4373
4374	l_acquire (EV_A);
4375	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4376	ev_run (EV_A_ 0);
4377	l_release (EV_A);
4378
4379	return 0;
4380	}
4381
4382	Instead of invoking all pending watchers, the C<l_invoke> callback will
4383	signal the main thread via some unspecified mechanism (signals? pipe
4384	writes? C<Async::Interrupt>?) and then waits until all pending watchers
4385	have been called (in a while loop because a) spurious wakeups are possible
4386	and b) skipping inter-thread-communication when there are no pending
4387	watchers is very beneficial):
4388
4389	static void
4390	l_invoke (EV_P)
4391	{
4392	userdata *u = ev_userdata (EV_A);
4393
4394	while (ev_pending_count (EV_A))
4395	{
4396	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4397	pthread_cond_wait (&u->invoke_cv, &u->lock);
4398	}
4399	}
4400
4401	Now, whenever the main thread gets told to invoke pending watchers, it
4402	will grab the lock, call C<ev_invoke_pending> and then signal the loop
4403	thread to continue:
4404
4405	static void
4406	real_invoke_pending (EV_P)
4407	{
4408	userdata *u = ev_userdata (EV_A);
4409
4410	pthread_mutex_lock (&u->lock);
4411	ev_invoke_pending (EV_A);
4412	pthread_cond_signal (&u->invoke_cv);
4413	pthread_mutex_unlock (&u->lock);
4414	}
4415
4416	Whenever you want to start/stop a watcher or do other modifications to an
4417	event loop, you will now have to lock:
4418
4419	ev_timer timeout_watcher;
4420	userdata *u = ev_userdata (EV_A);
4421
4422	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4423
4424	pthread_mutex_lock (&u->lock);
4425	ev_timer_start (EV_A_ &timeout_watcher);
4426	ev_async_send (EV_A_ &u->async_w);
4427	pthread_mutex_unlock (&u->lock);
4428
4429	Note that sending the C<ev_async> watcher is required because otherwise
4430	an event loop currently blocking in the kernel will have no knowledge
4431	about the newly added timer. By waking up the loop it will pick up any new
4432	watchers in the next event loop iteration.
4433		4959
4434	=head3 COROUTINES	4960	=head3 COROUTINES
4435		4961
4436	Libev is very accommodating to coroutines ("cooperative threads"):	4962	Libev is very accommodating to coroutines ("cooperative threads"):
4437	libev fully supports nesting calls to its functions from different	4963	libev fully supports nesting calls to its functions from different
…		…
4602	requires, and its I/O model is fundamentally incompatible with the POSIX	5128	requires, and its I/O model is fundamentally incompatible with the POSIX
4603	model. Libev still offers limited functionality on this platform in	5129	model. Libev still offers limited functionality on this platform in
4604	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	5130	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4605	descriptors. This only applies when using Win32 natively, not when using	5131	descriptors. This only applies when using Win32 natively, not when using
4606	e.g. cygwin. Actually, it only applies to the microsofts own compilers,	5132	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
4607	as every compielr comes with a slightly differently broken/incompatible	5133	as every compiler comes with a slightly differently broken/incompatible
4608	environment.	5134	environment.
4609		5135
4610	Lifting these limitations would basically require the full	5136	Lifting these limitations would basically require the full
4611	re-implementation of the I/O system. If you are into this kind of thing,	5137	re-implementation of the I/O system. If you are into this kind of thing,
4612	then note that glib does exactly that for you in a very portable way (note	5138	then note that glib does exactly that for you in a very portable way (note
…		…
4706	structure (guaranteed by POSIX but not by ISO C for example), but it also	5232	structure (guaranteed by POSIX but not by ISO C for example), but it also
4707	assumes that the same (machine) code can be used to call any watcher	5233	assumes that the same (machine) code can be used to call any watcher
4708	callback: The watcher callbacks have different type signatures, but libev	5234	callback: The watcher callbacks have different type signatures, but libev
4709	calls them using an C<ev_watcher *> internally.	5235	calls them using an C<ev_watcher *> internally.
4710		5236
		5237	=item pointer accesses must be thread-atomic
		5238
		5239	Accessing a pointer value must be atomic, it must both be readable and
		5240	writable in one piece - this is the case on all current architectures.
		5241
4711	=item C<sig_atomic_t volatile> must be thread-atomic as well	5242	=item C<sig_atomic_t volatile> must be thread-atomic as well
4712		5243
4713	The type C<sig_atomic_t volatile> (or whatever is defined as	5244	The type C<sig_atomic_t volatile> (or whatever is defined as
4714	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different	5245	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
4715	threads. This is not part of the specification for C<sig_atomic_t>, but is	5246	threads. This is not part of the specification for C<sig_atomic_t>, but is
…		…
4740		5271
4741	The type C<double> is used to represent timestamps. It is required to	5272	The type C<double> is used to represent timestamps. It is required to
4742	have at least 51 bits of mantissa (and 9 bits of exponent), which is	5273	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4743	good enough for at least into the year 4000 with millisecond accuracy	5274	good enough for at least into the year 4000 with millisecond accuracy
4744	(the design goal for libev). This requirement is overfulfilled by	5275	(the design goal for libev). This requirement is overfulfilled by
4745	implementations using IEEE 754, which is basically all existing ones. With	5276	implementations using IEEE 754, which is basically all existing ones.
		5277
4746	IEEE 754 doubles, you get microsecond accuracy until at least 2200.	5278	With IEEE 754 doubles, you get microsecond accuracy until at least the
		5279	year 2255 (and millisecond accuracy till the year 287396 - by then, libev
		5280	is either obsolete or somebody patched it to use C<long double> or
		5281	something like that, just kidding).
4747		5282
4748	=back	5283	=back
4749		5284
4750	If you know of other additional requirements drop me a note.	5285	If you know of other additional requirements drop me a note.
4751		5286
…		…
4813	=item Processing ev_async_send: O(number_of_async_watchers)	5348	=item Processing ev_async_send: O(number_of_async_watchers)
4814		5349
4815	=item Processing signals: O(max_signal_number)	5350	=item Processing signals: O(max_signal_number)
4816		5351
4817	Sending involves a system call I<iff> there were no other C<ev_async_send>	5352	Sending involves a system call I<iff> there were no other C<ev_async_send>
4818	calls in the current loop iteration. Checking for async and signal events	5353	calls in the current loop iteration and the loop is currently
		5354	blocked. Checking for async and signal events involves iterating over all
4819	involves iterating over all running async watchers or all signal numbers.	5355	running async watchers or all signal numbers.
4820		5356
4821	=back	5357	=back
4822		5358
4823		5359
4824	=head1 PORTING FROM LIBEV 3.X TO 4.X	5360	=head1 PORTING FROM LIBEV 3.X TO 4.X
4825		5361
4826	The major version 4 introduced some minor incompatible changes to the API.	5362	The major version 4 introduced some incompatible changes to the API.
4827		5363
4828	At the moment, the C<ev.h> header file tries to implement superficial	5364	At the moment, the C<ev.h> header file provides compatibility definitions
4829	compatibility, so most programs should still compile. Those might be	5365	for all changes, so most programs should still compile. The compatibility
4830	removed in later versions of libev, so better update early than late.	5366	layer might be removed in later versions of libev, so better update to the
		5367	new API early than late.
4831		5368
4832	=over 4	5369	=over 4
		5370
		5371	=item C<EV_COMPAT3> backwards compatibility mechanism
		5372
		5373	The backward compatibility mechanism can be controlled by
		5374	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		5375	section.
		5376
		5377	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		5378
		5379	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		5380
		5381	ev_loop_destroy (EV_DEFAULT_UC);
		5382	ev_loop_fork (EV_DEFAULT);
4833		5383
4834	=item function/symbol renames	5384	=item function/symbol renames
4835		5385
4836	A number of functions and symbols have been renamed:	5386	A number of functions and symbols have been renamed:
4837		5387
…		…
4856	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme	5406	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
4857	as all other watcher types. Note that C<ev_loop_fork> is still called	5407	as all other watcher types. Note that C<ev_loop_fork> is still called
4858	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>	5408	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
4859	typedef.	5409	typedef.
4860		5410
4861	=item C<EV_COMPAT3> backwards compatibility mechanism
4862
4863	The backward compatibility mechanism can be controlled by
4864	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
4865	section.
4866
4867	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>	5411	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
4868		5412
4869	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different	5413	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
4870	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile	5414	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
4871	and work, but the library code will of course be larger.	5415	and work, but the library code will of course be larger.
…		…
4933	The physical time that is observed. It is apparently strictly monotonic :)	5477	The physical time that is observed. It is apparently strictly monotonic :)
4934		5478
4935	=item wall-clock time	5479	=item wall-clock time
4936		5480
4937	The time and date as shown on clocks. Unlike real time, it can actually	5481	The time and date as shown on clocks. Unlike real time, it can actually
4938	be wrong and jump forwards and backwards, e.g. when the you adjust your	5482	be wrong and jump forwards and backwards, e.g. when you adjust your
4939	clock.	5483	clock.
4940		5484
4941	=item watcher	5485	=item watcher
4942		5486
4943	A data structure that describes interest in certain events. Watchers need	5487	A data structure that describes interest in certain events. Watchers need
…		…
4945		5489
4946	=back	5490	=back
4947		5491
4948	=head1 AUTHOR	5492	=head1 AUTHOR
4949		5493
4950	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5494	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5495	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
4951		5496

Diff Legend

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