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

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

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.58 by root, Wed Nov 28 11:31:34 2007 UTC vs. Revision 1.78 by root, Sun Dec 9 19:42:57 2007 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.58 by root, Wed Nov 28 11:31:34 2007 UTC vs.
Revision 1.78 by root, Sun Dec 9 19:42:57 2007 UTC