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

Comparing libev/ev.pod (file contents):
Revision 1.306 by root, Mon Oct 18 07:36:05 2010 UTC vs.
Revision 1.327 by root, Sun Oct 24 20:05:43 2010 UTC

…		…
26	puts ("stdin ready");	26	puts ("stdin ready");
27	// for one-shot events, one must manually stop the watcher	27	// for one-shot events, one must manually stop the watcher
28	// with its corresponding stop function.	28	// with its corresponding stop function.
29	ev_io_stop (EV_A_ w);	29	ev_io_stop (EV_A_ w);
30		30
31	// this causes all nested ev_loop's to stop iterating	31	// this causes all nested ev_run's to stop iterating
32	ev_unloop (EV_A_ EVUNLOOP_ALL);	32	ev_break (EV_A_ EVBREAK_ALL);
33	}	33	}
34		34
35	// another callback, this time for a time-out	35	// another callback, this time for a time-out
36	static void	36	static void
37	timeout_cb (EV_P_ ev_timer *w, int revents)	37	timeout_cb (EV_P_ ev_timer *w, int revents)
38	{	38	{
39	puts ("timeout");	39	puts ("timeout");
40	// this causes the innermost ev_loop to stop iterating	40	// this causes the innermost ev_run to stop iterating
41	ev_unloop (EV_A_ EVUNLOOP_ONE);	41	ev_break (EV_A_ EVBREAK_ONE);
42	}	42	}
43		43
44	int	44	int
45	main (void)	45	main (void)
46	{	46	{
47	// use the default event loop unless you have special needs	47	// use the default event loop unless you have special needs
48	struct ev_loop *loop = ev_default_loop (0);	48	struct ev_loop *loop = EV_DEFAULT;
49		49
50	// initialise an io watcher, then start it	50	// initialise an io watcher, then start it
51	// this one will watch for stdin to become readable	51	// this one will watch for stdin to become readable
52	ev_io_init (&stdin_watcher, stdin_cb, /STDIN_FILENO/ 0, EV_READ);	52	ev_io_init (&stdin_watcher, stdin_cb, /STDIN_FILENO/ 0, EV_READ);
53	ev_io_start (loop, &stdin_watcher);	53	ev_io_start (loop, &stdin_watcher);
…		…
56	// simple non-repeating 5.5 second timeout	56	// simple non-repeating 5.5 second timeout
57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
58	ev_timer_start (loop, &timeout_watcher);	58	ev_timer_start (loop, &timeout_watcher);
59		59
60	// now wait for events to arrive	60	// now wait for events to arrive
61	ev_loop (loop, 0);	61	ev_run (loop, 0);
62		62
63	// unloop was called, so exit	63	// unloop was called, so exit
64	return 0;	64	return 0;
65	}	65	}
66		66
…		…
124	this argument.	124	this argument.
125		125
126	=head2 TIME REPRESENTATION	126	=head2 TIME REPRESENTATION
127		127
128	Libev represents time as a single floating point number, representing	128	Libev represents time as a single floating point number, representing
129	the (fractional) number of seconds since the (POSIX) epoch (in practise	129	the (fractional) number of seconds since the (POSIX) epoch (in practice
130	somewhere near the beginning of 1970, details are complicated, don't	130	somewhere near the beginning of 1970, details are complicated, don't
131	ask). This type is called C<ev_tstamp>, which is what you should use	131	ask). This type is called C<ev_tstamp>, which is what you should use
132	too. It usually aliases to the C<double> type in C. When you need to do	132	too. It usually aliases to the C<double> type in C. When you need to do
133	any calculations on it, you should treat it as some floating point value.	133	any calculations on it, you should treat it as some floating point value.
134		134
…		…
165		165
166	=item ev_tstamp ev_time ()	166	=item ev_tstamp ev_time ()
167		167
168	Returns the current time as libev would use it. Please note that the	168	Returns the current time as libev would use it. Please note that the
169	C<ev_now> function is usually faster and also often returns the timestamp	169	C<ev_now> function is usually faster and also often returns the timestamp
170	you actually want to know.	170	you actually want to know. Also interesting is the combination of
		171	C<ev_update_now> and C<ev_now>.
171		172
172	=item ev_sleep (ev_tstamp interval)	173	=item ev_sleep (ev_tstamp interval)
173		174
174	Sleep for the given interval: The current thread will be blocked until	175	Sleep for the given interval: The current thread will be blocked until
175	either it is interrupted or the given time interval has passed. Basically	176	either it is interrupted or the given time interval has passed. Basically
…		…
192	as this indicates an incompatible change. Minor versions are usually	193	as this indicates an incompatible change. Minor versions are usually
193	compatible to older versions, so a larger minor version alone is usually	194	compatible to older versions, so a larger minor version alone is usually
194	not a problem.	195	not a problem.
195		196
196	Example: Make sure we haven't accidentally been linked against the wrong	197	Example: Make sure we haven't accidentally been linked against the wrong
197	version (note, however, that this will not detect ABI mismatches :).	198	version (note, however, that this will not detect other ABI mismatches,
		199	such as LFS or reentrancy).
198		200
199	assert (("libev version mismatch",	201	assert (("libev version mismatch",
200	ev_version_major () == EV_VERSION_MAJOR	202	ev_version_major () == EV_VERSION_MAJOR
201	&& ev_version_minor () >= EV_VERSION_MINOR));	203	&& ev_version_minor () >= EV_VERSION_MINOR));
202		204
…		…
213	assert (("sorry, no epoll, no sex",	215	assert (("sorry, no epoll, no sex",
214	ev_supported_backends () & EVBACKEND_EPOLL));	216	ev_supported_backends () & EVBACKEND_EPOLL));
215		217
216	=item unsigned int ev_recommended_backends ()	218	=item unsigned int ev_recommended_backends ()
217		219
218	Return the set of all backends compiled into this binary of libev and also	220	Return the set of all backends compiled into this binary of libev and
219	recommended for this platform. This set is often smaller than the one	221	also recommended for this platform, meaning it will work for most file
		222	descriptor types. This set is often smaller than the one returned by
220	returned by C<ev_supported_backends>, as for example kqueue is broken on	223	C<ev_supported_backends>, as for example kqueue is broken on most BSDs
221	most BSDs and will not be auto-detected unless you explicitly request it	224	and will not be auto-detected unless you explicitly request it (assuming
222	(assuming you know what you are doing). This is the set of backends that	225	you know what you are doing). This is the set of backends that libev will
223	libev will probe for if you specify no backends explicitly.	226	probe for if you specify no backends explicitly.
224		227
225	=item unsigned int ev_embeddable_backends ()	228	=item unsigned int ev_embeddable_backends ()
226		229
227	Returns the set of backends that are embeddable in other event loops. This	230	Returns the set of backends that are embeddable in other event loops. This
228	is the theoretical, all-platform, value. To find which backends	231	value is platform-specific but can include backends not available on the
229	might be supported on the current system, you would need to look at	232	current system. To find which embeddable backends might be supported on
230	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	233	the current system, you would need to look at C<ev_embeddable_backends ()
231	recommended ones.	234	& ev_supported_backends ()>, likewise for recommended ones.
232		235
233	See the description of C<ev_embed> watchers for more info.	236	See the description of C<ev_embed> watchers for more info.
234		237
235	=item ev_set_allocator (void (cb)(void *ptr, long size)) [NOT REENTRANT]	238	=item ev_set_allocator (void (cb)(void *ptr, long size)) [NOT REENTRANT]
236		239
…		…
290	...	293	...
291	ev_set_syserr_cb (fatal_error);	294	ev_set_syserr_cb (fatal_error);
292		295
293	=back	296	=back
294		297
295	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	298	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
296		299
297	An event loop is described by a C<struct ev_loop *> (the C<struct>	300	An event loop is described by a C<struct ev_loop *> (the C<struct> is
298	is I<not> optional in this case, as there is also an C<ev_loop>	301	I<not> optional in this case unless libev 3 compatibility is disabled, as
299	I<function>).	302	libev 3 had an C<ev_loop> function colliding with the struct name).
300		303
301	The library knows two types of such loops, the I<default> loop, which	304	The library knows two types of such loops, the I<default> loop, which
302	supports signals and child events, and dynamically created loops which do	305	supports signals and child events, and dynamically created event loops
303	not.	306	which do not.
304		307
305	=over 4	308	=over 4
306		309
307	=item struct ev_loop *ev_default_loop (unsigned int flags)	310	=item struct ev_loop *ev_default_loop (unsigned int flags)
308		311
309	This will initialise the default event loop if it hasn't been initialised	312	This returns the "default" event loop object, which is what you should
310	yet and return it. If the default loop could not be initialised, returns	313	normally use when you just need "the event loop". Event loop objects and
311	false. If it already was initialised it simply returns it (and ignores the	314	the C<flags> parameter are described in more detail in the entry for
312	flags. If that is troubling you, check C<ev_backend ()> afterwards).	315	C<ev_loop_new>.
		316
		317	If the default loop is already initialised then this function simply
		318	returns it (and ignores the flags. If that is troubling you, check
		319	C<ev_backend ()> afterwards). Otherwise it will create it with the given
		320	flags, which should almost always be C<0>, unless the caller is also the
		321	one calling C<ev_run> or otherwise qualifies as "the main program".
313		322
314	If you don't know what event loop to use, use the one returned from this	323	If you don't know what event loop to use, use the one returned from this
315	function.	324	function (or via the C<EV_DEFAULT> macro).
316		325
317	Note that this function is I<not> thread-safe, so if you want to use it	326	Note that this function is I<not> thread-safe, so if you want to use it
318	from multiple threads, you have to lock (note also that this is unlikely,	327	from multiple threads, you have to employ some kind of mutex (note also
319	as loops cannot be shared easily between threads anyway).	328	that this case is unlikely, as loops cannot be shared easily between
		329	threads anyway).
320		330
321	The default loop is the only loop that can handle C<ev_signal> and	331	The default loop is the only loop that can handle C<ev_child> watchers,
322	C<ev_child> watchers, and to do this, it always registers a handler	332	and to do this, it always registers a handler for C<SIGCHLD>. If this is
323	for C<SIGCHLD>. If this is a problem for your application you can either	333	a problem for your application you can either create a dynamic loop with
324	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	334	C<ev_loop_new> which doesn't do that, or you can simply overwrite the
325	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	335	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
326	C<ev_default_init>.	336
		337	Example: This is the most typical usage.
		338
		339	if (!ev_default_loop (0))
		340	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
		341
		342	Example: Restrict libev to the select and poll backends, and do not allow
		343	environment settings to be taken into account:
		344
		345	ev_default_loop (EVBACKEND_POLL \| EVBACKEND_SELECT \| EVFLAG_NOENV);
		346
		347	=item struct ev_loop *ev_loop_new (unsigned int flags)
		348
		349	This will create and initialise a new event loop object. If the loop
		350	could not be initialised, returns false.
		351
		352	Note that this function I<is> thread-safe, and one common way to use
		353	libev with threads is indeed to create one loop per thread, and using the
		354	default loop in the "main" or "initial" thread.
327		355
328	The flags argument can be used to specify special behaviour or specific	356	The flags argument can be used to specify special behaviour or specific
329	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).	357	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
330		358
331	The following flags are supported:	359	The following flags are supported:
…		…
549	If one or more of the backend flags are or'ed into the flags value,	577	If one or more of the backend flags are or'ed into the flags value,
550	then only these backends will be tried (in the reverse order as listed	578	then only these backends will be tried (in the reverse order as listed
551	here). If none are specified, all backends in C<ev_recommended_backends	579	here). If none are specified, all backends in C<ev_recommended_backends
552	()> will be tried.	580	()> will be tried.
553		581
554	Example: This is the most typical usage.
555
556	if (!ev_default_loop (0))
557	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
558
559	Example: Restrict libev to the select and poll backends, and do not allow
560	environment settings to be taken into account:
561
562	ev_default_loop (EVBACKEND_POLL \| EVBACKEND_SELECT \| EVFLAG_NOENV);
563
564	Example: Use whatever libev has to offer, but make sure that kqueue is
565	used if available (warning, breaks stuff, best use only with your own
566	private event loop and only if you know the OS supports your types of
567	fds):
568
569	ev_default_loop (ev_recommended_backends () \| EVBACKEND_KQUEUE);
570
571	=item struct ev_loop *ev_loop_new (unsigned int flags)
572
573	Similar to C<ev_default_loop>, but always creates a new event loop that is
574	always distinct from the default loop.
575
576	Note that this function I<is> thread-safe, and one common way to use
577	libev with threads is indeed to create one loop per thread, and using the
578	default loop in the "main" or "initial" thread.
579
580	Example: Try to create a event loop that uses epoll and nothing else.	582	Example: Try to create a event loop that uses epoll and nothing else.
581		583
582	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);	584	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);
583	if (!epoller)	585	if (!epoller)
584	fatal ("no epoll found here, maybe it hides under your chair");	586	fatal ("no epoll found here, maybe it hides under your chair");
585		587
		588	Example: Use whatever libev has to offer, but make sure that kqueue is
		589	used if available.
		590
		591	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () \| EVBACKEND_KQUEUE);
		592
586	=item ev_default_destroy ()	593	=item ev_loop_destroy (loop)
587		594
588	Destroys the default loop (frees all memory and kernel state etc.). None	595	Destroys an event loop object (frees all memory and kernel state
589	of the active event watchers will be stopped in the normal sense, so	596	etc.). None of the active event watchers will be stopped in the normal
590	e.g. C<ev_is_active> might still return true. It is your responsibility to	597	sense, so e.g. C<ev_is_active> might still return true. It is your
591	either stop all watchers cleanly yourself I<before> calling this function,	598	responsibility to either stop all watchers cleanly yourself I<before>
592	or cope with the fact afterwards (which is usually the easiest thing, you	599	calling this function, or cope with the fact afterwards (which is usually
593	can just ignore the watchers and/or C<free ()> them for example).	600	the easiest thing, you can just ignore the watchers and/or C<free ()> them
		601	for example).
594		602
595	Note that certain global state, such as signal state (and installed signal	603	Note that certain global state, such as signal state (and installed signal
596	handlers), will not be freed by this function, and related watchers (such	604	handlers), will not be freed by this function, and related watchers (such
597	as signal and child watchers) would need to be stopped manually.	605	as signal and child watchers) would need to be stopped manually.
598		606
599	In general it is not advisable to call this function except in the	607	This function is normally used on loop objects allocated by
600	rare occasion where you really need to free e.g. the signal handling	608	C<ev_loop_new>, but it can also be used on the default loop returned by
		609	C<ev_default_loop>, in which case it is not thread-safe.
		610
		611	Note that it is not advisable to call this function on the default loop
		612	except in the rare occasion where you really need to free it's resources.
601	pipe fds. If you need dynamically allocated loops it is better to use	613	If you need dynamically allocated loops it is better to use C<ev_loop_new>
602	C<ev_loop_new> and C<ev_loop_destroy>.	614	and C<ev_loop_destroy>.
603		615
604	=item ev_loop_destroy (loop)	616	=item ev_loop_fork (loop)
605		617
606	Like C<ev_default_destroy>, but destroys an event loop created by an
607	earlier call to C<ev_loop_new>.
608
609	=item ev_default_fork ()
610
611	This function sets a flag that causes subsequent C<ev_loop> iterations	618	This function sets a flag that causes subsequent C<ev_run> iterations to
612	to reinitialise the kernel state for backends that have one. Despite the	619	reinitialise the kernel state for backends that have one. Despite the
613	name, you can call it anytime, but it makes most sense after forking, in	620	name, you can call it anytime, but it makes most sense after forking, in
614	the child process (or both child and parent, but that again makes little	621	the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the
615	sense). You I<must> call it in the child before using any of the libev	622	child before resuming or calling C<ev_run>.
616	functions, and it will only take effect at the next C<ev_loop> iteration.
617		623
618	Again, you I<have> to call it on I<any> loop that you want to re-use after	624	Again, you I<have> to call it on I<any> loop that you want to re-use after
619	a fork, I<even if you do not plan to use the loop in the parent>. This is	625	a fork, I<even if you do not plan to use the loop in the parent>. This is
620	because some kernel interfaces cough I<kqueue> cough do funny things	626	because some kernel interfaces cough I<kqueue> cough do funny things
621	during fork.	627	during fork.
622		628
623	On the other hand, you only need to call this function in the child	629	On the other hand, you only need to call this function in the child
624	process if and only if you want to use the event loop in the child. If you	630	process if and only if you want to use the event loop in the child. If
625	just fork+exec or create a new loop in the child, you don't have to call	631	you just fork+exec or create a new loop in the child, you don't have to
626	it at all.	632	call it at all (in fact, C<epoll> is so badly broken that it makes a
		633	difference, but libev will usually detect this case on its own and do a
		634	costly reset of the backend).
627		635
628	The function itself is quite fast and it's usually not a problem to call	636	The function itself is quite fast and it's usually not a problem to call
629	it just in case after a fork. To make this easy, the function will fit in	637	it just in case after a fork.
630	quite nicely into a call to C<pthread_atfork>:
631		638
		639	Example: Automate calling C<ev_loop_fork> on the default loop when
		640	using pthreads.
		641
		642	static void
		643	post_fork_child (void)
		644	{
		645	ev_loop_fork (EV_DEFAULT);
		646	}
		647
		648	...
632	pthread_atfork (0, 0, ev_default_fork);	649	pthread_atfork (0, 0, post_fork_child);
633
634	=item ev_loop_fork (loop)
635
636	Like C<ev_default_fork>, but acts on an event loop created by
637	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
638	after fork that you want to re-use in the child, and how you keep track of
639	them is entirely your own problem.
640		650
641	=item int ev_is_default_loop (loop)	651	=item int ev_is_default_loop (loop)
642		652
643	Returns true when the given loop is, in fact, the default loop, and false	653	Returns true when the given loop is, in fact, the default loop, and false
644	otherwise.	654	otherwise.
645		655
646	=item unsigned int ev_iteration (loop)	656	=item unsigned int ev_iteration (loop)
647		657
648	Returns the current iteration count for the loop, which is identical to	658	Returns the current iteration count for the event loop, which is identical
649	the number of times libev did poll for new events. It starts at C<0> and	659	to the number of times libev did poll for new events. It starts at C<0>
650	happily wraps around with enough iterations.	660	and happily wraps around with enough iterations.
651		661
652	This value can sometimes be useful as a generation counter of sorts (it	662	This value can sometimes be useful as a generation counter of sorts (it
653	"ticks" the number of loop iterations), as it roughly corresponds with	663	"ticks" the number of loop iterations), as it roughly corresponds with
654	C<ev_prepare> and C<ev_check> calls - and is incremented between the	664	C<ev_prepare> and C<ev_check> calls - and is incremented between the
655	prepare and check phases.	665	prepare and check phases.
656		666
657	=item unsigned int ev_depth (loop)	667	=item unsigned int ev_depth (loop)
658		668
659	Returns the number of times C<ev_loop> was entered minus the number of	669	Returns the number of times C<ev_run> was entered minus the number of
660	times C<ev_loop> was exited, in other words, the recursion depth.	670	times C<ev_run> was exited, in other words, the recursion depth.
661		671
662	Outside C<ev_loop>, this number is zero. In a callback, this number is	672	Outside C<ev_run>, this number is zero. In a callback, this number is
663	C<1>, unless C<ev_loop> was invoked recursively (or from another thread),	673	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
664	in which case it is higher.	674	in which case it is higher.
665		675
666	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread	676	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread
667	etc.), doesn't count as "exit" - consider this as a hint to avoid such	677	etc.), doesn't count as "exit" - consider this as a hint to avoid such
668	ungentleman behaviour unless it's really convenient.	678	ungentleman-like behaviour unless it's really convenient.
669		679
670	=item unsigned int ev_backend (loop)	680	=item unsigned int ev_backend (loop)
671		681
672	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	682	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
673	use.	683	use.
…		…
682		692
683	=item ev_now_update (loop)	693	=item ev_now_update (loop)
684		694
685	Establishes the current time by querying the kernel, updating the time	695	Establishes the current time by querying the kernel, updating the time
686	returned by C<ev_now ()> in the progress. This is a costly operation and	696	returned by C<ev_now ()> in the progress. This is a costly operation and
687	is usually done automatically within C<ev_loop ()>.	697	is usually done automatically within C<ev_run ()>.
688		698
689	This function is rarely useful, but when some event callback runs for a	699	This function is rarely useful, but when some event callback runs for a
690	very long time without entering the event loop, updating libev's idea of	700	very long time without entering the event loop, updating libev's idea of
691	the current time is a good idea.	701	the current time is a good idea.
692		702
…		…
694		704
695	=item ev_suspend (loop)	705	=item ev_suspend (loop)
696		706
697	=item ev_resume (loop)	707	=item ev_resume (loop)
698		708
699	These two functions suspend and resume a loop, for use when the loop is	709	These two functions suspend and resume an event loop, for use when the
700	not used for a while and timeouts should not be processed.	710	loop is not used for a while and timeouts should not be processed.
701		711
702	A typical use case would be an interactive program such as a game: When	712	A typical use case would be an interactive program such as a game: When
703	the user presses C<^Z> to suspend the game and resumes it an hour later it	713	the user presses C<^Z> to suspend the game and resumes it an hour later it
704	would be best to handle timeouts as if no time had actually passed while	714	would be best to handle timeouts as if no time had actually passed while
705	the program was suspended. This can be achieved by calling C<ev_suspend>	715	the program was suspended. This can be achieved by calling C<ev_suspend>
…		…
716	without a previous call to C<ev_suspend>.	726	without a previous call to C<ev_suspend>.
717		727
718	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the	728	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
719	event loop time (see C<ev_now_update>).	729	event loop time (see C<ev_now_update>).
720		730
721	=item ev_loop (loop, int flags)	731	=item ev_run (loop, int flags)
722		732
723	Finally, this is it, the event handler. This function usually is called	733	Finally, this is it, the event handler. This function usually is called
724	after you have initialised all your watchers and you want to start	734	after you have initialised all your watchers and you want to start
725	handling events.	735	handling events. It will ask the operating system for any new events, call
		736	the watcher callbacks, an then repeat the whole process indefinitely: This
		737	is why event loops are called I<loops>.
726		738
727	If the flags argument is specified as C<0>, it will not return until	739	If the flags argument is specified as C<0>, it will keep handling events
728	either no event watchers are active anymore or C<ev_unloop> was called.	740	until either no event watchers are active anymore or C<ev_break> was
		741	called.
729		742
730	Please note that an explicit C<ev_unloop> is usually better than	743	Please note that an explicit C<ev_break> is usually better than
731	relying on all watchers to be stopped when deciding when a program has	744	relying on all watchers to be stopped when deciding when a program has
732	finished (especially in interactive programs), but having a program	745	finished (especially in interactive programs), but having a program
733	that automatically loops as long as it has to and no longer by virtue	746	that automatically loops as long as it has to and no longer by virtue
734	of relying on its watchers stopping correctly, that is truly a thing of	747	of relying on its watchers stopping correctly, that is truly a thing of
735	beauty.	748	beauty.
736		749
737	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	750	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
738	those events and any already outstanding ones, but will not block your	751	those events and any already outstanding ones, but will not wait and
739	process in case there are no events and will return after one iteration of	752	block your process in case there are no events and will return after one
740	the loop.	753	iteration of the loop. This is sometimes useful to poll and handle new
		754	events while doing lengthy calculations, to keep the program responsive.
741		755
742	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	756	A flags value of C<EVRUN_ONCE> will look for new events (waiting if
743	necessary) and will handle those and any already outstanding ones. It	757	necessary) and will handle those and any already outstanding ones. It
744	will block your process until at least one new event arrives (which could	758	will block your process until at least one new event arrives (which could
745	be an event internal to libev itself, so there is no guarantee that a	759	be an event internal to libev itself, so there is no guarantee that a
746	user-registered callback will be called), and will return after one	760	user-registered callback will be called), and will return after one
747	iteration of the loop.	761	iteration of the loop.
748		762
749	This is useful if you are waiting for some external event in conjunction	763	This is useful if you are waiting for some external event in conjunction
750	with something not expressible using other libev watchers (i.e. "roll your	764	with something not expressible using other libev watchers (i.e. "roll your
751	own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is	765	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
752	usually a better approach for this kind of thing.	766	usually a better approach for this kind of thing.
753		767
754	Here are the gory details of what C<ev_loop> does:	768	Here are the gory details of what C<ev_run> does:
755		769
		770	- Increment loop depth.
		771	- Reset the ev_break status.
756	- Before the first iteration, call any pending watchers.	772	- Before the first iteration, call any pending watchers.
		773	LOOP:
757	* If EVFLAG_FORKCHECK was used, check for a fork.	774	- If EVFLAG_FORKCHECK was used, check for a fork.
758	- If a fork was detected (by any means), queue and call all fork watchers.	775	- If a fork was detected (by any means), queue and call all fork watchers.
759	- Queue and call all prepare watchers.	776	- Queue and call all prepare watchers.
		777	- If ev_break was called, goto FINISH.
760	- If we have been forked, detach and recreate the kernel state	778	- If we have been forked, detach and recreate the kernel state
761	as to not disturb the other process.	779	as to not disturb the other process.
762	- Update the kernel state with all outstanding changes.	780	- Update the kernel state with all outstanding changes.
763	- Update the "event loop time" (ev_now ()).	781	- Update the "event loop time" (ev_now ()).
764	- Calculate for how long to sleep or block, if at all	782	- Calculate for how long to sleep or block, if at all
765	(active idle watchers, EVLOOP_NONBLOCK or not having	783	(active idle watchers, EVRUN_NOWAIT or not having
766	any active watchers at all will result in not sleeping).	784	any active watchers at all will result in not sleeping).
767	- Sleep if the I/O and timer collect interval say so.	785	- Sleep if the I/O and timer collect interval say so.
		786	- Increment loop iteration counter.
768	- Block the process, waiting for any events.	787	- Block the process, waiting for any events.
769	- Queue all outstanding I/O (fd) events.	788	- Queue all outstanding I/O (fd) events.
770	- Update the "event loop time" (ev_now ()), and do time jump adjustments.	789	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
771	- Queue all expired timers.	790	- Queue all expired timers.
772	- Queue all expired periodics.	791	- Queue all expired periodics.
773	- Unless any events are pending now, queue all idle watchers.	792	- Queue all idle watchers with priority higher than that of pending events.
774	- Queue all check watchers.	793	- Queue all check watchers.
775	- Call all queued watchers in reverse order (i.e. check watchers first).	794	- Call all queued watchers in reverse order (i.e. check watchers first).
776	Signals and child watchers are implemented as I/O watchers, and will	795	Signals and child watchers are implemented as I/O watchers, and will
777	be handled here by queueing them when their watcher gets executed.	796	be handled here by queueing them when their watcher gets executed.
778	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	797	- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
779	were used, or there are no active watchers, return, otherwise	798	were used, or there are no active watchers, goto FINISH, otherwise
780	continue with step *.	799	continue with step LOOP.
		800	FINISH:
		801	- Reset the ev_break status iff it was EVBREAK_ONE.
		802	- Decrement the loop depth.
		803	- Return.
781		804
782	Example: Queue some jobs and then loop until no events are outstanding	805	Example: Queue some jobs and then loop until no events are outstanding
783	anymore.	806	anymore.
784		807
785	... queue jobs here, make sure they register event watchers as long	808	... queue jobs here, make sure they register event watchers as long
786	... as they still have work to do (even an idle watcher will do..)	809	... as they still have work to do (even an idle watcher will do..)
787	ev_loop (my_loop, 0);	810	ev_run (my_loop, 0);
788	... jobs done or somebody called unloop. yeah!	811	... jobs done or somebody called unloop. yeah!
789		812
790	=item ev_unloop (loop, how)	813	=item ev_break (loop, how)
791		814
792	Can be used to make a call to C<ev_loop> return early (but only after it	815	Can be used to make a call to C<ev_run> return early (but only after it
793	has processed all outstanding events). The C<how> argument must be either	816	has processed all outstanding events). The C<how> argument must be either
794	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	817	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
795	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	818	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
796		819
797	This "unloop state" will be cleared when entering C<ev_loop> again.	820	This "unloop state" will be cleared when entering C<ev_run> again.
798		821
799	It is safe to call C<ev_unloop> from outside any C<ev_loop> calls.	822	It is safe to call C<ev_break> from outside any C<ev_run> calls. ##TODO##
800		823
801	=item ev_ref (loop)	824	=item ev_ref (loop)
802		825
803	=item ev_unref (loop)	826	=item ev_unref (loop)
804		827
805	Ref/unref can be used to add or remove a reference count on the event	828	Ref/unref can be used to add or remove a reference count on the event
806	loop: Every watcher keeps one reference, and as long as the reference	829	loop: Every watcher keeps one reference, and as long as the reference
807	count is nonzero, C<ev_loop> will not return on its own.	830	count is nonzero, C<ev_run> will not return on its own.
808		831
809	This is useful when you have a watcher that you never intend to	832	This is useful when you have a watcher that you never intend to
810	unregister, but that nevertheless should not keep C<ev_loop> from	833	unregister, but that nevertheless should not keep C<ev_run> from
811	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>	834	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
812	before stopping it.	835	before stopping it.
813		836
814	As an example, libev itself uses this for its internal signal pipe: It	837	As an example, libev itself uses this for its internal signal pipe: It
815	is not visible to the libev user and should not keep C<ev_loop> from	838	is not visible to the libev user and should not keep C<ev_run> from
816	exiting if no event watchers registered by it are active. It is also an	839	exiting if no event watchers registered by it are active. It is also an
817	excellent way to do this for generic recurring timers or from within	840	excellent way to do this for generic recurring timers or from within
818	third-party libraries. Just remember to I<unref after start> and I<ref	841	third-party libraries. Just remember to I<unref after start> and I<ref
819	before stop> (but only if the watcher wasn't active before, or was active	842	before stop> (but only if the watcher wasn't active before, or was active
820	before, respectively. Note also that libev might stop watchers itself	843	before, respectively. Note also that libev might stop watchers itself
821	(e.g. non-repeating timers) in which case you have to C<ev_ref>	844	(e.g. non-repeating timers) in which case you have to C<ev_ref>
822	in the callback).	845	in the callback).
823		846
824	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	847	Example: Create a signal watcher, but keep it from keeping C<ev_run>
825	running when nothing else is active.	848	running when nothing else is active.
826		849
827	ev_signal exitsig;	850	ev_signal exitsig;
828	ev_signal_init (&exitsig, sig_cb, SIGINT);	851	ev_signal_init (&exitsig, sig_cb, SIGINT);
829	ev_signal_start (loop, &exitsig);	852	ev_signal_start (loop, &exitsig);
…		…
892	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);	915	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
893		916
894	=item ev_invoke_pending (loop)	917	=item ev_invoke_pending (loop)
895		918
896	This call will simply invoke all pending watchers while resetting their	919	This call will simply invoke all pending watchers while resetting their
897	pending state. Normally, C<ev_loop> does this automatically when required,	920	pending state. Normally, C<ev_run> does this automatically when required,
898	but when overriding the invoke callback this call comes handy.	921	but when overriding the invoke callback this call comes handy. This
		922	function can be invoked from a watcher - this can be useful for example
		923	when you want to do some lengthy calculation and want to pass further
		924	event handling to another thread (you still have to make sure only one
		925	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
899		926
900	=item int ev_pending_count (loop)	927	=item int ev_pending_count (loop)
901		928
902	Returns the number of pending watchers - zero indicates that no watchers	929	Returns the number of pending watchers - zero indicates that no watchers
903	are pending.	930	are pending.
904		931
905	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))	932	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
906		933
907	This overrides the invoke pending functionality of the loop: Instead of	934	This overrides the invoke pending functionality of the loop: Instead of
908	invoking all pending watchers when there are any, C<ev_loop> will call	935	invoking all pending watchers when there are any, C<ev_run> will call
909	this callback instead. This is useful, for example, when you want to	936	this callback instead. This is useful, for example, when you want to
910	invoke the actual watchers inside another context (another thread etc.).	937	invoke the actual watchers inside another context (another thread etc.).
911		938
912	If you want to reset the callback, use C<ev_invoke_pending> as new	939	If you want to reset the callback, use C<ev_invoke_pending> as new
913	callback.	940	callback.
…		…
916		943
917	Sometimes you want to share the same loop between multiple threads. This	944	Sometimes you want to share the same loop between multiple threads. This
918	can be done relatively simply by putting mutex_lock/unlock calls around	945	can be done relatively simply by putting mutex_lock/unlock calls around
919	each call to a libev function.	946	each call to a libev function.
920		947
921	However, C<ev_loop> can run an indefinite time, so it is not feasible to	948	However, C<ev_run> can run an indefinite time, so it is not feasible
922	wait for it to return. One way around this is to wake up the loop via	949	to wait for it to return. One way around this is to wake up the event
923	C<ev_unloop> and C<av_async_send>, another way is to set these I<release>	950	loop via C<ev_break> and C<av_async_send>, another way is to set these
924	and I<acquire> callbacks on the loop.	951	I<release> and I<acquire> callbacks on the loop.
925		952
926	When set, then C<release> will be called just before the thread is	953	When set, then C<release> will be called just before the thread is
927	suspended waiting for new events, and C<acquire> is called just	954	suspended waiting for new events, and C<acquire> is called just
928	afterwards.	955	afterwards.
929		956
…		…
932		959
933	While event loop modifications are allowed between invocations of	960	While event loop modifications are allowed between invocations of
934	C<release> and C<acquire> (that's their only purpose after all), no	961	C<release> and C<acquire> (that's their only purpose after all), no
935	modifications done will affect the event loop, i.e. adding watchers will	962	modifications done will affect the event loop, i.e. adding watchers will
936	have no effect on the set of file descriptors being watched, or the time	963	have no effect on the set of file descriptors being watched, or the time
937	waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it	964	waited. Use an C<ev_async> watcher to wake up C<ev_run> when you want it
938	to take note of any changes you made.	965	to take note of any changes you made.
939		966
940	In theory, threads executing C<ev_loop> will be async-cancel safe between	967	In theory, threads executing C<ev_run> will be async-cancel safe between
941	invocations of C<release> and C<acquire>.	968	invocations of C<release> and C<acquire>.
942		969
943	See also the locking example in the C<THREADS> section later in this	970	See also the locking example in the C<THREADS> section later in this
944	document.	971	document.
945		972
…		…
954	These two functions can be used to associate arbitrary data with a loop,	981	These two functions can be used to associate arbitrary data with a loop,
955	and are intended solely for the C<invoke_pending_cb>, C<release> and	982	and are intended solely for the C<invoke_pending_cb>, C<release> and
956	C<acquire> callbacks described above, but of course can be (ab-)used for	983	C<acquire> callbacks described above, but of course can be (ab-)used for
957	any other purpose as well.	984	any other purpose as well.
958		985
959	=item ev_loop_verify (loop)	986	=item ev_verify (loop)
960		987
961	This function only does something when C<EV_VERIFY> support has been	988	This function only does something when C<EV_VERIFY> support has been
962	compiled in, which is the default for non-minimal builds. It tries to go	989	compiled in, which is the default for non-minimal builds. It tries to go
963	through all internal structures and checks them for validity. If anything	990	through all internal structures and checks them for validity. If anything
964	is found to be inconsistent, it will print an error message to standard	991	is found to be inconsistent, it will print an error message to standard
…		…
975		1002
976	In the following description, uppercase C<TYPE> in names stands for the	1003	In the following description, uppercase C<TYPE> in names stands for the
977	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer	1004	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
978	watchers and C<ev_io_start> for I/O watchers.	1005	watchers and C<ev_io_start> for I/O watchers.
979		1006
980	A watcher is a structure that you create and register to record your	1007	A watcher is an opaque structure that you allocate and register to record
981	interest in some event. For instance, if you want to wait for STDIN to	1008	your interest in some event. To make a concrete example, imagine you want
982	become readable, you would create an C<ev_io> watcher for that:	1009	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1010	for that:
983		1011
984	static void my_cb (struct ev_loop loop, ev_io w, int revents)	1012	static void my_cb (struct ev_loop loop, ev_io w, int revents)
985	{	1013	{
986	ev_io_stop (w);	1014	ev_io_stop (w);
987	ev_unloop (loop, EVUNLOOP_ALL);	1015	ev_break (loop, EVBREAK_ALL);
988	}	1016	}
989		1017
990	struct ev_loop *loop = ev_default_loop (0);	1018	struct ev_loop *loop = ev_default_loop (0);
991		1019
992	ev_io stdin_watcher;	1020	ev_io stdin_watcher;
993		1021
994	ev_init (&stdin_watcher, my_cb);	1022	ev_init (&stdin_watcher, my_cb);
995	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1023	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
996	ev_io_start (loop, &stdin_watcher);	1024	ev_io_start (loop, &stdin_watcher);
997		1025
998	ev_loop (loop, 0);	1026	ev_run (loop, 0);
999		1027
1000	As you can see, you are responsible for allocating the memory for your	1028	As you can see, you are responsible for allocating the memory for your
1001	watcher structures (and it is I<usually> a bad idea to do this on the	1029	watcher structures (and it is I<usually> a bad idea to do this on the
1002	stack).	1030	stack).
1003		1031
1004	Each watcher has an associated watcher structure (called C<struct ev_TYPE>	1032	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
1005	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).	1033	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
1006		1034
1007	Each watcher structure must be initialised by a call to C<ev_init	1035	Each watcher structure must be initialised by a call to C<ev_init (watcher
1008	(watcher *, callback)>, which expects a callback to be provided. This	1036	*, callback)>, which expects a callback to be provided. This callback is
1009	callback gets invoked each time the event occurs (or, in the case of I/O	1037	invoked each time the event occurs (or, in the case of I/O watchers, each
1010	watchers, each time the event loop detects that the file descriptor given	1038	time the event loop detects that the file descriptor given is readable
1011	is readable and/or writable).	1039	and/or writable).
1012		1040
1013	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>	1041	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
1014	macro to configure it, with arguments specific to the watcher type. There	1042	macro to configure it, with arguments specific to the watcher type. There
1015	is also a macro to combine initialisation and setting in one call: C<<	1043	is also a macro to combine initialisation and setting in one call: C<<
1016	ev_TYPE_init (watcher *, callback, ...) >>.	1044	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
1067		1095
1068	=item C<EV_PREPARE>	1096	=item C<EV_PREPARE>
1069		1097
1070	=item C<EV_CHECK>	1098	=item C<EV_CHECK>
1071		1099
1072	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts	1100	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts
1073	to gather new events, and all C<ev_check> watchers are invoked just after	1101	to gather new events, and all C<ev_check> watchers are invoked just after
1074	C<ev_loop> has gathered them, but before it invokes any callbacks for any	1102	C<ev_run> has gathered them, but before it invokes any callbacks for any
1075	received events. Callbacks of both watcher types can start and stop as	1103	received events. Callbacks of both watcher types can start and stop as
1076	many watchers as they want, and all of them will be taken into account	1104	many watchers as they want, and all of them will be taken into account
1077	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	1105	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
1078	C<ev_loop> from blocking).	1106	C<ev_run> from blocking).
1079		1107
1080	=item C<EV_EMBED>	1108	=item C<EV_EMBED>
1081		1109
1082	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1110	The embedded event loop specified in the C<ev_embed> watcher needs attention.
1083		1111
1084	=item C<EV_FORK>	1112	=item C<EV_FORK>
1085		1113
1086	The event loop has been resumed in the child process after fork (see	1114	The event loop has been resumed in the child process after fork (see
1087	C<ev_fork>).	1115	C<ev_fork>).
		1116
		1117	=item C<EV_CLEANUP>
		1118
		1119	The event loop is abotu to be destroyed (see C<ev_cleanup>).
1088		1120
1089	=item C<EV_ASYNC>	1121	=item C<EV_ASYNC>
1090		1122
1091	The given async watcher has been asynchronously notified (see C<ev_async>).	1123	The given async watcher has been asynchronously notified (see C<ev_async>).
1092		1124
…		…
1111	example it might indicate that a fd is readable or writable, and if your	1143	example it might indicate that a fd is readable or writable, and if your
1112	callbacks is well-written it can just attempt the operation and cope with	1144	callbacks is well-written it can just attempt the operation and cope with
1113	the error from read() or write(). This will not work in multi-threaded	1145	the error from read() or write(). This will not work in multi-threaded
1114	programs, though, as the fd could already be closed and reused for another	1146	programs, though, as the fd could already be closed and reused for another
1115	thing, so beware.	1147	thing, so beware.
		1148
		1149	=back
		1150
		1151	=head2 WATCHER STATES
		1152
		1153	There are various watcher states mentioned throughout this manual -
		1154	active, pending and so on. In this section these states and the rules to
		1155	transition between them will be described in more detail - and while these
		1156	rules might look complicated, they usually do "the right thing".
		1157
		1158	=over 4
		1159
		1160	=item initialiased
		1161
		1162	Before a watcher can be registered with the event looop it has to be
		1163	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1164	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
		1165
		1166	In this state it is simply some block of memory that is suitable for use
		1167	in an event loop. It can be moved around, freed, reused etc. at will.
		1168
		1169	=item started/running/active
		1170
		1171	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
		1172	property of the event loop, and is actively waiting for events. While in
		1173	this state it cannot be accessed (except in a few documented ways), moved,
		1174	freed or anything else - the only legal thing is to keep a pointer to it,
		1175	and call libev functions on it that are documented to work on active watchers.
		1176
		1177	=item pending
		1178
		1179	If a watcher is active and libev determines that an event it is interested
		1180	in has occurred (such as a timer expiring), it will become pending. It will
		1181	stay in this pending state until either it is stopped or its callback is
		1182	about to be invoked, so it is not normally pending inside the watcher
		1183	callback.
		1184
		1185	The watcher might or might not be active while it is pending (for example,
		1186	an expired non-repeating timer can be pending but no longer active). If it
		1187	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1188	but it is still property of the event loop at this time, so cannot be
		1189	moved, freed or reused. And if it is active the rules described in the
		1190	previous item still apply.
		1191
		1192	It is also possible to feed an event on a watcher that is not active (e.g.
		1193	via C<ev_feed_event>), in which case it becomes pending without being
		1194	active.
		1195
		1196	=item stopped
		1197
		1198	A watcher can be stopped implicitly by libev (in which case it might still
		1199	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
		1200	latter will clear any pending state the watcher might be in, regardless
		1201	of whether it was active or not, so stopping a watcher explicitly before
		1202	freeing it is often a good idea.
		1203
		1204	While stopped (and not pending) the watcher is essentially in the
		1205	initialised state, that is it can be reused, moved, modified in any way
		1206	you wish.
1116		1207
1117	=back	1208	=back
1118		1209
1119	=head2 GENERIC WATCHER FUNCTIONS	1210	=head2 GENERIC WATCHER FUNCTIONS
1120		1211
…		…
1624	...	1715	...
1625	struct ev_loop *loop = ev_default_init (0);	1716	struct ev_loop *loop = ev_default_init (0);
1626	ev_io stdin_readable;	1717	ev_io stdin_readable;
1627	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1718	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1628	ev_io_start (loop, &stdin_readable);	1719	ev_io_start (loop, &stdin_readable);
1629	ev_loop (loop, 0);	1720	ev_run (loop, 0);
1630		1721
1631		1722
1632	=head2 C<ev_timer> - relative and optionally repeating timeouts	1723	=head2 C<ev_timer> - relative and optionally repeating timeouts
1633		1724
1634	Timer watchers are simple relative timers that generate an event after a	1725	Timer watchers are simple relative timers that generate an event after a
…		…
1643	The callback is guaranteed to be invoked only I<after> its timeout has	1734	The callback is guaranteed to be invoked only I<after> its timeout has
1644	passed (not I<at>, so on systems with very low-resolution clocks this	1735	passed (not I<at>, so on systems with very low-resolution clocks this
1645	might introduce a small delay). If multiple timers become ready during the	1736	might introduce a small delay). If multiple timers become ready during the
1646	same loop iteration then the ones with earlier time-out values are invoked	1737	same loop iteration then the ones with earlier time-out values are invoked
1647	before ones of the same priority with later time-out values (but this is	1738	before ones of the same priority with later time-out values (but this is
1648	no longer true when a callback calls C<ev_loop> recursively).	1739	no longer true when a callback calls C<ev_run> recursively).
1649		1740
1650	=head3 Be smart about timeouts	1741	=head3 Be smart about timeouts
1651		1742
1652	Many real-world problems involve some kind of timeout, usually for error	1743	Many real-world problems involve some kind of timeout, usually for error
1653	recovery. A typical example is an HTTP request - if the other side hangs,	1744	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1824		1915
1825	=head3 The special problem of time updates	1916	=head3 The special problem of time updates
1826		1917
1827	Establishing the current time is a costly operation (it usually takes at	1918	Establishing the current time is a costly operation (it usually takes at
1828	least two system calls): EV therefore updates its idea of the current	1919	least two system calls): EV therefore updates its idea of the current
1829	time only before and after C<ev_loop> collects new events, which causes a	1920	time only before and after C<ev_run> collects new events, which causes a
1830	growing difference between C<ev_now ()> and C<ev_time ()> when handling	1921	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1831	lots of events in one iteration.	1922	lots of events in one iteration.
1832		1923
1833	The relative timeouts are calculated relative to the C<ev_now ()>	1924	The relative timeouts are calculated relative to the C<ev_now ()>
1834	time. This is usually the right thing as this timestamp refers to the time	1925	time. This is usually the right thing as this timestamp refers to the time
…		…
1951	}	2042	}
1952		2043
1953	ev_timer mytimer;	2044	ev_timer mytimer;
1954	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	2045	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1955	ev_timer_again (&mytimer); /* start timer */	2046	ev_timer_again (&mytimer); /* start timer */
1956	ev_loop (loop, 0);	2047	ev_run (loop, 0);
1957		2048
1958	// and in some piece of code that gets executed on any "activity":	2049	// and in some piece of code that gets executed on any "activity":
1959	// reset the timeout to start ticking again at 10 seconds	2050	// reset the timeout to start ticking again at 10 seconds
1960	ev_timer_again (&mytimer);	2051	ev_timer_again (&mytimer);
1961		2052
…		…
1987		2078
1988	As with timers, the callback is guaranteed to be invoked only when the	2079	As with timers, the callback is guaranteed to be invoked only when the
1989	point in time where it is supposed to trigger has passed. If multiple	2080	point in time where it is supposed to trigger has passed. If multiple
1990	timers become ready during the same loop iteration then the ones with	2081	timers become ready during the same loop iteration then the ones with
1991	earlier time-out values are invoked before ones with later time-out values	2082	earlier time-out values are invoked before ones with later time-out values
1992	(but this is no longer true when a callback calls C<ev_loop> recursively).	2083	(but this is no longer true when a callback calls C<ev_run> recursively).
1993		2084
1994	=head3 Watcher-Specific Functions and Data Members	2085	=head3 Watcher-Specific Functions and Data Members
1995		2086
1996	=over 4	2087	=over 4
1997		2088
…		…
2235	Example: Try to exit cleanly on SIGINT.	2326	Example: Try to exit cleanly on SIGINT.
2236		2327
2237	static void	2328	static void
2238	sigint_cb (struct ev_loop loop, ev_signal w, int revents)	2329	sigint_cb (struct ev_loop loop, ev_signal w, int revents)
2239	{	2330	{
2240	ev_unloop (loop, EVUNLOOP_ALL);	2331	ev_break (loop, EVBREAK_ALL);
2241	}	2332	}
2242		2333
2243	ev_signal signal_watcher;	2334	ev_signal signal_watcher;
2244	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2335	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2245	ev_signal_start (loop, &signal_watcher);	2336	ev_signal_start (loop, &signal_watcher);
…		…
2631		2722
2632	Prepare and check watchers are usually (but not always) used in pairs:	2723	Prepare and check watchers are usually (but not always) used in pairs:
2633	prepare watchers get invoked before the process blocks and check watchers	2724	prepare watchers get invoked before the process blocks and check watchers
2634	afterwards.	2725	afterwards.
2635		2726
2636	You I<must not> call C<ev_loop> or similar functions that enter	2727	You I<must not> call C<ev_run> or similar functions that enter
2637	the current event loop from either C<ev_prepare> or C<ev_check>	2728	the current event loop from either C<ev_prepare> or C<ev_check>
2638	watchers. Other loops than the current one are fine, however. The	2729	watchers. Other loops than the current one are fine, however. The
2639	rationale behind this is that you do not need to check for recursion in	2730	rationale behind this is that you do not need to check for recursion in
2640	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2731	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
2641	C<ev_check> so if you have one watcher of each kind they will always be	2732	C<ev_check> so if you have one watcher of each kind they will always be
…		…
2809		2900
2810	if (timeout >= 0)	2901	if (timeout >= 0)
2811	// create/start timer	2902	// create/start timer
2812		2903
2813	// poll	2904	// poll
2814	ev_loop (EV_A_ 0);	2905	ev_run (EV_A_ 0);
2815		2906
2816	// stop timer again	2907	// stop timer again
2817	if (timeout >= 0)	2908	if (timeout >= 0)
2818	ev_timer_stop (EV_A_ &to);	2909	ev_timer_stop (EV_A_ &to);
2819		2910
…		…
2897	if you do not want that, you need to temporarily stop the embed watcher).	2988	if you do not want that, you need to temporarily stop the embed watcher).
2898		2989
2899	=item ev_embed_sweep (loop, ev_embed *)	2990	=item ev_embed_sweep (loop, ev_embed *)
2900		2991
2901	Make a single, non-blocking sweep over the embedded loop. This works	2992	Make a single, non-blocking sweep over the embedded loop. This works
2902	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	2993	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2903	appropriate way for embedded loops.	2994	appropriate way for embedded loops.
2904		2995
2905	=item struct ev_loop *other [read-only]	2996	=item struct ev_loop *other [read-only]
2906		2997
2907	The embedded event loop.	2998	The embedded event loop.
…		…
2993	disadvantage of having to use multiple event loops (which do not support	3084	disadvantage of having to use multiple event loops (which do not support
2994	signal watchers).	3085	signal watchers).
2995		3086
2996	When this is not possible, or you want to use the default loop for	3087	When this is not possible, or you want to use the default loop for
2997	other reasons, then in the process that wants to start "fresh", call	3088	other reasons, then in the process that wants to start "fresh", call
2998	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3089	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
2999	the default loop will "orphan" (not stop) all registered watchers, so you	3090	Destroying the default loop will "orphan" (not stop) all registered
3000	have to be careful not to execute code that modifies those watchers. Note	3091	watchers, so you have to be careful not to execute code that modifies
3001	also that in that case, you have to re-register any signal watchers.	3092	those watchers. Note also that in that case, you have to re-register any
		3093	signal watchers.
3002		3094
3003	=head3 Watcher-Specific Functions and Data Members	3095	=head3 Watcher-Specific Functions and Data Members
3004		3096
3005	=over 4	3097	=over 4
3006		3098
3007	=item ev_fork_init (ev_signal *, callback)	3099	=item ev_fork_init (ev_fork *, callback)
3008		3100
3009	Initialises and configures the fork watcher - it has no parameters of any	3101	Initialises and configures the fork watcher - it has no parameters of any
3010	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3102	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
3011	believe me.	3103	believe me.
3012		3104
3013	=back	3105	=back
3014		3106
3015		3107
		3108	=head2 C<ev_cleanup> - even the best things end
		3109
		3110	Cleanup watchers are called just before the event loop they are registered
		3111	with is being destroyed.
		3112
		3113	While there is no guarantee that the event loop gets destroyed, cleanup
		3114	watchers provide a convenient method to install cleanup hooks for your
		3115	program, worker threads and so on - you just to make sure to destroy the
		3116	loop when you want them to be invoked.
		3117
		3118	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3119	all other watchers, they do not keep a reference to the event loop (which
		3120	makes a lot of sense if you think about it). Like all other watchers, you
		3121	can call libev functions in the callback, except C<ev_cleanup_start>.
		3122
		3123	=head3 Watcher-Specific Functions and Data Members
		3124
		3125	=over 4
		3126
		3127	=item ev_cleanup_init (ev_cleanup *, callback)
		3128
		3129	Initialises and configures the cleanup watcher - it has no parameters of
		3130	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3131	pointless, believe me.
		3132
		3133	=back
		3134
		3135	Example: Register an atexit handler to destroy the default loop, so any
		3136	cleanup functions are called.
		3137
		3138	static void
		3139	program_exits (void)
		3140	{
		3141	ev_loop_destroy (EV_DEFAULT_UC);
		3142	}
		3143
		3144	...
		3145	atexit (program_exits);
		3146
		3147
3016	=head2 C<ev_async> - how to wake up an event loop	3148	=head2 C<ev_async> - how to wake up an event loop
3017		3149
3018	In general, you cannot use an C<ev_loop> from multiple threads or other	3150	In general, you cannot use an C<ev_run> from multiple threads or other
3019	asynchronous sources such as signal handlers (as opposed to multiple event	3151	asynchronous sources such as signal handlers (as opposed to multiple event
3020	loops - those are of course safe to use in different threads).	3152	loops - those are of course safe to use in different threads).
3021		3153
3022	Sometimes, however, you need to wake up an event loop you do not control,	3154	Sometimes, however, you need to wake up an event loop you do not control,
3023	for example because it belongs to another thread. This is what C<ev_async>	3155	for example because it belongs to another thread. This is what C<ev_async>
…		…
3391	Associates a different C<struct ev_loop> with this watcher. You can only	3523	Associates a different C<struct ev_loop> with this watcher. You can only
3392	do this when the watcher is inactive (and not pending either).	3524	do this when the watcher is inactive (and not pending either).
3393		3525
3394	=item w->set ([arguments])	3526	=item w->set ([arguments])
3395		3527
3396	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be	3528	Basically the same as C<ev_TYPE_set>, with the same arguments. Either this
3397	called at least once. Unlike the C counterpart, an active watcher gets	3529	method or a suitable start method must be called at least once. Unlike the
3398	automatically stopped and restarted when reconfiguring it with this	3530	C counterpart, an active watcher gets automatically stopped and restarted
3399	method.	3531	when reconfiguring it with this method.
3400		3532
3401	=item w->start ()	3533	=item w->start ()
3402		3534
3403	Starts the watcher. Note that there is no C<loop> argument, as the	3535	Starts the watcher. Note that there is no C<loop> argument, as the
3404	constructor already stores the event loop.	3536	constructor already stores the event loop.
3405		3537
		3538	=item w->start ([arguments])
		3539
		3540	Instead of calling C<set> and C<start> methods separately, it is often
		3541	convenient to wrap them in one call. Uses the same type of arguments as
		3542	the configure C<set> method of the watcher.
		3543
3406	=item w->stop ()	3544	=item w->stop ()
3407		3545
3408	Stops the watcher if it is active. Again, no C<loop> argument.	3546	Stops the watcher if it is active. Again, no C<loop> argument.
3409		3547
3410	=item w->again () (C<ev::timer>, C<ev::periodic> only)	3548	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
3422		3560
3423	=back	3561	=back
3424		3562
3425	=back	3563	=back
3426		3564
3427	Example: Define a class with an IO and idle watcher, start one of them in	3565	Example: Define a class with two I/O and idle watchers, start the I/O
3428	the constructor.	3566	watchers in the constructor.
3429		3567
3430	class myclass	3568	class myclass
3431	{	3569	{
3432	ev::io io ; void io_cb (ev::io &w, int revents);	3570	ev::io io ; void io_cb (ev::io &w, int revents);
		3571	ev::io2 io2 ; void io2_cb (ev::io &w, int revents);
3433	ev::idle idle; void idle_cb (ev::idle &w, int revents);	3572	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3434		3573
3435	myclass (int fd)	3574	myclass (int fd)
3436	{	3575	{
3437	io .set <myclass, &myclass::io_cb > (this);	3576	io .set <myclass, &myclass::io_cb > (this);
		3577	io2 .set <myclass, &myclass::io2_cb > (this);
3438	idle.set <myclass, &myclass::idle_cb> (this);	3578	idle.set <myclass, &myclass::idle_cb> (this);
3439		3579
3440	io.start (fd, ev::READ);	3580	io.set (fd, ev::WRITE); // configure the watcher
		3581	io.start (); // start it whenever convenient
		3582
		3583	io2.start (fd, ev::READ); // set + start in one call
3441	}	3584	}
3442	};	3585	};
3443		3586
3444		3587
3445	=head1 OTHER LANGUAGE BINDINGS	3588	=head1 OTHER LANGUAGE BINDINGS
…		…
3519	loop argument"). The C<EV_A> form is used when this is the sole argument,	3662	loop argument"). The C<EV_A> form is used when this is the sole argument,
3520	C<EV_A_> is used when other arguments are following. Example:	3663	C<EV_A_> is used when other arguments are following. Example:
3521		3664
3522	ev_unref (EV_A);	3665	ev_unref (EV_A);
3523	ev_timer_add (EV_A_ watcher);	3666	ev_timer_add (EV_A_ watcher);
3524	ev_loop (EV_A_ 0);	3667	ev_run (EV_A_ 0);
3525		3668
3526	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	3669	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
3527	which is often provided by the following macro.	3670	which is often provided by the following macro.
3528		3671
3529	=item C<EV_P>, C<EV_P_>	3672	=item C<EV_P>, C<EV_P_>
…		…
3569	}	3712	}
3570		3713
3571	ev_check check;	3714	ev_check check;
3572	ev_check_init (&check, check_cb);	3715	ev_check_init (&check, check_cb);
3573	ev_check_start (EV_DEFAULT_ &check);	3716	ev_check_start (EV_DEFAULT_ &check);
3574	ev_loop (EV_DEFAULT_ 0);	3717	ev_run (EV_DEFAULT_ 0);
3575		3718
3576	=head1 EMBEDDING	3719	=head1 EMBEDDING
3577		3720
3578	Libev can (and often is) directly embedded into host	3721	Libev can (and often is) directly embedded into host
3579	applications. Examples of applications that embed it include the Deliantra	3722	applications. Examples of applications that embed it include the Deliantra
…		…
3670	to a compiled library. All other symbols change the ABI, which means all	3813	to a compiled library. All other symbols change the ABI, which means all
3671	users of libev and the libev code itself must be compiled with compatible	3814	users of libev and the libev code itself must be compiled with compatible
3672	settings.	3815	settings.
3673		3816
3674	=over 4	3817	=over 4
		3818
		3819	=item EV_COMPAT3 (h)
		3820
		3821	Backwards compatibility is a major concern for libev. This is why this
		3822	release of libev comes with wrappers for the functions and symbols that
		3823	have been renamed between libev version 3 and 4.
		3824
		3825	You can disable these wrappers (to test compatibility with future
		3826	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		3827	sources. This has the additional advantage that you can drop the C<struct>
		3828	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		3829	typedef in that case.
		3830
		3831	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		3832	and in some even more future version the compatibility code will be
		3833	removed completely.
3675		3834
3676	=item EV_STANDALONE (h)	3835	=item EV_STANDALONE (h)
3677		3836
3678	Must always be C<1> if you do not use autoconf configuration, which	3837	Must always be C<1> if you do not use autoconf configuration, which
3679	keeps libev from including F<config.h>, and it also defines dummy	3838	keeps libev from including F<config.h>, and it also defines dummy
…		…
4029	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it	4188	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4030	will be C<0>.	4189	will be C<0>.
4031		4190
4032	=item EV_VERIFY	4191	=item EV_VERIFY
4033		4192
4034	Controls how much internal verification (see C<ev_loop_verify ()>) will	4193	Controls how much internal verification (see C<ev_verify ()>) will
4035	be done: If set to C<0>, no internal verification code will be compiled	4194	be done: If set to C<0>, no internal verification code will be compiled
4036	in. If set to C<1>, then verification code will be compiled in, but not	4195	in. If set to C<1>, then verification code will be compiled in, but not
4037	called. If set to C<2>, then the internal verification code will be	4196	called. If set to C<2>, then the internal verification code will be
4038	called once per loop, which can slow down libev. If set to C<3>, then the	4197	called once per loop, which can slow down libev. If set to C<3>, then the
4039	verification code will be called very frequently, which will slow down	4198	verification code will be called very frequently, which will slow down
…		…
4254	userdata *u = ev_userdata (EV_A);	4413	userdata *u = ev_userdata (EV_A);
4255	pthread_mutex_lock (&u->lock);	4414	pthread_mutex_lock (&u->lock);
4256	}	4415	}
4257		4416
4258	The event loop thread first acquires the mutex, and then jumps straight	4417	The event loop thread first acquires the mutex, and then jumps straight
4259	into C<ev_loop>:	4418	into C<ev_run>:
4260		4419
4261	void *	4420	void *
4262	l_run (void *thr_arg)	4421	l_run (void *thr_arg)
4263	{	4422	{
4264	struct ev_loop loop = (struct ev_loop )thr_arg;	4423	struct ev_loop loop = (struct ev_loop )thr_arg;
4265		4424
4266	l_acquire (EV_A);	4425	l_acquire (EV_A);
4267	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);	4426	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4268	ev_loop (EV_A_ 0);	4427	ev_run (EV_A_ 0);
4269	l_release (EV_A);	4428	l_release (EV_A);
4270		4429
4271	return 0;	4430	return 0;
4272	}	4431	}
4273		4432
…		…
4325		4484
4326	=head3 COROUTINES	4485	=head3 COROUTINES
4327		4486
4328	Libev is very accommodating to coroutines ("cooperative threads"):	4487	Libev is very accommodating to coroutines ("cooperative threads"):
4329	libev fully supports nesting calls to its functions from different	4488	libev fully supports nesting calls to its functions from different
4330	coroutines (e.g. you can call C<ev_loop> on the same loop from two	4489	coroutines (e.g. you can call C<ev_run> on the same loop from two
4331	different coroutines, and switch freely between both coroutines running	4490	different coroutines, and switch freely between both coroutines running
4332	the loop, as long as you don't confuse yourself). The only exception is	4491	the loop, as long as you don't confuse yourself). The only exception is
4333	that you must not do this from C<ev_periodic> reschedule callbacks.	4492	that you must not do this from C<ev_periodic> reschedule callbacks.
4334		4493
4335	Care has been taken to ensure that libev does not keep local state inside	4494	Care has been taken to ensure that libev does not keep local state inside
4336	C<ev_loop>, and other calls do not usually allow for coroutine switches as	4495	C<ev_run>, and other calls do not usually allow for coroutine switches as
4337	they do not call any callbacks.	4496	they do not call any callbacks.
4338		4497
4339	=head2 COMPILER WARNINGS	4498	=head2 COMPILER WARNINGS
4340		4499
4341	Depending on your compiler and compiler settings, you might get no or a	4500	Depending on your compiler and compiler settings, you might get no or a
…		…
4425	=head3 C<kqueue> is buggy	4584	=head3 C<kqueue> is buggy
4426		4585
4427	The kqueue syscall is broken in all known versions - most versions support	4586	The kqueue syscall is broken in all known versions - most versions support
4428	only sockets, many support pipes.	4587	only sockets, many support pipes.
4429		4588
4430	Libev tries to work around this by not using C<kqueue> by default on	4589	Libev tries to work around this by not using C<kqueue> by default on this
4431	this rotten platform, but of course you can still ask for it when creating	4590	rotten platform, but of course you can still ask for it when creating a
4432	a loop.	4591	loop - embedding a socket-only kqueue loop into a select-based one is
		4592	probably going to work well.
4433		4593
4434	=head3 C<poll> is buggy	4594	=head3 C<poll> is buggy
4435		4595
4436	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>	4596	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
4437	implementation by something calling C<kqueue> internally around the 10.5.6	4597	implementation by something calling C<kqueue> internally around the 10.5.6
…		…
4456		4616
4457	=head3 C<errno> reentrancy	4617	=head3 C<errno> reentrancy
4458		4618
4459	The default compile environment on Solaris is unfortunately so	4619	The default compile environment on Solaris is unfortunately so
4460	thread-unsafe that you can't even use components/libraries compiled	4620	thread-unsafe that you can't even use components/libraries compiled
4461	without C<-D_REENTRANT> (as long as they use C<errno>), which, of course,	4621	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
4462	isn't defined by default.	4622	defined by default. A valid, if stupid, implementation choice.
4463		4623
4464	If you want to use libev in threaded environments you have to make sure	4624	If you want to use libev in threaded environments you have to make sure
4465	it's compiled with C<_REENTRANT> defined.	4625	it's compiled with C<_REENTRANT> defined.
4466		4626
4467	=head3 Event port backend	4627	=head3 Event port backend
4468		4628
4469	The scalable event interface for Solaris is called "event ports". Unfortunately,	4629	The scalable event interface for Solaris is called "event
4470	this mechanism is very buggy. If you run into high CPU usage, your program	4630	ports". Unfortunately, this mechanism is very buggy in all major
		4631	releases. If you run into high CPU usage, your program freezes or you get
4471	freezes or you get a large number of spurious wakeups, make sure you have	4632	a large number of spurious wakeups, make sure you have all the relevant
4472	all the relevant and latest kernel patches applied. No, I don't know which	4633	and latest kernel patches applied. No, I don't know which ones, but there
4473	ones, but there are multiple ones.	4634	are multiple ones to apply, and afterwards, event ports actually work
		4635	great.
4474		4636
4475	If you can't get it to work, you can try running the program by setting	4637	If you can't get it to work, you can try running the program by setting
4476	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and	4638	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
4477	C<select> backends.	4639	C<select> backends.
4478		4640
4479	=head2 AIX POLL BUG	4641	=head2 AIX POLL BUG
4480		4642
4481	AIX unfortunately has a broken C<poll.h> header. Libev works around	4643	AIX unfortunately has a broken C<poll.h> header. Libev works around
4482	this by trying to avoid the poll backend altogether (i.e. it's not even	4644	this by trying to avoid the poll backend altogether (i.e. it's not even
4483	compiled in), which normally isn't a big problem as C<select> works fine	4645	compiled in), which normally isn't a big problem as C<select> works fine
4484	with large bitsets, and AIX is dead anyway.	4646	with large bitsets on AIX, and AIX is dead anyway.
4485		4647
4486	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	4648	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
4487		4649
4488	=head3 General issues	4650	=head3 General issues
4489		4651
…		…
4626	watchers.	4788	watchers.
4627		4789
4628	=item C<double> must hold a time value in seconds with enough accuracy	4790	=item C<double> must hold a time value in seconds with enough accuracy
4629		4791
4630	The type C<double> is used to represent timestamps. It is required to	4792	The type C<double> is used to represent timestamps. It is required to
4631	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	4793	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4632	enough for at least into the year 4000. This requirement is fulfilled by	4794	good enough for at least into the year 4000 with millisecond accuracy
		4795	(the design goal for libev). This requirement is overfulfilled by
4633	implementations implementing IEEE 754, which is basically all existing	4796	implementations using IEEE 754, which is basically all existing ones. With
4634	ones. With IEEE 754 doubles, you get microsecond accuracy until at least	4797	IEEE 754 doubles, you get microsecond accuracy until at least 2200.
4635	2200.
4636		4798
4637	=back	4799	=back
4638		4800
4639	If you know of other additional requirements drop me a note.	4801	If you know of other additional requirements drop me a note.
4640		4802
…		…
4718	compatibility, so most programs should still compile. Those might be	4880	compatibility, so most programs should still compile. Those might be
4719	removed in later versions of libev, so better update early than late.	4881	removed in later versions of libev, so better update early than late.
4720		4882
4721	=over 4	4883	=over 4
4722		4884
4723	=item C<ev_loop_count> renamed to C<ev_iteration>	4885	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
4724		4886
4725	=item C<ev_loop_depth> renamed to C<ev_depth>	4887	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
4726		4888
4727	=item C<ev_loop_verify> renamed to C<ev_verify>	4889	ev_loop_destroy (EV_DEFAULT_UC);
		4890	ev_loop_fork (EV_DEFAULT);
		4891
		4892	=item function/symbol renames
		4893
		4894	A number of functions and symbols have been renamed:
		4895
		4896	ev_loop => ev_run
		4897	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		4898	EVLOOP_ONESHOT => EVRUN_ONCE
		4899
		4900	ev_unloop => ev_break
		4901	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		4902	EVUNLOOP_ONE => EVBREAK_ONE
		4903	EVUNLOOP_ALL => EVBREAK_ALL
		4904
		4905	EV_TIMEOUT => EV_TIMER
		4906
		4907	ev_loop_count => ev_iteration
		4908	ev_loop_depth => ev_depth
		4909	ev_loop_verify => ev_verify
4728		4910
4729	Most functions working on C<struct ev_loop> objects don't have an	4911	Most functions working on C<struct ev_loop> objects don't have an
4730	C<ev_loop_> prefix, so it was removed. Note that C<ev_loop_fork> is	4912	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		4913	associated constants have been renamed to not collide with the C<struct
		4914	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		4915	as all other watcher types. Note that C<ev_loop_fork> is still called
4731	still called C<ev_loop_fork> because it would otherwise clash with the	4916	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
4732	C<ev_fork> typedef.	4917	typedef.
4733		4918
4734	=item C<EV_TIMEOUT> renamed to C<EV_TIMER> in C<revents>	4919	=item C<EV_COMPAT3> backwards compatibility mechanism
4735		4920
4736	This is a simple rename - all other watcher types use their name	4921	The backward compatibility mechanism can be controlled by
4737	as revents flag, and now C<ev_timer> does, too.	4922	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
4738		4923	section.
4739	Both C<EV_TIMER> and C<EV_TIMEOUT> symbols were present in 3.x versions
4740	and continue to be present for the foreseeable future, so this is mostly a
4741	documentation change.
4742		4924
4743	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>	4925	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
4744		4926
4745	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different	4927	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
4746	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile	4928	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
…		…
4753		4935
4754	=over 4	4936	=over 4
4755		4937
4756	=item active	4938	=item active
4757		4939
4758	A watcher is active as long as it has been started (has been attached to	4940	A watcher is active as long as it has been started and not yet stopped.
4759	an event loop) but not yet stopped (disassociated from the event loop).	4941	See L<WATCHER STATES> for details.
4760		4942
4761	=item application	4943	=item application
4762		4944
4763	In this document, an application is whatever is using libev.	4945	In this document, an application is whatever is using libev.
		4946
		4947	=item backend
		4948
		4949	The part of the code dealing with the operating system interfaces.
4764		4950
4765	=item callback	4951	=item callback
4766		4952
4767	The address of a function that is called when some event has been	4953	The address of a function that is called when some event has been
4768	detected. Callbacks are being passed the event loop, the watcher that	4954	detected. Callbacks are being passed the event loop, the watcher that
4769	received the event, and the actual event bitset.	4955	received the event, and the actual event bitset.
4770		4956
4771	=item callback invocation	4957	=item callback/watcher invocation
4772		4958
4773	The act of calling the callback associated with a watcher.	4959	The act of calling the callback associated with a watcher.
4774		4960
4775	=item event	4961	=item event
4776		4962
…		…
4795	The model used to describe how an event loop handles and processes	4981	The model used to describe how an event loop handles and processes
4796	watchers and events.	4982	watchers and events.
4797		4983
4798	=item pending	4984	=item pending
4799		4985
4800	A watcher is pending as soon as the corresponding event has been detected,	4986	A watcher is pending as soon as the corresponding event has been
4801	and stops being pending as soon as the watcher will be invoked or its	4987	detected. See L<WATCHER STATES> for details.
4802	pending status is explicitly cleared by the application.
4803
4804	A watcher can be pending, but not active. Stopping a watcher also clears
4805	its pending status.
4806		4988
4807	=item real time	4989	=item real time
4808		4990
4809	The physical time that is observed. It is apparently strictly monotonic :)	4991	The physical time that is observed. It is apparently strictly monotonic :)
4810		4992
…		…
4817	=item watcher	4999	=item watcher
4818		5000
4819	A data structure that describes interest in certain events. Watchers need	5001	A data structure that describes interest in certain events. Watchers need
4820	to be started (attached to an event loop) before they can receive events.	5002	to be started (attached to an event loop) before they can receive events.
4821		5003
4822	=item watcher invocation
4823
4824	The act of calling the callback associated with a watcher.
4825
4826	=back	5004	=back
4827		5005
4828	=head1 AUTHOR	5006	=head1 AUTHOR
4829		5007
4830	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5008	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.306 by root, Mon Oct 18 07:36:05 2010 UTC vs. Revision 1.327 by root, Sun Oct 24 20:05:43 2010 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.306 by root, Mon Oct 18 07:36:05 2010 UTC vs.
Revision 1.327 by root, Sun Oct 24 20:05:43 2010 UTC