[ViewVC] Diff of: cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.338 by root, Sun Oct 31 21:16:26 2010 UTC vs.
Revision 1.370 by root, Thu Jun 2 23:42:40 2011 UTC

…		…
58	ev_timer_start (loop, &timeout_watcher);	58	ev_timer_start (loop, &timeout_watcher);
59		59
60	// now wait for events to arrive	60	// now wait for events to arrive
61	ev_run (loop, 0);	61	ev_run (loop, 0);
62		62
63	// unloop was called, so exit	63	// break was called, so exit
64	return 0;	64	return 0;
65	}	65	}
66		66
67	=head1 ABOUT THIS DOCUMENT	67	=head1 ABOUT THIS DOCUMENT
68		68
…		…
241	the current system, you would need to look at C<ev_embeddable_backends ()	241	the current system, you would need to look at C<ev_embeddable_backends ()
242	& ev_supported_backends ()>, likewise for recommended ones.	242	& ev_supported_backends ()>, likewise for recommended ones.
243		243
244	See the description of C<ev_embed> watchers for more info.	244	See the description of C<ev_embed> watchers for more info.
245		245
246	=item ev_set_allocator (void (cb)(void *ptr, long size)) [NOT REENTRANT]	246	=item ev_set_allocator (void (cb)(void *ptr, long size))
247		247
248	Sets the allocation function to use (the prototype is similar - the	248	Sets the allocation function to use (the prototype is similar - the
249	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is	249	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
250	used to allocate and free memory (no surprises here). If it returns zero	250	used to allocate and free memory (no surprises here). If it returns zero
251	when memory needs to be allocated (C<size != 0>), the library might abort	251	when memory needs to be allocated (C<size != 0>), the library might abort
…		…
277	}	277	}
278		278
279	...	279	...
280	ev_set_allocator (persistent_realloc);	280	ev_set_allocator (persistent_realloc);
281		281
282	=item ev_set_syserr_cb (void (cb)(const char msg)); [NOT REENTRANT]	282	=item ev_set_syserr_cb (void (cb)(const char msg))
283		283
284	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
285	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
286	indicating the system call or subsystem causing the problem. If this	286	indicating the system call or subsystem causing the problem. If this
287	callback is set, then libev will expect it to remedy the situation, no	287	callback is set, then libev will expect it to remedy the situation, no
…		…
299	}	299	}
300		300
301	...	301	...
302	ev_set_syserr_cb (fatal_error);	302	ev_set_syserr_cb (fatal_error);
303		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
304	=back	317	=back
305		318
306	=head1 FUNCTIONS CONTROLLING EVENT LOOPS	319	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
307		320
308	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
…		…
355	=item struct ev_loop *ev_loop_new (unsigned int flags)	368	=item struct ev_loop *ev_loop_new (unsigned int flags)
356		369
357	This will create and initialise a new event loop object. If the loop	370	This will create and initialise a new event loop object. If the loop
358	could not be initialised, returns false.	371	could not be initialised, returns false.
359		372
360	Note that this function I<is> thread-safe, and one common way to use	373	This function is thread-safe, and one common way to use libev with
361	libev with threads is indeed to create one loop per thread, and using the	374	threads is indeed to create one loop per thread, and using the default
362	default loop in the "main" or "initial" thread.	375	loop in the "main" or "initial" thread.
363		376
364	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
365	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>).
366		379
367	The following flags are supported:	380	The following flags are supported:
…		…
402	environment variable.	415	environment variable.
403		416
404	=item C<EVFLAG_NOINOTIFY>	417	=item C<EVFLAG_NOINOTIFY>
405		418
406	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
407	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
408	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
409	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.
410		423
411	=item C<EVFLAG_SIGNALFD>	424	=item C<EVFLAG_SIGNALFD>
412		425
413	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
414	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
415	delivers signals synchronously, which makes it both faster and might make	428	delivers signals synchronously, which makes it both faster and might make
416	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
417	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
418	threads that are not interested in handling them.	431	threads that are not interested in handling them.
419		432
420	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
421	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
422	example) that can't properly initialise their signal masks.	435	example) that can't properly initialise their signal masks.
		436
		437	=item C<EVFLAG_NOSIGMASK>
		438
		439	When this flag is specified, then libev will avoid to modify the signal
		440	mask. Specifically, this means you ahve to make sure signals are unblocked
		441	when you want to receive them.
		442
		443	This behaviour is useful when you want to do your own signal handling, or
		444	want to handle signals only in specific threads and want to avoid libev
		445	unblocking the signals.
		446
		447	It's also required by POSIX in a threaded program, as libev calls
		448	C<sigprocmask>, whose behaviour is officially unspecified.
		449
		450	This flag's behaviour will become the default in future versions of libev.
423		451
424	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	452	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
425		453
426	This is your standard select(2) backend. Not I<completely> standard, as	454	This is your standard select(2) backend. Not I<completely> standard, as
427	libev tries to roll its own fd_set with no limits on the number of fds,	455	libev tries to roll its own fd_set with no limits on the number of fds,
…		…
455	=item C<EVBACKEND_EPOLL> (value 4, Linux)	483	=item C<EVBACKEND_EPOLL> (value 4, Linux)
456		484
457	Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9	485	Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
458	kernels).	486	kernels).
459		487
460	For few fds, this backend is a bit little slower than poll and select,	488	For few fds, this backend is a bit little slower than poll and select, but
461	but it scales phenomenally better. While poll and select usually scale	489	it scales phenomenally better. While poll and select usually scale like
462	like O(total_fds) where n is the total number of fds (or the highest fd),	490	O(total_fds) where total_fds is the total number of fds (or the highest
463	epoll scales either O(1) or O(active_fds).	491	fd), epoll scales either O(1) or O(active_fds).
464		492
465	The epoll mechanism deserves honorable mention as the most misdesigned	493	The epoll mechanism deserves honorable mention as the most misdesigned
466	of the more advanced event mechanisms: mere annoyances include silently	494	of the more advanced event mechanisms: mere annoyances include silently
467	dropping file descriptors, requiring a system call per change per file	495	dropping file descriptors, requiring a system call per change per file
468	descriptor (and unnecessary guessing of parameters), problems with dup,	496	descriptor (and unnecessary guessing of parameters), problems with dup,
…		…
471	0.1ms) and so on. The biggest issue is fork races, however - if a program	499	0.1ms) and so on. The biggest issue is fork races, however - if a program
472	forks then I<both> parent and child process have to recreate the epoll	500	forks then I<both> parent and child process have to recreate the epoll
473	set, which can take considerable time (one syscall per file descriptor)	501	set, which can take considerable time (one syscall per file descriptor)
474	and is of course hard to detect.	502	and is of course hard to detect.
475		503
476	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	504	Epoll is also notoriously buggy - embedding epoll fds I<should> work,
477	of course I<doesn't>, and epoll just loves to report events for totally	505	but of course I<doesn't>, and epoll just loves to report events for
478	I<different> file descriptors (even already closed ones, so one cannot	506	totally I<different> file descriptors (even already closed ones, so
479	even remove them from the set) than registered in the set (especially	507	one cannot even remove them from the set) than registered in the set
480	on SMP systems). Libev tries to counter these spurious notifications by	508	(especially on SMP systems). Libev tries to counter these spurious
481	employing an additional generation counter and comparing that against the	509	notifications by employing an additional generation counter and comparing
482	events to filter out spurious ones, recreating the set when required. Last	510	that against the events to filter out spurious ones, recreating the set
		511	when required. Epoll also errornously rounds down timeouts, but gives you
		512	no way to know when and by how much, so sometimes you have to busy-wait
		513	because epoll returns immediately despite a nonzero timeout. And last
483	not least, it also refuses to work with some file descriptors which work	514	not least, it also refuses to work with some file descriptors which work
484	perfectly fine with C<select> (files, many character devices...).	515	perfectly fine with C<select> (files, many character devices...).
485		516
486	Epoll is truly the train wreck analog among event poll mechanisms.	517	Epoll is truly the train wreck among event poll mechanisms, a frankenpoll,
		518	cobbled together in a hurry, no thought to design or interaction with
		519	others. Oh, the pain, will it ever stop...
487		520
488	While stopping, setting and starting an I/O watcher in the same iteration	521	While stopping, setting and starting an I/O watcher in the same iteration
489	will result in some caching, there is still a system call per such	522	will result in some caching, there is still a system call per such
490	incident (because the same I<file descriptor> could point to a different	523	incident (because the same I<file descriptor> could point to a different
491	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed	524	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
…		…
557	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	590	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
558		591
559	This uses the Solaris 10 event port mechanism. As with everything on Solaris,	592	This uses the Solaris 10 event port mechanism. As with everything on Solaris,
560	it's really slow, but it still scales very well (O(active_fds)).	593	it's really slow, but it still scales very well (O(active_fds)).
561		594
562	Please note that Solaris event ports can deliver a lot of spurious
563	notifications, so you need to use non-blocking I/O or other means to avoid
564	blocking when no data (or space) is available.
565
566	While this backend scales well, it requires one system call per active	595	While this backend scales well, it requires one system call per active
567	file descriptor per loop iteration. For small and medium numbers of file	596	file descriptor per loop iteration. For small and medium numbers of file
568	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend	597	descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
569	might perform better.	598	might perform better.
570		599
571	On the positive side, with the exception of the spurious readiness	600	On the positive side, this backend actually performed fully to
572	notifications, this backend actually performed fully to specification
573	in all tests and is fully embeddable, which is a rare feat among the	601	specification in all tests and is fully embeddable, which is a rare feat
574	OS-specific backends (I vastly prefer correctness over speed hacks).	602	among the OS-specific backends (I vastly prefer correctness over speed
		603	hacks).
		604
		605	On the negative side, the interface is I<bizarre> - so bizarre that
		606	even sun itself gets it wrong in their code examples: The event polling
		607	function sometimes returning events to the caller even though an error
		608	occurred, but with no indication whether it has done so or not (yes, it's
		609	even documented that way) - deadly for edge-triggered interfaces where
		610	you absolutely have to know whether an event occurred or not because you
		611	have to re-arm the watcher.
		612
		613	Fortunately libev seems to be able to work around these idiocies.
575		614
576	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	615	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
577	C<EVBACKEND_POLL>.	616	C<EVBACKEND_POLL>.
578		617
579	=item C<EVBACKEND_ALL>	618	=item C<EVBACKEND_ALL>
580		619
581	Try all backends (even potentially broken ones that wouldn't be tried	620	Try all backends (even potentially broken ones that wouldn't be tried
582	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as	621	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
583	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	622	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
584		623
585	It is definitely not recommended to use this flag.	624	It is definitely not recommended to use this flag, use whatever
		625	C<ev_recommended_backends ()> returns, or simply do not specify a backend
		626	at all.
		627
		628	=item C<EVBACKEND_MASK>
		629
		630	Not a backend at all, but a mask to select all backend bits from a
		631	C<flags> value, in case you want to mask out any backends from a flags
		632	value (e.g. when modifying the C<LIBEV_FLAGS> environment variable).
586		633
587	=back	634	=back
588		635
589	If one or more of the backend flags are or'ed into the flags value,	636	If one or more of the backend flags are or'ed into the flags value,
590	then only these backends will be tried (in the reverse order as listed	637	then only these backends will be tried (in the reverse order as listed
…		…
619	This function is normally used on loop objects allocated by	666	This function is normally used on loop objects allocated by
620	C<ev_loop_new>, but it can also be used on the default loop returned by	667	C<ev_loop_new>, but it can also be used on the default loop returned by
621	C<ev_default_loop>, in which case it is not thread-safe.	668	C<ev_default_loop>, in which case it is not thread-safe.
622		669
623	Note that it is not advisable to call this function on the default loop	670	Note that it is not advisable to call this function on the default loop
624	except in the rare occasion where you really need to free it's resources.	671	except in the rare occasion where you really need to free its resources.
625	If you need dynamically allocated loops it is better to use C<ev_loop_new>	672	If you need dynamically allocated loops it is better to use C<ev_loop_new>
626	and C<ev_loop_destroy>.	673	and C<ev_loop_destroy>.
627		674
628	=item ev_loop_fork (loop)	675	=item ev_loop_fork (loop)
629		676
…		…
677	prepare and check phases.	724	prepare and check phases.
678		725
679	=item unsigned int ev_depth (loop)	726	=item unsigned int ev_depth (loop)
680		727
681	Returns the number of times C<ev_run> was entered minus the number of	728	Returns the number of times C<ev_run> was entered minus the number of
682	times C<ev_run> was exited, in other words, the recursion depth.	729	times C<ev_run> was exited normally, in other words, the recursion depth.
683		730
684	Outside C<ev_run>, this number is zero. In a callback, this number is	731	Outside C<ev_run>, this number is zero. In a callback, this number is
685	C<1>, unless C<ev_run> was invoked recursively (or from another thread),	732	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
686	in which case it is higher.	733	in which case it is higher.
687		734
688	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread	735	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread,
689	etc.), doesn't count as "exit" - consider this as a hint to avoid such	736	throwing an exception etc.), doesn't count as "exit" - consider this
690	ungentleman-like behaviour unless it's really convenient.	737	as a hint to avoid such ungentleman-like behaviour unless it's really
		738	convenient, in which case it is fully supported.
691		739
692	=item unsigned int ev_backend (loop)	740	=item unsigned int ev_backend (loop)
693		741
694	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	742	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
695	use.	743	use.
…		…
757	finished (especially in interactive programs), but having a program	805	finished (especially in interactive programs), but having a program
758	that automatically loops as long as it has to and no longer by virtue	806	that automatically loops as long as it has to and no longer by virtue
759	of relying on its watchers stopping correctly, that is truly a thing of	807	of relying on its watchers stopping correctly, that is truly a thing of
760	beauty.	808	beauty.
761		809
		810	This function is also I<mostly> exception-safe - you can break out of
		811	a C<ev_run> call by calling C<longjmp> in a callback, throwing a C++
		812	exception and so on. This does not decrement the C<ev_depth> value, nor
		813	will it clear any outstanding C<EVBREAK_ONE> breaks.
		814
762	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle	815	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
763	those events and any already outstanding ones, but will not wait and	816	those events and any already outstanding ones, but will not wait and
764	block your process in case there are no events and will return after one	817	block your process in case there are no events and will return after one
765	iteration of the loop. This is sometimes useful to poll and handle new	818	iteration of the loop. This is sometimes useful to poll and handle new
766	events while doing lengthy calculations, to keep the program responsive.	819	events while doing lengthy calculations, to keep the program responsive.
…		…
775	This is useful if you are waiting for some external event in conjunction	828	This is useful if you are waiting for some external event in conjunction
776	with something not expressible using other libev watchers (i.e. "roll your	829	with something not expressible using other libev watchers (i.e. "roll your
777	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is	830	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
778	usually a better approach for this kind of thing.	831	usually a better approach for this kind of thing.
779		832
780	Here are the gory details of what C<ev_run> does:	833	Here are the gory details of what C<ev_run> does (this is for your
		834	understanding, not a guarantee that things will work exactly like this in
		835	future versions):
781		836
782	- Increment loop depth.	837	- Increment loop depth.
783	- Reset the ev_break status.	838	- Reset the ev_break status.
784	- Before the first iteration, call any pending watchers.	839	- Before the first iteration, call any pending watchers.
785	LOOP:	840	LOOP:
…		…
818	anymore.	873	anymore.
819		874
820	... queue jobs here, make sure they register event watchers as long	875	... queue jobs here, make sure they register event watchers as long
821	... as they still have work to do (even an idle watcher will do..)	876	... as they still have work to do (even an idle watcher will do..)
822	ev_run (my_loop, 0);	877	ev_run (my_loop, 0);
823	... jobs done or somebody called unloop. yeah!	878	... jobs done or somebody called break. yeah!
824		879
825	=item ev_break (loop, how)	880	=item ev_break (loop, how)
826		881
827	Can be used to make a call to C<ev_run> return early (but only after it	882	Can be used to make a call to C<ev_run> return early (but only after it
828	has processed all outstanding events). The C<how> argument must be either	883	has processed all outstanding events). The C<how> argument must be either
829	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or	884	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
830	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.	885	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
831		886
832	This "break state" will be cleared when entering C<ev_run> again.	887	This "break state" will be cleared on the next call to C<ev_run>.
833		888
834	It is safe to call C<ev_break> from outside any C<ev_run> calls, too.	889	It is safe to call C<ev_break> from outside any C<ev_run> calls, too, in
		890	which case it will have no effect.
835		891
836	=item ev_ref (loop)	892	=item ev_ref (loop)
837		893
838	=item ev_unref (loop)	894	=item ev_unref (loop)
839		895
…		…
860	running when nothing else is active.	916	running when nothing else is active.
861		917
862	ev_signal exitsig;	918	ev_signal exitsig;
863	ev_signal_init (&exitsig, sig_cb, SIGINT);	919	ev_signal_init (&exitsig, sig_cb, SIGINT);
864	ev_signal_start (loop, &exitsig);	920	ev_signal_start (loop, &exitsig);
865	evf_unref (loop);	921	ev_unref (loop);
866		922
867	Example: For some weird reason, unregister the above signal handler again.	923	Example: For some weird reason, unregister the above signal handler again.
868		924
869	ev_ref (loop);	925	ev_ref (loop);
870	ev_signal_stop (loop, &exitsig);	926	ev_signal_stop (loop, &exitsig);
…		…
982	See also the locking example in the C<THREADS> section later in this	1038	See also the locking example in the C<THREADS> section later in this
983	document.	1039	document.
984		1040
985	=item ev_set_userdata (loop, void *data)	1041	=item ev_set_userdata (loop, void *data)
986		1042
987	=item ev_userdata (loop)	1043	=item void *ev_userdata (loop)
988		1044
989	Set and retrieve a single C<void *> associated with a loop. When	1045	Set and retrieve a single C<void *> associated with a loop. When
990	C<ev_set_userdata> has never been called, then C<ev_userdata> returns	1046	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
991	C<0.>	1047	C<0>.
992		1048
993	These two functions can be used to associate arbitrary data with a loop,	1049	These two functions can be used to associate arbitrary data with a loop,
994	and are intended solely for the C<invoke_pending_cb>, C<release> and	1050	and are intended solely for the C<invoke_pending_cb>, C<release> and
995	C<acquire> callbacks described above, but of course can be (ab-)used for	1051	C<acquire> callbacks described above, but of course can be (ab-)used for
996	any other purpose as well.	1052	any other purpose as well.
…		…
1309	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related	1365	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1310	functions that do not need a watcher.	1366	functions that do not need a watcher.
1311		1367
1312	=back	1368	=back
1313		1369
1314	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1370	See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
1315		1371	OWN COMPOSITE WATCHERS> idioms.
1316	Each watcher has, by default, a member C<void *data> that you can change
1317	and read at any time: libev will completely ignore it. This can be used
1318	to associate arbitrary data with your watcher. If you need more data and
1319	don't want to allocate memory and store a pointer to it in that data
1320	member, you can also "subclass" the watcher type and provide your own
1321	data:
1322
1323	struct my_io
1324	{
1325	ev_io io;
1326	int otherfd;
1327	void *somedata;
1328	struct whatever *mostinteresting;
1329	};
1330
1331	...
1332	struct my_io w;
1333	ev_io_init (&w.io, my_cb, fd, EV_READ);
1334
1335	And since your callback will be called with a pointer to the watcher, you
1336	can cast it back to your own type:
1337
1338	static void my_cb (struct ev_loop loop, ev_io w_, int revents)
1339	{
1340	struct my_io w = (struct my_io )w_;
1341	...
1342	}
1343
1344	More interesting and less C-conformant ways of casting your callback type
1345	instead have been omitted.
1346
1347	Another common scenario is to use some data structure with multiple
1348	embedded watchers:
1349
1350	struct my_biggy
1351	{
1352	int some_data;
1353	ev_timer t1;
1354	ev_timer t2;
1355	}
1356
1357	In this case getting the pointer to C<my_biggy> is a bit more
1358	complicated: Either you store the address of your C<my_biggy> struct
1359	in the C<data> member of the watcher (for woozies), or you need to use
1360	some pointer arithmetic using C<offsetof> inside your watchers (for real
1361	programmers):
1362
1363	#include <stddef.h>
1364
1365	static void
1366	t1_cb (EV_P_ ev_timer *w, int revents)
1367	{
1368	struct my_biggy big = (struct my_biggy *)
1369	(((char *)w) - offsetof (struct my_biggy, t1));
1370	}
1371
1372	static void
1373	t2_cb (EV_P_ ev_timer *w, int revents)
1374	{
1375	struct my_biggy big = (struct my_biggy *)
1376	(((char *)w) - offsetof (struct my_biggy, t2));
1377	}
1378		1372
1379	=head2 WATCHER STATES	1373	=head2 WATCHER STATES
1380		1374
1381	There are various watcher states mentioned throughout this manual -	1375	There are various watcher states mentioned throughout this manual -
1382	active, pending and so on. In this section these states and the rules to	1376	active, pending and so on. In this section these states and the rules to
…		…
1389		1383
1390	Before a watcher can be registered with the event looop it has to be	1384	Before a watcher can be registered with the event looop it has to be
1391	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to	1385	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1392	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.	1386	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1393		1387
1394	In this state it is simply some block of memory that is suitable for use	1388	In this state it is simply some block of memory that is suitable for
1395	in an event loop. It can be moved around, freed, reused etc. at will.	1389	use in an event loop. It can be moved around, freed, reused etc. at
		1390	will - as long as you either keep the memory contents intact, or call
		1391	C<ev_TYPE_init> again.
1396		1392
1397	=item started/running/active	1393	=item started/running/active
1398		1394
1399	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes	1395	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1400	property of the event loop, and is actively waiting for events. While in	1396	property of the event loop, and is actively waiting for events. While in
…		…
1428	latter will clear any pending state the watcher might be in, regardless	1424	latter will clear any pending state the watcher might be in, regardless
1429	of whether it was active or not, so stopping a watcher explicitly before	1425	of whether it was active or not, so stopping a watcher explicitly before
1430	freeing it is often a good idea.	1426	freeing it is often a good idea.
1431		1427
1432	While stopped (and not pending) the watcher is essentially in the	1428	While stopped (and not pending) the watcher is essentially in the
1433	initialised state, that is it can be reused, moved, modified in any way	1429	initialised state, that is, it can be reused, moved, modified in any way
1434	you wish.	1430	you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
		1431	it again).
1435		1432
1436	=back	1433	=back
1437		1434
1438	=head2 WATCHER PRIORITY MODELS	1435	=head2 WATCHER PRIORITY MODELS
1439		1436
…		…
1568	In general you can register as many read and/or write event watchers per	1565	In general you can register as many read and/or write event watchers per
1569	fd as you want (as long as you don't confuse yourself). Setting all file	1566	fd as you want (as long as you don't confuse yourself). Setting all file
1570	descriptors to non-blocking mode is also usually a good idea (but not	1567	descriptors to non-blocking mode is also usually a good idea (but not
1571	required if you know what you are doing).	1568	required if you know what you are doing).
1572		1569
1573	If you cannot use non-blocking mode, then force the use of a
1574	known-to-be-good backend (at the time of this writing, this includes only
1575	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1576	descriptors for which non-blocking operation makes no sense (such as
1577	files) - libev doesn't guarantee any specific behaviour in that case.
1578
1579	Another thing you have to watch out for is that it is quite easy to	1570	Another thing you have to watch out for is that it is quite easy to
1580	receive "spurious" readiness notifications, that is your callback might	1571	receive "spurious" readiness notifications, that is, your callback might
1581	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1572	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1582	because there is no data. Not only are some backends known to create a	1573	because there is no data. It is very easy to get into this situation even
1583	lot of those (for example Solaris ports), it is very easy to get into	1574	with a relatively standard program structure. Thus it is best to always
1584	this situation even with a relatively standard program structure. Thus	1575	use non-blocking I/O: An extra C<read>(2) returning C<EAGAIN> is far
1585	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1586	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1576	preferable to a program hanging until some data arrives.
1587		1577
1588	If you cannot run the fd in non-blocking mode (for example you should	1578	If you cannot run the fd in non-blocking mode (for example you should
1589	not play around with an Xlib connection), then you have to separately	1579	not play around with an Xlib connection), then you have to separately
1590	re-test whether a file descriptor is really ready with a known-to-be good	1580	re-test whether a file descriptor is really ready with a known-to-be good
1591	interface such as poll (fortunately in our Xlib example, Xlib already	1581	interface such as poll (fortunately in the case of Xlib, it already does
1592	does this on its own, so its quite safe to use). Some people additionally	1582	this on its own, so its quite safe to use). Some people additionally
1593	use C<SIGALRM> and an interval timer, just to be sure you won't block	1583	use C<SIGALRM> and an interval timer, just to be sure you won't block
1594	indefinitely.	1584	indefinitely.
1595		1585
1596	But really, best use non-blocking mode.	1586	But really, best use non-blocking mode.
1597		1587
…		…
1625		1615
1626	There is no workaround possible except not registering events	1616	There is no workaround possible except not registering events
1627	for potentially C<dup ()>'ed file descriptors, or to resort to	1617	for potentially C<dup ()>'ed file descriptors, or to resort to
1628	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1618	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1629		1619
		1620	=head3 The special problem of files
		1621
		1622	Many people try to use C<select> (or libev) on file descriptors
		1623	representing files, and expect it to become ready when their program
		1624	doesn't block on disk accesses (which can take a long time on their own).
		1625
		1626	However, this cannot ever work in the "expected" way - you get a readiness
		1627	notification as soon as the kernel knows whether and how much data is
		1628	there, and in the case of open files, that's always the case, so you
		1629	always get a readiness notification instantly, and your read (or possibly
		1630	write) will still block on the disk I/O.
		1631
		1632	Another way to view it is that in the case of sockets, pipes, character
		1633	devices and so on, there is another party (the sender) that delivers data
		1634	on its own, but in the case of files, there is no such thing: the disk
		1635	will not send data on its own, simply because it doesn't know what you
		1636	wish to read - you would first have to request some data.
		1637
		1638	Since files are typically not-so-well supported by advanced notification
		1639	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1640	to files, even though you should not use it. The reason for this is
		1641	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1642	usually a tty, often a pipe, but also sometimes files or special devices
		1643	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1644	F</dev/urandom>), and even though the file might better be served with
		1645	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1646	it "just works" instead of freezing.
		1647
		1648	So avoid file descriptors pointing to files when you know it (e.g. use
		1649	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1650	when you rarely read from a file instead of from a socket, and want to
		1651	reuse the same code path.
		1652
1630	=head3 The special problem of fork	1653	=head3 The special problem of fork
1631		1654
1632	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1655	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1633	useless behaviour. Libev fully supports fork, but needs to be told about	1656	useless behaviour. Libev fully supports fork, but needs to be told about
1634	it in the child.	1657	it in the child if you want to continue to use it in the child.
1635		1658
1636	To support fork in your programs, you either have to call	1659	To support fork in your child processes, you have to call C<ev_loop_fork
1637	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1660	()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1638	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1661	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1639	C<EVBACKEND_POLL>.
1640		1662
1641	=head3 The special problem of SIGPIPE	1663	=head3 The special problem of SIGPIPE
1642		1664
1643	While not really specific to libev, it is easy to forget about C<SIGPIPE>:	1665	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1644	when writing to a pipe whose other end has been closed, your program gets	1666	when writing to a pipe whose other end has been closed, your program gets
…		…
2134		2156
2135	Another way to think about it (for the mathematically inclined) is that	2157	Another way to think about it (for the mathematically inclined) is that
2136	C<ev_periodic> will try to run the callback in this mode at the next possible	2158	C<ev_periodic> will try to run the callback in this mode at the next possible
2137	time where C<time = offset (mod interval)>, regardless of any time jumps.	2159	time where C<time = offset (mod interval)>, regardless of any time jumps.
2138		2160
2139	For numerical stability it is preferable that the C<offset> value is near	2161	The C<interval> I<MUST> be positive, and for numerical stability, the
2140	C<ev_now ()> (the current time), but there is no range requirement for	2162	interval value should be higher than C<1/8192> (which is around 100
2141	this value, and in fact is often specified as zero.	2163	microseconds) and C<offset> should be higher than C<0> and should have
		2164	at most a similar magnitude as the current time (say, within a factor of
		2165	ten). Typical values for offset are, in fact, C<0> or something between
		2166	C<0> and C<interval>, which is also the recommended range.
2142		2167
2143	Note also that there is an upper limit to how often a timer can fire (CPU	2168	Note also that there is an upper limit to how often a timer can fire (CPU
2144	speed for example), so if C<interval> is very small then timing stability	2169	speed for example), so if C<interval> is very small then timing stability
2145	will of course deteriorate. Libev itself tries to be exact to be about one	2170	will of course deteriorate. Libev itself tries to be exact to be about one
2146	millisecond (if the OS supports it and the machine is fast enough).	2171	millisecond (if the OS supports it and the machine is fast enough).
…		…
2260		2285
2261	=head2 C<ev_signal> - signal me when a signal gets signalled!	2286	=head2 C<ev_signal> - signal me when a signal gets signalled!
2262		2287
2263	Signal watchers will trigger an event when the process receives a specific	2288	Signal watchers will trigger an event when the process receives a specific
2264	signal one or more times. Even though signals are very asynchronous, libev	2289	signal one or more times. Even though signals are very asynchronous, libev
2265	will try it's best to deliver signals synchronously, i.e. as part of the	2290	will try its best to deliver signals synchronously, i.e. as part of the
2266	normal event processing, like any other event.	2291	normal event processing, like any other event.
2267		2292
2268	If you want signals to be delivered truly asynchronously, just use	2293	If you want signals to be delivered truly asynchronously, just use
2269	C<sigaction> as you would do without libev and forget about sharing	2294	C<sigaction> as you would do without libev and forget about sharing
2270	the signal. You can even use C<ev_async> from a signal handler to	2295	the signal. You can even use C<ev_async> from a signal handler to
…		…
2289	=head3 The special problem of inheritance over fork/execve/pthread_create	2314	=head3 The special problem of inheritance over fork/execve/pthread_create
2290		2315
2291	Both the signal mask (C<sigprocmask>) and the signal disposition	2316	Both the signal mask (C<sigprocmask>) and the signal disposition
2292	(C<sigaction>) are unspecified after starting a signal watcher (and after	2317	(C<sigaction>) are unspecified after starting a signal watcher (and after
2293	stopping it again), that is, libev might or might not block the signal,	2318	stopping it again), that is, libev might or might not block the signal,
2294	and might or might not set or restore the installed signal handler.	2319	and might or might not set or restore the installed signal handler (but
		2320	see C<EVFLAG_NOSIGMASK>).
2295		2321
2296	While this does not matter for the signal disposition (libev never	2322	While this does not matter for the signal disposition (libev never
2297	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on	2323	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2298	C<execve>), this matters for the signal mask: many programs do not expect	2324	C<execve>), this matters for the signal mask: many programs do not expect
2299	certain signals to be blocked.	2325	certain signals to be blocked.
…		…
2312	I<has> to modify the signal mask, at least temporarily.	2338	I<has> to modify the signal mask, at least temporarily.
2313		2339
2314	So I can't stress this enough: I<If you do not reset your signal mask when	2340	So I can't stress this enough: I<If you do not reset your signal mask when
2315	you expect it to be empty, you have a race condition in your code>. This	2341	you expect it to be empty, you have a race condition in your code>. This
2316	is not a libev-specific thing, this is true for most event libraries.	2342	is not a libev-specific thing, this is true for most event libraries.
		2343
		2344	=head3 The special problem of threads signal handling
		2345
		2346	POSIX threads has problematic signal handling semantics, specifically,
		2347	a lot of functionality (sigfd, sigwait etc.) only really works if all
		2348	threads in a process block signals, which is hard to achieve.
		2349
		2350	When you want to use sigwait (or mix libev signal handling with your own
		2351	for the same signals), you can tackle this problem by globally blocking
		2352	all signals before creating any threads (or creating them with a fully set
		2353	sigprocmask) and also specifying the C<EVFLAG_NOSIGMASK> when creating
		2354	loops. Then designate one thread as "signal receiver thread" which handles
		2355	these signals. You can pass on any signals that libev might be interested
		2356	in by calling C<ev_feed_signal>.
2317		2357
2318	=head3 Watcher-Specific Functions and Data Members	2358	=head3 Watcher-Specific Functions and Data Members
2319		2359
2320	=over 4	2360	=over 4
2321		2361
…		…
3156	atexit (program_exits);	3196	atexit (program_exits);
3157		3197
3158		3198
3159	=head2 C<ev_async> - how to wake up an event loop	3199	=head2 C<ev_async> - how to wake up an event loop
3160		3200
3161	In general, you cannot use an C<ev_run> from multiple threads or other	3201	In general, you cannot use an C<ev_loop> from multiple threads or other
3162	asynchronous sources such as signal handlers (as opposed to multiple event	3202	asynchronous sources such as signal handlers (as opposed to multiple event
3163	loops - those are of course safe to use in different threads).	3203	loops - those are of course safe to use in different threads).
3164		3204
3165	Sometimes, however, you need to wake up an event loop you do not control,	3205	Sometimes, however, you need to wake up an event loop you do not control,
3166	for example because it belongs to another thread. This is what C<ev_async>	3206	for example because it belongs to another thread. This is what C<ev_async>
…		…
3168	it by calling C<ev_async_send>, which is thread- and signal safe.	3208	it by calling C<ev_async_send>, which is thread- and signal safe.
3169		3209
3170	This functionality is very similar to C<ev_signal> watchers, as signals,	3210	This functionality is very similar to C<ev_signal> watchers, as signals,
3171	too, are asynchronous in nature, and signals, too, will be compressed	3211	too, are asynchronous in nature, and signals, too, will be compressed
3172	(i.e. the number of callback invocations may be less than the number of	3212	(i.e. the number of callback invocations may be less than the number of
3173	C<ev_async_sent> calls).	3213	C<ev_async_sent> calls). In fact, you could use signal watchers as a kind
		3214	of "global async watchers" by using a watcher on an otherwise unused
		3215	signal, and C<ev_feed_signal> to signal this watcher from another thread,
		3216	even without knowing which loop owns the signal.
3174		3217
3175	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not	3218	Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
3176	just the default loop.	3219	just the default loop.
3177		3220
3178	=head3 Queueing	3221	=head3 Queueing
…		…
3273	trust me.	3316	trust me.
3274		3317
3275	=item ev_async_send (loop, ev_async *)	3318	=item ev_async_send (loop, ev_async *)
3276		3319
3277	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	3320	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
3278	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	3321	an C<EV_ASYNC> event on the watcher into the event loop, and instantly
		3322	returns.
		3323
3279	C<ev_feed_event>, this call is safe to do from other threads, signal or	3324	Unlike C<ev_feed_event>, this call is safe to do from other threads,
3280	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	3325	signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3281	section below on what exactly this means).	3326	embedding section below on what exactly this means).
3282		3327
3283	Note that, as with other watchers in libev, multiple events might get	3328	Note that, as with other watchers in libev, multiple events might get
3284	compressed into a single callback invocation (another way to look at this	3329	compressed into a single callback invocation (another way to look at this
3285	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,	3330	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
3286	reset when the event loop detects that).	3331	reset when the event loop detects that).
…		…
3354	Feed an event on the given fd, as if a file descriptor backend detected	3399	Feed an event on the given fd, as if a file descriptor backend detected
3355	the given events it.	3400	the given events it.
3356		3401
3357	=item ev_feed_signal_event (loop, int signum)	3402	=item ev_feed_signal_event (loop, int signum)
3358		3403
3359	Feed an event as if the given signal occurred (C<loop> must be the default	3404	Feed an event as if the given signal occurred. See also C<ev_feed_signal>,
3360	loop!).	3405	which is async-safe.
3361		3406
3362	=back	3407	=back
		3408
		3409
		3410	=head1 COMMON OR USEFUL IDIOMS (OR BOTH)
		3411
		3412	This section explains some common idioms that are not immediately
		3413	obvious. Note that examples are sprinkled over the whole manual, and this
		3414	section only contains stuff that wouldn't fit anywhere else.
		3415
		3416	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
		3417
		3418	Each watcher has, by default, a C<void *data> member that you can read
		3419	or modify at any time: libev will completely ignore it. This can be used
		3420	to associate arbitrary data with your watcher. If you need more data and
		3421	don't want to allocate memory separately and store a pointer to it in that
		3422	data member, you can also "subclass" the watcher type and provide your own
		3423	data:
		3424
		3425	struct my_io
		3426	{
		3427	ev_io io;
		3428	int otherfd;
		3429	void *somedata;
		3430	struct whatever *mostinteresting;
		3431	};
		3432
		3433	...
		3434	struct my_io w;
		3435	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3436
		3437	And since your callback will be called with a pointer to the watcher, you
		3438	can cast it back to your own type:
		3439
		3440	static void my_cb (struct ev_loop loop, ev_io w_, int revents)
		3441	{
		3442	struct my_io w = (struct my_io )w_;
		3443	...
		3444	}
		3445
		3446	More interesting and less C-conformant ways of casting your callback
		3447	function type instead have been omitted.
		3448
		3449	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3450
		3451	Another common scenario is to use some data structure with multiple
		3452	embedded watchers, in effect creating your own watcher that combines
		3453	multiple libev event sources into one "super-watcher":
		3454
		3455	struct my_biggy
		3456	{
		3457	int some_data;
		3458	ev_timer t1;
		3459	ev_timer t2;
		3460	}
		3461
		3462	In this case getting the pointer to C<my_biggy> is a bit more
		3463	complicated: Either you store the address of your C<my_biggy> struct in
		3464	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3465	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3466	real programmers):
		3467
		3468	#include <stddef.h>
		3469
		3470	static void
		3471	t1_cb (EV_P_ ev_timer *w, int revents)
		3472	{
		3473	struct my_biggy big = (struct my_biggy *)
		3474	(((char *)w) - offsetof (struct my_biggy, t1));
		3475	}
		3476
		3477	static void
		3478	t2_cb (EV_P_ ev_timer *w, int revents)
		3479	{
		3480	struct my_biggy big = (struct my_biggy *)
		3481	(((char *)w) - offsetof (struct my_biggy, t2));
		3482	}
		3483
		3484	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
		3485
		3486	Often (especially in GUI toolkits) there are places where you have
		3487	I<modal> interaction, which is most easily implemented by recursively
		3488	invoking C<ev_run>.
		3489
		3490	This brings the problem of exiting - a callback might want to finish the
		3491	main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
		3492	a modal "Are you sure?" dialog is still waiting), or just the nested one
		3493	and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
		3494	other combination: In these cases, C<ev_break> will not work alone.
		3495
		3496	The solution is to maintain "break this loop" variable for each C<ev_run>
		3497	invocation, and use a loop around C<ev_run> until the condition is
		3498	triggered, using C<EVRUN_ONCE>:
		3499
		3500	// main loop
		3501	int exit_main_loop = 0;
		3502
		3503	while (!exit_main_loop)
		3504	ev_run (EV_DEFAULT_ EVRUN_ONCE);
		3505
		3506	// in a model watcher
		3507	int exit_nested_loop = 0;
		3508
		3509	while (!exit_nested_loop)
		3510	ev_run (EV_A_ EVRUN_ONCE);
		3511
		3512	To exit from any of these loops, just set the corresponding exit variable:
		3513
		3514	// exit modal loop
		3515	exit_nested_loop = 1;
		3516
		3517	// exit main program, after modal loop is finished
		3518	exit_main_loop = 1;
		3519
		3520	// exit both
		3521	exit_main_loop = exit_nested_loop = 1;
		3522
		3523	=head2 THREAD LOCKING EXAMPLE
		3524
		3525	Here is a fictitious example of how to run an event loop in a different
		3526	thread from where callbacks are being invoked and watchers are
		3527	created/added/removed.
		3528
		3529	For a real-world example, see the C<EV::Loop::Async> perl module,
		3530	which uses exactly this technique (which is suited for many high-level
		3531	languages).
		3532
		3533	The example uses a pthread mutex to protect the loop data, a condition
		3534	variable to wait for callback invocations, an async watcher to notify the
		3535	event loop thread and an unspecified mechanism to wake up the main thread.
		3536
		3537	First, you need to associate some data with the event loop:
		3538
		3539	typedef struct {
		3540	mutex_t lock; /* global loop lock */
		3541	ev_async async_w;
		3542	thread_t tid;
		3543	cond_t invoke_cv;
		3544	} userdata;
		3545
		3546	void prepare_loop (EV_P)
		3547	{
		3548	// for simplicity, we use a static userdata struct.
		3549	static userdata u;
		3550
		3551	ev_async_init (&u->async_w, async_cb);
		3552	ev_async_start (EV_A_ &u->async_w);
		3553
		3554	pthread_mutex_init (&u->lock, 0);
		3555	pthread_cond_init (&u->invoke_cv, 0);
		3556
		3557	// now associate this with the loop
		3558	ev_set_userdata (EV_A_ u);
		3559	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3560	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3561
		3562	// then create the thread running ev_run
		3563	pthread_create (&u->tid, 0, l_run, EV_A);
		3564	}
		3565
		3566	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3567	solely to wake up the event loop so it takes notice of any new watchers
		3568	that might have been added:
		3569
		3570	static void
		3571	async_cb (EV_P_ ev_async *w, int revents)
		3572	{
		3573	// just used for the side effects
		3574	}
		3575
		3576	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3577	protecting the loop data, respectively.
		3578
		3579	static void
		3580	l_release (EV_P)
		3581	{
		3582	userdata *u = ev_userdata (EV_A);
		3583	pthread_mutex_unlock (&u->lock);
		3584	}
		3585
		3586	static void
		3587	l_acquire (EV_P)
		3588	{
		3589	userdata *u = ev_userdata (EV_A);
		3590	pthread_mutex_lock (&u->lock);
		3591	}
		3592
		3593	The event loop thread first acquires the mutex, and then jumps straight
		3594	into C<ev_run>:
		3595
		3596	void *
		3597	l_run (void *thr_arg)
		3598	{
		3599	struct ev_loop loop = (struct ev_loop )thr_arg;
		3600
		3601	l_acquire (EV_A);
		3602	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3603	ev_run (EV_A_ 0);
		3604	l_release (EV_A);
		3605
		3606	return 0;
		3607	}
		3608
		3609	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3610	signal the main thread via some unspecified mechanism (signals? pipe
		3611	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3612	have been called (in a while loop because a) spurious wakeups are possible
		3613	and b) skipping inter-thread-communication when there are no pending
		3614	watchers is very beneficial):
		3615
		3616	static void
		3617	l_invoke (EV_P)
		3618	{
		3619	userdata *u = ev_userdata (EV_A);
		3620
		3621	while (ev_pending_count (EV_A))
		3622	{
		3623	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3624	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3625	}
		3626	}
		3627
		3628	Now, whenever the main thread gets told to invoke pending watchers, it
		3629	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3630	thread to continue:
		3631
		3632	static void
		3633	real_invoke_pending (EV_P)
		3634	{
		3635	userdata *u = ev_userdata (EV_A);
		3636
		3637	pthread_mutex_lock (&u->lock);
		3638	ev_invoke_pending (EV_A);
		3639	pthread_cond_signal (&u->invoke_cv);
		3640	pthread_mutex_unlock (&u->lock);
		3641	}
		3642
		3643	Whenever you want to start/stop a watcher or do other modifications to an
		3644	event loop, you will now have to lock:
		3645
		3646	ev_timer timeout_watcher;
		3647	userdata *u = ev_userdata (EV_A);
		3648
		3649	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3650
		3651	pthread_mutex_lock (&u->lock);
		3652	ev_timer_start (EV_A_ &timeout_watcher);
		3653	ev_async_send (EV_A_ &u->async_w);
		3654	pthread_mutex_unlock (&u->lock);
		3655
		3656	Note that sending the C<ev_async> watcher is required because otherwise
		3657	an event loop currently blocking in the kernel will have no knowledge
		3658	about the newly added timer. By waking up the loop it will pick up any new
		3659	watchers in the next event loop iteration.
		3660
		3661	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3662
		3663	While the overhead of a callback that e.g. schedules a thread is small, it
		3664	is still an overhead. If you embed libev, and your main usage is with some
		3665	kind of threads or coroutines, you might want to customise libev so that
		3666	doesn't need callbacks anymore.
		3667
		3668	Imagine you have coroutines that you can switch to using a function
		3669	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3670	and that due to some magic, the currently active coroutine is stored in a
		3671	global called C<current_coro>. Then you can build your own "wait for libev
		3672	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3673	the differing C<;> conventions):
		3674
		3675	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3676	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3677
		3678	That means instead of having a C callback function, you store the
		3679	coroutine to switch to in each watcher, and instead of having libev call
		3680	your callback, you instead have it switch to that coroutine.
		3681
		3682	A coroutine might now wait for an event with a function called
		3683	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		3684	matter when, or whether the watcher is active or not when this function is
		3685	called):
		3686
		3687	void
		3688	wait_for_event (ev_watcher *w)
		3689	{
		3690	ev_cb_set (w) = current_coro;
		3691	switch_to (libev_coro);
		3692	}
		3693
		3694	That basically suspends the coroutine inside C<wait_for_event> and
		3695	continues the libev coroutine, which, when appropriate, switches back to
		3696	this or any other coroutine. I am sure if you sue this your own :)
		3697
		3698	You can do similar tricks if you have, say, threads with an event queue -
		3699	instead of storing a coroutine, you store the queue object and instead of
		3700	switching to a coroutine, you push the watcher onto the queue and notify
		3701	any waiters.
		3702
		3703	To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two
		3704	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		3705
		3706	// my_ev.h
		3707	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3708	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
		3709	#include "../libev/ev.h"
		3710
		3711	// my_ev.c
		3712	#define EV_H "my_ev.h"
		3713	#include "../libev/ev.c"
		3714
		3715	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		3716	F<my_ev.c> into your project. When properly specifying include paths, you
		3717	can even use F<ev.h> as header file name directly.
3363		3718
3364		3719
3365	=head1 LIBEVENT EMULATION	3720	=head1 LIBEVENT EMULATION
3366		3721
3367	Libev offers a compatibility emulation layer for libevent. It cannot	3722	Libev offers a compatibility emulation layer for libevent. It cannot
3368	emulate the internals of libevent, so here are some usage hints:	3723	emulate the internals of libevent, so here are some usage hints:
3369		3724
3370	=over 4	3725	=over 4
		3726
		3727	=item * Only the libevent-1.4.1-beta API is being emulated.
		3728
		3729	This was the newest libevent version available when libev was implemented,
		3730	and is still mostly unchanged in 2010.
3371		3731
3372	=item * Use it by including <event.h>, as usual.	3732	=item * Use it by including <event.h>, as usual.
3373		3733
3374	=item * The following members are fully supported: ev_base, ev_callback,	3734	=item * The following members are fully supported: ev_base, ev_callback,
3375	ev_arg, ev_fd, ev_res, ev_events.	3735	ev_arg, ev_fd, ev_res, ev_events.
…		…
3381	=item * Priorities are not currently supported. Initialising priorities	3741	=item * Priorities are not currently supported. Initialising priorities
3382	will fail and all watchers will have the same priority, even though there	3742	will fail and all watchers will have the same priority, even though there
3383	is an ev_pri field.	3743	is an ev_pri field.
3384		3744
3385	=item * In libevent, the last base created gets the signals, in libev, the	3745	=item * In libevent, the last base created gets the signals, in libev, the
3386	first base created (== the default loop) gets the signals.	3746	base that registered the signal gets the signals.
3387		3747
3388	=item * Other members are not supported.	3748	=item * Other members are not supported.
3389		3749
3390	=item * The libev emulation is I<not> ABI compatible to libevent, you need	3750	=item * The libev emulation is I<not> ABI compatible to libevent, you need
3391	to use the libev header file and library.	3751	to use the libev header file and library.
…		…
3410	Care has been taken to keep the overhead low. The only data member the C++	3770	Care has been taken to keep the overhead low. The only data member the C++
3411	classes add (compared to plain C-style watchers) is the event loop pointer	3771	classes add (compared to plain C-style watchers) is the event loop pointer
3412	that the watcher is associated with (or no additional members at all if	3772	that the watcher is associated with (or no additional members at all if
3413	you disable C<EV_MULTIPLICITY> when embedding libev).	3773	you disable C<EV_MULTIPLICITY> when embedding libev).
3414		3774
3415	Currently, functions, and static and non-static member functions can be	3775	Currently, functions, static and non-static member functions and classes
3416	used as callbacks. Other types should be easy to add as long as they only	3776	with C<operator ()> can be used as callbacks. Other types should be easy
3417	need one additional pointer for context. If you need support for other	3777	to add as long as they only need one additional pointer for context. If
3418	types of functors please contact the author (preferably after implementing	3778	you need support for other types of functors please contact the author
3419	it).	3779	(preferably after implementing it).
3420		3780
3421	Here is a list of things available in the C<ev> namespace:	3781	Here is a list of things available in the C<ev> namespace:
3422		3782
3423	=over 4	3783	=over 4
3424		3784
…		…
3852	F<event.h> that are not directly supported by the libev core alone.	4212	F<event.h> that are not directly supported by the libev core alone.
3853		4213
3854	In standalone mode, libev will still try to automatically deduce the	4214	In standalone mode, libev will still try to automatically deduce the
3855	configuration, but has to be more conservative.	4215	configuration, but has to be more conservative.
3856		4216
		4217	=item EV_USE_FLOOR
		4218
		4219	If defined to be C<1>, libev will use the C<floor ()> function for its
		4220	periodic reschedule calculations, otherwise libev will fall back on a
		4221	portable (slower) implementation. If you enable this, you usually have to
		4222	link against libm or something equivalent. Enabling this when the C<floor>
		4223	function is not available will fail, so the safe default is to not enable
		4224	this.
		4225
3857	=item EV_USE_MONOTONIC	4226	=item EV_USE_MONOTONIC
3858		4227
3859	If defined to be C<1>, libev will try to detect the availability of the	4228	If defined to be C<1>, libev will try to detect the availability of the
3860	monotonic clock option at both compile time and runtime. Otherwise no	4229	monotonic clock option at both compile time and runtime. Otherwise no
3861	use of the monotonic clock option will be attempted. If you enable this,	4230	use of the monotonic clock option will be attempted. If you enable this,
…		…
4292	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4661	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
4293		4662
4294	#include "ev_cpp.h"	4663	#include "ev_cpp.h"
4295	#include "ev.c"	4664	#include "ev.c"
4296		4665
4297	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	4666	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
4298		4667
4299	=head2 THREADS AND COROUTINES	4668	=head2 THREADS AND COROUTINES
4300		4669
4301	=head3 THREADS	4670	=head3 THREADS
4302		4671
…		…
4353	default loop and triggering an C<ev_async> watcher from the default loop	4722	default loop and triggering an C<ev_async> watcher from the default loop
4354	watcher callback into the event loop interested in the signal.	4723	watcher callback into the event loop interested in the signal.
4355		4724
4356	=back	4725	=back
4357		4726
4358	=head4 THREAD LOCKING EXAMPLE	4727	See also L<THREAD LOCKING EXAMPLE>.
4359
4360	Here is a fictitious example of how to run an event loop in a different
4361	thread than where callbacks are being invoked and watchers are
4362	created/added/removed.
4363
4364	For a real-world example, see the C<EV::Loop::Async> perl module,
4365	which uses exactly this technique (which is suited for many high-level
4366	languages).
4367
4368	The example uses a pthread mutex to protect the loop data, a condition
4369	variable to wait for callback invocations, an async watcher to notify the
4370	event loop thread and an unspecified mechanism to wake up the main thread.
4371
4372	First, you need to associate some data with the event loop:
4373
4374	typedef struct {
4375	mutex_t lock; /* global loop lock */
4376	ev_async async_w;
4377	thread_t tid;
4378	cond_t invoke_cv;
4379	} userdata;
4380
4381	void prepare_loop (EV_P)
4382	{
4383	// for simplicity, we use a static userdata struct.
4384	static userdata u;
4385
4386	ev_async_init (&u->async_w, async_cb);
4387	ev_async_start (EV_A_ &u->async_w);
4388
4389	pthread_mutex_init (&u->lock, 0);
4390	pthread_cond_init (&u->invoke_cv, 0);
4391
4392	// now associate this with the loop
4393	ev_set_userdata (EV_A_ u);
4394	ev_set_invoke_pending_cb (EV_A_ l_invoke);
4395	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4396
4397	// then create the thread running ev_loop
4398	pthread_create (&u->tid, 0, l_run, EV_A);
4399	}
4400
4401	The callback for the C<ev_async> watcher does nothing: the watcher is used
4402	solely to wake up the event loop so it takes notice of any new watchers
4403	that might have been added:
4404
4405	static void
4406	async_cb (EV_P_ ev_async *w, int revents)
4407	{
4408	// just used for the side effects
4409	}
4410
4411	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4412	protecting the loop data, respectively.
4413
4414	static void
4415	l_release (EV_P)
4416	{
4417	userdata *u = ev_userdata (EV_A);
4418	pthread_mutex_unlock (&u->lock);
4419	}
4420
4421	static void
4422	l_acquire (EV_P)
4423	{
4424	userdata *u = ev_userdata (EV_A);
4425	pthread_mutex_lock (&u->lock);
4426	}
4427
4428	The event loop thread first acquires the mutex, and then jumps straight
4429	into C<ev_run>:
4430
4431	void *
4432	l_run (void *thr_arg)
4433	{
4434	struct ev_loop loop = (struct ev_loop )thr_arg;
4435
4436	l_acquire (EV_A);
4437	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4438	ev_run (EV_A_ 0);
4439	l_release (EV_A);
4440
4441	return 0;
4442	}
4443
4444	Instead of invoking all pending watchers, the C<l_invoke> callback will
4445	signal the main thread via some unspecified mechanism (signals? pipe
4446	writes? C<Async::Interrupt>?) and then waits until all pending watchers
4447	have been called (in a while loop because a) spurious wakeups are possible
4448	and b) skipping inter-thread-communication when there are no pending
4449	watchers is very beneficial):
4450
4451	static void
4452	l_invoke (EV_P)
4453	{
4454	userdata *u = ev_userdata (EV_A);
4455
4456	while (ev_pending_count (EV_A))
4457	{
4458	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4459	pthread_cond_wait (&u->invoke_cv, &u->lock);
4460	}
4461	}
4462
4463	Now, whenever the main thread gets told to invoke pending watchers, it
4464	will grab the lock, call C<ev_invoke_pending> and then signal the loop
4465	thread to continue:
4466
4467	static void
4468	real_invoke_pending (EV_P)
4469	{
4470	userdata *u = ev_userdata (EV_A);
4471
4472	pthread_mutex_lock (&u->lock);
4473	ev_invoke_pending (EV_A);
4474	pthread_cond_signal (&u->invoke_cv);
4475	pthread_mutex_unlock (&u->lock);
4476	}
4477
4478	Whenever you want to start/stop a watcher or do other modifications to an
4479	event loop, you will now have to lock:
4480
4481	ev_timer timeout_watcher;
4482	userdata *u = ev_userdata (EV_A);
4483
4484	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4485
4486	pthread_mutex_lock (&u->lock);
4487	ev_timer_start (EV_A_ &timeout_watcher);
4488	ev_async_send (EV_A_ &u->async_w);
4489	pthread_mutex_unlock (&u->lock);
4490
4491	Note that sending the C<ev_async> watcher is required because otherwise
4492	an event loop currently blocking in the kernel will have no knowledge
4493	about the newly added timer. By waking up the loop it will pick up any new
4494	watchers in the next event loop iteration.
4495		4728
4496	=head3 COROUTINES	4729	=head3 COROUTINES
4497		4730
4498	Libev is very accommodating to coroutines ("cooperative threads"):	4731	Libev is very accommodating to coroutines ("cooperative threads"):
4499	libev fully supports nesting calls to its functions from different	4732	libev fully supports nesting calls to its functions from different
…		…
5008	The physical time that is observed. It is apparently strictly monotonic :)	5241	The physical time that is observed. It is apparently strictly monotonic :)
5009		5242
5010	=item wall-clock time	5243	=item wall-clock time
5011		5244
5012	The time and date as shown on clocks. Unlike real time, it can actually	5245	The time and date as shown on clocks. Unlike real time, it can actually
5013	be wrong and jump forwards and backwards, e.g. when the you adjust your	5246	be wrong and jump forwards and backwards, e.g. when you adjust your
5014	clock.	5247	clock.
5015		5248
5016	=item watcher	5249	=item watcher
5017		5250
5018	A data structure that describes interest in certain events. Watchers need	5251	A data structure that describes interest in certain events. Watchers need
…		…
5021	=back	5254	=back
5022		5255
5023	=head1 AUTHOR	5256	=head1 AUTHOR
5024		5257
5025	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael	5258	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5026	Magnusson and Emanuele Giaquinta.	5259	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
5027		5260

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.338 by root, Sun Oct 31 21:16:26 2010 UTC vs. Revision 1.370 by root, Thu Jun 2 23:42:40 2011 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.338 by root, Sun Oct 31 21:16:26 2010 UTC vs.
Revision 1.370 by root, Thu Jun 2 23:42:40 2011 UTC