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

Comparing libev/ev.pod (file contents):
Revision 1.351 by root, Mon Jan 10 14:24:26 2011 UTC vs.
Revision 1.365 by root, Mon Jan 31 00:07:21 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
…		…
506	employing an additional generation counter and comparing that against the	509	employing an additional generation counter and comparing that against the
507	events to filter out spurious ones, recreating the set when required. Last	510	events to filter out spurious ones, recreating the set when required. Last
508	not least, it also refuses to work with some file descriptors which work	511	not least, it also refuses to work with some file descriptors which work
509	perfectly fine with C<select> (files, many character devices...).	512	perfectly fine with C<select> (files, many character devices...).
510		513
511	Epoll is truly the train wreck analog among event poll mechanisms.	514	Epoll is truly the train wreck analog among event poll mechanisms,
		515	a frankenpoll, cobbled together in a hurry, no thought to design or
		516	interaction with others.
512		517
513	While stopping, setting and starting an I/O watcher in the same iteration	518	While stopping, setting and starting an I/O watcher in the same iteration
514	will result in some caching, there is still a system call per such	519	will result in some caching, there is still a system call per such
515	incident (because the same I<file descriptor> could point to a different	520	incident (because the same I<file descriptor> could point to a different
516	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed	521	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
…		…
592	On the positive side, this backend actually performed fully to	597	On the positive side, this backend actually performed fully to
593	specification in all tests and is fully embeddable, which is a rare feat	598	specification in all tests and is fully embeddable, which is a rare feat
594	among the OS-specific backends (I vastly prefer correctness over speed	599	among the OS-specific backends (I vastly prefer correctness over speed
595	hacks).	600	hacks).
596		601
597	On the negative side, the interface is I<bizarre>, with the event polling	602	On the negative side, the interface is I<bizarre> - so bizarre that
		603	even sun itself gets it wrong in their code examples: The event polling
598	function sometimes returning events to the caller even though an error	604	function sometimes returning events to the caller even though an error
599	occured, but with no indication whether it has done so or not (yes, it's	605	occurred, but with no indication whether it has done so or not (yes, it's
600	even documented that way) - deadly for edge-triggered interfaces, but	606	even documented that way) - deadly for edge-triggered interfaces where
		607	you absolutely have to know whether an event occurred or not because you
		608	have to re-arm the watcher.
		609
601	fortunately libev seems to be able to work around it.	610	Fortunately libev seems to be able to work around these idiocies.
602		611
603	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as	612	This backend maps C<EV_READ> and C<EV_WRITE> in the same way as
604	C<EVBACKEND_POLL>.	613	C<EVBACKEND_POLL>.
605		614
606	=item C<EVBACKEND_ALL>	615	=item C<EVBACKEND_ALL>
…		…
859	anymore.	868	anymore.
860		869
861	... queue jobs here, make sure they register event watchers as long	870	... queue jobs here, make sure they register event watchers as long
862	... as they still have work to do (even an idle watcher will do..)	871	... as they still have work to do (even an idle watcher will do..)
863	ev_run (my_loop, 0);	872	ev_run (my_loop, 0);
864	... jobs done or somebody called unloop. yeah!	873	... jobs done or somebody called break. yeah!
865		874
866	=item ev_break (loop, how)	875	=item ev_break (loop, how)
867		876
868	Can be used to make a call to C<ev_run> return early (but only after it	877	Can be used to make a call to C<ev_run> return early (but only after it
869	has processed all outstanding events). The C<how> argument must be either	878	has processed all outstanding events). The C<how> argument must be either
…		…
1351	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related	1360	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1352	functions that do not need a watcher.	1361	functions that do not need a watcher.
1353		1362
1354	=back	1363	=back
1355		1364
1356	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1365	See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR
1357		1366	OWN COMPOSITE WATCHERS> idioms.
1358	Each watcher has, by default, a member C<void *data> that you can change
1359	and read at any time: libev will completely ignore it. This can be used
1360	to associate arbitrary data with your watcher. If you need more data and
1361	don't want to allocate memory and store a pointer to it in that data
1362	member, you can also "subclass" the watcher type and provide your own
1363	data:
1364
1365	struct my_io
1366	{
1367	ev_io io;
1368	int otherfd;
1369	void *somedata;
1370	struct whatever *mostinteresting;
1371	};
1372
1373	...
1374	struct my_io w;
1375	ev_io_init (&w.io, my_cb, fd, EV_READ);
1376
1377	And since your callback will be called with a pointer to the watcher, you
1378	can cast it back to your own type:
1379
1380	static void my_cb (struct ev_loop loop, ev_io w_, int revents)
1381	{
1382	struct my_io w = (struct my_io )w_;
1383	...
1384	}
1385
1386	More interesting and less C-conformant ways of casting your callback type
1387	instead have been omitted.
1388
1389	Another common scenario is to use some data structure with multiple
1390	embedded watchers:
1391
1392	struct my_biggy
1393	{
1394	int some_data;
1395	ev_timer t1;
1396	ev_timer t2;
1397	}
1398
1399	In this case getting the pointer to C<my_biggy> is a bit more
1400	complicated: Either you store the address of your C<my_biggy> struct
1401	in the C<data> member of the watcher (for woozies), or you need to use
1402	some pointer arithmetic using C<offsetof> inside your watchers (for real
1403	programmers):
1404
1405	#include <stddef.h>
1406
1407	static void
1408	t1_cb (EV_P_ ev_timer *w, int revents)
1409	{
1410	struct my_biggy big = (struct my_biggy *)
1411	(((char *)w) - offsetof (struct my_biggy, t1));
1412	}
1413
1414	static void
1415	t2_cb (EV_P_ ev_timer *w, int revents)
1416	{
1417	struct my_biggy big = (struct my_biggy *)
1418	(((char *)w) - offsetof (struct my_biggy, t2));
1419	}
1420		1367
1421	=head2 WATCHER STATES	1368	=head2 WATCHER STATES
1422		1369
1423	There are various watcher states mentioned throughout this manual -	1370	There are various watcher states mentioned throughout this manual -
1424	active, pending and so on. In this section these states and the rules to	1371	active, pending and so on. In this section these states and the rules to
…		…
1431		1378
1432	Before a watcher can be registered with the event looop it has to be	1379	Before a watcher can be registered with the event looop it has to be
1433	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to	1380	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1434	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.	1381	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1435		1382
1436	In this state it is simply some block of memory that is suitable for use	1383	In this state it is simply some block of memory that is suitable for
1437	in an event loop. It can be moved around, freed, reused etc. at will.	1384	use in an event loop. It can be moved around, freed, reused etc. at
		1385	will - as long as you either keep the memory contents intact, or call
		1386	C<ev_TYPE_init> again.
1438		1387
1439	=item started/running/active	1388	=item started/running/active
1440		1389
1441	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes	1390	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
1442	property of the event loop, and is actively waiting for events. While in	1391	property of the event loop, and is actively waiting for events. While in
…		…
1470	latter will clear any pending state the watcher might be in, regardless	1419	latter will clear any pending state the watcher might be in, regardless
1471	of whether it was active or not, so stopping a watcher explicitly before	1420	of whether it was active or not, so stopping a watcher explicitly before
1472	freeing it is often a good idea.	1421	freeing it is often a good idea.
1473		1422
1474	While stopped (and not pending) the watcher is essentially in the	1423	While stopped (and not pending) the watcher is essentially in the
1475	initialised state, that is it can be reused, moved, modified in any way	1424	initialised state, that is, it can be reused, moved, modified in any way
1476	you wish.	1425	you wish (but when you trash the memory block, you need to C<ev_TYPE_init>
		1426	it again).
1477		1427
1478	=back	1428	=back
1479		1429
1480	=head2 WATCHER PRIORITY MODELS	1430	=head2 WATCHER PRIORITY MODELS
1481		1431
…		…
1610	In general you can register as many read and/or write event watchers per	1560	In general you can register as many read and/or write event watchers per
1611	fd as you want (as long as you don't confuse yourself). Setting all file	1561	fd as you want (as long as you don't confuse yourself). Setting all file
1612	descriptors to non-blocking mode is also usually a good idea (but not	1562	descriptors to non-blocking mode is also usually a good idea (but not
1613	required if you know what you are doing).	1563	required if you know what you are doing).
1614		1564
1615	If you cannot use non-blocking mode, then force the use of a
1616	known-to-be-good backend (at the time of this writing, this includes only
1617	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1618	descriptors for which non-blocking operation makes no sense (such as
1619	files) - libev doesn't guarantee any specific behaviour in that case.
1620
1621	Another thing you have to watch out for is that it is quite easy to	1565	Another thing you have to watch out for is that it is quite easy to
1622	receive "spurious" readiness notifications, that is your callback might	1566	receive "spurious" readiness notifications, that is, your callback might
1623	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1567	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1624	because there is no data. Not only are some backends known to create a	1568	because there is no data. It is very easy to get into this situation even
1625	lot of those (for example Solaris ports), it is very easy to get into	1569	with a relatively standard program structure. Thus it is best to always
1626	this situation even with a relatively standard program structure. Thus	1570	use non-blocking I/O: An extra C<read>(2) returning C<EAGAIN> is far
1627	it is best to always use non-blocking I/O: An extra C<read>(2) returning
1628	C<EAGAIN> is far preferable to a program hanging until some data arrives.	1571	preferable to a program hanging until some data arrives.
1629		1572
1630	If you cannot run the fd in non-blocking mode (for example you should	1573	If you cannot run the fd in non-blocking mode (for example you should
1631	not play around with an Xlib connection), then you have to separately	1574	not play around with an Xlib connection), then you have to separately
1632	re-test whether a file descriptor is really ready with a known-to-be good	1575	re-test whether a file descriptor is really ready with a known-to-be good
1633	interface such as poll (fortunately in our Xlib example, Xlib already	1576	interface such as poll (fortunately in the case of Xlib, it already does
1634	does this on its own, so its quite safe to use). Some people additionally	1577	this on its own, so its quite safe to use). Some people additionally
1635	use C<SIGALRM> and an interval timer, just to be sure you won't block	1578	use C<SIGALRM> and an interval timer, just to be sure you won't block
1636	indefinitely.	1579	indefinitely.
1637		1580
1638	But really, best use non-blocking mode.	1581	But really, best use non-blocking mode.
1639		1582
…		…
1667		1610
1668	There is no workaround possible except not registering events	1611	There is no workaround possible except not registering events
1669	for potentially C<dup ()>'ed file descriptors, or to resort to	1612	for potentially C<dup ()>'ed file descriptors, or to resort to
1670	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.	1613	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1671		1614
		1615	=head3 The special problem of files
		1616
		1617	Many people try to use C<select> (or libev) on file descriptors
		1618	representing files, and expect it to become ready when their program
		1619	doesn't block on disk accesses (which can take a long time on their own).
		1620
		1621	However, this cannot ever work in the "expected" way - you get a readiness
		1622	notification as soon as the kernel knows whether and how much data is
		1623	there, and in the case of open files, that's always the case, so you
		1624	always get a readiness notification instantly, and your read (or possibly
		1625	write) will still block on the disk I/O.
		1626
		1627	Another way to view it is that in the case of sockets, pipes, character
		1628	devices and so on, there is another party (the sender) that delivers data
		1629	on its own, but in the case of files, there is no such thing: the disk
		1630	will not send data on its own, simply because it doesn't know what you
		1631	wish to read - you would first have to request some data.
		1632
		1633	Since files are typically not-so-well supported by advanced notification
		1634	mechanism, libev tries hard to emulate POSIX behaviour with respect
		1635	to files, even though you should not use it. The reason for this is
		1636	convenience: sometimes you want to watch STDIN or STDOUT, which is
		1637	usually a tty, often a pipe, but also sometimes files or special devices
		1638	(for example, C<epoll> on Linux works with F</dev/random> but not with
		1639	F</dev/urandom>), and even though the file might better be served with
		1640	asynchronous I/O instead of with non-blocking I/O, it is still useful when
		1641	it "just works" instead of freezing.
		1642
		1643	So avoid file descriptors pointing to files when you know it (e.g. use
		1644	libeio), but use them when it is convenient, e.g. for STDIN/STDOUT, or
		1645	when you rarely read from a file instead of from a socket, and want to
		1646	reuse the same code path.
		1647
1672	=head3 The special problem of fork	1648	=head3 The special problem of fork
1673		1649
1674	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit	1650	Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1675	useless behaviour. Libev fully supports fork, but needs to be told about	1651	useless behaviour. Libev fully supports fork, but needs to be told about
1676	it in the child.	1652	it in the child if you want to continue to use it in the child.
1677		1653
1678	To support fork in your programs, you either have to call	1654	To support fork in your child processes, you have to call C<ev_loop_fork
1679	C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,	1655	()> after a fork in the child, enable C<EVFLAG_FORKCHECK>, or resort to
1680	enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or	1656	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1681	C<EVBACKEND_POLL>.
1682		1657
1683	=head3 The special problem of SIGPIPE	1658	=head3 The special problem of SIGPIPE
1684		1659
1685	While not really specific to libev, it is easy to forget about C<SIGPIPE>:	1660	While not really specific to libev, it is easy to forget about C<SIGPIPE>:
1686	when writing to a pipe whose other end has been closed, your program gets	1661	when writing to a pipe whose other end has been closed, your program gets
…		…
2331	=head3 The special problem of inheritance over fork/execve/pthread_create	2306	=head3 The special problem of inheritance over fork/execve/pthread_create
2332		2307
2333	Both the signal mask (C<sigprocmask>) and the signal disposition	2308	Both the signal mask (C<sigprocmask>) and the signal disposition
2334	(C<sigaction>) are unspecified after starting a signal watcher (and after	2309	(C<sigaction>) are unspecified after starting a signal watcher (and after
2335	stopping it again), that is, libev might or might not block the signal,	2310	stopping it again), that is, libev might or might not block the signal,
2336	and might or might not set or restore the installed signal handler.	2311	and might or might not set or restore the installed signal handler (but
		2312	see C<EVFLAG_NOSIGMASK>).
2337		2313
2338	While this does not matter for the signal disposition (libev never	2314	While this does not matter for the signal disposition (libev never
2339	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on	2315	sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2340	C<execve>), this matters for the signal mask: many programs do not expect	2316	C<execve>), this matters for the signal mask: many programs do not expect
2341	certain signals to be blocked.	2317	certain signals to be blocked.
…		…
3212	atexit (program_exits);	3188	atexit (program_exits);
3213		3189
3214		3190
3215	=head2 C<ev_async> - how to wake up an event loop	3191	=head2 C<ev_async> - how to wake up an event loop
3216		3192
3217	In general, you cannot use an C<ev_run> from multiple threads or other	3193	In general, you cannot use an C<ev_loop> from multiple threads or other
3218	asynchronous sources such as signal handlers (as opposed to multiple event	3194	asynchronous sources such as signal handlers (as opposed to multiple event
3219	loops - those are of course safe to use in different threads).	3195	loops - those are of course safe to use in different threads).
3220		3196
3221	Sometimes, however, you need to wake up an event loop you do not control,	3197	Sometimes, however, you need to wake up an event loop you do not control,
3222	for example because it belongs to another thread. This is what C<ev_async>	3198	for example because it belongs to another thread. This is what C<ev_async>
…		…
3332	trust me.	3308	trust me.
3333		3309
3334	=item ev_async_send (loop, ev_async *)	3310	=item ev_async_send (loop, ev_async *)
3335		3311
3336	Sends/signals/activates the given C<ev_async> watcher, that is, feeds	3312	Sends/signals/activates the given C<ev_async> watcher, that is, feeds
3337	an C<EV_ASYNC> event on the watcher into the event loop. Unlike	3313	an C<EV_ASYNC> event on the watcher into the event loop, and instantly
		3314	returns.
		3315
3338	C<ev_feed_event>, this call is safe to do from other threads, signal or	3316	Unlike C<ev_feed_event>, this call is safe to do from other threads,
3339	similar contexts (see the discussion of C<EV_ATOMIC_T> in the embedding	3317	signal or similar contexts (see the discussion of C<EV_ATOMIC_T> in the
3340	section below on what exactly this means).	3318	embedding section below on what exactly this means).
3341		3319
3342	Note that, as with other watchers in libev, multiple events might get	3320	Note that, as with other watchers in libev, multiple events might get
3343	compressed into a single callback invocation (another way to look at this	3321	compressed into a single callback invocation (another way to look at this
3344	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,	3322	is that C<ev_async> watchers are level-triggered, set on C<ev_async_send>,
3345	reset when the event loop detects that).	3323	reset when the event loop detects that).
…		…
3425		3403
3426	This section explains some common idioms that are not immediately	3404	This section explains some common idioms that are not immediately
3427	obvious. Note that examples are sprinkled over the whole manual, and this	3405	obvious. Note that examples are sprinkled over the whole manual, and this
3428	section only contains stuff that wouldn't fit anywhere else.	3406	section only contains stuff that wouldn't fit anywhere else.
3429		3407
3430	=over 4	3408	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
3431		3409
3432	=item Model/nested event loop invocations and exit conditions.	3410	Each watcher has, by default, a C<void *data> member that you can read
		3411	or modify at any time: libev will completely ignore it. This can be used
		3412	to associate arbitrary data with your watcher. If you need more data and
		3413	don't want to allocate memory separately and store a pointer to it in that
		3414	data member, you can also "subclass" the watcher type and provide your own
		3415	data:
		3416
		3417	struct my_io
		3418	{
		3419	ev_io io;
		3420	int otherfd;
		3421	void *somedata;
		3422	struct whatever *mostinteresting;
		3423	};
		3424
		3425	...
		3426	struct my_io w;
		3427	ev_io_init (&w.io, my_cb, fd, EV_READ);
		3428
		3429	And since your callback will be called with a pointer to the watcher, you
		3430	can cast it back to your own type:
		3431
		3432	static void my_cb (struct ev_loop loop, ev_io w_, int revents)
		3433	{
		3434	struct my_io w = (struct my_io )w_;
		3435	...
		3436	}
		3437
		3438	More interesting and less C-conformant ways of casting your callback
		3439	function type instead have been omitted.
		3440
		3441	=head2 BUILDING YOUR OWN COMPOSITE WATCHERS
		3442
		3443	Another common scenario is to use some data structure with multiple
		3444	embedded watchers, in effect creating your own watcher that combines
		3445	multiple libev event sources into one "super-watcher":
		3446
		3447	struct my_biggy
		3448	{
		3449	int some_data;
		3450	ev_timer t1;
		3451	ev_timer t2;
		3452	}
		3453
		3454	In this case getting the pointer to C<my_biggy> is a bit more
		3455	complicated: Either you store the address of your C<my_biggy> struct in
		3456	the C<data> member of the watcher (for woozies or C++ coders), or you need
		3457	to use some pointer arithmetic using C<offsetof> inside your watchers (for
		3458	real programmers):
		3459
		3460	#include <stddef.h>
		3461
		3462	static void
		3463	t1_cb (EV_P_ ev_timer *w, int revents)
		3464	{
		3465	struct my_biggy big = (struct my_biggy *)
		3466	(((char *)w) - offsetof (struct my_biggy, t1));
		3467	}
		3468
		3469	static void
		3470	t2_cb (EV_P_ ev_timer *w, int revents)
		3471	{
		3472	struct my_biggy big = (struct my_biggy *)
		3473	(((char *)w) - offsetof (struct my_biggy, t2));
		3474	}
		3475
		3476	=head2 MODEL/NESTED EVENT LOOP INVOCATIONS AND EXIT CONDITIONS
3433		3477
3434	Often (especially in GUI toolkits) there are places where you have	3478	Often (especially in GUI toolkits) there are places where you have
3435	I<modal> interaction, which is most easily implemented by recursively	3479	I<modal> interaction, which is most easily implemented by recursively
3436	invoking C<ev_run>.	3480	invoking C<ev_run>.
3437		3481
…		…
3466	exit_main_loop = 1;	3510	exit_main_loop = 1;
3467		3511
3468	// exit both	3512	// exit both
3469	exit_main_loop = exit_nested_loop = 1;	3513	exit_main_loop = exit_nested_loop = 1;
3470		3514
3471	=back	3515	=head2 THREAD LOCKING EXAMPLE
		3516
		3517	Here is a fictitious example of how to run an event loop in a different
		3518	thread from where callbacks are being invoked and watchers are
		3519	created/added/removed.
		3520
		3521	For a real-world example, see the C<EV::Loop::Async> perl module,
		3522	which uses exactly this technique (which is suited for many high-level
		3523	languages).
		3524
		3525	The example uses a pthread mutex to protect the loop data, a condition
		3526	variable to wait for callback invocations, an async watcher to notify the
		3527	event loop thread and an unspecified mechanism to wake up the main thread.
		3528
		3529	First, you need to associate some data with the event loop:
		3530
		3531	typedef struct {
		3532	mutex_t lock; /* global loop lock */
		3533	ev_async async_w;
		3534	thread_t tid;
		3535	cond_t invoke_cv;
		3536	} userdata;
		3537
		3538	void prepare_loop (EV_P)
		3539	{
		3540	// for simplicity, we use a static userdata struct.
		3541	static userdata u;
		3542
		3543	ev_async_init (&u->async_w, async_cb);
		3544	ev_async_start (EV_A_ &u->async_w);
		3545
		3546	pthread_mutex_init (&u->lock, 0);
		3547	pthread_cond_init (&u->invoke_cv, 0);
		3548
		3549	// now associate this with the loop
		3550	ev_set_userdata (EV_A_ u);
		3551	ev_set_invoke_pending_cb (EV_A_ l_invoke);
		3552	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
		3553
		3554	// then create the thread running ev_run
		3555	pthread_create (&u->tid, 0, l_run, EV_A);
		3556	}
		3557
		3558	The callback for the C<ev_async> watcher does nothing: the watcher is used
		3559	solely to wake up the event loop so it takes notice of any new watchers
		3560	that might have been added:
		3561
		3562	static void
		3563	async_cb (EV_P_ ev_async *w, int revents)
		3564	{
		3565	// just used for the side effects
		3566	}
		3567
		3568	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
		3569	protecting the loop data, respectively.
		3570
		3571	static void
		3572	l_release (EV_P)
		3573	{
		3574	userdata *u = ev_userdata (EV_A);
		3575	pthread_mutex_unlock (&u->lock);
		3576	}
		3577
		3578	static void
		3579	l_acquire (EV_P)
		3580	{
		3581	userdata *u = ev_userdata (EV_A);
		3582	pthread_mutex_lock (&u->lock);
		3583	}
		3584
		3585	The event loop thread first acquires the mutex, and then jumps straight
		3586	into C<ev_run>:
		3587
		3588	void *
		3589	l_run (void *thr_arg)
		3590	{
		3591	struct ev_loop loop = (struct ev_loop )thr_arg;
		3592
		3593	l_acquire (EV_A);
		3594	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
		3595	ev_run (EV_A_ 0);
		3596	l_release (EV_A);
		3597
		3598	return 0;
		3599	}
		3600
		3601	Instead of invoking all pending watchers, the C<l_invoke> callback will
		3602	signal the main thread via some unspecified mechanism (signals? pipe
		3603	writes? C<Async::Interrupt>?) and then waits until all pending watchers
		3604	have been called (in a while loop because a) spurious wakeups are possible
		3605	and b) skipping inter-thread-communication when there are no pending
		3606	watchers is very beneficial):
		3607
		3608	static void
		3609	l_invoke (EV_P)
		3610	{
		3611	userdata *u = ev_userdata (EV_A);
		3612
		3613	while (ev_pending_count (EV_A))
		3614	{
		3615	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
		3616	pthread_cond_wait (&u->invoke_cv, &u->lock);
		3617	}
		3618	}
		3619
		3620	Now, whenever the main thread gets told to invoke pending watchers, it
		3621	will grab the lock, call C<ev_invoke_pending> and then signal the loop
		3622	thread to continue:
		3623
		3624	static void
		3625	real_invoke_pending (EV_P)
		3626	{
		3627	userdata *u = ev_userdata (EV_A);
		3628
		3629	pthread_mutex_lock (&u->lock);
		3630	ev_invoke_pending (EV_A);
		3631	pthread_cond_signal (&u->invoke_cv);
		3632	pthread_mutex_unlock (&u->lock);
		3633	}
		3634
		3635	Whenever you want to start/stop a watcher or do other modifications to an
		3636	event loop, you will now have to lock:
		3637
		3638	ev_timer timeout_watcher;
		3639	userdata *u = ev_userdata (EV_A);
		3640
		3641	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
		3642
		3643	pthread_mutex_lock (&u->lock);
		3644	ev_timer_start (EV_A_ &timeout_watcher);
		3645	ev_async_send (EV_A_ &u->async_w);
		3646	pthread_mutex_unlock (&u->lock);
		3647
		3648	Note that sending the C<ev_async> watcher is required because otherwise
		3649	an event loop currently blocking in the kernel will have no knowledge
		3650	about the newly added timer. By waking up the loop it will pick up any new
		3651	watchers in the next event loop iteration.
		3652
		3653	=head2 THREADS, COROUTINES, CONTINUATIONS, QUEUES... INSTEAD OF CALLBACKS
		3654
		3655	While the overhead of a callback that e.g. schedules a thread is small, it
		3656	is still an overhead. If you embed libev, and your main usage is with some
		3657	kind of threads or coroutines, you might want to customise libev so that
		3658	doesn't need callbacks anymore.
		3659
		3660	Imagine you have coroutines that you can switch to using a function
		3661	C<switch_to (coro)>, that libev runs in a coroutine called C<libev_coro>
		3662	and that due to some magic, the currently active coroutine is stored in a
		3663	global called C<current_coro>. Then you can build your own "wait for libev
		3664	event" primitive by changing C<EV_CB_DECLARE> and C<EV_CB_INVOKE> (note
		3665	the differing C<;> conventions):
		3666
		3667	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3668	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
		3669
		3670	That means instead of having a C callback function, you store the
		3671	coroutine to switch to in each watcher, and instead of having libev call
		3672	your callback, you instead have it switch to that coroutine.
		3673
		3674	A coroutine might now wait for an event with a function called
		3675	C<wait_for_event>. (the watcher needs to be started, as always, but it doesn't
		3676	matter when, or whether the watcher is active or not when this function is
		3677	called):
		3678
		3679	void
		3680	wait_for_event (ev_watcher *w)
		3681	{
		3682	ev_cb_set (w) = current_coro;
		3683	switch_to (libev_coro);
		3684	}
		3685
		3686	That basically suspends the coroutine inside C<wait_for_event> and
		3687	continues the libev coroutine, which, when appropriate, switches back to
		3688	this or any other coroutine. I am sure if you sue this your own :)
		3689
		3690	You can do similar tricks if you have, say, threads with an event queue -
		3691	instead of storing a coroutine, you store the queue object and instead of
		3692	switching to a coroutine, you push the watcher onto the queue and notify
		3693	any waiters.
		3694
		3695	To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two
		3696	files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
		3697
		3698	// my_ev.h
		3699	#define EV_CB_DECLARE(type) struct my_coro *cb;
		3700	#define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
		3701	#include "../libev/ev.h"
		3702
		3703	// my_ev.c
		3704	#define EV_H "my_ev.h"
		3705	#include "../libev/ev.c"
		3706
		3707	And then use F<my_ev.h> when you would normally use F<ev.h>, and compile
		3708	F<my_ev.c> into your project. When properly specifying include paths, you
		3709	can even use F<ev.h> as header file name directly.
3472		3710
3473		3711
3474	=head1 LIBEVENT EMULATION	3712	=head1 LIBEVENT EMULATION
3475		3713
3476	Libev offers a compatibility emulation layer for libevent. It cannot	3714	Libev offers a compatibility emulation layer for libevent. It cannot
…		…
4406	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4644	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
4407		4645
4408	#include "ev_cpp.h"	4646	#include "ev_cpp.h"
4409	#include "ev.c"	4647	#include "ev.c"
4410		4648
4411	=head1 INTERACTION WITH OTHER PROGRAMS OR LIBRARIES	4649	=head1 INTERACTION WITH OTHER PROGRAMS, LIBRARIES OR THE ENVIRONMENT
4412		4650
4413	=head2 THREADS AND COROUTINES	4651	=head2 THREADS AND COROUTINES
4414		4652
4415	=head3 THREADS	4653	=head3 THREADS
4416		4654
…		…
4467	default loop and triggering an C<ev_async> watcher from the default loop	4705	default loop and triggering an C<ev_async> watcher from the default loop
4468	watcher callback into the event loop interested in the signal.	4706	watcher callback into the event loop interested in the signal.
4469		4707
4470	=back	4708	=back
4471		4709
4472	=head4 THREAD LOCKING EXAMPLE	4710	See also L<THREAD LOCKING EXAMPLE>.
4473
4474	Here is a fictitious example of how to run an event loop in a different
4475	thread than where callbacks are being invoked and watchers are
4476	created/added/removed.
4477
4478	For a real-world example, see the C<EV::Loop::Async> perl module,
4479	which uses exactly this technique (which is suited for many high-level
4480	languages).
4481
4482	The example uses a pthread mutex to protect the loop data, a condition
4483	variable to wait for callback invocations, an async watcher to notify the
4484	event loop thread and an unspecified mechanism to wake up the main thread.
4485
4486	First, you need to associate some data with the event loop:
4487
4488	typedef struct {
4489	mutex_t lock; /* global loop lock */
4490	ev_async async_w;
4491	thread_t tid;
4492	cond_t invoke_cv;
4493	} userdata;
4494
4495	void prepare_loop (EV_P)
4496	{
4497	// for simplicity, we use a static userdata struct.
4498	static userdata u;
4499
4500	ev_async_init (&u->async_w, async_cb);
4501	ev_async_start (EV_A_ &u->async_w);
4502
4503	pthread_mutex_init (&u->lock, 0);
4504	pthread_cond_init (&u->invoke_cv, 0);
4505
4506	// now associate this with the loop
4507	ev_set_userdata (EV_A_ u);
4508	ev_set_invoke_pending_cb (EV_A_ l_invoke);
4509	ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4510
4511	// then create the thread running ev_loop
4512	pthread_create (&u->tid, 0, l_run, EV_A);
4513	}
4514
4515	The callback for the C<ev_async> watcher does nothing: the watcher is used
4516	solely to wake up the event loop so it takes notice of any new watchers
4517	that might have been added:
4518
4519	static void
4520	async_cb (EV_P_ ev_async *w, int revents)
4521	{
4522	// just used for the side effects
4523	}
4524
4525	The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4526	protecting the loop data, respectively.
4527
4528	static void
4529	l_release (EV_P)
4530	{
4531	userdata *u = ev_userdata (EV_A);
4532	pthread_mutex_unlock (&u->lock);
4533	}
4534
4535	static void
4536	l_acquire (EV_P)
4537	{
4538	userdata *u = ev_userdata (EV_A);
4539	pthread_mutex_lock (&u->lock);
4540	}
4541
4542	The event loop thread first acquires the mutex, and then jumps straight
4543	into C<ev_run>:
4544
4545	void *
4546	l_run (void *thr_arg)
4547	{
4548	struct ev_loop loop = (struct ev_loop )thr_arg;
4549
4550	l_acquire (EV_A);
4551	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4552	ev_run (EV_A_ 0);
4553	l_release (EV_A);
4554
4555	return 0;
4556	}
4557
4558	Instead of invoking all pending watchers, the C<l_invoke> callback will
4559	signal the main thread via some unspecified mechanism (signals? pipe
4560	writes? C<Async::Interrupt>?) and then waits until all pending watchers
4561	have been called (in a while loop because a) spurious wakeups are possible
4562	and b) skipping inter-thread-communication when there are no pending
4563	watchers is very beneficial):
4564
4565	static void
4566	l_invoke (EV_P)
4567	{
4568	userdata *u = ev_userdata (EV_A);
4569
4570	while (ev_pending_count (EV_A))
4571	{
4572	wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4573	pthread_cond_wait (&u->invoke_cv, &u->lock);
4574	}
4575	}
4576
4577	Now, whenever the main thread gets told to invoke pending watchers, it
4578	will grab the lock, call C<ev_invoke_pending> and then signal the loop
4579	thread to continue:
4580
4581	static void
4582	real_invoke_pending (EV_P)
4583	{
4584	userdata *u = ev_userdata (EV_A);
4585
4586	pthread_mutex_lock (&u->lock);
4587	ev_invoke_pending (EV_A);
4588	pthread_cond_signal (&u->invoke_cv);
4589	pthread_mutex_unlock (&u->lock);
4590	}
4591
4592	Whenever you want to start/stop a watcher or do other modifications to an
4593	event loop, you will now have to lock:
4594
4595	ev_timer timeout_watcher;
4596	userdata *u = ev_userdata (EV_A);
4597
4598	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4599
4600	pthread_mutex_lock (&u->lock);
4601	ev_timer_start (EV_A_ &timeout_watcher);
4602	ev_async_send (EV_A_ &u->async_w);
4603	pthread_mutex_unlock (&u->lock);
4604
4605	Note that sending the C<ev_async> watcher is required because otherwise
4606	an event loop currently blocking in the kernel will have no knowledge
4607	about the newly added timer. By waking up the loop it will pick up any new
4608	watchers in the next event loop iteration.
4609		4711
4610	=head3 COROUTINES	4712	=head3 COROUTINES
4611		4713
4612	Libev is very accommodating to coroutines ("cooperative threads"):	4714	Libev is very accommodating to coroutines ("cooperative threads"):
4613	libev fully supports nesting calls to its functions from different	4715	libev fully supports nesting calls to its functions from different
…		…
5135	=back	5237	=back
5136		5238
5137	=head1 AUTHOR	5239	=head1 AUTHOR
5138		5240
5139	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael	5241	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
5140	Magnusson and Emanuele Giaquinta.	5242	Magnusson and Emanuele Giaquinta, and minor corrections by many others.
5141		5243

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.351 by root, Mon Jan 10 14:24:26 2011 UTC vs. Revision 1.365 by root, Mon Jan 31 00:07:21 2011 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.351 by root, Mon Jan 10 14:24:26 2011 UTC vs.
Revision 1.365 by root, Mon Jan 31 00:07:21 2011 UTC