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.359 by root, Tue Jan 11 10:56:01 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	This flag's behaviour will become the default in future versions of libev.
387		448
388	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	449	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
389		450
390	This is your standard select(2) backend. Not I<completely> standard, as	451	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,	452	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).	488	epoll scales either O(1) or O(active_fds).
428		489
429	The epoll mechanism deserves honorable mention as the most misdesigned	490	The epoll mechanism deserves honorable mention as the most misdesigned
430	of the more advanced event mechanisms: mere annoyances include silently	491	of the more advanced event mechanisms: mere annoyances include silently
431	dropping file descriptors, requiring a system call per change per file	492	dropping file descriptors, requiring a system call per change per file
432	descriptor (and unnecessary guessing of parameters), problems with dup and	493	descriptor (and unnecessary guessing of parameters), problems with dup,
		494	returning before the timeout value, resulting in additional iterations
		495	(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	496	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	497	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	498	set, which can take considerable time (one syscall per file descriptor)
436	hard to detect.	499	and is of course hard to detect.
437		500
438	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	501	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	502	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	503	I<different> file descriptors (even already closed ones, so one cannot
441	even remove them from the set) than registered in the set (especially	504	even remove them from the set) than registered in the set (especially
…		…
443	employing an additional generation counter and comparing that against the	506	employing an additional generation counter and comparing that against the
444	events to filter out spurious ones, recreating the set when required. Last	507	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	508	not least, it also refuses to work with some file descriptors which work
446	perfectly fine with C<select> (files, many character devices...).	509	perfectly fine with C<select> (files, many character devices...).
447		510
		511	Epoll is truly the train wreck analog among event poll mechanisms,
		512	a frankenpoll, cobbled together in a hurry, no thought to design or
		513	interaction with others.
		514
448	While stopping, setting and starting an I/O watcher in the same iteration	515	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	516	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	517	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	518	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	519	file descriptors might not work very well if you register events for both
…		…
517	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	584	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
518		585
519	This uses the Solaris 10 event port mechanism. As with everything on Solaris,	586	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)).	587	it's really slow, but it still scales very well (O(active_fds)).
521		588
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	589	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	590	file descriptor per loop iteration. For small and medium numbers of file
528	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	591	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
529	might perform better.	592	might perform better.
530		593
531	On the positive side, with the exception of the spurious readiness	594	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	595	specification in all tests and is fully embeddable, which is a rare feat
534	OS-specific backends (I vastly prefer correctness over speed hacks).	596	among the OS-specific backends (I vastly prefer correctness over speed
		597	hacks).
		598
		599	On the negative side, the interface is I<bizarre> - so bizarre that
		600	even sun itself gets it wrong in their code examples: The event polling
		601	function sometimes returning events to the caller even though an error
		602	occurred, but with no indication whether it has done so or not (yes, it's
		603	even documented that way) - deadly for edge-triggered interfaces where
		604	you absolutely have to know whether an event occurred or not because you
		605	have to re-arm the watcher.
		606
		607	Fortunately libev seems to be able to work around these idiocies.
535		608
536	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	609	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
537	C<EVBACKEND_POLL>.	610	C<EVBACKEND_POLL>.
538		611
539	=item C<EVBACKEND_ALL>	612	=item C<EVBACKEND_ALL>
540		613
541	Try all backends (even potentially broken ones that wouldn't be tried	614	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	615	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
543	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	616	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
544		617
545	It is definitely not recommended to use this flag.	618	It is definitely not recommended to use this flag, use whatever
		619	C<ev_recommended_backends ()> returns, or simply do not specify a backend
		620	at all.
		621
		622	=item C<EVBACKEND_MASK>
		623
		624	Not a backend at all, but a mask to select all backend bits from a
		625	C<flags> value, in case you want to mask out any backends from a flags
		626	value (e.g. when modifying the C<LIBEV_FLAGS> environment variable).
546		627
547	=back	628	=back
548		629
549	If one or more of the backend flags are or'ed into the flags value,	630	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	631	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	632	here). If none are specified, all backends in C<ev_recommended_backends
552	()> will be tried.	633	()> will be tried.
553		634
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.	635	Example: Try to create a event loop that uses epoll and nothing else.
581		636
582	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	637	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
583	if (!epoller)	638	if (!epoller)
584	fatal ("no epoll found here, maybe it hides under your chair");	639	fatal ("no epoll found here, maybe it hides under your chair");
585		640
		641	Example: Use whatever libev has to offer, but make sure that kqueue is
		642	used if available.
		643
		644	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
		645
586	=item ev_default_destroy ()	646	=item ev_loop_destroy (loop)
587		647
588	Destroys the default loop (frees all memory and kernel state etc.). None	648	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	649	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	650	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,	651	responsibility to either stop all watchers cleanly yourself I<before>
592	or cope with the fact afterwards (which is usually the easiest thing, you	652	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).	653	the easiest thing, you can just ignore the watchers and/or C<free ()> them
		654	for example).
594		655
595	Note that certain global state, such as signal state (and installed signal	656	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	657	handlers), will not be freed by this function, and related watchers (such
597	as signal and child watchers) would need to be stopped manually.	658	as signal and child watchers) would need to be stopped manually.
598		659
599	In general it is not advisable to call this function except in the	660	This function is normally used on loop objects allocated by
600	rare occasion where you really need to free e.g. the signal handling	661	C<ev_loop_new>, but it can also be used on the default loop returned by
		662	C<ev_default_loop>, in which case it is not thread-safe.
		663
		664	Note that it is not advisable to call this function on the default loop
		665	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	666	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>.	667	and C<ev_loop_destroy>.
603		668
604	=item ev_loop_destroy (loop)	669	=item ev_loop_fork (loop)
605		670
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	671	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	672	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	673	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	674	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	675	child before resuming or calling C<ev_run>.
616	functions, and it will only take effect at the next C<ev_run> iteration.
617		676
618	Again, you I<have> to call it on I<any> loop that you want to re-use after	677	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	678	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	679	because some kernel interfaces *cough* I<kqueue> *cough* do funny things
621	during fork.	680	during fork.
…		…
626	call it at all (in fact, C<epoll> is so badly broken that it makes a	685	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	686	difference, but libev will usually detect this case on its own and do a
628	costly reset of the backend).	687	costly reset of the backend).
629		688
630	The function itself is quite fast and it's usually not a problem to call	689	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	690	it just in case after a fork.
632	quite nicely into a call to C<pthread_atfork>:
633		691
		692	Example: Automate calling C<ev_loop_fork> on the default loop when
		693	using pthreads.
		694
		695	static void
		696	post_fork_child (void)
		697	{
		698	ev_loop_fork (EV_DEFAULT);
		699	}
		700
		701	...
634	pthread_atfork (0, 0, ev_default_fork);	702	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		703
643	=item int ev_is_default_loop (loop)	704	=item int ev_is_default_loop (loop)
644		705
645	Returns true when the given loop is, in fact, the default loop, and false	706	Returns true when the given loop is, in fact, the default loop, and false
646	otherwise.	707	otherwise.
…		…
657	prepare and check phases.	718	prepare and check phases.
658		719
659	=item unsigned int ev_depth (loop)	720	=item unsigned int ev_depth (loop)
660		721
661	Returns the number of times C<ev_run> was entered minus the number of	722	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.	723	times C<ev_run> was exited normally, in other words, the recursion depth.
663		724
664	Outside C<ev_run>, this number is zero. In a callback, this number is	725	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),	726	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
666	in which case it is higher.	727	in which case it is higher.
667		728
668	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread	729	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	730	throwing an exception etc.), doesn't count as "exit" - consider this
670	ungentleman-like behaviour unless it's really convenient.	731	as a hint to avoid such ungentleman-like behaviour unless it's really
		732	convenient, in which case it is fully supported.
671		733
672	=item unsigned int ev_backend (loop)	734	=item unsigned int ev_backend (loop)
673		735
674	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	736	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
675	use.	737	use.
…		…
736	relying on all watchers to be stopped when deciding when a program has	798	relying on all watchers to be stopped when deciding when a program has
737	finished (especially in interactive programs), but having a program	799	finished (especially in interactive programs), but having a program
738	that automatically loops as long as it has to and no longer by virtue	800	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	801	of relying on its watchers stopping correctly, that is truly a thing of
740	beauty.	802	beauty.
		803
		804	This function is also I<mostly> exception-safe - you can break out of
		805	a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
		806	exception and so on. This does not decrement the C<ev_depth> value, nor
		807	will it clear any outstanding C<EVBREAK_ONE> breaks.
741		808
742	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle	809	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	810	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	811	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	812	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	874	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	875	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	876	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.	877	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
811		878
812	This "unloop state" will be cleared when entering C<ev_run> again.	879	This "break state" will be cleared on the next call to C<ev_run>.
813		880
814	It is safe to call C<ev_break> from outside any C<ev_run> calls. ##TODO##	881	It is safe to call C<ev_break> from outside any C<ev_run> calls, too, in
		882	which case it will have no effect.
815		883
816	=item ev_ref (loop)	884	=item ev_ref (loop)
817		885
818	=item ev_unref (loop)	886	=item ev_unref (loop)
819		887
…		…
840	running when nothing else is active.	908	running when nothing else is active.
841		909
842	ev_signal exitsig;	910	ev_signal exitsig;
843	ev_signal_init (&exitsig, sig_cb, SIGINT);	911	ev_signal_init (&exitsig, sig_cb, SIGINT);
844	ev_signal_start (loop, &exitsig);	912	ev_signal_start (loop, &exitsig);
845	evf_unref (loop);	913	ev_unref (loop);
846		914
847	Example: For some weird reason, unregister the above signal handler again.	915	Example: For some weird reason, unregister the above signal handler again.
848		916
849	ev_ref (loop);	917	ev_ref (loop);
850	ev_signal_stop (loop, &exitsig);	918	ev_signal_stop (loop, &exitsig);
…		…
908		976
909	=item ev_invoke_pending (loop)	977	=item ev_invoke_pending (loop)
910		978
911	This call will simply invoke all pending watchers while resetting their	979	This call will simply invoke all pending watchers while resetting their
912	pending state. Normally, C<ev_run> does this automatically when required,	980	pending state. Normally, C<ev_run> does this automatically when required,
913	but when overriding the invoke callback this call comes handy.	981	but when overriding the invoke callback this call comes handy. This
		982	function can be invoked from a watcher - this can be useful for example
		983	when you want to do some lengthy calculation and want to pass further
		984	event handling to another thread (you still have to make sure only one
		985	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
914		986
915	=item int ev_pending_count (loop)	987	=item int ev_pending_count (loop)
916		988
917	Returns the number of pending watchers - zero indicates that no watchers	989	Returns the number of pending watchers - zero indicates that no watchers
918	are pending.	990	are pending.
…		…
958	See also the locking example in the C<THREADS> section later in this	1030	See also the locking example in the C<THREADS> section later in this
959	document.	1031	document.
960		1032
961	=item ev_set_userdata (loop, void *data)	1033	=item ev_set_userdata (loop, void *data)
962		1034
963	=item ev_userdata (loop)	1035	=item void *ev_userdata (loop)
964		1036
965	Set and retrieve a single C<void *> associated with a loop. When	1037	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	1038	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
967	C<0.>	1039	C<0>.
968		1040
969	These two functions can be used to associate arbitrary data with a loop,	1041	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	1042	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	1043	C<acquire> callbacks described above, but of course can be (ab-)used for
972	any other purpose as well.	1044	any other purpose as well.
…		…
990		1062
991	In the following description, uppercase C<TYPE> in names stands for the	1063	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	1064	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.	1065	watchers and C<ev_io_start> for I/O watchers.
994		1066
995	A watcher is a structure that you create and register to record your	1067	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	1068	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:	1069	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1070	for that:
998		1071
999	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)	1072	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
1000	{	1073	{
1001	ev_io_stop (w);	1074	ev_io_stop (w);
1002	ev_break (loop, EVBREAK_ALL);	1075	ev_break (loop, EVBREAK_ALL);
…		…
1017	stack).	1090	stack).
1018		1091
1019	Each watcher has an associated watcher structure (called C<struct ev_TYPE>	1092	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).	1093	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
1021		1094
1022	Each watcher structure must be initialised by a call to C<ev_init	1095	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	1096	*, 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	1097	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	1098	time the event loop detects that the file descriptor given is readable
1026	is readable and/or writable).	1099	and/or writable).
1027		1100
1028	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>	1101	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	1102	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<<	1103	is also a macro to combine initialisation and setting in one call: C<<
1031	ev_TYPE_init (watcher *, callback, ...) >>.	1104	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
1099	=item C<EV_FORK>	1172	=item C<EV_FORK>
1100		1173
1101	The event loop has been resumed in the child process after fork (see	1174	The event loop has been resumed in the child process after fork (see
1102	C<ev_fork>).	1175	C<ev_fork>).
1103		1176
		1177	=item C<EV_CLEANUP>
		1178
		1179	The event loop is about to be destroyed (see C<ev_cleanup>).
		1180
1104	=item C<EV_ASYNC>	1181	=item C<EV_ASYNC>
1105		1182
1106	The given async watcher has been asynchronously notified (see C<ev_async>).	1183	The given async watcher has been asynchronously notified (see C<ev_async>).
1107		1184
1108	=item C<EV_CUSTOM>	1185	=item C<EV_CUSTOM>
…		…
1280	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related	1357	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1281	functions that do not need a watcher.	1358	functions that do not need a watcher.
1282		1359
1283	=back	1360	=back
1284		1361
		1362	See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
		1363	OWN COMPOSITE WATCHERS> idioms.
1285		1364
1286	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1365	=head2 WATCHER STATES
1287		1366
1288	Each watcher has, by default, a member C<void *data> that you can change	1367	There are various watcher states mentioned throughout this manual -
1289	and read at any time: libev will completely ignore it. This can be used	1368	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	1369	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	1370	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		1371
1295	struct my_io	1372	=over 4
1296	{
1297	ev_io io;
1298	int otherfd;
1299	void *somedata;
1300	struct whatever *mostinteresting;
1301	};
1302		1373
1303	...	1374	=item initialiased
1304	struct my_io w;
1305	ev_io_init (&w.io, my_cb, fd, EV_READ);
1306		1375
1307	And since your callback will be called with a pointer to the watcher, you	1376	Before a watcher can be registered with the event looop it has to be
1308	can cast it back to your own type:	1377	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1378	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1309		1379
1310	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)	1380	In this state it is simply some block of memory that is suitable for use
1311	{	1381	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		1382
1316	More interesting and less C-conformant ways of casting your callback type	1383	=item started/running/active
1317	instead have been omitted.
1318		1384
1319	Another common scenario is to use some data structure with multiple	1385	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1320	embedded watchers:	1386	property of the event loop, and is actively waiting for events. While in
		1387	this state it cannot be accessed (except in a few documented ways), moved,
		1388	freed or anything else - the only legal thing is to keep a pointer to it,
		1389	and call libev functions on it that are documented to work on active watchers.
1321		1390
1322	struct my_biggy	1391	=item pending
1323	{
1324	int some_data;
1325	ev_timer t1;
1326	ev_timer t2;
1327	}
1328		1392
1329	In this case getting the pointer to C<my_biggy> is a bit more	1393	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	1394	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	1395	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	1396	about to be invoked, so it is not normally pending inside the watcher
1333	programmers):	1397	callback.
1334		1398
1335	#include <stddef.h>	1399	The watcher might or might not be active while it is pending (for example,
		1400	an expired non-repeating timer can be pending but no longer active). If it
		1401	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1402	but it is still property of the event loop at this time, so cannot be
		1403	moved, freed or reused. And if it is active the rules described in the
		1404	previous item still apply.
1336		1405
1337	static void	1406	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)	1407	via C<ev_feed_event>), in which case it becomes pending without being
1339	{	1408	active.
1340	struct my_biggy big = (struct my_biggy *)
1341	(((char *)w) - offsetof (struct my_biggy, t1));
1342	}
1343		1409
1344	static void	1410	=item stopped
1345	t2_cb (EV_P_ ev_timer *w, int revents)	1411
1346	{	1412	A watcher can be stopped implicitly by libev (in which case it might still
1347	struct my_biggy big = (struct my_biggy *)	1413	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
1348	(((char *)w) - offsetof (struct my_biggy, t2));	1414	latter will clear any pending state the watcher might be in, regardless
1349	}	1415	of whether it was active or not, so stopping a watcher explicitly before
		1416	freeing it is often a good idea.
		1417
		1418	While stopped (and not pending) the watcher is essentially in the
		1419	initialised state, that is it can be reused, moved, modified in any way
		1420	you wish.
		1421
		1422	=back
1350		1423
1351	=head2 WATCHER PRIORITY MODELS	1424	=head2 WATCHER PRIORITY MODELS
1352		1425
1353	Many event loops support I<watcher priorities>, which are usually small	1426	Many event loops support I<watcher priorities>, which are usually small
1354	integers that influence the ordering of event callback invocation	1427	integers that influence the ordering of event callback invocation
…		…
1481	In general you can register as many read and/or write event watchers per	1554	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	1555	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	1556	descriptors to non-blocking mode is also usually a good idea (but not
1484	required if you know what you are doing).	1557	required if you know what you are doing).
1485		1558
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	1559	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	1560	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	1561	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	1562	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	1563	with a relatively standard program structure. Thus it is best to always
1497	this situation even with a relatively standard program structure. Thus	1564	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.	1565	preferable to a program hanging until some data arrives.
1500		1566
1501	If you cannot run the fd in non-blocking mode (for example you should	1567	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	1568	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	1569	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	1570	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	1571	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	1572	use C<SIGALRM> and an interval timer, just to be sure you won't block
1507	indefinitely.	1573	indefinitely.
1508		1574
1509	But really, best use non-blocking mode.	1575	But really, best use non-blocking mode.
1510		1576
…		…
1538		1604
1539	There is no workaround possible except not registering events	1605	There is no workaround possible except not registering events
1540	for potentially C<dup ()>'ed file descriptors, or to resort to	1606	for potentially C<dup ()>'ed file descriptors, or to resort to
1541	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1607	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1542		1608
		1609	=head3 The special problem of files
		1610
		1611	Many people try to use C<select> (or libev) on file descriptors
		1612	representing files, and expect it to become ready when their program
		1613	doesn't block on disk accesses (which can take a long time on their own).
		1614
		1615	However, this cannot ever work in the "expected" way - you get a readiness
		1616	notification as soon as the kernel knows whether and how much data is
		1617	there, and in the case of open files, that's always the case, so you
		1618	always get a readiness notification instantly, and your read (or possibly
		1619	write) will still block on the disk I/O.
		1620
		1621	Another way to view it is that in the case of sockets, pipes, character
		1622	devices and so on, there is another party (the sender) that delivers data
		1623	on its own, but in the case of files, there is no such thing: the disk
		1624	will not send data on its own, simply because it doesn't know what you
		1625	wish to read - you would first have to request some data.
		1626
		1627	Since files are typically not-so-well supported by advanced notification
		1628	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1629	to files, even though you should not use it. The reason for this is
		1630	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1631	usually a tty, often a pipe, but also sometimes files or special devices
		1632	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1633	F</dev/urandom>), and even though the file might better be served with
		1634	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1635	it "just works" instead of freezing.
		1636
		1637	So avoid file descriptors pointing to files when you know it (e.g. use
		1638	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1639	when you rarely read from a file instead of from a socket, and want to
		1640	reuse the same code path.
		1641
1543	=head3 The special problem of fork	1642	=head3 The special problem of fork
1544		1643
1545	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1644	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	1645	useless behaviour. Libev fully supports fork, but needs to be told about
1547	it in the child.	1646	it in the child if you want to continue to use it in the child.
1548		1647
1549	To support fork in your programs, you either have to call	1648	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,	1649	()> 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	1650	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1552	C<EVBACKEND_POLL>.
1553		1651
1554	=head3 The special problem of SIGPIPE	1652	=head3 The special problem of SIGPIPE
1555		1653
1556	While not really specific to libev, it is easy to forget about C<SIGPIPE>:	1654	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	1655	when writing to a pipe whose other end has been closed, your program gets
…		…
2173		2271
2174	=head2 C<ev_signal> - signal me when a signal gets signalled!	2272	=head2 C<ev_signal> - signal me when a signal gets signalled!
2175		2273
2176	Signal watchers will trigger an event when the process receives a specific	2274	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	2275	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	2276	will try its best to deliver signals synchronously, i.e. as part of the
2179	normal event processing, like any other event.	2277	normal event processing, like any other event.
2180		2278
2181	If you want signals to be delivered truly asynchronously, just use	2279	If you want signals to be delivered truly asynchronously, just use
2182	C<sigaction> as you would do without libev and forget about sharing	2280	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	2281	the signal. You can even use C<ev_async> from a signal handler to
…		…
2225	I<has> to modify the signal mask, at least temporarily.	2323	I<has> to modify the signal mask, at least temporarily.
2226		2324
2227	So I can't stress this enough: I<If you do not reset your signal mask when	2325	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	2326	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.	2327	is not a libev-specific thing, this is true for most event libraries.
		2328
		2329	=head3 The special problem of threads signal handling
		2330
		2331	POSIX threads has problematic signal handling semantics, specifically,
		2332	a lot of functionality (sigfd, sigwait etc.) only really works if all
		2333	threads in a process block signals, which is hard to achieve.
		2334
		2335	When you want to use sigwait (or mix libev signal handling with your own
		2336	for the same signals), you can tackle this problem by globally blocking
		2337	all signals before creating any threads (or creating them with a fully set
		2338	sigprocmask) and also specifying the C<EVFLAG_NOSIGMASK> when creating
		2339	loops. Then designate one thread as "signal receiver thread" which handles
		2340	these signals. You can pass on any signals that libev might be interested
		2341	in by calling C<ev_feed_signal>.
2230		2342
2231	=head3 Watcher-Specific Functions and Data Members	2343	=head3 Watcher-Specific Functions and Data Members
2232		2344
2233	=over 4	2345	=over 4
2234		2346
…		…
3008	disadvantage of having to use multiple event loops (which do not support	3120	disadvantage of having to use multiple event loops (which do not support
3009	signal watchers).	3121	signal watchers).
3010		3122
3011	When this is not possible, or you want to use the default loop for	3123	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	3124	other reasons, then in the process that wants to start "fresh", call
3013	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3125	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	3126	Destroying the default loop will "orphan" (not stop) all registered
3015	have to be careful not to execute code that modifies those watchers. Note	3127	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.	3128	those watchers. Note also that in that case, you have to re-register any
		3129	signal watchers.
3017		3130
3018	=head3 Watcher-Specific Functions and Data Members	3131	=head3 Watcher-Specific Functions and Data Members
3019		3132
3020	=over 4	3133	=over 4
3021		3134
3022	=item ev_fork_init (ev_signal *, callback)	3135	=item ev_fork_init (ev_fork *, callback)
3023		3136
3024	Initialises and configures the fork watcher - it has no parameters of any	3137	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,	3138	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
3026	believe me.	3139	really.
3027		3140
3028	=back	3141	=back
		3142
		3143
		3144	=head2 C<ev_cleanup> - even the best things end
		3145
		3146	Cleanup watchers are called just before the event loop is being destroyed
		3147	by a call to C<ev_loop_destroy>.
		3148
		3149	While there is no guarantee that the event loop gets destroyed, cleanup
		3150	watchers provide a convenient method to install cleanup hooks for your
		3151	program, worker threads and so on - you just to make sure to destroy the
		3152	loop when you want them to be invoked.
		3153
		3154	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3155	all other watchers, they do not keep a reference to the event loop (which
		3156	makes a lot of sense if you think about it). Like all other watchers, you
		3157	can call libev functions in the callback, except C<ev_cleanup_start>.
		3158
		3159	=head3 Watcher-Specific Functions and Data Members
		3160
		3161	=over 4
		3162
		3163	=item ev_cleanup_init (ev_cleanup *, callback)
		3164
		3165	Initialises and configures the cleanup watcher - it has no parameters of
		3166	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3167	pointless, I assure you.
		3168
		3169	=back
		3170
		3171	Example: Register an atexit handler to destroy the default loop, so any
		3172	cleanup functions are called.
		3173
		3174	static void
		3175	program_exits (void)
		3176	{
		3177	ev_loop_destroy (EV_DEFAULT_UC);
		3178	}
		3179
		3180	...
		3181	atexit (program_exits);
3029		3182
3030		3183
3031	=head2 C<ev_async> - how to wake up an event loop	3184	=head2 C<ev_async> - how to wake up an event loop
3032		3185
3033	In general, you cannot use an C<ev_run> from multiple threads or other	3186	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.	3193	it by calling C<ev_async_send>, which is thread- and signal safe.
3041		3194
3042	This functionality is very similar to C<ev_signal> watchers, as signals,	3195	This functionality is very similar to C<ev_signal> watchers, as signals,
3043	too, are asynchronous in nature, and signals, too, will be compressed	3196	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	3197	(i.e. the number of callback invocations may be less than the number of
3045	C<ev_async_sent> calls).	3198	C<ev_async_sent> calls). In fact, you could use signal watchers as a kind
		3199	of "global async watchers" by using a watcher on an otherwise unused
		3200	signal, and C<ev_feed_signal> to signal this watcher from another thread,
		3201	even without knowing which loop owns the signal.
3046		3202
3047	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not	3203	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
3048	just the default loop.	3204	just the default loop.
3049		3205
3050	=head3 Queueing	3206	=head3 Queueing
…		…
3226	Feed an event on the given fd, as if a file descriptor backend detected	3382	Feed an event on the given fd, as if a file descriptor backend detected
3227	the given events it.	3383	the given events it.
3228		3384
3229	=item ev_feed_signal_event (loop, int signum)	3385	=item ev_feed_signal_event (loop, int signum)
3230		3386
3231	Feed an event as if the given signal occurred (C<loop> must be the default	3387	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3232	loop!).	3388	which is async-safe.
3233		3389
3234	=back	3390	=back
		3391
		3392
		3393	=head1 COMMON OR USEFUL IDIOMS (OR BOTH)
		3394
		3395	This section explains some common idioms that are not immediately
		3396	obvious. Note that examples are sprinkled over the whole manual, and this
		3397	section only contains stuff that wouldn't fit anywhere else.
		3398
		3399	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
		3400
		3401	Each watcher has, by default, a C<void *data> member that you can read
		3402	or modify at any time: libev will completely ignore it. This can be used
		3403	to associate arbitrary data with your watcher. If you need more data and
		3404	don't want to allocate memory separately and store a pointer to it in that
		3405	data member, you can also "subclass" the watcher type and provide your own
		3406	data:
		3407
		3408	struct my_io
		3409	{
		3410	ev_io io;
		3411	int otherfd;
		3412	void *somedata;
		3413	struct whatever *mostinteresting;
		3414	};
		3415
		3416	...
		3417	struct my_io w;
		3418	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3419
		3420	And since your callback will be called with a pointer to the watcher, you
		3421	can cast it back to your own type:
		3422
		3423	static void my_cb (struct ev_loop *loop, ev_io *w_, int revents)
		3424	{
		3425	struct my_io *w = (struct my_io *)w_;
		3426	...
		3427	}
		3428
		3429	More interesting and less C-conformant ways of casting your callback
		3430	function type instead have been omitted.
		3431
		3432	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3433
		3434	Another common scenario is to use some data structure with multiple
		3435	embedded watchers, in effect creating your own watcher that combines
		3436	multiple libev event sources into one "super-watcher":
		3437
		3438	struct my_biggy
		3439	{
		3440	int some_data;
		3441	ev_timer t1;
		3442	ev_timer t2;
		3443	}
		3444
		3445	In this case getting the pointer to C<my_biggy> is a bit more
		3446	complicated: Either you store the address of your C<my_biggy> struct in
		3447	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3448	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3449	real programmers):
		3450
		3451	#include <stddef.h>
		3452
		3453	static void
		3454	t1_cb (EV_P_ ev_timer *w, int revents)
		3455	{
		3456	struct my_biggy big = (struct my_biggy *)
		3457	(((char *)w) - offsetof (struct my_biggy, t1));
		3458	}
		3459
		3460	static void
		3461	t2_cb (EV_P_ ev_timer *w, int revents)
		3462	{
		3463	struct my_biggy big = (struct my_biggy *)
		3464	(((char *)w) - offsetof (struct my_biggy, t2));
		3465	}
		3466
		3467	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
		3468
		3469	Often (especially in GUI toolkits) there are places where you have
		3470	I<modal> interaction, which is most easily implemented by recursively
		3471	invoking C<ev_run>.
		3472
		3473	This brings the problem of exiting - a callback might want to finish the
		3474	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
		3475	a modal "Are you sure?" dialog is still waiting), or just the nested one
		3476	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
		3477	other combination: In these cases, C<ev_break> will not work alone.
		3478
		3479	The solution is to maintain "break this loop" variable for each C<ev_run>
		3480	invocation, and use a loop around C<ev_run> until the condition is
		3481	triggered, using C<EVRUN_ONCE>:
		3482
		3483	// main loop
		3484	int exit_main_loop = 0;
		3485
		3486	while (!exit_main_loop)
		3487	ev_run (EV_DEFAULT_ EVRUN_ONCE);
		3488
		3489	// in a model watcher
		3490	int exit_nested_loop = 0;
		3491
		3492	while (!exit_nested_loop)
		3493	ev_run (EV_A_ EVRUN_ONCE);
		3494
		3495	To exit from any of these loops, just set the corresponding exit variable:
		3496
		3497	// exit modal loop
		3498	exit_nested_loop = 1;
		3499
		3500	// exit main program, after modal loop is finished
		3501	exit_main_loop = 1;
		3502
		3503	// exit both
		3504	exit_main_loop = exit_nested_loop = 1;
		3505
		3506	=head2 THREAD LOCKING EXAMPLE
		3507
		3508	Here is a fictitious example of how to run an event loop in a different
		3509	thread from where callbacks are being invoked and watchers are
		3510	created/added/removed.
		3511
		3512	For a real-world example, see the C<EV::Loop::Async> perl module,
		3513	which uses exactly this technique (which is suited for many high-level
		3514	languages).
		3515
		3516	The example uses a pthread mutex to protect the loop data, a condition
		3517	variable to wait for callback invocations, an async watcher to notify the
		3518	event loop thread and an unspecified mechanism to wake up the main thread.
		3519
		3520	First, you need to associate some data with the event loop:
		3521
		3522	typedef struct {
		3523	mutex_t lock; /* global loop lock */
		3524	ev_async async_w;
		3525	thread_t tid;
		3526	cond_t invoke_cv;
		3527	} userdata;
		3528
		3529	void prepare_loop (EV_P)
		3530	{
		3531	// for simplicity, we use a static userdata struct.
		3532	static userdata u;
		3533
		3534	ev_async_init (&u->async_w, async_cb);
		3535	ev_async_start (EV_A_ &u->async_w);
		3536
		3537	pthread_mutex_init (&u->lock, 0);
		3538	pthread_cond_init (&u->invoke_cv, 0);
		3539
		3540	// now associate this with the loop
		3541	ev_set_userdata (EV_A_ u);
		3542	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3543	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3544
		3545	// then create the thread running ev_loop
		3546	pthread_create (&u->tid, 0, l_run, EV_A);
		3547	}
		3548
		3549	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3550	solely to wake up the event loop so it takes notice of any new watchers
		3551	that might have been added:
		3552
		3553	static void
		3554	async_cb (EV_P_ ev_async *w, int revents)
		3555	{
		3556	// just used for the side effects
		3557	}
		3558
		3559	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3560	protecting the loop data, respectively.
		3561
		3562	static void
		3563	l_release (EV_P)
		3564	{
		3565	userdata *u = ev_userdata (EV_A);
		3566	pthread_mutex_unlock (&u->lock);
		3567	}
		3568
		3569	static void
		3570	l_acquire (EV_P)
		3571	{
		3572	userdata *u = ev_userdata (EV_A);
		3573	pthread_mutex_lock (&u->lock);
		3574	}
		3575
		3576	The event loop thread first acquires the mutex, and then jumps straight
		3577	into C<ev_run>:
		3578
		3579	void *
		3580	l_run (void *thr_arg)
		3581	{
		3582	struct ev_loop *loop = (struct ev_loop *)thr_arg;
		3583
		3584	l_acquire (EV_A);
		3585	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3586	ev_run (EV_A_ 0);
		3587	l_release (EV_A);
		3588
		3589	return 0;
		3590	}
		3591
		3592	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3593	signal the main thread via some unspecified mechanism (signals? pipe
		3594	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3595	have been called (in a while loop because a) spurious wakeups are possible
		3596	and b) skipping inter-thread-communication when there are no pending
		3597	watchers is very beneficial):
		3598
		3599	static void
		3600	l_invoke (EV_P)
		3601	{
		3602	userdata *u = ev_userdata (EV_A);
		3603
		3604	while (ev_pending_count (EV_A))
		3605	{
		3606	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3607	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3608	}
		3609	}
		3610
		3611	Now, whenever the main thread gets told to invoke pending watchers, it
		3612	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3613	thread to continue:
		3614
		3615	static void
		3616	real_invoke_pending (EV_P)
		3617	{
		3618	userdata *u = ev_userdata (EV_A);
		3619
		3620	pthread_mutex_lock (&u->lock);
		3621	ev_invoke_pending (EV_A);
		3622	pthread_cond_signal (&u->invoke_cv);
		3623	pthread_mutex_unlock (&u->lock);
		3624	}
		3625
		3626	Whenever you want to start/stop a watcher or do other modifications to an
		3627	event loop, you will now have to lock:
		3628
		3629	ev_timer timeout_watcher;
		3630	userdata *u = ev_userdata (EV_A);
		3631
		3632	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3633
		3634	pthread_mutex_lock (&u->lock);
		3635	ev_timer_start (EV_A_ &timeout_watcher);
		3636	ev_async_send (EV_A_ &u->async_w);
		3637	pthread_mutex_unlock (&u->lock);
		3638
		3639	Note that sending the C<ev_async> watcher is required because otherwise
		3640	an event loop currently blocking in the kernel will have no knowledge
		3641	about the newly added timer. By waking up the loop it will pick up any new
		3642	watchers in the next event loop iteration.
		3643
		3644	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3645
		3646	While the overhead of a callback that e.g. schedules a thread is small, it
		3647	is still an overhead. If you embed libev, and your main usage is with some
		3648	kind of threads or coroutines, you might want to customise libev so that
		3649	doesn't need callbacks anymore.
		3650
		3651	Imagine you have coroutines that you can switch to using a function
		3652	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3653	and that due to some magic, the currently active coroutine is stored in a
		3654	global called C<current_coro>. Then you can build your own "wait for libev
		3655	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3656	the differing C<;> conventions):
		3657
		3658	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3659	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3660
		3661	That means instead of having a C callback function, you store the
		3662	coroutine to switch to in each watcher, and instead of having libev call
		3663	your callback, you instead have it switch to that coroutine.
		3664
		3665	A coroutine might now wait for an event with a function called
		3666	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		3667	matter when, or whether the watcher is active or not when this function is
		3668	called):
		3669
		3670	void
		3671	wait_for_event (ev_watcher *w)
		3672	{
		3673	ev_cb_set (w) = current_coro;
		3674	switch_to (libev_coro);
		3675	}
		3676
		3677	That basically suspends the coroutine inside C<wait_for_event> and
		3678	continues the libev coroutine, which, when appropriate, switches back to
		3679	this or any other coroutine. I am sure if you sue this your own :)
		3680
		3681	You can do similar tricks if you have, say, threads with an event queue -
		3682	instead of storing a coroutine, you store the queue object and instead of
		3683	switching to a coroutine, you push the watcher onto the queue and notify
		3684	any waiters.
		3685
		3686	To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two
		3687	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		3688
		3689	// my_ev.h
		3690	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3691	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
		3692	#include "../libev/ev.h"
		3693
		3694	// my_ev.c
		3695	#define EV_H "my_ev.h"
		3696	#include "../libev/ev.c"
		3697
		3698	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		3699	F<my_ev.c> into your project. When properly specifying include paths, you
		3700	can even use F<ev.h> as header file name directly.
3235		3701
3236		3702
3237	=head1 LIBEVENT EMULATION	3703	=head1 LIBEVENT EMULATION
3238		3704
3239	Libev offers a compatibility emulation layer for libevent. It cannot	3705	Libev offers a compatibility emulation layer for libevent. It cannot
3240	emulate the internals of libevent, so here are some usage hints:	3706	emulate the internals of libevent, so here are some usage hints:
3241		3707
3242	=over 4	3708	=over 4
		3709
		3710	=item * Only the libevent-1.4.1-beta API is being emulated.
		3711
		3712	This was the newest libevent version available when libev was implemented,
		3713	and is still mostly unchanged in 2010.
3243		3714
3244	=item * Use it by including <event.h>, as usual.	3715	=item * Use it by including <event.h>, as usual.
3245		3716
3246	=item * The following members are fully supported: ev_base, ev_callback,	3717	=item * The following members are fully supported: ev_base, ev_callback,
3247	ev_arg, ev_fd, ev_res, ev_events.	3718	ev_arg, ev_fd, ev_res, ev_events.
…		…
3253	=item * Priorities are not currently supported. Initialising priorities	3724	=item * Priorities are not currently supported. Initialising priorities
3254	will fail and all watchers will have the same priority, even though there	3725	will fail and all watchers will have the same priority, even though there
3255	is an ev_pri field.	3726	is an ev_pri field.
3256		3727
3257	=item * In libevent, the last base created gets the signals, in libev, the	3728	=item * In libevent, the last base created gets the signals, in libev, the
3258	first base created (== the default loop) gets the signals.	3729	base that registered the signal gets the signals.
3259		3730
3260	=item * Other members are not supported.	3731	=item * Other members are not supported.
3261		3732
3262	=item * The libev emulation is I<not> ABI compatible to libevent, you need	3733	=item * The libev emulation is I<not> ABI compatible to libevent, you need
3263	to use the libev header file and library.	3734	to use the libev header file and library.
…		…
3282	Care has been taken to keep the overhead low. The only data member the C++	3753	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	3754	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	3755	that the watcher is associated with (or no additional members at all if
3285	you disable C<EV_MULTIPLICITY> when embedding libev).	3756	you disable C<EV_MULTIPLICITY> when embedding libev).
3286		3757
3287	Currently, functions, and static and non-static member functions can be	3758	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	3759	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	3760	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	3761	you need support for other types of functors please contact the author
3291	it).	3762	(preferably after implementing it).
3292		3763
3293	Here is a list of things available in the C<ev> namespace:	3764	Here is a list of things available in the C<ev> namespace:
3294		3765
3295	=over 4	3766	=over 4
3296		3767
…		…
4164	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4635	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
4165		4636
4166	#include "ev_cpp.h"	4637	#include "ev_cpp.h"
4167	#include "ev.c"	4638	#include "ev.c"
4168		4639
4169	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	4640	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
4170		4641
4171	=head2 THREADS AND COROUTINES	4642	=head2 THREADS AND COROUTINES
4172		4643
4173	=head3 THREADS	4644	=head3 THREADS
4174		4645
…		…
4225	default loop and triggering an C<ev_async> watcher from the default loop	4696	default loop and triggering an C<ev_async> watcher from the default loop
4226	watcher callback into the event loop interested in the signal.	4697	watcher callback into the event loop interested in the signal.
4227		4698
4228	=back	4699	=back
4229		4700
4230	=head4 THREAD LOCKING EXAMPLE	4701	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		4702
4368	=head3 COROUTINES	4703	=head3 COROUTINES
4369		4704
4370	Libev is very accommodating to coroutines ("cooperative threads"):	4705	Libev is very accommodating to coroutines ("cooperative threads"):
4371	libev fully supports nesting calls to its functions from different	4706	libev fully supports nesting calls to its functions from different
…		…
4467	=head3 C<kqueue> is buggy	4802	=head3 C<kqueue> is buggy
4468		4803
4469	The kqueue syscall is broken in all known versions - most versions support	4804	The kqueue syscall is broken in all known versions - most versions support
4470	only sockets, many support pipes.	4805	only sockets, many support pipes.
4471		4806
4472	Libev tries to work around this by not using C<kqueue> by default on	4807	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	4808	rotten platform, but of course you can still ask for it when creating a
4474	a loop.	4809	loop - embedding a socket-only kqueue loop into a select-based one is
		4810	probably going to work well.
4475		4811
4476	=head3 C<poll> is buggy	4812	=head3 C<poll> is buggy
4477		4813
4478	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>	4814	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
4479	implementation by something calling C<kqueue> internally around the 10.5.6	4815	implementation by something calling C<kqueue> internally around the 10.5.6
…		…
4498		4834
4499	=head3 C<errno> reentrancy	4835	=head3 C<errno> reentrancy
4500		4836
4501	The default compile environment on Solaris is unfortunately so	4837	The default compile environment on Solaris is unfortunately so
4502	thread-unsafe that you can't even use components/libraries compiled	4838	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,	4839	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
4504	isn't defined by default.	4840	defined by default. A valid, if stupid, implementation choice.
4505		4841
4506	If you want to use libev in threaded environments you have to make sure	4842	If you want to use libev in threaded environments you have to make sure
4507	it's compiled with C<_REENTRANT> defined.	4843	it's compiled with C<_REENTRANT> defined.
4508		4844
4509	=head3 Event port backend	4845	=head3 Event port backend
4510		4846
4511	The scalable event interface for Solaris is called "event ports". Unfortunately,	4847	The scalable event interface for Solaris is called "event
4512	this mechanism is very buggy. If you run into high CPU usage, your program	4848	ports". Unfortunately, this mechanism is very buggy in all major
		4849	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	4850	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	4851	and latest kernel patches applied. No, I don't know which ones, but there
4515	ones, but there are multiple ones.	4852	are multiple ones to apply, and afterwards, event ports actually work
		4853	great.
4516		4854
4517	If you can't get it to work, you can try running the program by setting	4855	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	4856	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
4519	C<select> backends.	4857	C<select> backends.
4520		4858
4521	=head2 AIX POLL BUG	4859	=head2 AIX POLL BUG
4522		4860
4523	AIX unfortunately has a broken C<poll.h> header. Libev works around	4861	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	4862	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	4863	compiled in), which normally isn't a big problem as C<select> works fine
4526	with large bitsets, and AIX is dead anyway.	4864	with large bitsets on AIX, and AIX is dead anyway.
4527		4865
4528	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	4866	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
4529		4867
4530	=head3 General issues	4868	=head3 General issues
4531		4869
…		…
4637	structure (guaranteed by POSIX but not by ISO C for example), but it also	4975	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	4976	assumes that the same (machine) code can be used to call any watcher
4639	callback: The watcher callbacks have different type signatures, but libev	4977	callback: The watcher callbacks have different type signatures, but libev
4640	calls them using an C<ev_watcher *> internally.	4978	calls them using an C<ev_watcher *> internally.
4641		4979
		4980	=item pointer accesses must be thread-atomic
		4981
		4982	Accessing a pointer value must be atomic, it must both be readable and
		4983	writable in one piece - this is the case on all current architectures.
		4984
4642	=item C<sig_atomic_t volatile> must be thread-atomic as well	4985	=item C<sig_atomic_t volatile> must be thread-atomic as well
4643		4986
4644	The type C<sig_atomic_t volatile> (or whatever is defined as	4987	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	4988	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	4989	threads. This is not part of the specification for C<sig_atomic_t>, but is
…		…
4752	=back	5095	=back
4753		5096
4754		5097
4755	=head1 PORTING FROM LIBEV 3.X TO 4.X	5098	=head1 PORTING FROM LIBEV 3.X TO 4.X
4756		5099
4757	The major version 4 introduced some minor incompatible changes to the API.	5100	The major version 4 introduced some incompatible changes to the API.
4758		5101
4759	At the moment, the C<ev.h> header file tries to implement superficial	5102	At the moment, the C<ev.h> header file provides compatibility definitions
4760	compatibility, so most programs should still compile. Those might be	5103	for all changes, so most programs should still compile. The compatibility
4761	removed in later versions of libev, so better update early than late.	5104	layer might be removed in later versions of libev, so better update to the
		5105	new API early than late.
4762		5106
4763	=over 4	5107	=over 4
		5108
		5109	=item C<EV_COMPAT3> backwards compatibility mechanism
		5110
		5111	The backward compatibility mechanism can be controlled by
		5112	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		5113	section.
		5114
		5115	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		5116
		5117	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		5118
		5119	ev_loop_destroy (EV_DEFAULT_UC);
		5120	ev_loop_fork (EV_DEFAULT);
4764		5121
4765	=item function/symbol renames	5122	=item function/symbol renames
4766		5123
4767	A number of functions and symbols have been renamed:	5124	A number of functions and symbols have been renamed:
4768		5125
…		…
4787	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme	5144	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	5145	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>	5146	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
4790	typedef.	5147	typedef.
4791		5148
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>	5149	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
4799		5150
4800	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different	5151	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
4801	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile	5152	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
4802	and work, but the library code will of course be larger.	5153	and work, but the library code will of course be larger.
…		…
4808		5159
4809	=over 4	5160	=over 4
4810		5161
4811	=item active	5162	=item active
4812		5163
4813	A watcher is active as long as it has been started (has been attached to	5164	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).	5165	See L<WATCHER STATES> for details.
4815		5166
4816	=item application	5167	=item application
4817		5168
4818	In this document, an application is whatever is using libev.	5169	In this document, an application is whatever is using libev.
		5170
		5171	=item backend
		5172
		5173	The part of the code dealing with the operating system interfaces.
4819		5174
4820	=item callback	5175	=item callback
4821		5176
4822	The address of a function that is called when some event has been	5177	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	5178	detected. Callbacks are being passed the event loop, the watcher that
4824	received the event, and the actual event bitset.	5179	received the event, and the actual event bitset.
4825		5180
4826	=item callback invocation	5181	=item callback/watcher invocation
4827		5182
4828	The act of calling the callback associated with a watcher.	5183	The act of calling the callback associated with a watcher.
4829		5184
4830	=item event	5185	=item event
4831		5186
…		…
4850	The model used to describe how an event loop handles and processes	5205	The model used to describe how an event loop handles and processes
4851	watchers and events.	5206	watchers and events.
4852		5207
4853	=item pending	5208	=item pending
4854		5209
4855	A watcher is pending as soon as the corresponding event has been detected,	5210	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	5211	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		5212
4862	=item real time	5213	=item real time
4863		5214
4864	The physical time that is observed. It is apparently strictly monotonic :)	5215	The physical time that is observed. It is apparently strictly monotonic :)
4865		5216
…		…
4872	=item watcher	5223	=item watcher
4873		5224
4874	A data structure that describes interest in certain events. Watchers need	5225	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.	5226	to be started (attached to an event loop) before they can receive events.
4876		5227
4877	=item watcher invocation
4878
4879	The act of calling the callback associated with a watcher.
4880
4881	=back	5228	=back
4882		5229
4883	=head1 AUTHOR	5230	=head1 AUTHOR
4884		5231
4885	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5232	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5233	Magnusson and Emanuele Giaquinta.
4886		5234

Diff Legend

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