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

Comparing libev/ev.pod (file contents):
Revision 1.352 by root, Mon Jan 10 14:30:15 2011 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
…		…
442		442
443	This behaviour is useful when you want to do your own signal handling, or	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	444	want to handle signals only in specific threads and want to avoid libev
445	unblocking the signals.	445	unblocking the signals.
446		446
		447	It's also required by POSIX in a threaded program, as libev calls
		448	C<sigprocmask>, whose behaviour is officially unspecified.
		449
447	This flag's behaviour will become the default in future versions of libev.	450	This flag's behaviour will become the default in future versions of libev.
448		451
449	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	452	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
450		453
451	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
…		…
480	=item C<EVBACKEND_EPOLL> (value 4, Linux)	483	=item C<EVBACKEND_EPOLL> (value 4, Linux)
481		484
482	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
483	kernels).	486	kernels).
484		487
485	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
486	but it scales phenomenally better. While poll and select usually scale	489	it scales phenomenally better. While poll and select usually scale like
487	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
488	epoll scales either O(1) or O(active_fds).	491	fd), epoll scales either O(1) or O(active_fds).
489		492
490	The epoll mechanism deserves honorable mention as the most misdesigned	493	The epoll mechanism deserves honorable mention as the most misdesigned
491	of the more advanced event mechanisms: mere annoyances include silently	494	of the more advanced event mechanisms: mere annoyances include silently
492	dropping file descriptors, requiring a system call per change per file	495	dropping file descriptors, requiring a system call per change per file
493	descriptor (and unnecessary guessing of parameters), problems with dup,	496	descriptor (and unnecessary guessing of parameters), problems with dup,
…		…
496	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
497	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
498	set, which can take considerable time (one syscall per file descriptor)	501	set, which can take considerable time (one syscall per file descriptor)
499	and is of course hard to detect.	502	and is of course hard to detect.
500		503
501	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	504	Epoll is also notoriously buggy - embedding epoll fds I<should> work,
502	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
503	I<different> file descriptors (even already closed ones, so one cannot	506	totally I<different> file descriptors (even already closed ones, so
504	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
505	on SMP systems). Libev tries to counter these spurious notifications by	508	(especially on SMP systems). Libev tries to counter these spurious
506	employing an additional generation counter and comparing that against the	509	notifications by employing an additional generation counter and comparing
507	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
508	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
509	perfectly fine with C<select> (files, many character devices...).	515	perfectly fine with C<select> (files, many character devices...).
510		516
511	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...
512		520
513	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
514	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
515	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
516	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
…		…
595	hacks).	603	hacks).
596		604
597	On the negative side, the interface is I<bizarre> - so bizarre that	605	On the negative side, the interface is I<bizarre> - so bizarre that
598	even sun itself gets it wrong in their code examples: The event polling	606	even sun itself gets it wrong in their code examples: The event polling
599	function sometimes returning events to the caller even though an error	607	function sometimes returning events to the caller even though an error
600	occured, but with no indication whether it has done so or not (yes, it's	608	occurred, but with no indication whether it has done so or not (yes, it's
601	even documented that way) - deadly for edge-triggered interfaces where	609	even documented that way) - deadly for edge-triggered interfaces where
602	you absolutely have to know whether an event occured or not because you	610	you absolutely have to know whether an event occurred or not because you
603	have to re-arm the watcher.	611	have to re-arm the watcher.
604		612
605	Fortunately libev seems to be able to work around these idiocies.	613	Fortunately libev seems to be able to work around these idiocies.
606		614
607	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
…		…
820	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
821	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
822	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
823	usually a better approach for this kind of thing.	831	usually a better approach for this kind of thing.
824		832
825	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):
826		836
827	- Increment loop depth.	837	- Increment loop depth.
828	- Reset the ev_break status.	838	- Reset the ev_break status.
829	- Before the first iteration, call any pending watchers.	839	- Before the first iteration, call any pending watchers.
830	LOOP:	840	LOOP:
…		…
863	anymore.	873	anymore.
864		874
865	... queue jobs here, make sure they register event watchers as long	875	... queue jobs here, make sure they register event watchers as long
866	... 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..)
867	ev_run (my_loop, 0);	877	ev_run (my_loop, 0);
868	... jobs done or somebody called unloop. yeah!	878	... jobs done or somebody called break. yeah!
869		879
870	=item ev_break (loop, how)	880	=item ev_break (loop, how)
871		881
872	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
873	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
…		…
1355	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
1356	functions that do not need a watcher.	1366	functions that do not need a watcher.
1357		1367
1358	=back	1368	=back
1359		1369
1360	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1370	See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
1361		1371	OWN COMPOSITE WATCHERS> idioms.
1362	Each watcher has, by default, a member C<void *data> that you can change
1363	and read at any time: libev will completely ignore it. This can be used
1364	to associate arbitrary data with your watcher. If you need more data and
1365	don't want to allocate memory and store a pointer to it in that data
1366	member, you can also "subclass" the watcher type and provide your own
1367	data:
1368
1369	struct my_io
1370	{
1371	ev_io io;
1372	int otherfd;
1373	void *somedata;
1374	struct whatever *mostinteresting;
1375	};
1376
1377	...
1378	struct my_io w;
1379	ev_io_init (&w.io, my_cb, fd, EV_READ);
1380
1381	And since your callback will be called with a pointer to the watcher, you
1382	can cast it back to your own type:
1383
1384	static void my_cb (struct ev_loop loop, ev_io w_, int revents)
1385	{
1386	struct my_io w = (struct my_io )w_;
1387	...
1388	}
1389
1390	More interesting and less C-conformant ways of casting your callback type
1391	instead have been omitted.
1392
1393	Another common scenario is to use some data structure with multiple
1394	embedded watchers:
1395
1396	struct my_biggy
1397	{
1398	int some_data;
1399	ev_timer t1;
1400	ev_timer t2;
1401	}
1402
1403	In this case getting the pointer to C<my_biggy> is a bit more
1404	complicated: Either you store the address of your C<my_biggy> struct
1405	in the C<data> member of the watcher (for woozies), or you need to use
1406	some pointer arithmetic using C<offsetof> inside your watchers (for real
1407	programmers):
1408
1409	#include <stddef.h>
1410
1411	static void
1412	t1_cb (EV_P_ ev_timer *w, int revents)
1413	{
1414	struct my_biggy big = (struct my_biggy *)
1415	(((char *)w) - offsetof (struct my_biggy, t1));
1416	}
1417
1418	static void
1419	t2_cb (EV_P_ ev_timer *w, int revents)
1420	{
1421	struct my_biggy big = (struct my_biggy *)
1422	(((char *)w) - offsetof (struct my_biggy, t2));
1423	}
1424		1372
1425	=head2 WATCHER STATES	1373	=head2 WATCHER STATES
1426		1374
1427	There are various watcher states mentioned throughout this manual -	1375	There are various watcher states mentioned throughout this manual -
1428	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
…		…
1435		1383
1436	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
1437	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
1438	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.
1439		1387
1440	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
1441	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.
1442		1392
1443	=item started/running/active	1393	=item started/running/active
1444		1394
1445	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
1446	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
…		…
1474	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
1475	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
1476	freeing it is often a good idea.	1426	freeing it is often a good idea.
1477		1427
1478	While stopped (and not pending) the watcher is essentially in the	1428	While stopped (and not pending) the watcher is essentially in the
1479	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
1480	you wish.	1430	you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
		1431	it again).
1481		1432
1482	=back	1433	=back
1483		1434
1484	=head2 WATCHER PRIORITY MODELS	1435	=head2 WATCHER PRIORITY MODELS
1485		1436
…		…
1614	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
1615	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
1616	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
1617	required if you know what you are doing).	1568	required if you know what you are doing).
1618		1569
1619	If you cannot use non-blocking mode, then force the use of a
1620	known-to-be-good backend (at the time of this writing, this includes only
1621	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1622	descriptors for which non-blocking operation makes no sense (such as
1623	files) - libev doesn't guarantee any specific behaviour in that case.
1624
1625	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
1626	receive "spurious" readiness notifications, that is your callback might	1571	receive "spurious" readiness notifications, that is, your callback might
1627	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
1628	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
1629	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
1630	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
1631	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1632	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1576	preferable to a program hanging until some data arrives.
1633		1577
1634	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
1635	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
1636	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
1637	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
1638	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
1639	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
1640	indefinitely.	1584	indefinitely.
1641		1585
1642	But really, best use non-blocking mode.	1586	But really, best use non-blocking mode.
1643		1587
…		…
1671		1615
1672	There is no workaround possible except not registering events	1616	There is no workaround possible except not registering events
1673	for potentially C<dup ()>'ed file descriptors, or to resort to	1617	for potentially C<dup ()>'ed file descriptors, or to resort to
1674	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1618	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1675		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
1676	=head3 The special problem of fork	1653	=head3 The special problem of fork
1677		1654
1678	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
1679	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
1680	it in the child.	1657	it in the child if you want to continue to use it in the child.
1681		1658
1682	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
1683	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
1684	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1661	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1685	C<EVBACKEND_POLL>.
1686		1662
1687	=head3 The special problem of SIGPIPE	1663	=head3 The special problem of SIGPIPE
1688		1664
1689	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>:
1690	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
…		…
2180		2156
2181	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
2182	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
2183	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.
2184		2160
2185	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
2186	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
2187	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.
2188		2167
2189	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
2190	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
2191	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
2192	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).
…		…
2335	=head3 The special problem of inheritance over fork/execve/pthread_create	2314	=head3 The special problem of inheritance over fork/execve/pthread_create
2336		2315
2337	Both the signal mask (C<sigprocmask>) and the signal disposition	2316	Both the signal mask (C<sigprocmask>) and the signal disposition
2338	(C<sigaction>) are unspecified after starting a signal watcher (and after	2317	(C<sigaction>) are unspecified after starting a signal watcher (and after
2339	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,
2340	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>).
2341		2321
2342	While this does not matter for the signal disposition (libev never	2322	While this does not matter for the signal disposition (libev never
2343	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
2344	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
2345	certain signals to be blocked.	2325	certain signals to be blocked.
…		…
3216	atexit (program_exits);	3196	atexit (program_exits);
3217		3197
3218		3198
3219	=head2 C<ev_async> - how to wake up an event loop	3199	=head2 C<ev_async> - how to wake up an event loop
3220		3200
3221	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
3222	asynchronous sources such as signal handlers (as opposed to multiple event	3202	asynchronous sources such as signal handlers (as opposed to multiple event
3223	loops - those are of course safe to use in different threads).	3203	loops - those are of course safe to use in different threads).
3224		3204
3225	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,
3226	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>
…		…
3336	trust me.	3316	trust me.
3337		3317
3338	=item ev_async_send (loop, ev_async *)	3318	=item ev_async_send (loop, ev_async *)
3339		3319
3340	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
3341	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
3342	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,
3343	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
3344	section below on what exactly this means).	3326	embedding section below on what exactly this means).
3345		3327
3346	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
3347	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
3348	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>,
3349	reset when the event loop detects that).	3331	reset when the event loop detects that).
…		…
3429		3411
3430	This section explains some common idioms that are not immediately	3412	This section explains some common idioms that are not immediately
3431	obvious. Note that examples are sprinkled over the whole manual, and this	3413	obvious. Note that examples are sprinkled over the whole manual, and this
3432	section only contains stuff that wouldn't fit anywhere else.	3414	section only contains stuff that wouldn't fit anywhere else.
3433		3415
3434	=over 4	3416	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
3435		3417
3436	=item Model/nested event loop invocations and exit conditions.	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
3437		3485
3438	Often (especially in GUI toolkits) there are places where you have	3486	Often (especially in GUI toolkits) there are places where you have
3439	I<modal> interaction, which is most easily implemented by recursively	3487	I<modal> interaction, which is most easily implemented by recursively
3440	invoking C<ev_run>.	3488	invoking C<ev_run>.
3441		3489
…		…
3470	exit_main_loop = 1;	3518	exit_main_loop = 1;
3471		3519
3472	// exit both	3520	// exit both
3473	exit_main_loop = exit_nested_loop = 1;	3521	exit_main_loop = exit_nested_loop = 1;
3474		3522
3475	=back	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.
3476		3718
3477		3719
3478	=head1 LIBEVENT EMULATION	3720	=head1 LIBEVENT EMULATION
3479		3721
3480	Libev offers a compatibility emulation layer for libevent. It cannot	3722	Libev offers a compatibility emulation layer for libevent. It cannot
…		…
3970	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.
3971		4213
3972	In standalone mode, libev will still try to automatically deduce the	4214	In standalone mode, libev will still try to automatically deduce the
3973	configuration, but has to be more conservative.	4215	configuration, but has to be more conservative.
3974		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
3975	=item EV_USE_MONOTONIC	4226	=item EV_USE_MONOTONIC
3976		4227
3977	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
3978	monotonic clock option at both compile time and runtime. Otherwise no	4229	monotonic clock option at both compile time and runtime. Otherwise no
3979	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,
…		…
4410	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:
4411		4662
4412	#include "ev_cpp.h"	4663	#include "ev_cpp.h"
4413	#include "ev.c"	4664	#include "ev.c"
4414		4665
4415	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	4666	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
4416		4667
4417	=head2 THREADS AND COROUTINES	4668	=head2 THREADS AND COROUTINES
4418		4669
4419	=head3 THREADS	4670	=head3 THREADS
4420		4671
…		…
4471	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
4472	watcher callback into the event loop interested in the signal.	4723	watcher callback into the event loop interested in the signal.
4473		4724
4474	=back	4725	=back
4475		4726
4476	=head4 THREAD LOCKING EXAMPLE	4727	See also L<THREAD LOCKING EXAMPLE>.
4477
4478	Here is a fictitious example of how to run an event loop in a different
4479	thread than where callbacks are being invoked and watchers are
4480	created/added/removed.
4481
4482	For a real-world example, see the C<EV::Loop::Async> perl module,
4483	which uses exactly this technique (which is suited for many high-level
4484	languages).
4485
4486	The example uses a pthread mutex to protect the loop data, a condition
4487	variable to wait for callback invocations, an async watcher to notify the
4488	event loop thread and an unspecified mechanism to wake up the main thread.
4489
4490	First, you need to associate some data with the event loop:
4491
4492	typedef struct {
4493	mutex_t lock; /* global loop lock */
4494	ev_async async_w;
4495	thread_t tid;
4496	cond_t invoke_cv;
4497	} userdata;
4498
4499	void prepare_loop (EV_P)
4500	{
4501	// for simplicity, we use a static userdata struct.
4502	static userdata u;
4503
4504	ev_async_init (&u->async_w, async_cb);
4505	ev_async_start (EV_A_ &u->async_w);
4506
4507	pthread_mutex_init (&u->lock, 0);
4508	pthread_cond_init (&u->invoke_cv, 0);
4509
4510	// now associate this with the loop
4511	ev_set_userdata (EV_A_ u);
4512	ev_set_invoke_pending_cb (EV_A_ l_invoke);
4513	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4514
4515	// then create the thread running ev_loop
4516	pthread_create (&u->tid, 0, l_run, EV_A);
4517	}
4518
4519	The callback for the C<ev_async> watcher does nothing: the watcher is used
4520	solely to wake up the event loop so it takes notice of any new watchers
4521	that might have been added:
4522
4523	static void
4524	async_cb (EV_P_ ev_async *w, int revents)
4525	{
4526	// just used for the side effects
4527	}
4528
4529	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4530	protecting the loop data, respectively.
4531
4532	static void
4533	l_release (EV_P)
4534	{
4535	userdata *u = ev_userdata (EV_A);
4536	pthread_mutex_unlock (&u->lock);
4537	}
4538
4539	static void
4540	l_acquire (EV_P)
4541	{
4542	userdata *u = ev_userdata (EV_A);
4543	pthread_mutex_lock (&u->lock);
4544	}
4545
4546	The event loop thread first acquires the mutex, and then jumps straight
4547	into C<ev_run>:
4548
4549	void *
4550	l_run (void *thr_arg)
4551	{
4552	struct ev_loop loop = (struct ev_loop )thr_arg;
4553
4554	l_acquire (EV_A);
4555	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4556	ev_run (EV_A_ 0);
4557	l_release (EV_A);
4558
4559	return 0;
4560	}
4561
4562	Instead of invoking all pending watchers, the C<l_invoke> callback will
4563	signal the main thread via some unspecified mechanism (signals? pipe
4564	writes? C<Async::Interrupt>?) and then waits until all pending watchers
4565	have been called (in a while loop because a) spurious wakeups are possible
4566	and b) skipping inter-thread-communication when there are no pending
4567	watchers is very beneficial):
4568
4569	static void
4570	l_invoke (EV_P)
4571	{
4572	userdata *u = ev_userdata (EV_A);
4573
4574	while (ev_pending_count (EV_A))
4575	{
4576	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4577	pthread_cond_wait (&u->invoke_cv, &u->lock);
4578	}
4579	}
4580
4581	Now, whenever the main thread gets told to invoke pending watchers, it
4582	will grab the lock, call C<ev_invoke_pending> and then signal the loop
4583	thread to continue:
4584
4585	static void
4586	real_invoke_pending (EV_P)
4587	{
4588	userdata *u = ev_userdata (EV_A);
4589
4590	pthread_mutex_lock (&u->lock);
4591	ev_invoke_pending (EV_A);
4592	pthread_cond_signal (&u->invoke_cv);
4593	pthread_mutex_unlock (&u->lock);
4594	}
4595
4596	Whenever you want to start/stop a watcher or do other modifications to an
4597	event loop, you will now have to lock:
4598
4599	ev_timer timeout_watcher;
4600	userdata *u = ev_userdata (EV_A);
4601
4602	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4603
4604	pthread_mutex_lock (&u->lock);
4605	ev_timer_start (EV_A_ &timeout_watcher);
4606	ev_async_send (EV_A_ &u->async_w);
4607	pthread_mutex_unlock (&u->lock);
4608
4609	Note that sending the C<ev_async> watcher is required because otherwise
4610	an event loop currently blocking in the kernel will have no knowledge
4611	about the newly added timer. By waking up the loop it will pick up any new
4612	watchers in the next event loop iteration.
4613		4728
4614	=head3 COROUTINES	4729	=head3 COROUTINES
4615		4730
4616	Libev is very accommodating to coroutines ("cooperative threads"):	4731	Libev is very accommodating to coroutines ("cooperative threads"):
4617	libev fully supports nesting calls to its functions from different	4732	libev fully supports nesting calls to its functions from different
…		…
5126	The physical time that is observed. It is apparently strictly monotonic :)	5241	The physical time that is observed. It is apparently strictly monotonic :)
5127		5242
5128	=item wall-clock time	5243	=item wall-clock time
5129		5244
5130	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
5131	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
5132	clock.	5247	clock.
5133		5248
5134	=item watcher	5249	=item watcher
5135		5250
5136	A data structure that describes interest in certain events. Watchers need	5251	A data structure that describes interest in certain events. Watchers need
…		…
5139	=back	5254	=back
5140		5255
5141	=head1 AUTHOR	5256	=head1 AUTHOR
5142		5257
5143	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael	5258	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5144	Magnusson and Emanuele Giaquinta.	5259	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
5145		5260

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.352 by root, Mon Jan 10 14:30:15 2011 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.352 by root, Mon Jan 10 14:30:15 2011 UTC vs.
Revision 1.370 by root, Thu Jun 2 23:42:40 2011 UTC