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

Comparing libev/ev.pod (file contents):
Revision 1.60 by root, Wed Nov 28 18:29:30 2007 UTC vs.
Revision 1.80 by root, Sun Dec 9 19:47:30 2007 UTC

…		…
47		47
48	return 0;	48	return 0;
49	}	49	}
50		50
51	=head1 DESCRIPTION	51	=head1 DESCRIPTION
		52
		53	The newest version of this document is also available as a html-formatted
		54	web page you might find easier to navigate when reading it for the first
		55	time: L<http://cvs.schmorp.de/libev/ev.html>.
52		56
53	Libev is an event loop: you register interest in certain events (such as a	57	Libev is an event loop: you register interest in certain events (such as a
54	file descriptor being readable or a timeout occuring), and it will manage	58	file descriptor being readable or a timeout occuring), and it will manage
55	these event sources and provide your program with events.	59	these event sources and provide your program with events.
56		60
…		…
113		117
114	=item int ev_version_major ()	118	=item int ev_version_major ()
115		119
116	=item int ev_version_minor ()	120	=item int ev_version_minor ()
117		121
118	You can find out the major and minor version numbers of the library	122	You can find out the major and minor ABI version numbers of the library
119	you linked against by calling the functions C<ev_version_major> and	123	you linked against by calling the functions C<ev_version_major> and
120	C<ev_version_minor>. If you want, you can compare against the global	124	C<ev_version_minor>. If you want, you can compare against the global
121	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the	125	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
122	version of the library your program was compiled against.	126	version of the library your program was compiled against.
123		127
		128	These version numbers refer to the ABI version of the library, not the
		129	release version.
		130
124	Usually, it's a good idea to terminate if the major versions mismatch,	131	Usually, it's a good idea to terminate if the major versions mismatch,
125	as this indicates an incompatible change. Minor versions are usually	132	as this indicates an incompatible change. Minor versions are usually
126	compatible to older versions, so a larger minor version alone is usually	133	compatible to older versions, so a larger minor version alone is usually
127	not a problem.	134	not a problem.
128		135
129	Example: Make sure we haven't accidentally been linked against the wrong	136	Example: Make sure we haven't accidentally been linked against the wrong
130	version.	137	version.
…		…
266	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	273	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
267	override the flags completely if it is found in the environment. This is	274	override the flags completely if it is found in the environment. This is
268	useful to try out specific backends to test their performance, or to work	275	useful to try out specific backends to test their performance, or to work
269	around bugs.	276	around bugs.
270		277
		278	=item C<EVFLAG_FORKCHECK>
		279
		280	Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after
		281	a fork, you can also make libev check for a fork in each iteration by
		282	enabling this flag.
		283
		284	This works by calling C<getpid ()> on every iteration of the loop,
		285	and thus this might slow down your event loop if you do a lot of loop
		286	iterations and little real work, but is usually not noticeable (on my
		287	Linux system for example, C<getpid> is actually a simple 5-insn sequence
		288	without a syscall and thus I<very> fast, but my Linux system also has
		289	C<pthread_atfork> which is even faster).
		290
		291	The big advantage of this flag is that you can forget about fork (and
		292	forget about forgetting to tell libev about forking) when you use this
		293	flag.
		294
		295	This flag setting cannot be overriden or specified in the C<LIBEV_FLAGS>
		296	environment variable.
		297
271	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	298	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
272		299
273	This is your standard select(2) backend. Not I<completely> standard, as	300	This is your standard select(2) backend. Not I<completely> standard, as
274	libev tries to roll its own fd_set with no limits on the number of fds,	301	libev tries to roll its own fd_set with no limits on the number of fds,
275	but if that fails, expect a fairly low limit on the number of fds when	302	but if that fails, expect a fairly low limit on the number of fds when
…		…
410		437
411	Like C<ev_default_fork>, but acts on an event loop created by	438	Like C<ev_default_fork>, but acts on an event loop created by
412	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	439	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
413	after fork, and how you do this is entirely your own problem.	440	after fork, and how you do this is entirely your own problem.
414		441
		442	=item unsigned int ev_loop_count (loop)
		443
		444	Returns the count of loop iterations for the loop, which is identical to
		445	the number of times libev did poll for new events. It starts at C<0> and
		446	happily wraps around with enough iterations.
		447
		448	This value can sometimes be useful as a generation counter of sorts (it
		449	"ticks" the number of loop iterations), as it roughly corresponds with
		450	C<ev_prepare> and C<ev_check> calls.
		451
415	=item unsigned int ev_backend (loop)	452	=item unsigned int ev_backend (loop)
416		453
417	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	454	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
418	use.	455	use.
419		456
…		…
452	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is	489	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
453	usually a better approach for this kind of thing.	490	usually a better approach for this kind of thing.
454		491
455	Here are the gory details of what C<ev_loop> does:	492	Here are the gory details of what C<ev_loop> does:
456		493
		494	- Before the first iteration, call any pending watchers.
457	* If there are no active watchers (reference count is zero), return.	495	* If there are no active watchers (reference count is zero), return.
458	- Queue prepare watchers and then call all outstanding watchers.	496	- Queue all prepare watchers and then call all outstanding watchers.
459	- If we have been forked, recreate the kernel state.	497	- If we have been forked, recreate the kernel state.
460	- Update the kernel state with all outstanding changes.	498	- Update the kernel state with all outstanding changes.
461	- Update the "event loop time".	499	- Update the "event loop time".
462	- Calculate for how long to block.	500	- Calculate for how long to block.
463	- Block the process, waiting for any events.	501	- Block the process, waiting for any events.
…		…
702	=item bool ev_is_pending (ev_TYPE *watcher)	740	=item bool ev_is_pending (ev_TYPE *watcher)
703		741
704	Returns a true value iff the watcher is pending, (i.e. it has outstanding	742	Returns a true value iff the watcher is pending, (i.e. it has outstanding
705	events but its callback has not yet been invoked). As long as a watcher	743	events but its callback has not yet been invoked). As long as a watcher
706	is pending (but not active) you must not call an init function on it (but	744	is pending (but not active) you must not call an init function on it (but
707	C<ev_TYPE_set> is safe) and you must make sure the watcher is available to	745	C<ev_TYPE_set> is safe), you must not change its priority, and you must
708	libev (e.g. you cnanot C<free ()> it).	746	make sure the watcher is available to libev (e.g. you cannot C<free ()>
		747	it).
709		748
710	=item callback ev_cb (ev_TYPE *watcher)	749	=item callback ev_cb (ev_TYPE *watcher)
711		750
712	Returns the callback currently set on the watcher.	751	Returns the callback currently set on the watcher.
713		752
714	=item ev_cb_set (ev_TYPE *watcher, callback)	753	=item ev_cb_set (ev_TYPE *watcher, callback)
715		754
716	Change the callback. You can change the callback at virtually any time	755	Change the callback. You can change the callback at virtually any time
717	(modulo threads).	756	(modulo threads).
		757
		758	=item ev_set_priority (ev_TYPE *watcher, priority)
		759
		760	=item int ev_priority (ev_TYPE *watcher)
		761
		762	Set and query the priority of the watcher. The priority is a small
		763	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
		764	(default: C<-2>). Pending watchers with higher priority will be invoked
		765	before watchers with lower priority, but priority will not keep watchers
		766	from being executed (except for C<ev_idle> watchers).
		767
		768	This means that priorities are I<only> used for ordering callback
		769	invocation after new events have been received. This is useful, for
		770	example, to reduce latency after idling, or more often, to bind two
		771	watchers on the same event and make sure one is called first.
		772
		773	If you need to suppress invocation when higher priority events are pending
		774	you need to look at C<ev_idle> watchers, which provide this functionality.
		775
		776	You I<must not> change the priority of a watcher as long as it is active or
		777	pending.
		778
		779	The default priority used by watchers when no priority has been set is
		780	always C<0>, which is supposed to not be too high and not be too low :).
		781
		782	Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
		783	fine, as long as you do not mind that the priority value you query might
		784	or might not have been adjusted to be within valid range.
		785
		786	=item ev_invoke (loop, ev_TYPE *watcher, int revents)
		787
		788	Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
		789	C<loop> nor C<revents> need to be valid as long as the watcher callback
		790	can deal with that fact.
		791
		792	=item int ev_clear_pending (loop, ev_TYPE *watcher)
		793
		794	If the watcher is pending, this function returns clears its pending status
		795	and returns its C<revents> bitset (as if its callback was invoked). If the
		796	watcher isn't pending it does nothing and returns C<0>.
718		797
719	=back	798	=back
720		799
721		800
722	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	801	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
…		…
828	it is best to always use non-blocking I/O: An extra C<read>(2) returning	907	it is best to always use non-blocking I/O: An extra C<read>(2) returning
829	C<EAGAIN> is far preferable to a program hanging until some data arrives.	908	C<EAGAIN> is far preferable to a program hanging until some data arrives.
830		909
831	If you cannot run the fd in non-blocking mode (for example you should not	910	If you cannot run the fd in non-blocking mode (for example you should not
832	play around with an Xlib connection), then you have to seperately re-test	911	play around with an Xlib connection), then you have to seperately re-test
833	wether a file descriptor is really ready with a known-to-be good interface	912	whether a file descriptor is really ready with a known-to-be good interface
834	such as poll (fortunately in our Xlib example, Xlib already does this on	913	such as poll (fortunately in our Xlib example, Xlib already does this on
835	its own, so its quite safe to use).	914	its own, so its quite safe to use).
836		915
837	=over 4	916	=over 4
838		917
…		…
916	=item ev_timer_again (loop)	995	=item ev_timer_again (loop)
917		996
918	This will act as if the timer timed out and restart it again if it is	997	This will act as if the timer timed out and restart it again if it is
919	repeating. The exact semantics are:	998	repeating. The exact semantics are:
920		999
		1000	If the timer is pending, its pending status is cleared.
		1001
921	If the timer is started but nonrepeating, stop it.	1002	If the timer is started but nonrepeating, stop it (as if it timed out).
922		1003
923	If the timer is repeating, either start it if necessary (with the repeat	1004	If the timer is repeating, either start it if necessary (with the
924	value), or reset the running timer to the repeat value.	1005	C<repeat> value), or reset the running timer to the C<repeat> value.
925		1006
926	This sounds a bit complicated, but here is a useful and typical	1007	This sounds a bit complicated, but here is a useful and typical
927	example: Imagine you have a tcp connection and you want a so-called	1008	example: Imagine you have a tcp connection and you want a so-called idle
928	idle timeout, that is, you want to be called when there have been,	1009	timeout, that is, you want to be called when there have been, say, 60
929	say, 60 seconds of inactivity on the socket. The easiest way to do	1010	seconds of inactivity on the socket. The easiest way to do this is to
930	this is to configure an C<ev_timer> with C<after>=C<repeat>=C<60> and calling	1011	configure an C<ev_timer> with a C<repeat> value of C<60> and then call
931	C<ev_timer_again> each time you successfully read or write some data. If	1012	C<ev_timer_again> each time you successfully read or write some data. If
932	you go into an idle state where you do not expect data to travel on the	1013	you go into an idle state where you do not expect data to travel on the
933	socket, you can stop the timer, and again will automatically restart it if	1014	socket, you can C<ev_timer_stop> the timer, and C<ev_timer_again> will
934	need be.	1015	automatically restart it if need be.
935		1016
936	You can also ignore the C<after> value and C<ev_timer_start> altogether	1017	That means you can ignore the C<after> value and C<ev_timer_start>
937	and only ever use the C<repeat> value:	1018	altogether and only ever use the C<repeat> value and C<ev_timer_again>:
938		1019
939	ev_timer_init (timer, callback, 0., 5.);	1020	ev_timer_init (timer, callback, 0., 5.);
940	ev_timer_again (loop, timer);	1021	ev_timer_again (loop, timer);
941	...	1022	...
942	timer->again = 17.;	1023	timer->again = 17.;
943	ev_timer_again (loop, timer);	1024	ev_timer_again (loop, timer);
944	...	1025	...
945	timer->again = 10.;	1026	timer->again = 10.;
946	ev_timer_again (loop, timer);	1027	ev_timer_again (loop, timer);
947		1028
948	This is more efficient then stopping/starting the timer eahc time you want	1029	This is more slightly efficient then stopping/starting the timer each time
949	to modify its timeout value.	1030	you want to modify its timeout value.
950		1031
951	=item ev_tstamp repeat [read-write]	1032	=item ev_tstamp repeat [read-write]
952		1033
953	The current C<repeat> value. Will be used each time the watcher times out	1034	The current C<repeat> value. Will be used each time the watcher times out
954	or C<ev_timer_again> is called and determines the next timeout (if any),	1035	or C<ev_timer_again> is called and determines the next timeout (if any),
…		…
996	but on wallclock time (absolute time). You can tell a periodic watcher	1077	but on wallclock time (absolute time). You can tell a periodic watcher
997	to trigger "at" some specific point in time. For example, if you tell a	1078	to trigger "at" some specific point in time. For example, if you tell a
998	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()	1079	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
999	+ 10.>) and then reset your system clock to the last year, then it will	1080	+ 10.>) and then reset your system clock to the last year, then it will
1000	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	1081	take a year to trigger the event (unlike an C<ev_timer>, which would trigger
1001	roughly 10 seconds later and of course not if you reset your system time	1082	roughly 10 seconds later).
1002	again).
1003		1083
1004	They can also be used to implement vastly more complex timers, such as	1084	They can also be used to implement vastly more complex timers, such as
1005	triggering an event on eahc midnight, local time.	1085	triggering an event on each midnight, local time or other, complicated,
		1086	rules.
1006		1087
1007	As with timers, the callback is guarenteed to be invoked only when the	1088	As with timers, the callback is guarenteed to be invoked only when the
1008	time (C<at>) has been passed, but if multiple periodic timers become ready	1089	time (C<at>) has been passed, but if multiple periodic timers become ready
1009	during the same loop iteration then order of execution is undefined.	1090	during the same loop iteration then order of execution is undefined.
1010		1091
…		…
1017	Lots of arguments, lets sort it out... There are basically three modes of	1098	Lots of arguments, lets sort it out... There are basically three modes of
1018	operation, and we will explain them from simplest to complex:	1099	operation, and we will explain them from simplest to complex:
1019		1100
1020	=over 4	1101	=over 4
1021		1102
1022	=item * absolute timer (interval = reschedule_cb = 0)	1103	=item * absolute timer (at = time, interval = reschedule_cb = 0)
1023		1104
1024	In this configuration the watcher triggers an event at the wallclock time	1105	In this configuration the watcher triggers an event at the wallclock time
1025	C<at> and doesn't repeat. It will not adjust when a time jump occurs,	1106	C<at> and doesn't repeat. It will not adjust when a time jump occurs,
1026	that is, if it is to be run at January 1st 2011 then it will run when the	1107	that is, if it is to be run at January 1st 2011 then it will run when the
1027	system time reaches or surpasses this time.	1108	system time reaches or surpasses this time.
1028		1109
1029	=item * non-repeating interval timer (interval > 0, reschedule_cb = 0)	1110	=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1030		1111
1031	In this mode the watcher will always be scheduled to time out at the next	1112	In this mode the watcher will always be scheduled to time out at the next
1032	C<at + N * interval> time (for some integer N) and then repeat, regardless	1113	C<at + N * interval> time (for some integer N, which can also be negative)
1033	of any time jumps.	1114	and then repeat, regardless of any time jumps.
1034		1115
1035	This can be used to create timers that do not drift with respect to system	1116	This can be used to create timers that do not drift with respect to system
1036	time:	1117	time:
1037		1118
1038	ev_periodic_set (&periodic, 0., 3600., 0);	1119	ev_periodic_set (&periodic, 0., 3600., 0);
…		…
1044		1125
1045	Another way to think about it (for the mathematically inclined) is that	1126	Another way to think about it (for the mathematically inclined) is that
1046	C<ev_periodic> will try to run the callback in this mode at the next possible	1127	C<ev_periodic> will try to run the callback in this mode at the next possible
1047	time where C<time = at (mod interval)>, regardless of any time jumps.	1128	time where C<time = at (mod interval)>, regardless of any time jumps.
1048		1129
		1130	For numerical stability it is preferable that the C<at> value is near
		1131	C<ev_now ()> (the current time), but there is no range requirement for
		1132	this value.
		1133
1049	=item * manual reschedule mode (reschedule_cb = callback)	1134	=item * manual reschedule mode (at and interval ignored, reschedule_cb = callback)
1050		1135
1051	In this mode the values for C<interval> and C<at> are both being	1136	In this mode the values for C<interval> and C<at> are both being
1052	ignored. Instead, each time the periodic watcher gets scheduled, the	1137	ignored. Instead, each time the periodic watcher gets scheduled, the
1053	reschedule callback will be called with the watcher as first, and the	1138	reschedule callback will be called with the watcher as first, and the
1054	current time as second argument.	1139	current time as second argument.
1055		1140
1056	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,	1141	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
1057	ever, or make any event loop modifications>. If you need to stop it,	1142	ever, or make any event loop modifications>. If you need to stop it,
1058	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by	1143	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
1059	starting a prepare watcher).	1144	starting an C<ev_prepare> watcher, which is legal).
1060		1145
1061	Its prototype is C<ev_tstamp (reschedule_cb)(struct ev_periodic w,	1146	Its prototype is C<ev_tstamp (reschedule_cb)(struct ev_periodic w,
1062	ev_tstamp now)>, e.g.:	1147	ev_tstamp now)>, e.g.:
1063		1148
1064	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	1149	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
…		…
1086		1171
1087	Simply stops and restarts the periodic watcher again. This is only useful	1172	Simply stops and restarts the periodic watcher again. This is only useful
1088	when you changed some parameters or the reschedule callback would return	1173	when you changed some parameters or the reschedule callback would return
1089	a different time than the last time it was called (e.g. in a crond like	1174	a different time than the last time it was called (e.g. in a crond like
1090	program when the crontabs have changed).	1175	program when the crontabs have changed).
		1176
		1177	=item ev_tstamp offset [read-write]
		1178
		1179	When repeating, this contains the offset value, otherwise this is the
		1180	absolute point in time (the C<at> value passed to C<ev_periodic_set>).
		1181
		1182	Can be modified any time, but changes only take effect when the periodic
		1183	timer fires or C<ev_periodic_again> is being called.
1091		1184
1092	=item ev_tstamp interval [read-write]	1185	=item ev_tstamp interval [read-write]
1093		1186
1094	The current interval value. Can be modified any time, but changes only	1187	The current interval value. Can be modified any time, but changes only
1095	take effect when the periodic timer fires or C<ev_periodic_again> is being	1188	take effect when the periodic timer fires or C<ev_periodic_again> is being
…		…
1319	ev_stat_start (loop, &passwd);	1412	ev_stat_start (loop, &passwd);
1320		1413
1321		1414
1322	=head2 C<ev_idle> - when you've got nothing better to do...	1415	=head2 C<ev_idle> - when you've got nothing better to do...
1323		1416
1324	Idle watchers trigger events when there are no other events are pending	1417	Idle watchers trigger events when no other events of the same or higher
1325	(prepare, check and other idle watchers do not count). That is, as long	1418	priority are pending (prepare, check and other idle watchers do not
1326	as your process is busy handling sockets or timeouts (or even signals,	1419	count).
1327	imagine) it will not be triggered. But when your process is idle all idle	1420
1328	watchers are being called again and again, once per event loop iteration -	1421	That is, as long as your process is busy handling sockets or timeouts
		1422	(or even signals, imagine) of the same or higher priority it will not be
		1423	triggered. But when your process is idle (or only lower-priority watchers
		1424	are pending), the idle watchers are being called once per event loop
1329	until stopped, that is, or your process receives more events and becomes	1425	iteration - until stopped, that is, or your process receives more events
1330	busy.	1426	and becomes busy again with higher priority stuff.
1331		1427
1332	The most noteworthy effect is that as long as any idle watchers are	1428	The most noteworthy effect is that as long as any idle watchers are
1333	active, the process will not block when waiting for new events.	1429	active, the process will not block when waiting for new events.
1334		1430
1335	Apart from keeping your process non-blocking (which is a useful	1431	Apart from keeping your process non-blocking (which is a useful
…		…
1401	with priority higher than or equal to the event loop and one coroutine	1497	with priority higher than or equal to the event loop and one coroutine
1402	of lower priority, but only once, using idle watchers to keep the event	1498	of lower priority, but only once, using idle watchers to keep the event
1403	loop from blocking if lower-priority coroutines are active, thus mapping	1499	loop from blocking if lower-priority coroutines are active, thus mapping
1404	low-priority coroutines to idle/background tasks).	1500	low-priority coroutines to idle/background tasks).
1405		1501
		1502	It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
		1503	priority, to ensure that they are being run before any other watchers
		1504	after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
		1505	too) should not activate ("feed") events into libev. While libev fully
		1506	supports this, they will be called before other C<ev_check> watchers did
		1507	their job. As C<ev_check> watchers are often used to embed other event
		1508	loops those other event loops might be in an unusable state until their
		1509	C<ev_check> watcher ran (always remind yourself to coexist peacefully with
		1510	others).
		1511
1406	=over 4	1512	=over 4
1407		1513
1408	=item ev_prepare_init (ev_prepare *, callback)	1514	=item ev_prepare_init (ev_prepare *, callback)
1409		1515
1410	=item ev_check_init (ev_check *, callback)	1516	=item ev_check_init (ev_check *, callback)
…		…
1413	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	1519	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1414	macros, but using them is utterly, utterly and completely pointless.	1520	macros, but using them is utterly, utterly and completely pointless.
1415		1521
1416	=back	1522	=back
1417		1523
1418	Example: To include a library such as adns, you would add IO watchers	1524	There are a number of principal ways to embed other event loops or modules
1419	and a timeout watcher in a prepare handler, as required by libadns, and	1525	into libev. Here are some ideas on how to include libadns into libev
		1526	(there is a Perl module named C<EV::ADNS> that does this, which you could
		1527	use for an actually working example. Another Perl module named C<EV::Glib>
		1528	embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
		1529	into the Glib event loop).
		1530
		1531	Method 1: Add IO watchers and a timeout watcher in a prepare handler,
1420	in a check watcher, destroy them and call into libadns. What follows is	1532	and in a check watcher, destroy them and call into libadns. What follows
1421	pseudo-code only of course:	1533	is pseudo-code only of course. This requires you to either use a low
		1534	priority for the check watcher or use C<ev_clear_pending> explicitly, as
		1535	the callbacks for the IO/timeout watchers might not have been called yet.
1422		1536
1423	static ev_io iow [nfd];	1537	static ev_io iow [nfd];
1424	static ev_timer tw;	1538	static ev_timer tw;
1425		1539
1426	static void	1540	static void
1427	io_cb (ev_loop loop, ev_io w, int revents)	1541	io_cb (ev_loop loop, ev_io w, int revents)
1428	{	1542	{
1429	// set the relevant poll flags
1430	// could also call adns_processreadable etc. here
1431	struct pollfd fd = (struct pollfd )w->data;
1432	if (revents & EV_READ ) fd->revents \|= fd->events & POLLIN;
1433	if (revents & EV_WRITE) fd->revents \|= fd->events & POLLOUT;
1434	}	1543	}
1435		1544
1436	// create io watchers for each fd and a timer before blocking	1545	// create io watchers for each fd and a timer before blocking
1437	static void	1546	static void
1438	adns_prepare_cb (ev_loop loop, ev_prepare w, int revents)	1547	adns_prepare_cb (ev_loop loop, ev_prepare w, int revents)
1439	{	1548	{
1440	int timeout = 3600000;truct pollfd fds [nfd];	1549	int timeout = 3600000;
		1550	struct pollfd fds [nfd];
1441	// actual code will need to loop here and realloc etc.	1551	// actual code will need to loop here and realloc etc.
1442	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));	1552	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
1443		1553
1444	/* the callback is illegal, but won't be called as we stop during check */	1554	/* the callback is illegal, but won't be called as we stop during check */
1445	ev_timer_init (&tw, 0, timeout * 1e-3);	1555	ev_timer_init (&tw, 0, timeout * 1e-3);
1446	ev_timer_start (loop, &tw);	1556	ev_timer_start (loop, &tw);
1447		1557
1448	// create on ev_io per pollfd	1558	// create one ev_io per pollfd
1449	for (int i = 0; i < nfd; ++i)	1559	for (int i = 0; i < nfd; ++i)
1450	{	1560	{
1451	ev_io_init (iow + i, io_cb, fds [i].fd,	1561	ev_io_init (iow + i, io_cb, fds [i].fd,
1452	((fds [i].events & POLLIN ? EV_READ : 0)	1562	((fds [i].events & POLLIN ? EV_READ : 0)
1453	\| (fds [i].events & POLLOUT ? EV_WRITE : 0)));	1563	\| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
1454		1564
1455	fds [i].revents = 0;	1565	fds [i].revents = 0;
1456	iow [i].data = fds + i;
1457	ev_io_start (loop, iow + i);	1566	ev_io_start (loop, iow + i);
1458	}	1567	}
1459	}	1568	}
1460		1569
1461	// stop all watchers after blocking	1570	// stop all watchers after blocking
…		…
1463	adns_check_cb (ev_loop loop, ev_check w, int revents)	1572	adns_check_cb (ev_loop loop, ev_check w, int revents)
1464	{	1573	{
1465	ev_timer_stop (loop, &tw);	1574	ev_timer_stop (loop, &tw);
1466		1575
1467	for (int i = 0; i < nfd; ++i)	1576	for (int i = 0; i < nfd; ++i)
		1577	{
		1578	// set the relevant poll flags
		1579	// could also call adns_processreadable etc. here
		1580	struct pollfd *fd = fds + i;
		1581	int revents = ev_clear_pending (iow + i);
		1582	if (revents & EV_READ ) fd->revents \|= fd->events & POLLIN;
		1583	if (revents & EV_WRITE) fd->revents \|= fd->events & POLLOUT;
		1584
		1585	// now stop the watcher
1468	ev_io_stop (loop, iow + i);	1586	ev_io_stop (loop, iow + i);
		1587	}
1469		1588
1470	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));	1589	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
		1590	}
		1591
		1592	Method 2: This would be just like method 1, but you run C<adns_afterpoll>
		1593	in the prepare watcher and would dispose of the check watcher.
		1594
		1595	Method 3: If the module to be embedded supports explicit event
		1596	notification (adns does), you can also make use of the actual watcher
		1597	callbacks, and only destroy/create the watchers in the prepare watcher.
		1598
		1599	static void
		1600	timer_cb (EV_P_ ev_timer *w, int revents)
		1601	{
		1602	adns_state ads = (adns_state)w->data;
		1603	update_now (EV_A);
		1604
		1605	adns_processtimeouts (ads, &tv_now);
		1606	}
		1607
		1608	static void
		1609	io_cb (EV_P_ ev_io *w, int revents)
		1610	{
		1611	adns_state ads = (adns_state)w->data;
		1612	update_now (EV_A);
		1613
		1614	if (revents & EV_READ ) adns_processreadable (ads, w->fd, &tv_now);
		1615	if (revents & EV_WRITE) adns_processwriteable (ads, w->fd, &tv_now);
		1616	}
		1617
		1618	// do not ever call adns_afterpoll
		1619
		1620	Method 4: Do not use a prepare or check watcher because the module you
		1621	want to embed is too inflexible to support it. Instead, youc na override
		1622	their poll function. The drawback with this solution is that the main
		1623	loop is now no longer controllable by EV. The C<Glib::EV> module does
		1624	this.
		1625
		1626	static gint
		1627	event_poll_func (GPollFD *fds, guint nfds, gint timeout)
		1628	{
		1629	int got_events = 0;
		1630
		1631	for (n = 0; n < nfds; ++n)
		1632	// create/start io watcher that sets the relevant bits in fds[n] and increment got_events
		1633
		1634	if (timeout >= 0)
		1635	// create/start timer
		1636
		1637	// poll
		1638	ev_loop (EV_A_ 0);
		1639
		1640	// stop timer again
		1641	if (timeout >= 0)
		1642	ev_timer_stop (EV_A_ &to);
		1643
		1644	// stop io watchers again - their callbacks should have set
		1645	for (n = 0; n < nfds; ++n)
		1646	ev_io_stop (EV_A_ iow [n]);
		1647
		1648	return got_events;
1471	}	1649	}
1472		1650
1473		1651
1474	=head2 C<ev_embed> - when one backend isn't enough...	1652	=head2 C<ev_embed> - when one backend isn't enough...
1475		1653
…		…
1679		1857
1680	To use it,	1858	To use it,
1681		1859
1682	#include <ev++.h>	1860	#include <ev++.h>
1683		1861
1684	(it is not installed by default). This automatically includes F<ev.h>	1862	This automatically includes F<ev.h> and puts all of its definitions (many
1685	and puts all of its definitions (many of them macros) into the global	1863	of them macros) into the global namespace. All C++ specific things are
1686	namespace. All C++ specific things are put into the C<ev> namespace.	1864	put into the C<ev> namespace. It should support all the same embedding
		1865	options as F<ev.h>, most notably C<EV_MULTIPLICITY>.
1687		1866
1688	It should support all the same embedding options as F<ev.h>, most notably	1867	Care has been taken to keep the overhead low. The only data member the C++
1689	C<EV_MULTIPLICITY>.	1868	classes add (compared to plain C-style watchers) is the event loop pointer
		1869	that the watcher is associated with (or no additional members at all if
		1870	you disable C<EV_MULTIPLICITY> when embedding libev).
		1871
		1872	Currently, functions, and static and non-static member functions can be
		1873	used as callbacks. Other types should be easy to add as long as they only
		1874	need one additional pointer for context. If you need support for other
		1875	types of functors please contact the author (preferably after implementing
		1876	it).
1690		1877
1691	Here is a list of things available in the C<ev> namespace:	1878	Here is a list of things available in the C<ev> namespace:
1692		1879
1693	=over 4	1880	=over 4
1694		1881
…		…
1710		1897
1711	All of those classes have these methods:	1898	All of those classes have these methods:
1712		1899
1713	=over 4	1900	=over 4
1714		1901
1715	=item ev::TYPE::TYPE (object , object::method )	1902	=item ev::TYPE::TYPE ()
1716		1903
1717	=item ev::TYPE::TYPE (object , object::method , struct ev_loop *)	1904	=item ev::TYPE::TYPE (struct ev_loop *)
1718		1905
1719	=item ev::TYPE::~TYPE	1906	=item ev::TYPE::~TYPE
1720		1907
1721	The constructor takes a pointer to an object and a method pointer to	1908	The constructor (optionally) takes an event loop to associate the watcher
1722	the event handler callback to call in this class. The constructor calls	1909	with. If it is omitted, it will use C<EV_DEFAULT>.
1723	C<ev_init> for you, which means you have to call the C<set> method	1910
1724	before starting it. If you do not specify a loop then the constructor	1911	The constructor calls C<ev_init> for you, which means you have to call the
1725	automatically associates the default loop with this watcher.	1912	C<set> method before starting it.
		1913
		1914	It will not set a callback, however: You have to call the templated C<set>
		1915	method to set a callback before you can start the watcher.
		1916
		1917	(The reason why you have to use a method is a limitation in C++ which does
		1918	not allow explicit template arguments for constructors).
1726		1919
1727	The destructor automatically stops the watcher if it is active.	1920	The destructor automatically stops the watcher if it is active.
		1921
		1922	=item w->set<class, &class::method> (object *)
		1923
		1924	This method sets the callback method to call. The method has to have a
		1925	signature of C<void (*)(ev_TYPE &, int)>, it receives the watcher as
		1926	first argument and the C<revents> as second. The object must be given as
		1927	parameter and is stored in the C<data> member of the watcher.
		1928
		1929	This method synthesizes efficient thunking code to call your method from
		1930	the C callback that libev requires. If your compiler can inline your
		1931	callback (i.e. it is visible to it at the place of the C<set> call and
		1932	your compiler is good :), then the method will be fully inlined into the
		1933	thunking function, making it as fast as a direct C callback.
		1934
		1935	Example: simple class declaration and watcher initialisation
		1936
		1937	struct myclass
		1938	{
		1939	void io_cb (ev::io &w, int revents) { }
		1940	}
		1941
		1942	myclass obj;
		1943	ev::io iow;
		1944	iow.set <myclass, &myclass::io_cb> (&obj);
		1945
		1946	=item w->set<function> (void *data = 0)
		1947
		1948	Also sets a callback, but uses a static method or plain function as
		1949	callback. The optional C<data> argument will be stored in the watcher's
		1950	C<data> member and is free for you to use.
		1951
		1952	The prototype of the C<function> must be C<void (*)(ev::TYPE &w, int)>.
		1953
		1954	See the method-C<set> above for more details.
		1955
		1956	Example:
		1957
		1958	static void io_cb (ev::io &w, int revents) { }
		1959	iow.set <io_cb> ();
1728		1960
1729	=item w->set (struct ev_loop *)	1961	=item w->set (struct ev_loop *)
1730		1962
1731	Associates a different C<struct ev_loop> with this watcher. You can only	1963	Associates a different C<struct ev_loop> with this watcher. You can only
1732	do this when the watcher is inactive (and not pending either).	1964	do this when the watcher is inactive (and not pending either).
1733		1965
1734	=item w->set ([args])	1966	=item w->set ([args])
1735		1967
1736	Basically the same as C<ev_TYPE_set>, with the same args. Must be	1968	Basically the same as C<ev_TYPE_set>, with the same args. Must be
1737	called at least once. Unlike the C counterpart, an active watcher gets	1969	called at least once. Unlike the C counterpart, an active watcher gets
1738	automatically stopped and restarted.	1970	automatically stopped and restarted when reconfiguring it with this
		1971	method.
1739		1972
1740	=item w->start ()	1973	=item w->start ()
1741		1974
1742	Starts the watcher. Note that there is no C<loop> argument as the	1975	Starts the watcher. Note that there is no C<loop> argument, as the
1743	constructor already takes the loop.	1976	constructor already stores the event loop.
1744		1977
1745	=item w->stop ()	1978	=item w->stop ()
1746		1979
1747	Stops the watcher if it is active. Again, no C<loop> argument.	1980	Stops the watcher if it is active. Again, no C<loop> argument.
1748		1981
…		…
1773		2006
1774	myclass ();	2007	myclass ();
1775	}	2008	}
1776		2009
1777	myclass::myclass (int fd)	2010	myclass::myclass (int fd)
1778	: io (this, &myclass::io_cb),
1779	idle (this, &myclass::idle_cb)
1780	{	2011	{
		2012	io .set <myclass, &myclass::io_cb > (this);
		2013	idle.set <myclass, &myclass::idle_cb> (this);
		2014
1781	io.start (fd, ev::READ);	2015	io.start (fd, ev::READ);
1782	}	2016	}
1783		2017
1784		2018
1785	=head1 MACRO MAGIC	2019	=head1 MACRO MAGIC
1786		2020
1787	Libev can be compiled with a variety of options, the most fundemantal is	2021	Libev can be compiled with a variety of options, the most fundemantal is
1788	C<EV_MULTIPLICITY>. This option determines wether (most) functions and	2022	C<EV_MULTIPLICITY>. This option determines whether (most) functions and
1789	callbacks have an initial C<struct ev_loop *> argument.	2023	callbacks have an initial C<struct ev_loop *> argument.
1790		2024
1791	To make it easier to write programs that cope with either variant, the	2025	To make it easier to write programs that cope with either variant, the
1792	following macros are defined:	2026	following macros are defined:
1793		2027
…		…
1826	Similar to the other two macros, this gives you the value of the default	2060	Similar to the other two macros, this gives you the value of the default
1827	loop, if multiple loops are supported ("ev loop default").	2061	loop, if multiple loops are supported ("ev loop default").
1828		2062
1829	=back	2063	=back
1830		2064
1831	Example: Declare and initialise a check watcher, working regardless of	2065	Example: Declare and initialise a check watcher, utilising the above
1832	wether multiple loops are supported or not.	2066	macros so it will work regardless of whether multiple loops are supported
		2067	or not.
1833		2068
1834	static void	2069	static void
1835	check_cb (EV_P_ ev_timer *w, int revents)	2070	check_cb (EV_P_ ev_timer *w, int revents)
1836	{	2071	{
1837	ev_check_stop (EV_A_ w);	2072	ev_check_stop (EV_A_ w);
…		…
1839		2074
1840	ev_check check;	2075	ev_check check;
1841	ev_check_init (&check, check_cb);	2076	ev_check_init (&check, check_cb);
1842	ev_check_start (EV_DEFAULT_ &check);	2077	ev_check_start (EV_DEFAULT_ &check);
1843	ev_loop (EV_DEFAULT_ 0);	2078	ev_loop (EV_DEFAULT_ 0);
1844
1845		2079
1846	=head1 EMBEDDING	2080	=head1 EMBEDDING
1847		2081
1848	Libev can (and often is) directly embedded into host	2082	Libev can (and often is) directly embedded into host
1849	applications. Examples of applications that embed it include the Deliantra	2083	applications. Examples of applications that embed it include the Deliantra
…		…
1889	ev_vars.h	2123	ev_vars.h
1890	ev_wrap.h	2124	ev_wrap.h
1891		2125
1892	ev_win32.c required on win32 platforms only	2126	ev_win32.c required on win32 platforms only
1893		2127
1894	ev_select.c only when select backend is enabled (which is by default)	2128	ev_select.c only when select backend is enabled (which is enabled by default)
1895	ev_poll.c only when poll backend is enabled (disabled by default)	2129	ev_poll.c only when poll backend is enabled (disabled by default)
1896	ev_epoll.c only when the epoll backend is enabled (disabled by default)	2130	ev_epoll.c only when the epoll backend is enabled (disabled by default)
1897	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)	2131	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
1898	ev_port.c only when the solaris port backend is enabled (disabled by default)	2132	ev_port.c only when the solaris port backend is enabled (disabled by default)
1899		2133
…		…
2062	will have the C<struct ev_loop *> as first argument, and you can create	2296	will have the C<struct ev_loop *> as first argument, and you can create
2063	additional independent event loops. Otherwise there will be no support	2297	additional independent event loops. Otherwise there will be no support
2064	for multiple event loops and there is no first event loop pointer	2298	for multiple event loops and there is no first event loop pointer
2065	argument. Instead, all functions act on the single default loop.	2299	argument. Instead, all functions act on the single default loop.
2066		2300
		2301	=item EV_MINPRI
		2302
		2303	=item EV_MAXPRI
		2304
		2305	The range of allowed priorities. C<EV_MINPRI> must be smaller or equal to
		2306	C<EV_MAXPRI>, but otherwise there are no non-obvious limitations. You can
		2307	provide for more priorities by overriding those symbols (usually defined
		2308	to be C<-2> and C<2>, respectively).
		2309
		2310	When doing priority-based operations, libev usually has to linearly search
		2311	all the priorities, so having many of them (hundreds) uses a lot of space
		2312	and time, so using the defaults of five priorities (-2 .. +2) is usually
		2313	fine.
		2314
		2315	If your embedding app does not need any priorities, defining these both to
		2316	C<0> will save some memory and cpu.
		2317
2067	=item EV_PERIODIC_ENABLE	2318	=item EV_PERIODIC_ENABLE
2068		2319
2069	If undefined or defined to be C<1>, then periodic timers are supported. If	2320	If undefined or defined to be C<1>, then periodic timers are supported. If
		2321	defined to be C<0>, then they are not. Disabling them saves a few kB of
		2322	code.
		2323
		2324	=item EV_IDLE_ENABLE
		2325
		2326	If undefined or defined to be C<1>, then idle watchers are supported. If
2070	defined to be C<0>, then they are not. Disabling them saves a few kB of	2327	defined to be C<0>, then they are not. Disabling them saves a few kB of
2071	code.	2328	code.
2072		2329
2073	=item EV_EMBED_ENABLE	2330	=item EV_EMBED_ENABLE
2074		2331
…		…
2141	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file	2398	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
2142	will be compiled. It is pretty complex because it provides its own header	2399	will be compiled. It is pretty complex because it provides its own header
2143	file.	2400	file.
2144		2401
2145	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	2402	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
2146	that everybody includes and which overrides some autoconf choices:	2403	that everybody includes and which overrides some configure choices:
2147		2404
		2405	#define EV_MINIMAL 1
2148	#define EV_USE_POLL 0	2406	#define EV_USE_POLL 0
2149	#define EV_MULTIPLICITY 0	2407	#define EV_MULTIPLICITY 0
2150	#define EV_PERIODICS 0	2408	#define EV_PERIODIC_ENABLE 0
		2409	#define EV_STAT_ENABLE 0
		2410	#define EV_FORK_ENABLE 0
2151	#define EV_CONFIG_H <config.h>	2411	#define EV_CONFIG_H <config.h>
		2412	#define EV_MINPRI 0
		2413	#define EV_MAXPRI 0
2152		2414
2153	#include "ev++.h"	2415	#include "ev++.h"
2154		2416
2155	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	2417	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
2156		2418
…		…
2162		2424
2163	In this section the complexities of (many of) the algorithms used inside	2425	In this section the complexities of (many of) the algorithms used inside
2164	libev will be explained. For complexity discussions about backends see the	2426	libev will be explained. For complexity discussions about backends see the
2165	documentation for C<ev_default_init>.	2427	documentation for C<ev_default_init>.
2166		2428
		2429	All of the following are about amortised time: If an array needs to be
		2430	extended, libev needs to realloc and move the whole array, but this
		2431	happens asymptotically never with higher number of elements, so O(1) might
		2432	mean it might do a lengthy realloc operation in rare cases, but on average
		2433	it is much faster and asymptotically approaches constant time.
		2434
2167	=over 4	2435	=over 4
2168		2436
2169	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)	2437	=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2170		2438
		2439	This means that, when you have a watcher that triggers in one hour and
		2440	there are 100 watchers that would trigger before that then inserting will
		2441	have to skip those 100 watchers.
		2442
2171	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)	2443	=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers)
2172		2444
		2445	That means that for changing a timer costs less than removing/adding them
		2446	as only the relative motion in the event queue has to be paid for.
		2447
2173	=item Starting io/check/prepare/idle/signal/child watchers: O(1)	2448	=item Starting io/check/prepare/idle/signal/child watchers: O(1)
2174		2449
		2450	These just add the watcher into an array or at the head of a list.
2175	=item Stopping check/prepare/idle watchers: O(1)	2451	=item Stopping check/prepare/idle watchers: O(1)
2176		2452
2177	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))	2453	=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2178		2454
		2455	These watchers are stored in lists then need to be walked to find the
		2456	correct watcher to remove. The lists are usually short (you don't usually
		2457	have many watchers waiting for the same fd or signal).
		2458
2179	=item Finding the next timer per loop iteration: O(1)	2459	=item Finding the next timer per loop iteration: O(1)
2180		2460
2181	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)	2461	=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2182		2462
		2463	A change means an I/O watcher gets started or stopped, which requires
		2464	libev to recalculate its status (and possibly tell the kernel).
		2465
2183	=item Activating one watcher: O(1)	2466	=item Activating one watcher: O(1)
2184		2467
		2468	=item Priority handling: O(number_of_priorities)
		2469
		2470	Priorities are implemented by allocating some space for each
		2471	priority. When doing priority-based operations, libev usually has to
		2472	linearly search all the priorities.
		2473
2185	=back	2474	=back
2186		2475
2187		2476
2188	=head1 AUTHOR	2477	=head1 AUTHOR
2189		2478

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.60 by root, Wed Nov 28 18:29:30 2007 UTC vs. Revision 1.80 by root, Sun Dec 9 19:47:30 2007 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.60 by root, Wed Nov 28 18:29:30 2007 UTC vs.
Revision 1.80 by root, Sun Dec 9 19:47:30 2007 UTC