ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.310 by root, Thu Oct 21 12:32:47 2010 UTC vs.
Revision 1.360 by root, Mon Jan 17 12:11:12 2011 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);
…		…
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
…		…
124	this argument.	132	this argument.
125		133
126	=head2 TIME REPRESENTATION	134	=head2 TIME REPRESENTATION
127		135
128	Libev represents time as a single floating point number, representing	136	Libev represents time as a single floating point number, representing
129	the (fractional) number of seconds since the (POSIX) epoch (in practise	137	the (fractional) number of seconds since the (POSIX) epoch (in practice
130	somewhere near the beginning of 1970, details are complicated, don't	138	somewhere near the beginning of 1970, details are complicated, don't
131	ask). This type is called C<ev_tstamp>, which is what you should use	139	ask). This type is called C<ev_tstamp>, which is what you should use
132	too. It usually aliases to the C<double> type in C. When you need to do	140	too. It usually aliases to the C<double> type in C. When you need to do
133	any calculations on it, you should treat it as some floating point value.	141	any calculations on it, you should treat it as some floating point value.
134		142
…		…
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.	178	you actually want to know. Also interesting is the combination of
		179	C<ev_update_now> and C<ev_now>.
171		180
172	=item ev_sleep (ev_tstamp interval)	181	=item ev_sleep (ev_tstamp interval)
173		182
174	Sleep for the given interval: The current thread will be blocked until	183	Sleep for the given interval: The current thread will be blocked until
175	either it is interrupted or the given time interval has passed. Basically	184	either it is interrupted or the given time interval has passed. Basically
…		…
192	as this indicates an incompatible change. Minor versions are usually	201	as this indicates an incompatible change. Minor versions are usually
193	compatible to older versions, so a larger minor version alone is usually	202	compatible to older versions, so a larger minor version alone is usually
194	not a problem.	203	not a problem.
195		204
196	Example: Make sure we haven't accidentally been linked against the wrong	205	Example: Make sure we haven't accidentally been linked against the wrong
197	version (note, however, that this will not detect ABI mismatches :).	206	version (note, however, that this will not detect other ABI mismatches,
		207	such as LFS or reentrancy).
198		208
199	assert (("libev version mismatch",	209	assert (("libev version mismatch",
200	ev_version_major () == EV_VERSION_MAJOR	210	ev_version_major () == EV_VERSION_MAJOR
201	&& ev_version_minor () >= EV_VERSION_MINOR));	211	&& ev_version_minor () >= EV_VERSION_MINOR));
202		212
…		…
213	assert (("sorry, no epoll, no sex",	223	assert (("sorry, no epoll, no sex",
214	ev_supported_backends () & EVBACKEND_EPOLL));	224	ev_supported_backends () & EVBACKEND_EPOLL));
215		225
216	=item unsigned int ev_recommended_backends ()	226	=item unsigned int ev_recommended_backends ()
217		227
218	Return the set of all backends compiled into this binary of libev and also	228	Return the set of all backends compiled into this binary of libev and
219	recommended for this platform. This set is often smaller than the one	229	also recommended for this platform, meaning it will work for most file
		230	descriptor types. This set is often smaller than the one returned by
220	returned by C<ev_supported_backends>, as for example kqueue is broken on	231	C<ev_supported_backends>, as for example kqueue is broken on most BSDs
221	most BSDs and will not be auto-detected unless you explicitly request it	232	and will not be auto-detected unless you explicitly request it (assuming
222	(assuming you know what you are doing). This is the set of backends that	233	you know what you are doing). This is the set of backends that libev will
223	libev will probe for if you specify no backends explicitly.	234	probe for if you specify no backends explicitly.
224		235
225	=item unsigned int ev_embeddable_backends ()	236	=item unsigned int ev_embeddable_backends ()
226		237
227	Returns the set of backends that are embeddable in other event loops. This	238	Returns the set of backends that are embeddable in other event loops. This
228	is the theoretical, all-platform, value. To find which backends	239	value is platform-specific but can include backends not available on the
229	might be supported on the current system, you would need to look at	240	current system. To find which embeddable backends might be supported on
230	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	241	the current system, you would need to look at C<ev_embeddable_backends ()
231	recommended ones.	242	& ev_supported_backends ()>, likewise for recommended ones.
232		243
233	See the description of C<ev_embed> watchers for more info.	244	See the description of C<ev_embed> watchers for more info.
234		245
235	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]	246	=item ev_set_allocator (void *(*cb)(void *ptr, long size))
236		247
237	Sets the allocation function to use (the prototype is similar - the	248	Sets the allocation function to use (the prototype is similar - the
238	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is	249	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
239	used to allocate and free memory (no surprises here). If it returns zero	250	used to allocate and free memory (no surprises here). If it returns zero
240	when memory needs to be allocated (C<size != 0>), the library might abort	251	when memory needs to be allocated (C<size != 0>), the library might abort
…		…
266	}	277	}
267		278
268	...	279	...
269	ev_set_allocator (persistent_realloc);	280	ev_set_allocator (persistent_realloc);
270		281
271	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]	282	=item ev_set_syserr_cb (void (*cb)(const char *msg))
272		283
273	Set the callback function to call on a retryable system call error (such	284	Set the callback function to call on a retryable system call error (such
274	as failed select, poll, epoll_wait). The message is a printable string	285	as failed select, poll, epoll_wait). The message is a printable string
275	indicating the system call or subsystem causing the problem. If this	286	indicating the system call or subsystem causing the problem. If this
276	callback is set, then libev will expect it to remedy the situation, no	287	callback is set, then libev will expect it to remedy the situation, no
…		…
288	}	299	}
289		300
290	...	301	...
291	ev_set_syserr_cb (fatal_error);	302	ev_set_syserr_cb (fatal_error);
292		303
		304	=item ev_feed_signal (int signum)
		305
		306	This function can be used to "simulate" a signal receive. It is completely
		307	safe to call this function at any time, from any context, including signal
		308	handlers or random threads.
		309
		310	Its main use is to customise signal handling in your process, especially
		311	in the presence of threads. For example, you could block signals
		312	by default in all threads (and specifying C<EVFLAG_NOSIGMASK> when
		313	creating any loops), and in one thread, use C<sigwait> or any other
		314	mechanism to wait for signals, then "deliver" them to libev by calling
		315	C<ev_feed_signal>.
		316
293	=back	317	=back
294		318
295	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	319	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
296		320
297	An event loop is described by a C<struct ev_loop *> (the C<struct> is	321	An event loop is described by a C<struct ev_loop *> (the C<struct> is
298	I<not> optional in case unless libev 3 compatibility is disabled, as libev	322	I<not> optional in this case unless libev 3 compatibility is disabled, as
299	3 had an C<ev_loop> function colliding with the struct name).	323	libev 3 had an C<ev_loop> function colliding with the struct name).
300		324
301	The library knows two types of such loops, the I<default> loop, which	325	The library knows two types of such loops, the I<default> loop, which
302	supports signals and child events, and dynamically created event loops	326	supports child process events, and dynamically created event loops which
303	which do not.	327	do not.
304		328
305	=over 4	329	=over 4
306		330
307	=item struct ev_loop *ev_default_loop (unsigned int flags)	331	=item struct ev_loop *ev_default_loop (unsigned int flags)
308		332
309	This will initialise the default event loop if it hasn't been initialised	333	This returns the "default" event loop object, which is what you should
310	yet and return it. If the default loop could not be initialised, returns	334	normally use when you just need "the event loop". Event loop objects and
311	false. If it already was initialised it simply returns it (and ignores the	335	the C<flags> parameter are described in more detail in the entry for
312	flags. If that is troubling you, check C<ev_backend ()> afterwards).	336	C<ev_loop_new>.
		337
		338	If the default loop is already initialised then this function simply
		339	returns it (and ignores the flags. If that is troubling you, check
		340	C<ev_backend ()> afterwards). Otherwise it will create it with the given
		341	flags, which should almost always be C<0>, unless the caller is also the
		342	one calling C<ev_run> or otherwise qualifies as "the main program".
313		343
314	If you don't know what event loop to use, use the one returned from this	344	If you don't know what event loop to use, use the one returned from this
315	function.	345	function (or via the C<EV_DEFAULT> macro).
316		346
317	Note that this function is I<not> thread-safe, so if you want to use it	347	Note that this function is I<not> thread-safe, so if you want to use it
318	from multiple threads, you have to lock (note also that this is unlikely,	348	from multiple threads, you have to employ some kind of mutex (note also
319	as loops cannot be shared easily between threads anyway).	349	that this case is unlikely, as loops cannot be shared easily between
		350	threads anyway).
320		351
321	The default loop is the only loop that can handle C<ev_signal> and	352	The default loop is the only loop that can handle C<ev_child> watchers,
322	C<ev_child> watchers, and to do this, it always registers a handler	353	and to do this, it always registers a handler for C<SIGCHLD>. If this is
323	for C<SIGCHLD>. If this is a problem for your application you can either	354	a problem for your application you can either create a dynamic loop with
324	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	355	C<ev_loop_new> which doesn't do that, or you can simply overwrite the
325	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	356	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
326	C<ev_default_init>.	357
		358	Example: This is the most typical usage.
		359
		360	if (!ev_default_loop (0))
		361	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
		362
		363	Example: Restrict libev to the select and poll backends, and do not allow
		364	environment settings to be taken into account:
		365
		366	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
		367
		368	=item struct ev_loop *ev_loop_new (unsigned int flags)
		369
		370	This will create and initialise a new event loop object. If the loop
		371	could not be initialised, returns false.
		372
		373	This function is thread-safe, and one common way to use libev with
		374	threads is indeed to create one loop per thread, and using the default
		375	loop in the "main" or "initial" thread.
327		376
328	The flags argument can be used to specify special behaviour or specific	377	The flags argument can be used to specify special behaviour or specific
329	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).	378	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
330		379
331	The following flags are supported:	380	The following flags are supported:
…		…
366	environment variable.	415	environment variable.
367		416
368	=item C<EVFLAG_NOINOTIFY>	417	=item C<EVFLAG_NOINOTIFY>
369		418
370	When this flag is specified, then libev will not attempt to use the	419	When this flag is specified, then libev will not attempt to use the
371	I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and	420	I<inotify> API for its C<ev_stat> watchers. Apart from debugging and
372	testing, this flag can be useful to conserve inotify file descriptors, as	421	testing, this flag can be useful to conserve inotify file descriptors, as
373	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.	422	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
374		423
375	=item C<EVFLAG_SIGNALFD>	424	=item C<EVFLAG_SIGNALFD>
376		425
377	When this flag is specified, then libev will attempt to use the	426	When this flag is specified, then libev will attempt to use the
378	I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This API	427	I<signalfd> API for its C<ev_signal> (and C<ev_child>) watchers. This API
379	delivers signals synchronously, which makes it both faster and might make	428	delivers signals synchronously, which makes it both faster and might make
380	it possible to get the queued signal data. It can also simplify signal	429	it possible to get the queued signal data. It can also simplify signal
381	handling with threads, as long as you properly block signals in your	430	handling with threads, as long as you properly block signals in your
382	threads that are not interested in handling them.	431	threads that are not interested in handling them.
383		432
384	Signalfd will not be used by default as this changes your signal mask, and	433	Signalfd will not be used by default as this changes your signal mask, and
385	there are a lot of shoddy libraries and programs (glib's threadpool for	434	there are a lot of shoddy libraries and programs (glib's threadpool for
386	example) that can't properly initialise their signal masks.	435	example) that can't properly initialise their signal masks.
		436
		437	=item C<EVFLAG_NOSIGMASK>
		438
		439	When this flag is specified, then libev will avoid to modify the signal
		440	mask. Specifically, this means you ahve to make sure signals are unblocked
		441	when you want to receive them.
		442
		443	This behaviour is useful when you want to do your own signal handling, or
		444	want to handle signals only in specific threads and want to avoid libev
		445	unblocking the signals.
		446
		447	It's also required by POSIX in a threaded program, as libev calls
		448	C<sigprocmask>, whose behaviour is officially unspecified.
		449
		450	This flag's behaviour will become the default in future versions of libev.
387		451
388	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	452	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
389		453
390	This is your standard select(2) backend. Not I<completely> standard, as	454	This is your standard select(2) backend. Not I<completely> standard, as
391	libev tries to roll its own fd_set with no limits on the number of fds,	455	libev tries to roll its own fd_set with no limits on the number of fds,
…		…
427	epoll scales either O(1) or O(active_fds).	491	epoll scales either O(1) or O(active_fds).
428		492
429	The epoll mechanism deserves honorable mention as the most misdesigned	493	The epoll mechanism deserves honorable mention as the most misdesigned
430	of the more advanced event mechanisms: mere annoyances include silently	494	of the more advanced event mechanisms: mere annoyances include silently
431	dropping file descriptors, requiring a system call per change per file	495	dropping file descriptors, requiring a system call per change per file
432	descriptor (and unnecessary guessing of parameters), problems with dup and	496	descriptor (and unnecessary guessing of parameters), problems with dup,
		497	returning before the timeout value, resulting in additional iterations
		498	(and only giving 5ms accuracy while select on the same platform gives
433	so on. The biggest issue is fork races, however - if a program forks then	499	0.1ms) and so on. The biggest issue is fork races, however - if a program
434	I<both> parent and child process have to recreate the epoll set, which can	500	forks then I<both> parent and child process have to recreate the epoll
435	take considerable time (one syscall per file descriptor) and is of course	501	set, which can take considerable time (one syscall per file descriptor)
436	hard to detect.	502	and is of course hard to detect.
437		503
438	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	504	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
439	of course I<doesn't>, and epoll just loves to report events for totally	505	of course I<doesn't>, and epoll just loves to report events for totally
440	I<different> file descriptors (even already closed ones, so one cannot	506	I<different> file descriptors (even already closed ones, so one cannot
441	even remove them from the set) than registered in the set (especially	507	even remove them from the set) than registered in the set (especially
…		…
443	employing an additional generation counter and comparing that against the	509	employing an additional generation counter and comparing that against the
444	events to filter out spurious ones, recreating the set when required. Last	510	events to filter out spurious ones, recreating the set when required. Last
445	not least, it also refuses to work with some file descriptors which work	511	not least, it also refuses to work with some file descriptors which work
446	perfectly fine with C<select> (files, many character devices...).	512	perfectly fine with C<select> (files, many character devices...).
447		513
		514	Epoll is truly the train wreck analog among event poll mechanisms,
		515	a frankenpoll, cobbled together in a hurry, no thought to design or
		516	interaction with others.
		517
448	While stopping, setting and starting an I/O watcher in the same iteration	518	While stopping, setting and starting an I/O watcher in the same iteration
449	will result in some caching, there is still a system call per such	519	will result in some caching, there is still a system call per such
450	incident (because the same I<file descriptor> could point to a different	520	incident (because the same I<file descriptor> could point to a different
451	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed	521	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
452	file descriptors might not work very well if you register events for both	522	file descriptors might not work very well if you register events for both
…		…
517	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	587	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
518		588
519	This uses the Solaris 10 event port mechanism. As with everything on Solaris,	589	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
520	it's really slow, but it still scales very well (O(active_fds)).	590	it's really slow, but it still scales very well (O(active_fds)).
521		591
522	Please note that Solaris event ports can deliver a lot of spurious
523	notifications, so you need to use non-blocking I/O or other means to avoid
524	blocking when no data (or space) is available.
525
526	While this backend scales well, it requires one system call per active	592	While this backend scales well, it requires one system call per active
527	file descriptor per loop iteration. For small and medium numbers of file	593	file descriptor per loop iteration. For small and medium numbers of file
528	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	594	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
529	might perform better.	595	might perform better.
530		596
531	On the positive side, with the exception of the spurious readiness	597	On the positive side, this backend actually performed fully to
532	notifications, this backend actually performed fully to specification
533	in all tests and is fully embeddable, which is a rare feat among the	598	specification in all tests and is fully embeddable, which is a rare feat
534	OS-specific backends (I vastly prefer correctness over speed hacks).	599	among the OS-specific backends (I vastly prefer correctness over speed
		600	hacks).
		601
		602	On the negative side, the interface is I<bizarre> - so bizarre that
		603	even sun itself gets it wrong in their code examples: The event polling
		604	function sometimes returning events to the caller even though an error
		605	occurred, but with no indication whether it has done so or not (yes, it's
		606	even documented that way) - deadly for edge-triggered interfaces where
		607	you absolutely have to know whether an event occurred or not because you
		608	have to re-arm the watcher.
		609
		610	Fortunately libev seems to be able to work around these idiocies.
535		611
536	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	612	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
537	C<EVBACKEND_POLL>.	613	C<EVBACKEND_POLL>.
538		614
539	=item C<EVBACKEND_ALL>	615	=item C<EVBACKEND_ALL>
540		616
541	Try all backends (even potentially broken ones that wouldn't be tried	617	Try all backends (even potentially broken ones that wouldn't be tried
542	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	618	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
543	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	619	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
544		620
545	It is definitely not recommended to use this flag.	621	It is definitely not recommended to use this flag, use whatever
		622	C<ev_recommended_backends ()> returns, or simply do not specify a backend
		623	at all.
		624
		625	=item C<EVBACKEND_MASK>
		626
		627	Not a backend at all, but a mask to select all backend bits from a
		628	C<flags> value, in case you want to mask out any backends from a flags
		629	value (e.g. when modifying the C<LIBEV_FLAGS> environment variable).
546		630
547	=back	631	=back
548		632
549	If one or more of the backend flags are or'ed into the flags value,	633	If one or more of the backend flags are or'ed into the flags value,
550	then only these backends will be tried (in the reverse order as listed	634	then only these backends will be tried (in the reverse order as listed
551	here). If none are specified, all backends in C<ev_recommended_backends	635	here). If none are specified, all backends in C<ev_recommended_backends
552	()> will be tried.	636	()> will be tried.
553		637
554	Example: This is the most typical usage.
555
556	if (!ev_default_loop (0))
557	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
558
559	Example: Restrict libev to the select and poll backends, and do not allow
560	environment settings to be taken into account:
561
562	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
563
564	Example: Use whatever libev has to offer, but make sure that kqueue is
565	used if available (warning, breaks stuff, best use only with your own
566	private event loop and only if you know the OS supports your types of
567	fds):
568
569	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
570
571	=item struct ev_loop *ev_loop_new (unsigned int flags)
572
573	Similar to C<ev_default_loop>, but always creates a new event loop that is
574	always distinct from the default loop.
575
576	Note that this function I<is> thread-safe, and one common way to use
577	libev with threads is indeed to create one loop per thread, and using the
578	default loop in the "main" or "initial" thread.
579
580	Example: Try to create a event loop that uses epoll and nothing else.	638	Example: Try to create a event loop that uses epoll and nothing else.
581		639
582	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	640	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
583	if (!epoller)	641	if (!epoller)
584	fatal ("no epoll found here, maybe it hides under your chair");	642	fatal ("no epoll found here, maybe it hides under your chair");
585		643
		644	Example: Use whatever libev has to offer, but make sure that kqueue is
		645	used if available.
		646
		647	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
		648
586	=item ev_default_destroy ()	649	=item ev_loop_destroy (loop)
587		650
588	Destroys the default loop (frees all memory and kernel state etc.). None	651	Destroys an event loop object (frees all memory and kernel state
589	of the active event watchers will be stopped in the normal sense, so	652	etc.). None of the active event watchers will be stopped in the normal
590	e.g. C<ev_is_active> might still return true. It is your responsibility to	653	sense, so e.g. C<ev_is_active> might still return true. It is your
591	either stop all watchers cleanly yourself I<before> calling this function,	654	responsibility to either stop all watchers cleanly yourself I<before>
592	or cope with the fact afterwards (which is usually the easiest thing, you	655	calling this function, or cope with the fact afterwards (which is usually
593	can just ignore the watchers and/or C<free ()> them for example).	656	the easiest thing, you can just ignore the watchers and/or C<free ()> them
		657	for example).
594		658
595	Note that certain global state, such as signal state (and installed signal	659	Note that certain global state, such as signal state (and installed signal
596	handlers), will not be freed by this function, and related watchers (such	660	handlers), will not be freed by this function, and related watchers (such
597	as signal and child watchers) would need to be stopped manually.	661	as signal and child watchers) would need to be stopped manually.
598		662
599	In general it is not advisable to call this function except in the	663	This function is normally used on loop objects allocated by
600	rare occasion where you really need to free e.g. the signal handling	664	C<ev_loop_new>, but it can also be used on the default loop returned by
		665	C<ev_default_loop>, in which case it is not thread-safe.
		666
		667	Note that it is not advisable to call this function on the default loop
		668	except in the rare occasion where you really need to free its resources.
601	pipe fds. If you need dynamically allocated loops it is better to use	669	If you need dynamically allocated loops it is better to use C<ev_loop_new>
602	C<ev_loop_new> and C<ev_loop_destroy>.	670	and C<ev_loop_destroy>.
603		671
604	=item ev_loop_destroy (loop)	672	=item ev_loop_fork (loop)
605		673
606	Like C<ev_default_destroy>, but destroys an event loop created by an
607	earlier call to C<ev_loop_new>.
608
609	=item ev_default_fork ()
610
611	This function sets a flag that causes subsequent C<ev_run> iterations	674	This function sets a flag that causes subsequent C<ev_run> iterations to
612	to reinitialise the kernel state for backends that have one. Despite the	675	reinitialise the kernel state for backends that have one. Despite the
613	name, you can call it anytime, but it makes most sense after forking, in	676	name, you can call it anytime, but it makes most sense after forking, in
614	the child process (or both child and parent, but that again makes little	677	the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the
615	sense). You I<must> call it in the child before using any of the libev	678	child before resuming or calling C<ev_run>.
616	functions, and it will only take effect at the next C<ev_run> iteration.
617		679
618	Again, you I<have> to call it on I<any> loop that you want to re-use after	680	Again, you I<have> to call it on I<any> loop that you want to re-use after
619	a fork, I<even if you do not plan to use the loop in the parent>. This is	681	a fork, I<even if you do not plan to use the loop in the parent>. This is
620	because some kernel interfaces *cough* I<kqueue> *cough* do funny things	682	because some kernel interfaces *cough* I<kqueue> *cough* do funny things
621	during fork.	683	during fork.
…		…
626	call it at all (in fact, C<epoll> is so badly broken that it makes a	688	call it at all (in fact, C<epoll> is so badly broken that it makes a
627	difference, but libev will usually detect this case on its own and do a	689	difference, but libev will usually detect this case on its own and do a
628	costly reset of the backend).	690	costly reset of the backend).
629		691
630	The function itself is quite fast and it's usually not a problem to call	692	The function itself is quite fast and it's usually not a problem to call
631	it just in case after a fork. To make this easy, the function will fit in	693	it just in case after a fork.
632	quite nicely into a call to C<pthread_atfork>:
633		694
		695	Example: Automate calling C<ev_loop_fork> on the default loop when
		696	using pthreads.
		697
		698	static void
		699	post_fork_child (void)
		700	{
		701	ev_loop_fork (EV_DEFAULT);
		702	}
		703
		704	...
634	pthread_atfork (0, 0, ev_default_fork);	705	pthread_atfork (0, 0, post_fork_child);
635
636	=item ev_loop_fork (loop)
637
638	Like C<ev_default_fork>, but acts on an event loop created by
639	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
640	after fork that you want to re-use in the child, and how you keep track of
641	them is entirely your own problem.
642		706
643	=item int ev_is_default_loop (loop)	707	=item int ev_is_default_loop (loop)
644		708
645	Returns true when the given loop is, in fact, the default loop, and false	709	Returns true when the given loop is, in fact, the default loop, and false
646	otherwise.	710	otherwise.
…		…
657	prepare and check phases.	721	prepare and check phases.
658		722
659	=item unsigned int ev_depth (loop)	723	=item unsigned int ev_depth (loop)
660		724
661	Returns the number of times C<ev_run> was entered minus the number of	725	Returns the number of times C<ev_run> was entered minus the number of
662	times C<ev_run> was exited, in other words, the recursion depth.	726	times C<ev_run> was exited normally, in other words, the recursion depth.
663		727
664	Outside C<ev_run>, this number is zero. In a callback, this number is	728	Outside C<ev_run>, this number is zero. In a callback, this number is
665	C<1>, unless C<ev_run> was invoked recursively (or from another thread),	729	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
666	in which case it is higher.	730	in which case it is higher.
667		731
668	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread	732	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread,
669	etc.), doesn't count as "exit" - consider this as a hint to avoid such	733	throwing an exception etc.), doesn't count as "exit" - consider this
670	ungentleman-like behaviour unless it's really convenient.	734	as a hint to avoid such ungentleman-like behaviour unless it's really
		735	convenient, in which case it is fully supported.
671		736
672	=item unsigned int ev_backend (loop)	737	=item unsigned int ev_backend (loop)
673		738
674	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	739	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
675	use.	740	use.
…		…
736	relying on all watchers to be stopped when deciding when a program has	801	relying on all watchers to be stopped when deciding when a program has
737	finished (especially in interactive programs), but having a program	802	finished (especially in interactive programs), but having a program
738	that automatically loops as long as it has to and no longer by virtue	803	that automatically loops as long as it has to and no longer by virtue
739	of relying on its watchers stopping correctly, that is truly a thing of	804	of relying on its watchers stopping correctly, that is truly a thing of
740	beauty.	805	beauty.
		806
		807	This function is also I<mostly> exception-safe - you can break out of
		808	a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
		809	exception and so on. This does not decrement the C<ev_depth> value, nor
		810	will it clear any outstanding C<EVBREAK_ONE> breaks.
741		811
742	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle	812	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
743	those events and any already outstanding ones, but will not wait and	813	those events and any already outstanding ones, but will not wait and
744	block your process in case there are no events and will return after one	814	block your process in case there are no events and will return after one
745	iteration of the loop. This is sometimes useful to poll and handle new	815	iteration of the loop. This is sometimes useful to poll and handle new
…		…
807	Can be used to make a call to C<ev_run> return early (but only after it	877	Can be used to make a call to C<ev_run> return early (but only after it
808	has processed all outstanding events). The C<how> argument must be either	878	has processed all outstanding events). The C<how> argument must be either
809	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or	879	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
810	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.	880	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
811		881
812	This "unloop state" will be cleared when entering C<ev_run> again.	882	This "break state" will be cleared on the next call to C<ev_run>.
813		883
814	It is safe to call C<ev_break> from outside any C<ev_run> calls. ##TODO##	884	It is safe to call C<ev_break> from outside any C<ev_run> calls, too, in
		885	which case it will have no effect.
815		886
816	=item ev_ref (loop)	887	=item ev_ref (loop)
817		888
818	=item ev_unref (loop)	889	=item ev_unref (loop)
819		890
…		…
840	running when nothing else is active.	911	running when nothing else is active.
841		912
842	ev_signal exitsig;	913	ev_signal exitsig;
843	ev_signal_init (&exitsig, sig_cb, SIGINT);	914	ev_signal_init (&exitsig, sig_cb, SIGINT);
844	ev_signal_start (loop, &exitsig);	915	ev_signal_start (loop, &exitsig);
845	evf_unref (loop);	916	ev_unref (loop);
846		917
847	Example: For some weird reason, unregister the above signal handler again.	918	Example: For some weird reason, unregister the above signal handler again.
848		919
849	ev_ref (loop);	920	ev_ref (loop);
850	ev_signal_stop (loop, &exitsig);	921	ev_signal_stop (loop, &exitsig);
…		…
908		979
909	=item ev_invoke_pending (loop)	980	=item ev_invoke_pending (loop)
910		981
911	This call will simply invoke all pending watchers while resetting their	982	This call will simply invoke all pending watchers while resetting their
912	pending state. Normally, C<ev_run> does this automatically when required,	983	pending state. Normally, C<ev_run> does this automatically when required,
913	but when overriding the invoke callback this call comes handy.	984	but when overriding the invoke callback this call comes handy. This
		985	function can be invoked from a watcher - this can be useful for example
		986	when you want to do some lengthy calculation and want to pass further
		987	event handling to another thread (you still have to make sure only one
		988	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
914		989
915	=item int ev_pending_count (loop)	990	=item int ev_pending_count (loop)
916		991
917	Returns the number of pending watchers - zero indicates that no watchers	992	Returns the number of pending watchers - zero indicates that no watchers
918	are pending.	993	are pending.
…		…
958	See also the locking example in the C<THREADS> section later in this	1033	See also the locking example in the C<THREADS> section later in this
959	document.	1034	document.
960		1035
961	=item ev_set_userdata (loop, void *data)	1036	=item ev_set_userdata (loop, void *data)
962		1037
963	=item ev_userdata (loop)	1038	=item void *ev_userdata (loop)
964		1039
965	Set and retrieve a single C<void *> associated with a loop. When	1040	Set and retrieve a single C<void *> associated with a loop. When
966	C<ev_set_userdata> has never been called, then C<ev_userdata> returns	1041	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
967	C<0.>	1042	C<0>.
968		1043
969	These two functions can be used to associate arbitrary data with a loop,	1044	These two functions can be used to associate arbitrary data with a loop,
970	and are intended solely for the C<invoke_pending_cb>, C<release> and	1045	and are intended solely for the C<invoke_pending_cb>, C<release> and
971	C<acquire> callbacks described above, but of course can be (ab-)used for	1046	C<acquire> callbacks described above, but of course can be (ab-)used for
972	any other purpose as well.	1047	any other purpose as well.
…		…
990		1065
991	In the following description, uppercase C<TYPE> in names stands for the	1066	In the following description, uppercase C<TYPE> in names stands for the
992	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer	1067	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
993	watchers and C<ev_io_start> for I/O watchers.	1068	watchers and C<ev_io_start> for I/O watchers.
994		1069
995	A watcher is a structure that you create and register to record your	1070	A watcher is an opaque structure that you allocate and register to record
996	interest in some event. For instance, if you want to wait for STDIN to	1071	your interest in some event. To make a concrete example, imagine you want
997	become readable, you would create an C<ev_io> watcher for that:	1072	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1073	for that:
998		1074
999	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)	1075	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
1000	{	1076	{
1001	ev_io_stop (w);	1077	ev_io_stop (w);
1002	ev_break (loop, EVBREAK_ALL);	1078	ev_break (loop, EVBREAK_ALL);
…		…
1017	stack).	1093	stack).
1018		1094
1019	Each watcher has an associated watcher structure (called C<struct ev_TYPE>	1095	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
1020	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).	1096	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
1021		1097
1022	Each watcher structure must be initialised by a call to C<ev_init	1098	Each watcher structure must be initialised by a call to C<ev_init (watcher
1023	(watcher *, callback)>, which expects a callback to be provided. This	1099	*, callback)>, which expects a callback to be provided. This callback is
1024	callback gets invoked each time the event occurs (or, in the case of I/O	1100	invoked each time the event occurs (or, in the case of I/O watchers, each
1025	watchers, each time the event loop detects that the file descriptor given	1101	time the event loop detects that the file descriptor given is readable
1026	is readable and/or writable).	1102	and/or writable).
1027		1103
1028	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>	1104	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
1029	macro to configure it, with arguments specific to the watcher type. There	1105	macro to configure it, with arguments specific to the watcher type. There
1030	is also a macro to combine initialisation and setting in one call: C<<	1106	is also a macro to combine initialisation and setting in one call: C<<
1031	ev_TYPE_init (watcher *, callback, ...) >>.	1107	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
1099	=item C<EV_FORK>	1175	=item C<EV_FORK>
1100		1176
1101	The event loop has been resumed in the child process after fork (see	1177	The event loop has been resumed in the child process after fork (see
1102	C<ev_fork>).	1178	C<ev_fork>).
1103		1179
		1180	=item C<EV_CLEANUP>
		1181
		1182	The event loop is about to be destroyed (see C<ev_cleanup>).
		1183
1104	=item C<EV_ASYNC>	1184	=item C<EV_ASYNC>
1105		1185
1106	The given async watcher has been asynchronously notified (see C<ev_async>).	1186	The given async watcher has been asynchronously notified (see C<ev_async>).
1107		1187
1108	=item C<EV_CUSTOM>	1188	=item C<EV_CUSTOM>
…		…
1280	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related	1360	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1281	functions that do not need a watcher.	1361	functions that do not need a watcher.
1282		1362
1283	=back	1363	=back
1284		1364
		1365	See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
		1366	OWN COMPOSITE WATCHERS> idioms.
1285		1367
1286	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1368	=head2 WATCHER STATES
1287		1369
1288	Each watcher has, by default, a member C<void *data> that you can change	1370	There are various watcher states mentioned throughout this manual -
1289	and read at any time: libev will completely ignore it. This can be used	1371	active, pending and so on. In this section these states and the rules to
1290	to associate arbitrary data with your watcher. If you need more data and	1372	transition between them will be described in more detail - and while these
1291	don't want to allocate memory and store a pointer to it in that data	1373	rules might look complicated, they usually do "the right thing".
1292	member, you can also "subclass" the watcher type and provide your own
1293	data:
1294		1374
1295	struct my_io	1375	=over 4
1296	{
1297	ev_io io;
1298	int otherfd;
1299	void *somedata;
1300	struct whatever *mostinteresting;
1301	};
1302		1376
1303	...	1377	=item initialiased
1304	struct my_io w;
1305	ev_io_init (&w.io, my_cb, fd, EV_READ);
1306		1378
1307	And since your callback will be called with a pointer to the watcher, you	1379	Before a watcher can be registered with the event looop it has to be
1308	can cast it back to your own type:	1380	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1381	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1309		1382
1310	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)	1383	In this state it is simply some block of memory that is suitable for use
1311	{	1384	in an event loop. It can be moved around, freed, reused etc. at will.
1312	struct my_io *w = (struct my_io *)w_;
1313	...
1314	}
1315		1385
1316	More interesting and less C-conformant ways of casting your callback type	1386	=item started/running/active
1317	instead have been omitted.
1318		1387
1319	Another common scenario is to use some data structure with multiple	1388	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1320	embedded watchers:	1389	property of the event loop, and is actively waiting for events. While in
		1390	this state it cannot be accessed (except in a few documented ways), moved,
		1391	freed or anything else - the only legal thing is to keep a pointer to it,
		1392	and call libev functions on it that are documented to work on active watchers.
1321		1393
1322	struct my_biggy	1394	=item pending
1323	{
1324	int some_data;
1325	ev_timer t1;
1326	ev_timer t2;
1327	}
1328		1395
1329	In this case getting the pointer to C<my_biggy> is a bit more	1396	If a watcher is active and libev determines that an event it is interested
1330	complicated: Either you store the address of your C<my_biggy> struct	1397	in has occurred (such as a timer expiring), it will become pending. It will
1331	in the C<data> member of the watcher (for woozies), or you need to use	1398	stay in this pending state until either it is stopped or its callback is
1332	some pointer arithmetic using C<offsetof> inside your watchers (for real	1399	about to be invoked, so it is not normally pending inside the watcher
1333	programmers):	1400	callback.
1334		1401
1335	#include <stddef.h>	1402	The watcher might or might not be active while it is pending (for example,
		1403	an expired non-repeating timer can be pending but no longer active). If it
		1404	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1405	but it is still property of the event loop at this time, so cannot be
		1406	moved, freed or reused. And if it is active the rules described in the
		1407	previous item still apply.
1336		1408
1337	static void	1409	It is also possible to feed an event on a watcher that is not active (e.g.
1338	t1_cb (EV_P_ ev_timer *w, int revents)	1410	via C<ev_feed_event>), in which case it becomes pending without being
1339	{	1411	active.
1340	struct my_biggy big = (struct my_biggy *)
1341	(((char *)w) - offsetof (struct my_biggy, t1));
1342	}
1343		1412
1344	static void	1413	=item stopped
1345	t2_cb (EV_P_ ev_timer *w, int revents)	1414
1346	{	1415	A watcher can be stopped implicitly by libev (in which case it might still
1347	struct my_biggy big = (struct my_biggy *)	1416	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
1348	(((char *)w) - offsetof (struct my_biggy, t2));	1417	latter will clear any pending state the watcher might be in, regardless
1349	}	1418	of whether it was active or not, so stopping a watcher explicitly before
		1419	freeing it is often a good idea.
		1420
		1421	While stopped (and not pending) the watcher is essentially in the
		1422	initialised state, that is it can be reused, moved, modified in any way
		1423	you wish.
		1424
		1425	=back
1350		1426
1351	=head2 WATCHER PRIORITY MODELS	1427	=head2 WATCHER PRIORITY MODELS
1352		1428
1353	Many event loops support I<watcher priorities>, which are usually small	1429	Many event loops support I<watcher priorities>, which are usually small
1354	integers that influence the ordering of event callback invocation	1430	integers that influence the ordering of event callback invocation
…		…
1481	In general you can register as many read and/or write event watchers per	1557	In general you can register as many read and/or write event watchers per
1482	fd as you want (as long as you don't confuse yourself). Setting all file	1558	fd as you want (as long as you don't confuse yourself). Setting all file
1483	descriptors to non-blocking mode is also usually a good idea (but not	1559	descriptors to non-blocking mode is also usually a good idea (but not
1484	required if you know what you are doing).	1560	required if you know what you are doing).
1485		1561
1486	If you cannot use non-blocking mode, then force the use of a
1487	known-to-be-good backend (at the time of this writing, this includes only
1488	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1489	descriptors for which non-blocking operation makes no sense (such as
1490	files) - libev doesn't guarantee any specific behaviour in that case.
1491
1492	Another thing you have to watch out for is that it is quite easy to	1562	Another thing you have to watch out for is that it is quite easy to
1493	receive "spurious" readiness notifications, that is your callback might	1563	receive "spurious" readiness notifications, that is, your callback might
1494	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1564	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1495	because there is no data. Not only are some backends known to create a	1565	because there is no data. It is very easy to get into this situation even
1496	lot of those (for example Solaris ports), it is very easy to get into	1566	with a relatively standard program structure. Thus it is best to always
1497	this situation even with a relatively standard program structure. Thus	1567	use non-blocking I/O: An extra C<read>(2) returning C<EAGAIN> is far
1498	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1499	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1568	preferable to a program hanging until some data arrives.
1500		1569
1501	If you cannot run the fd in non-blocking mode (for example you should	1570	If you cannot run the fd in non-blocking mode (for example you should
1502	not play around with an Xlib connection), then you have to separately	1571	not play around with an Xlib connection), then you have to separately
1503	re-test whether a file descriptor is really ready with a known-to-be good	1572	re-test whether a file descriptor is really ready with a known-to-be good
1504	interface such as poll (fortunately in our Xlib example, Xlib already	1573	interface such as poll (fortunately in the case of Xlib, it already does
1505	does this on its own, so its quite safe to use). Some people additionally	1574	this on its own, so its quite safe to use). Some people additionally
1506	use C<SIGALRM> and an interval timer, just to be sure you won't block	1575	use C<SIGALRM> and an interval timer, just to be sure you won't block
1507	indefinitely.	1576	indefinitely.
1508		1577
1509	But really, best use non-blocking mode.	1578	But really, best use non-blocking mode.
1510		1579
…		…
1538		1607
1539	There is no workaround possible except not registering events	1608	There is no workaround possible except not registering events
1540	for potentially C<dup ()>'ed file descriptors, or to resort to	1609	for potentially C<dup ()>'ed file descriptors, or to resort to
1541	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1610	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1542		1611
		1612	=head3 The special problem of files
		1613
		1614	Many people try to use C<select> (or libev) on file descriptors
		1615	representing files, and expect it to become ready when their program
		1616	doesn't block on disk accesses (which can take a long time on their own).
		1617
		1618	However, this cannot ever work in the "expected" way - you get a readiness
		1619	notification as soon as the kernel knows whether and how much data is
		1620	there, and in the case of open files, that's always the case, so you
		1621	always get a readiness notification instantly, and your read (or possibly
		1622	write) will still block on the disk I/O.
		1623
		1624	Another way to view it is that in the case of sockets, pipes, character
		1625	devices and so on, there is another party (the sender) that delivers data
		1626	on its own, but in the case of files, there is no such thing: the disk
		1627	will not send data on its own, simply because it doesn't know what you
		1628	wish to read - you would first have to request some data.
		1629
		1630	Since files are typically not-so-well supported by advanced notification
		1631	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1632	to files, even though you should not use it. The reason for this is
		1633	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1634	usually a tty, often a pipe, but also sometimes files or special devices
		1635	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1636	F</dev/urandom>), and even though the file might better be served with
		1637	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1638	it "just works" instead of freezing.
		1639
		1640	So avoid file descriptors pointing to files when you know it (e.g. use
		1641	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1642	when you rarely read from a file instead of from a socket, and want to
		1643	reuse the same code path.
		1644
1543	=head3 The special problem of fork	1645	=head3 The special problem of fork
1544		1646
1545	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1647	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1546	useless behaviour. Libev fully supports fork, but needs to be told about	1648	useless behaviour. Libev fully supports fork, but needs to be told about
1547	it in the child.	1649	it in the child if you want to continue to use it in the child.
1548		1650
1549	To support fork in your programs, you either have to call	1651	To support fork in your child processes, you have to call C<ev_loop_fork
1550	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1652	()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1551	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1653	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1552	C<EVBACKEND_POLL>.
1553		1654
1554	=head3 The special problem of SIGPIPE	1655	=head3 The special problem of SIGPIPE
1555		1656
1556	While not really specific to libev, it is easy to forget about C<SIGPIPE>:	1657	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1557	when writing to a pipe whose other end has been closed, your program gets	1658	when writing to a pipe whose other end has been closed, your program gets
…		…
2173		2274
2174	=head2 C<ev_signal> - signal me when a signal gets signalled!	2275	=head2 C<ev_signal> - signal me when a signal gets signalled!
2175		2276
2176	Signal watchers will trigger an event when the process receives a specific	2277	Signal watchers will trigger an event when the process receives a specific
2177	signal one or more times. Even though signals are very asynchronous, libev	2278	signal one or more times. Even though signals are very asynchronous, libev
2178	will try it's best to deliver signals synchronously, i.e. as part of the	2279	will try its best to deliver signals synchronously, i.e. as part of the
2179	normal event processing, like any other event.	2280	normal event processing, like any other event.
2180		2281
2181	If you want signals to be delivered truly asynchronously, just use	2282	If you want signals to be delivered truly asynchronously, just use
2182	C<sigaction> as you would do without libev and forget about sharing	2283	C<sigaction> as you would do without libev and forget about sharing
2183	the signal. You can even use C<ev_async> from a signal handler to	2284	the signal. You can even use C<ev_async> from a signal handler to
…		…
2202	=head3 The special problem of inheritance over fork/execve/pthread_create	2303	=head3 The special problem of inheritance over fork/execve/pthread_create
2203		2304
2204	Both the signal mask (C<sigprocmask>) and the signal disposition	2305	Both the signal mask (C<sigprocmask>) and the signal disposition
2205	(C<sigaction>) are unspecified after starting a signal watcher (and after	2306	(C<sigaction>) are unspecified after starting a signal watcher (and after
2206	stopping it again), that is, libev might or might not block the signal,	2307	stopping it again), that is, libev might or might not block the signal,
2207	and might or might not set or restore the installed signal handler.	2308	and might or might not set or restore the installed signal handler (but
		2309	see C<EVFLAG_NOSIGMASK>).
2208		2310
2209	While this does not matter for the signal disposition (libev never	2311	While this does not matter for the signal disposition (libev never
2210	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on	2312	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2211	C<execve>), this matters for the signal mask: many programs do not expect	2313	C<execve>), this matters for the signal mask: many programs do not expect
2212	certain signals to be blocked.	2314	certain signals to be blocked.
…		…
2225	I<has> to modify the signal mask, at least temporarily.	2327	I<has> to modify the signal mask, at least temporarily.
2226		2328
2227	So I can't stress this enough: I<If you do not reset your signal mask when	2329	So I can't stress this enough: I<If you do not reset your signal mask when
2228	you expect it to be empty, you have a race condition in your code>. This	2330	you expect it to be empty, you have a race condition in your code>. This
2229	is not a libev-specific thing, this is true for most event libraries.	2331	is not a libev-specific thing, this is true for most event libraries.
		2332
		2333	=head3 The special problem of threads signal handling
		2334
		2335	POSIX threads has problematic signal handling semantics, specifically,
		2336	a lot of functionality (sigfd, sigwait etc.) only really works if all
		2337	threads in a process block signals, which is hard to achieve.
		2338
		2339	When you want to use sigwait (or mix libev signal handling with your own
		2340	for the same signals), you can tackle this problem by globally blocking
		2341	all signals before creating any threads (or creating them with a fully set
		2342	sigprocmask) and also specifying the C<EVFLAG_NOSIGMASK> when creating
		2343	loops. Then designate one thread as "signal receiver thread" which handles
		2344	these signals. You can pass on any signals that libev might be interested
		2345	in by calling C<ev_feed_signal>.
2230		2346
2231	=head3 Watcher-Specific Functions and Data Members	2347	=head3 Watcher-Specific Functions and Data Members
2232		2348
2233	=over 4	2349	=over 4
2234		2350
…		…
3008	disadvantage of having to use multiple event loops (which do not support	3124	disadvantage of having to use multiple event loops (which do not support
3009	signal watchers).	3125	signal watchers).
3010		3126
3011	When this is not possible, or you want to use the default loop for	3127	When this is not possible, or you want to use the default loop for
3012	other reasons, then in the process that wants to start "fresh", call	3128	other reasons, then in the process that wants to start "fresh", call
3013	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3129	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
3014	the default loop will "orphan" (not stop) all registered watchers, so you	3130	Destroying the default loop will "orphan" (not stop) all registered
3015	have to be careful not to execute code that modifies those watchers. Note	3131	watchers, so you have to be careful not to execute code that modifies
3016	also that in that case, you have to re-register any signal watchers.	3132	those watchers. Note also that in that case, you have to re-register any
		3133	signal watchers.
3017		3134
3018	=head3 Watcher-Specific Functions and Data Members	3135	=head3 Watcher-Specific Functions and Data Members
3019		3136
3020	=over 4	3137	=over 4
3021		3138
3022	=item ev_fork_init (ev_signal *, callback)	3139	=item ev_fork_init (ev_fork *, callback)
3023		3140
3024	Initialises and configures the fork watcher - it has no parameters of any	3141	Initialises and configures the fork watcher - it has no parameters of any
3025	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3142	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
3026	believe me.	3143	really.
3027		3144
3028	=back	3145	=back
		3146
		3147
		3148	=head2 C<ev_cleanup> - even the best things end
		3149
		3150	Cleanup watchers are called just before the event loop is being destroyed
		3151	by a call to C<ev_loop_destroy>.
		3152
		3153	While there is no guarantee that the event loop gets destroyed, cleanup
		3154	watchers provide a convenient method to install cleanup hooks for your
		3155	program, worker threads and so on - you just to make sure to destroy the
		3156	loop when you want them to be invoked.
		3157
		3158	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3159	all other watchers, they do not keep a reference to the event loop (which
		3160	makes a lot of sense if you think about it). Like all other watchers, you
		3161	can call libev functions in the callback, except C<ev_cleanup_start>.
		3162
		3163	=head3 Watcher-Specific Functions and Data Members
		3164
		3165	=over 4
		3166
		3167	=item ev_cleanup_init (ev_cleanup *, callback)
		3168
		3169	Initialises and configures the cleanup watcher - it has no parameters of
		3170	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3171	pointless, I assure you.
		3172
		3173	=back
		3174
		3175	Example: Register an atexit handler to destroy the default loop, so any
		3176	cleanup functions are called.
		3177
		3178	static void
		3179	program_exits (void)
		3180	{
		3181	ev_loop_destroy (EV_DEFAULT_UC);
		3182	}
		3183
		3184	...
		3185	atexit (program_exits);
3029		3186
3030		3187
3031	=head2 C<ev_async> - how to wake up an event loop	3188	=head2 C<ev_async> - how to wake up an event loop
3032		3189
3033	In general, you cannot use an C<ev_run> from multiple threads or other	3190	In general, you cannot use an C<ev_run> from multiple threads or other
…		…
3040	it by calling C<ev_async_send>, which is thread- and signal safe.	3197	it by calling C<ev_async_send>, which is thread- and signal safe.
3041		3198
3042	This functionality is very similar to C<ev_signal> watchers, as signals,	3199	This functionality is very similar to C<ev_signal> watchers, as signals,
3043	too, are asynchronous in nature, and signals, too, will be compressed	3200	too, are asynchronous in nature, and signals, too, will be compressed
3044	(i.e. the number of callback invocations may be less than the number of	3201	(i.e. the number of callback invocations may be less than the number of
3045	C<ev_async_sent> calls).	3202	C<ev_async_sent> calls). In fact, you could use signal watchers as a kind
		3203	of "global async watchers" by using a watcher on an otherwise unused
		3204	signal, and C<ev_feed_signal> to signal this watcher from another thread,
		3205	even without knowing which loop owns the signal.
3046		3206
3047	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not	3207	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
3048	just the default loop.	3208	just the default loop.
3049		3209
3050	=head3 Queueing	3210	=head3 Queueing
…		…
3226	Feed an event on the given fd, as if a file descriptor backend detected	3386	Feed an event on the given fd, as if a file descriptor backend detected
3227	the given events it.	3387	the given events it.
3228		3388
3229	=item ev_feed_signal_event (loop, int signum)	3389	=item ev_feed_signal_event (loop, int signum)
3230		3390
3231	Feed an event as if the given signal occurred (C<loop> must be the default	3391	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3232	loop!).	3392	which is async-safe.
3233		3393
3234	=back	3394	=back
		3395
		3396
		3397	=head1 COMMON OR USEFUL IDIOMS (OR BOTH)
		3398
		3399	This section explains some common idioms that are not immediately
		3400	obvious. Note that examples are sprinkled over the whole manual, and this
		3401	section only contains stuff that wouldn't fit anywhere else.
		3402
		3403	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
		3404
		3405	Each watcher has, by default, a C<void *data> member that you can read
		3406	or modify at any time: libev will completely ignore it. This can be used
		3407	to associate arbitrary data with your watcher. If you need more data and
		3408	don't want to allocate memory separately and store a pointer to it in that
		3409	data member, you can also "subclass" the watcher type and provide your own
		3410	data:
		3411
		3412	struct my_io
		3413	{
		3414	ev_io io;
		3415	int otherfd;
		3416	void *somedata;
		3417	struct whatever *mostinteresting;
		3418	};
		3419
		3420	...
		3421	struct my_io w;
		3422	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3423
		3424	And since your callback will be called with a pointer to the watcher, you
		3425	can cast it back to your own type:
		3426
		3427	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
		3428	{
		3429	struct my_io *w = (struct my_io *)w_;
		3430	...
		3431	}
		3432
		3433	More interesting and less C-conformant ways of casting your callback
		3434	function type instead have been omitted.
		3435
		3436	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3437
		3438	Another common scenario is to use some data structure with multiple
		3439	embedded watchers, in effect creating your own watcher that combines
		3440	multiple libev event sources into one "super-watcher":
		3441
		3442	struct my_biggy
		3443	{
		3444	int some_data;
		3445	ev_timer t1;
		3446	ev_timer t2;
		3447	}
		3448
		3449	In this case getting the pointer to C<my_biggy> is a bit more
		3450	complicated: Either you store the address of your C<my_biggy> struct in
		3451	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3452	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3453	real programmers):
		3454
		3455	#include <stddef.h>
		3456
		3457	static void
		3458	t1_cb (EV_P_ ev_timer *w, int revents)
		3459	{
		3460	struct my_biggy big = (struct my_biggy *)
		3461	(((char *)w) - offsetof (struct my_biggy, t1));
		3462	}
		3463
		3464	static void
		3465	t2_cb (EV_P_ ev_timer *w, int revents)
		3466	{
		3467	struct my_biggy big = (struct my_biggy *)
		3468	(((char *)w) - offsetof (struct my_biggy, t2));
		3469	}
		3470
		3471	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
		3472
		3473	Often (especially in GUI toolkits) there are places where you have
		3474	I<modal> interaction, which is most easily implemented by recursively
		3475	invoking C<ev_run>.
		3476
		3477	This brings the problem of exiting - a callback might want to finish the
		3478	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
		3479	a modal "Are you sure?" dialog is still waiting), or just the nested one
		3480	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
		3481	other combination: In these cases, C<ev_break> will not work alone.
		3482
		3483	The solution is to maintain "break this loop" variable for each C<ev_run>
		3484	invocation, and use a loop around C<ev_run> until the condition is
		3485	triggered, using C<EVRUN_ONCE>:
		3486
		3487	// main loop
		3488	int exit_main_loop = 0;
		3489
		3490	while (!exit_main_loop)
		3491	ev_run (EV_DEFAULT_ EVRUN_ONCE);
		3492
		3493	// in a model watcher
		3494	int exit_nested_loop = 0;
		3495
		3496	while (!exit_nested_loop)
		3497	ev_run (EV_A_ EVRUN_ONCE);
		3498
		3499	To exit from any of these loops, just set the corresponding exit variable:
		3500
		3501	// exit modal loop
		3502	exit_nested_loop = 1;
		3503
		3504	// exit main program, after modal loop is finished
		3505	exit_main_loop = 1;
		3506
		3507	// exit both
		3508	exit_main_loop = exit_nested_loop = 1;
		3509
		3510	=head2 THREAD LOCKING EXAMPLE
		3511
		3512	Here is a fictitious example of how to run an event loop in a different
		3513	thread from where callbacks are being invoked and watchers are
		3514	created/added/removed.
		3515
		3516	For a real-world example, see the C<EV::Loop::Async> perl module,
		3517	which uses exactly this technique (which is suited for many high-level
		3518	languages).
		3519
		3520	The example uses a pthread mutex to protect the loop data, a condition
		3521	variable to wait for callback invocations, an async watcher to notify the
		3522	event loop thread and an unspecified mechanism to wake up the main thread.
		3523
		3524	First, you need to associate some data with the event loop:
		3525
		3526	typedef struct {
		3527	mutex_t lock; /* global loop lock */
		3528	ev_async async_w;
		3529	thread_t tid;
		3530	cond_t invoke_cv;
		3531	} userdata;
		3532
		3533	void prepare_loop (EV_P)
		3534	{
		3535	// for simplicity, we use a static userdata struct.
		3536	static userdata u;
		3537
		3538	ev_async_init (&u->async_w, async_cb);
		3539	ev_async_start (EV_A_ &u->async_w);
		3540
		3541	pthread_mutex_init (&u->lock, 0);
		3542	pthread_cond_init (&u->invoke_cv, 0);
		3543
		3544	// now associate this with the loop
		3545	ev_set_userdata (EV_A_ u);
		3546	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3547	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3548
		3549	// then create the thread running ev_loop
		3550	pthread_create (&u->tid, 0, l_run, EV_A);
		3551	}
		3552
		3553	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3554	solely to wake up the event loop so it takes notice of any new watchers
		3555	that might have been added:
		3556
		3557	static void
		3558	async_cb (EV_P_ ev_async *w, int revents)
		3559	{
		3560	// just used for the side effects
		3561	}
		3562
		3563	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3564	protecting the loop data, respectively.
		3565
		3566	static void
		3567	l_release (EV_P)
		3568	{
		3569	userdata *u = ev_userdata (EV_A);
		3570	pthread_mutex_unlock (&u->lock);
		3571	}
		3572
		3573	static void
		3574	l_acquire (EV_P)
		3575	{
		3576	userdata *u = ev_userdata (EV_A);
		3577	pthread_mutex_lock (&u->lock);
		3578	}
		3579
		3580	The event loop thread first acquires the mutex, and then jumps straight
		3581	into C<ev_run>:
		3582
		3583	void *
		3584	l_run (void *thr_arg)
		3585	{
		3586	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		3587
		3588	l_acquire (EV_A);
		3589	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3590	ev_run (EV_A_ 0);
		3591	l_release (EV_A);
		3592
		3593	return 0;
		3594	}
		3595
		3596	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3597	signal the main thread via some unspecified mechanism (signals? pipe
		3598	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3599	have been called (in a while loop because a) spurious wakeups are possible
		3600	and b) skipping inter-thread-communication when there are no pending
		3601	watchers is very beneficial):
		3602
		3603	static void
		3604	l_invoke (EV_P)
		3605	{
		3606	userdata *u = ev_userdata (EV_A);
		3607
		3608	while (ev_pending_count (EV_A))
		3609	{
		3610	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3611	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3612	}
		3613	}
		3614
		3615	Now, whenever the main thread gets told to invoke pending watchers, it
		3616	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3617	thread to continue:
		3618
		3619	static void
		3620	real_invoke_pending (EV_P)
		3621	{
		3622	userdata *u = ev_userdata (EV_A);
		3623
		3624	pthread_mutex_lock (&u->lock);
		3625	ev_invoke_pending (EV_A);
		3626	pthread_cond_signal (&u->invoke_cv);
		3627	pthread_mutex_unlock (&u->lock);
		3628	}
		3629
		3630	Whenever you want to start/stop a watcher or do other modifications to an
		3631	event loop, you will now have to lock:
		3632
		3633	ev_timer timeout_watcher;
		3634	userdata *u = ev_userdata (EV_A);
		3635
		3636	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3637
		3638	pthread_mutex_lock (&u->lock);
		3639	ev_timer_start (EV_A_ &timeout_watcher);
		3640	ev_async_send (EV_A_ &u->async_w);
		3641	pthread_mutex_unlock (&u->lock);
		3642
		3643	Note that sending the C<ev_async> watcher is required because otherwise
		3644	an event loop currently blocking in the kernel will have no knowledge
		3645	about the newly added timer. By waking up the loop it will pick up any new
		3646	watchers in the next event loop iteration.
		3647
		3648	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3649
		3650	While the overhead of a callback that e.g. schedules a thread is small, it
		3651	is still an overhead. If you embed libev, and your main usage is with some
		3652	kind of threads or coroutines, you might want to customise libev so that
		3653	doesn't need callbacks anymore.
		3654
		3655	Imagine you have coroutines that you can switch to using a function
		3656	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3657	and that due to some magic, the currently active coroutine is stored in a
		3658	global called C<current_coro>. Then you can build your own "wait for libev
		3659	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3660	the differing C<;> conventions):
		3661
		3662	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3663	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3664
		3665	That means instead of having a C callback function, you store the
		3666	coroutine to switch to in each watcher, and instead of having libev call
		3667	your callback, you instead have it switch to that coroutine.
		3668
		3669	A coroutine might now wait for an event with a function called
		3670	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		3671	matter when, or whether the watcher is active or not when this function is
		3672	called):
		3673
		3674	void
		3675	wait_for_event (ev_watcher *w)
		3676	{
		3677	ev_cb_set (w) = current_coro;
		3678	switch_to (libev_coro);
		3679	}
		3680
		3681	That basically suspends the coroutine inside C<wait_for_event> and
		3682	continues the libev coroutine, which, when appropriate, switches back to
		3683	this or any other coroutine. I am sure if you sue this your own :)
		3684
		3685	You can do similar tricks if you have, say, threads with an event queue -
		3686	instead of storing a coroutine, you store the queue object and instead of
		3687	switching to a coroutine, you push the watcher onto the queue and notify
		3688	any waiters.
		3689
		3690	To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two
		3691	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		3692
		3693	// my_ev.h
		3694	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3695	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
		3696	#include "../libev/ev.h"
		3697
		3698	// my_ev.c
		3699	#define EV_H "my_ev.h"
		3700	#include "../libev/ev.c"
		3701
		3702	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		3703	F<my_ev.c> into your project. When properly specifying include paths, you
		3704	can even use F<ev.h> as header file name directly.
3235		3705
3236		3706
3237	=head1 LIBEVENT EMULATION	3707	=head1 LIBEVENT EMULATION
3238		3708
3239	Libev offers a compatibility emulation layer for libevent. It cannot	3709	Libev offers a compatibility emulation layer for libevent. It cannot
3240	emulate the internals of libevent, so here are some usage hints:	3710	emulate the internals of libevent, so here are some usage hints:
3241		3711
3242	=over 4	3712	=over 4
		3713
		3714	=item * Only the libevent-1.4.1-beta API is being emulated.
		3715
		3716	This was the newest libevent version available when libev was implemented,
		3717	and is still mostly unchanged in 2010.
3243		3718
3244	=item * Use it by including <event.h>, as usual.	3719	=item * Use it by including <event.h>, as usual.
3245		3720
3246	=item * The following members are fully supported: ev_base, ev_callback,	3721	=item * The following members are fully supported: ev_base, ev_callback,
3247	ev_arg, ev_fd, ev_res, ev_events.	3722	ev_arg, ev_fd, ev_res, ev_events.
…		…
3253	=item * Priorities are not currently supported. Initialising priorities	3728	=item * Priorities are not currently supported. Initialising priorities
3254	will fail and all watchers will have the same priority, even though there	3729	will fail and all watchers will have the same priority, even though there
3255	is an ev_pri field.	3730	is an ev_pri field.
3256		3731
3257	=item * In libevent, the last base created gets the signals, in libev, the	3732	=item * In libevent, the last base created gets the signals, in libev, the
3258	first base created (== the default loop) gets the signals.	3733	base that registered the signal gets the signals.
3259		3734
3260	=item * Other members are not supported.	3735	=item * Other members are not supported.
3261		3736
3262	=item * The libev emulation is I<not> ABI compatible to libevent, you need	3737	=item * The libev emulation is I<not> ABI compatible to libevent, you need
3263	to use the libev header file and library.	3738	to use the libev header file and library.
…		…
3282	Care has been taken to keep the overhead low. The only data member the C++	3757	Care has been taken to keep the overhead low. The only data member the C++
3283	classes add (compared to plain C-style watchers) is the event loop pointer	3758	classes add (compared to plain C-style watchers) is the event loop pointer
3284	that the watcher is associated with (or no additional members at all if	3759	that the watcher is associated with (or no additional members at all if
3285	you disable C<EV_MULTIPLICITY> when embedding libev).	3760	you disable C<EV_MULTIPLICITY> when embedding libev).
3286		3761
3287	Currently, functions, and static and non-static member functions can be	3762	Currently, functions, static and non-static member functions and classes
3288	used as callbacks. Other types should be easy to add as long as they only	3763	with C<operator ()> can be used as callbacks. Other types should be easy
3289	need one additional pointer for context. If you need support for other	3764	to add as long as they only need one additional pointer for context. If
3290	types of functors please contact the author (preferably after implementing	3765	you need support for other types of functors please contact the author
3291	it).	3766	(preferably after implementing it).
3292		3767
3293	Here is a list of things available in the C<ev> namespace:	3768	Here is a list of things available in the C<ev> namespace:
3294		3769
3295	=over 4	3770	=over 4
3296		3771
…		…
4164	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4639	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
4165		4640
4166	#include "ev_cpp.h"	4641	#include "ev_cpp.h"
4167	#include "ev.c"	4642	#include "ev.c"
4168		4643
4169	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	4644	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
4170		4645
4171	=head2 THREADS AND COROUTINES	4646	=head2 THREADS AND COROUTINES
4172		4647
4173	=head3 THREADS	4648	=head3 THREADS
4174		4649
…		…
4225	default loop and triggering an C<ev_async> watcher from the default loop	4700	default loop and triggering an C<ev_async> watcher from the default loop
4226	watcher callback into the event loop interested in the signal.	4701	watcher callback into the event loop interested in the signal.
4227		4702
4228	=back	4703	=back
4229		4704
4230	=head4 THREAD LOCKING EXAMPLE	4705	See also L<THREAD LOCKING EXAMPLE>.
4231
4232	Here is a fictitious example of how to run an event loop in a different
4233	thread than where callbacks are being invoked and watchers are
4234	created/added/removed.
4235
4236	For a real-world example, see the C<EV::Loop::Async> perl module,
4237	which uses exactly this technique (which is suited for many high-level
4238	languages).
4239
4240	The example uses a pthread mutex to protect the loop data, a condition
4241	variable to wait for callback invocations, an async watcher to notify the
4242	event loop thread and an unspecified mechanism to wake up the main thread.
4243
4244	First, you need to associate some data with the event loop:
4245
4246	typedef struct {
4247	mutex_t lock; /* global loop lock */
4248	ev_async async_w;
4249	thread_t tid;
4250	cond_t invoke_cv;
4251	} userdata;
4252
4253	void prepare_loop (EV_P)
4254	{
4255	// for simplicity, we use a static userdata struct.
4256	static userdata u;
4257
4258	ev_async_init (&u->async_w, async_cb);
4259	ev_async_start (EV_A_ &u->async_w);
4260
4261	pthread_mutex_init (&u->lock, 0);
4262	pthread_cond_init (&u->invoke_cv, 0);
4263
4264	// now associate this with the loop
4265	ev_set_userdata (EV_A_ u);
4266	ev_set_invoke_pending_cb (EV_A_ l_invoke);
4267	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4268
4269	// then create the thread running ev_loop
4270	pthread_create (&u->tid, 0, l_run, EV_A);
4271	}
4272
4273	The callback for the C<ev_async> watcher does nothing: the watcher is used
4274	solely to wake up the event loop so it takes notice of any new watchers
4275	that might have been added:
4276
4277	static void
4278	async_cb (EV_P_ ev_async *w, int revents)
4279	{
4280	// just used for the side effects
4281	}
4282
4283	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4284	protecting the loop data, respectively.
4285
4286	static void
4287	l_release (EV_P)
4288	{
4289	userdata *u = ev_userdata (EV_A);
4290	pthread_mutex_unlock (&u->lock);
4291	}
4292
4293	static void
4294	l_acquire (EV_P)
4295	{
4296	userdata *u = ev_userdata (EV_A);
4297	pthread_mutex_lock (&u->lock);
4298	}
4299
4300	The event loop thread first acquires the mutex, and then jumps straight
4301	into C<ev_run>:
4302
4303	void *
4304	l_run (void *thr_arg)
4305	{
4306	struct ev_loop *loop = (struct ev_loop *)thr_arg;
4307
4308	l_acquire (EV_A);
4309	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4310	ev_run (EV_A_ 0);
4311	l_release (EV_A);
4312
4313	return 0;
4314	}
4315
4316	Instead of invoking all pending watchers, the C<l_invoke> callback will
4317	signal the main thread via some unspecified mechanism (signals? pipe
4318	writes? C<Async::Interrupt>?) and then waits until all pending watchers
4319	have been called (in a while loop because a) spurious wakeups are possible
4320	and b) skipping inter-thread-communication when there are no pending
4321	watchers is very beneficial):
4322
4323	static void
4324	l_invoke (EV_P)
4325	{
4326	userdata *u = ev_userdata (EV_A);
4327
4328	while (ev_pending_count (EV_A))
4329	{
4330	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4331	pthread_cond_wait (&u->invoke_cv, &u->lock);
4332	}
4333	}
4334
4335	Now, whenever the main thread gets told to invoke pending watchers, it
4336	will grab the lock, call C<ev_invoke_pending> and then signal the loop
4337	thread to continue:
4338
4339	static void
4340	real_invoke_pending (EV_P)
4341	{
4342	userdata *u = ev_userdata (EV_A);
4343
4344	pthread_mutex_lock (&u->lock);
4345	ev_invoke_pending (EV_A);
4346	pthread_cond_signal (&u->invoke_cv);
4347	pthread_mutex_unlock (&u->lock);
4348	}
4349
4350	Whenever you want to start/stop a watcher or do other modifications to an
4351	event loop, you will now have to lock:
4352
4353	ev_timer timeout_watcher;
4354	userdata *u = ev_userdata (EV_A);
4355
4356	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4357
4358	pthread_mutex_lock (&u->lock);
4359	ev_timer_start (EV_A_ &timeout_watcher);
4360	ev_async_send (EV_A_ &u->async_w);
4361	pthread_mutex_unlock (&u->lock);
4362
4363	Note that sending the C<ev_async> watcher is required because otherwise
4364	an event loop currently blocking in the kernel will have no knowledge
4365	about the newly added timer. By waking up the loop it will pick up any new
4366	watchers in the next event loop iteration.
4367		4706
4368	=head3 COROUTINES	4707	=head3 COROUTINES
4369		4708
4370	Libev is very accommodating to coroutines ("cooperative threads"):	4709	Libev is very accommodating to coroutines ("cooperative threads"):
4371	libev fully supports nesting calls to its functions from different	4710	libev fully supports nesting calls to its functions from different
…		…
4467	=head3 C<kqueue> is buggy	4806	=head3 C<kqueue> is buggy
4468		4807
4469	The kqueue syscall is broken in all known versions - most versions support	4808	The kqueue syscall is broken in all known versions - most versions support
4470	only sockets, many support pipes.	4809	only sockets, many support pipes.
4471		4810
4472	Libev tries to work around this by not using C<kqueue> by default on	4811	Libev tries to work around this by not using C<kqueue> by default on this
4473	this rotten platform, but of course you can still ask for it when creating	4812	rotten platform, but of course you can still ask for it when creating a
4474	a loop.	4813	loop - embedding a socket-only kqueue loop into a select-based one is
		4814	probably going to work well.
4475		4815
4476	=head3 C<poll> is buggy	4816	=head3 C<poll> is buggy
4477		4817
4478	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>	4818	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
4479	implementation by something calling C<kqueue> internally around the 10.5.6	4819	implementation by something calling C<kqueue> internally around the 10.5.6
…		…
4498		4838
4499	=head3 C<errno> reentrancy	4839	=head3 C<errno> reentrancy
4500		4840
4501	The default compile environment on Solaris is unfortunately so	4841	The default compile environment on Solaris is unfortunately so
4502	thread-unsafe that you can't even use components/libraries compiled	4842	thread-unsafe that you can't even use components/libraries compiled
4503	without C<-D_REENTRANT> (as long as they use C<errno>), which, of course,	4843	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
4504	isn't defined by default.	4844	defined by default. A valid, if stupid, implementation choice.
4505		4845
4506	If you want to use libev in threaded environments you have to make sure	4846	If you want to use libev in threaded environments you have to make sure
4507	it's compiled with C<_REENTRANT> defined.	4847	it's compiled with C<_REENTRANT> defined.
4508		4848
4509	=head3 Event port backend	4849	=head3 Event port backend
4510		4850
4511	The scalable event interface for Solaris is called "event ports". Unfortunately,	4851	The scalable event interface for Solaris is called "event
4512	this mechanism is very buggy. If you run into high CPU usage, your program	4852	ports". Unfortunately, this mechanism is very buggy in all major
		4853	releases. If you run into high CPU usage, your program freezes or you get
4513	freezes or you get a large number of spurious wakeups, make sure you have	4854	a large number of spurious wakeups, make sure you have all the relevant
4514	all the relevant and latest kernel patches applied. No, I don't know which	4855	and latest kernel patches applied. No, I don't know which ones, but there
4515	ones, but there are multiple ones.	4856	are multiple ones to apply, and afterwards, event ports actually work
		4857	great.
4516		4858
4517	If you can't get it to work, you can try running the program by setting	4859	If you can't get it to work, you can try running the program by setting
4518	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and	4860	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
4519	C<select> backends.	4861	C<select> backends.
4520		4862
4521	=head2 AIX POLL BUG	4863	=head2 AIX POLL BUG
4522		4864
4523	AIX unfortunately has a broken C<poll.h> header. Libev works around	4865	AIX unfortunately has a broken C<poll.h> header. Libev works around
4524	this by trying to avoid the poll backend altogether (i.e. it's not even	4866	this by trying to avoid the poll backend altogether (i.e. it's not even
4525	compiled in), which normally isn't a big problem as C<select> works fine	4867	compiled in), which normally isn't a big problem as C<select> works fine
4526	with large bitsets, and AIX is dead anyway.	4868	with large bitsets on AIX, and AIX is dead anyway.
4527		4869
4528	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	4870	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
4529		4871
4530	=head3 General issues	4872	=head3 General issues
4531		4873
…		…
4637	structure (guaranteed by POSIX but not by ISO C for example), but it also	4979	structure (guaranteed by POSIX but not by ISO C for example), but it also
4638	assumes that the same (machine) code can be used to call any watcher	4980	assumes that the same (machine) code can be used to call any watcher
4639	callback: The watcher callbacks have different type signatures, but libev	4981	callback: The watcher callbacks have different type signatures, but libev
4640	calls them using an C<ev_watcher *> internally.	4982	calls them using an C<ev_watcher *> internally.
4641		4983
		4984	=item pointer accesses must be thread-atomic
		4985
		4986	Accessing a pointer value must be atomic, it must both be readable and
		4987	writable in one piece - this is the case on all current architectures.
		4988
4642	=item C<sig_atomic_t volatile> must be thread-atomic as well	4989	=item C<sig_atomic_t volatile> must be thread-atomic as well
4643		4990
4644	The type C<sig_atomic_t volatile> (or whatever is defined as	4991	The type C<sig_atomic_t volatile> (or whatever is defined as
4645	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different	4992	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
4646	threads. This is not part of the specification for C<sig_atomic_t>, but is	4993	threads. This is not part of the specification for C<sig_atomic_t>, but is
…		…
4752	=back	5099	=back
4753		5100
4754		5101
4755	=head1 PORTING FROM LIBEV 3.X TO 4.X	5102	=head1 PORTING FROM LIBEV 3.X TO 4.X
4756		5103
4757	The major version 4 introduced some minor incompatible changes to the API.	5104	The major version 4 introduced some incompatible changes to the API.
4758		5105
4759	At the moment, the C<ev.h> header file tries to implement superficial	5106	At the moment, the C<ev.h> header file provides compatibility definitions
4760	compatibility, so most programs should still compile. Those might be	5107	for all changes, so most programs should still compile. The compatibility
4761	removed in later versions of libev, so better update early than late.	5108	layer might be removed in later versions of libev, so better update to the
		5109	new API early than late.
4762		5110
4763	=over 4	5111	=over 4
		5112
		5113	=item C<EV_COMPAT3> backwards compatibility mechanism
		5114
		5115	The backward compatibility mechanism can be controlled by
		5116	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		5117	section.
		5118
		5119	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		5120
		5121	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		5122
		5123	ev_loop_destroy (EV_DEFAULT_UC);
		5124	ev_loop_fork (EV_DEFAULT);
4764		5125
4765	=item function/symbol renames	5126	=item function/symbol renames
4766		5127
4767	A number of functions and symbols have been renamed:	5128	A number of functions and symbols have been renamed:
4768		5129
…		…
4787	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme	5148	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
4788	as all other watcher types. Note that C<ev_loop_fork> is still called	5149	as all other watcher types. Note that C<ev_loop_fork> is still called
4789	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>	5150	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
4790	typedef.	5151	typedef.
4791		5152
4792	=item C<EV_COMPAT3> backwards compatibility mechanism
4793
4794	The backward compatibility mechanism can be controlled by
4795	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
4796	section.
4797
4798	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>	5153	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
4799		5154
4800	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different	5155	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
4801	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile	5156	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
4802	and work, but the library code will of course be larger.	5157	and work, but the library code will of course be larger.
…		…
4808		5163
4809	=over 4	5164	=over 4
4810		5165
4811	=item active	5166	=item active
4812		5167
4813	A watcher is active as long as it has been started (has been attached to	5168	A watcher is active as long as it has been started and not yet stopped.
4814	an event loop) but not yet stopped (disassociated from the event loop).	5169	See L<WATCHER STATES> for details.
4815		5170
4816	=item application	5171	=item application
4817		5172
4818	In this document, an application is whatever is using libev.	5173	In this document, an application is whatever is using libev.
		5174
		5175	=item backend
		5176
		5177	The part of the code dealing with the operating system interfaces.
4819		5178
4820	=item callback	5179	=item callback
4821		5180
4822	The address of a function that is called when some event has been	5181	The address of a function that is called when some event has been
4823	detected. Callbacks are being passed the event loop, the watcher that	5182	detected. Callbacks are being passed the event loop, the watcher that
4824	received the event, and the actual event bitset.	5183	received the event, and the actual event bitset.
4825		5184
4826	=item callback invocation	5185	=item callback/watcher invocation
4827		5186
4828	The act of calling the callback associated with a watcher.	5187	The act of calling the callback associated with a watcher.
4829		5188
4830	=item event	5189	=item event
4831		5190
…		…
4850	The model used to describe how an event loop handles and processes	5209	The model used to describe how an event loop handles and processes
4851	watchers and events.	5210	watchers and events.
4852		5211
4853	=item pending	5212	=item pending
4854		5213
4855	A watcher is pending as soon as the corresponding event has been detected,	5214	A watcher is pending as soon as the corresponding event has been
4856	and stops being pending as soon as the watcher will be invoked or its	5215	detected. See L<WATCHER STATES> for details.
4857	pending status is explicitly cleared by the application.
4858
4859	A watcher can be pending, but not active. Stopping a watcher also clears
4860	its pending status.
4861		5216
4862	=item real time	5217	=item real time
4863		5218
4864	The physical time that is observed. It is apparently strictly monotonic :)	5219	The physical time that is observed. It is apparently strictly monotonic :)
4865		5220
…		…
4872	=item watcher	5227	=item watcher
4873		5228
4874	A data structure that describes interest in certain events. Watchers need	5229	A data structure that describes interest in certain events. Watchers need
4875	to be started (attached to an event loop) before they can receive events.	5230	to be started (attached to an event loop) before they can receive events.
4876		5231
4877	=item watcher invocation
4878
4879	The act of calling the callback associated with a watcher.
4880
4881	=back	5232	=back
4882		5233
4883	=head1 AUTHOR	5234	=head1 AUTHOR
4884		5235
4885	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5236	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5237	Magnusson and Emanuele Giaquinta.
4886		5238

Diff Legend

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