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

Comparing libev/ev.pod (file contents):
Revision 1.305 by root, Thu Oct 14 05:07:04 2010 UTC vs.
Revision 1.310 by root, Thu Oct 21 12:32:47 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	{
…		…
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
…		…
292		292
293	=back	293	=back
294		294
295	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	295	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
296		296
297	An event loop is described by a C<struct ev_loop *> (the C<struct>	297	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>	298	I<not> optional in case unless libev 3 compatibility is disabled, as libev
299	I<function>).	299	3 had an C<ev_loop> function colliding with the struct name).
300		300
301	The library knows two types of such loops, the I<default> loop, which	301	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	302	supports signals and child events, and dynamically created event loops
303	not.	303	which do not.
304		304
305	=over 4	305	=over 4
306		306
307	=item struct ev_loop *ev_default_loop (unsigned int flags)	307	=item struct ev_loop *ev_default_loop (unsigned int flags)
308		308
…		…
439	of course I<doesn't>, and epoll just loves to report events for totally	439	of course I<doesn't>, and epoll just loves to report events for totally
440	I<different> file descriptors (even already closed ones, so one cannot	440	I<different> file descriptors (even already closed ones, so one cannot
441	even remove them from the set) than registered in the set (especially	441	even remove them from the set) than registered in the set (especially
442	on SMP systems). Libev tries to counter these spurious notifications by	442	on SMP systems). Libev tries to counter these spurious notifications by
443	employing an additional generation counter and comparing that against the	443	employing an additional generation counter and comparing that against the
444	events to filter out spurious ones, recreating the set when required.	444	events to filter out spurious ones, recreating the set when required. Last
		445	not least, it also refuses to work with some file descriptors which work
		446	perfectly fine with C<select> (files, many character devices...).
445		447
446	While stopping, setting and starting an I/O watcher in the same iteration	448	While stopping, setting and starting an I/O watcher in the same iteration
447	will result in some caching, there is still a system call per such	449	will result in some caching, there is still a system call per such
448	incident (because the same I<file descriptor> could point to a different	450	incident (because the same I<file descriptor> could point to a different
449	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed	451	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
…		…
604	Like C<ev_default_destroy>, but destroys an event loop created by an	606	Like C<ev_default_destroy>, but destroys an event loop created by an
605	earlier call to C<ev_loop_new>.	607	earlier call to C<ev_loop_new>.
606		608
607	=item ev_default_fork ()	609	=item ev_default_fork ()
608		610
609	This function sets a flag that causes subsequent C<ev_loop> iterations	611	This function sets a flag that causes subsequent C<ev_run> iterations
610	to reinitialise the kernel state for backends that have one. Despite the	612	to reinitialise the kernel state for backends that have one. Despite the
611	name, you can call it anytime, but it makes most sense after forking, in	613	name, you can call it anytime, but it makes most sense after forking, in
612	the child process (or both child and parent, but that again makes little	614	the child process (or both child and parent, but that again makes little
613	sense). You I<must> call it in the child before using any of the libev	615	sense). You I<must> call it in the child before using any of the libev
614	functions, and it will only take effect at the next C<ev_loop> iteration.	616	functions, and it will only take effect at the next C<ev_run> iteration.
615		617
616	Again, you I<have> to call it on I<any> loop that you want to re-use after	618	Again, you I<have> to call it on I<any> loop that you want to re-use after
617	a fork, I<even if you do not plan to use the loop in the parent>. This is	619	a fork, I<even if you do not plan to use the loop in the parent>. This is
618	because some kernel interfaces cough I<kqueue> cough do funny things	620	because some kernel interfaces cough I<kqueue> cough do funny things
619	during fork.	621	during fork.
620		622
621	On the other hand, you only need to call this function in the child	623	On the other hand, you only need to call this function in the child
622	process if and only if you want to use the event loop in the child. If you	624	process if and only if you want to use the event loop in the child. If
623	just fork+exec or create a new loop in the child, you don't have to call	625	you just fork+exec or create a new loop in the child, you don't have to
624	it at all.	626	call it at all (in fact, C<epoll> is so badly broken that it makes a
		627	difference, but libev will usually detect this case on its own and do a
		628	costly reset of the backend).
625		629
626	The function itself is quite fast and it's usually not a problem to call	630	The function itself is quite fast and it's usually not a problem to call
627	it just in case after a fork. To make this easy, the function will fit in	631	it just in case after a fork. To make this easy, the function will fit in
628	quite nicely into a call to C<pthread_atfork>:	632	quite nicely into a call to C<pthread_atfork>:
629		633
…		…
641	Returns true when the given loop is, in fact, the default loop, and false	645	Returns true when the given loop is, in fact, the default loop, and false
642	otherwise.	646	otherwise.
643		647
644	=item unsigned int ev_iteration (loop)	648	=item unsigned int ev_iteration (loop)
645		649
646	Returns the current iteration count for the loop, which is identical to	650	Returns the current iteration count for the event loop, which is identical
647	the number of times libev did poll for new events. It starts at C<0> and	651	to the number of times libev did poll for new events. It starts at C<0>
648	happily wraps around with enough iterations.	652	and happily wraps around with enough iterations.
649		653
650	This value can sometimes be useful as a generation counter of sorts (it	654	This value can sometimes be useful as a generation counter of sorts (it
651	"ticks" the number of loop iterations), as it roughly corresponds with	655	"ticks" the number of loop iterations), as it roughly corresponds with
652	C<ev_prepare> and C<ev_check> calls - and is incremented between the	656	C<ev_prepare> and C<ev_check> calls - and is incremented between the
653	prepare and check phases.	657	prepare and check phases.
654		658
655	=item unsigned int ev_depth (loop)	659	=item unsigned int ev_depth (loop)
656		660
657	Returns the number of times C<ev_loop> was entered minus the number of	661	Returns the number of times C<ev_run> was entered minus the number of
658	times C<ev_loop> was exited, in other words, the recursion depth.	662	times C<ev_run> was exited, in other words, the recursion depth.
659		663
660	Outside C<ev_loop>, this number is zero. In a callback, this number is	664	Outside C<ev_run>, this number is zero. In a callback, this number is
661	C<1>, unless C<ev_loop> was invoked recursively (or from another thread),	665	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
662	in which case it is higher.	666	in which case it is higher.
663		667
664	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread	668	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread
665	etc.), doesn't count as "exit" - consider this as a hint to avoid such	669	etc.), doesn't count as "exit" - consider this as a hint to avoid such
666	ungentleman behaviour unless it's really convenient.	670	ungentleman-like behaviour unless it's really convenient.
667		671
668	=item unsigned int ev_backend (loop)	672	=item unsigned int ev_backend (loop)
669		673
670	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	674	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
671	use.	675	use.
…		…
680		684
681	=item ev_now_update (loop)	685	=item ev_now_update (loop)
682		686
683	Establishes the current time by querying the kernel, updating the time	687	Establishes the current time by querying the kernel, updating the time
684	returned by C<ev_now ()> in the progress. This is a costly operation and	688	returned by C<ev_now ()> in the progress. This is a costly operation and
685	is usually done automatically within C<ev_loop ()>.	689	is usually done automatically within C<ev_run ()>.
686		690
687	This function is rarely useful, but when some event callback runs for a	691	This function is rarely useful, but when some event callback runs for a
688	very long time without entering the event loop, updating libev's idea of	692	very long time without entering the event loop, updating libev's idea of
689	the current time is a good idea.	693	the current time is a good idea.
690		694
…		…
692		696
693	=item ev_suspend (loop)	697	=item ev_suspend (loop)
694		698
695	=item ev_resume (loop)	699	=item ev_resume (loop)
696		700
697	These two functions suspend and resume a loop, for use when the loop is	701	These two functions suspend and resume an event loop, for use when the
698	not used for a while and timeouts should not be processed.	702	loop is not used for a while and timeouts should not be processed.
699		703
700	A typical use case would be an interactive program such as a game: When	704	A typical use case would be an interactive program such as a game: When
701	the user presses C<^Z> to suspend the game and resumes it an hour later it	705	the user presses C<^Z> to suspend the game and resumes it an hour later it
702	would be best to handle timeouts as if no time had actually passed while	706	would be best to handle timeouts as if no time had actually passed while
703	the program was suspended. This can be achieved by calling C<ev_suspend>	707	the program was suspended. This can be achieved by calling C<ev_suspend>
…		…
714	without a previous call to C<ev_suspend>.	718	without a previous call to C<ev_suspend>.
715		719
716	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the	720	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
717	event loop time (see C<ev_now_update>).	721	event loop time (see C<ev_now_update>).
718		722
719	=item ev_loop (loop, int flags)	723	=item ev_run (loop, int flags)
720		724
721	Finally, this is it, the event handler. This function usually is called	725	Finally, this is it, the event handler. This function usually is called
722	after you have initialised all your watchers and you want to start	726	after you have initialised all your watchers and you want to start
723	handling events.	727	handling events. It will ask the operating system for any new events, call
		728	the watcher callbacks, an then repeat the whole process indefinitely: This
		729	is why event loops are called I<loops>.
724		730
725	If the flags argument is specified as C<0>, it will not return until	731	If the flags argument is specified as C<0>, it will keep handling events
726	either no event watchers are active anymore or C<ev_unloop> was called.	732	until either no event watchers are active anymore or C<ev_break> was
		733	called.
727		734
728	Please note that an explicit C<ev_unloop> is usually better than	735	Please note that an explicit C<ev_break> is usually better than
729	relying on all watchers to be stopped when deciding when a program has	736	relying on all watchers to be stopped when deciding when a program has
730	finished (especially in interactive programs), but having a program	737	finished (especially in interactive programs), but having a program
731	that automatically loops as long as it has to and no longer by virtue	738	that automatically loops as long as it has to and no longer by virtue
732	of relying on its watchers stopping correctly, that is truly a thing of	739	of relying on its watchers stopping correctly, that is truly a thing of
733	beauty.	740	beauty.
734		741
735	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	742	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
736	those events and any already outstanding ones, but will not block your	743	those events and any already outstanding ones, but will not wait and
737	process in case there are no events and will return after one iteration of	744	block your process in case there are no events and will return after one
738	the loop.	745	iteration of the loop. This is sometimes useful to poll and handle new
		746	events while doing lengthy calculations, to keep the program responsive.
739		747
740	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	748	A flags value of C<EVRUN_ONCE> will look for new events (waiting if
741	necessary) and will handle those and any already outstanding ones. It	749	necessary) and will handle those and any already outstanding ones. It
742	will block your process until at least one new event arrives (which could	750	will block your process until at least one new event arrives (which could
743	be an event internal to libev itself, so there is no guarantee that a	751	be an event internal to libev itself, so there is no guarantee that a
744	user-registered callback will be called), and will return after one	752	user-registered callback will be called), and will return after one
745	iteration of the loop.	753	iteration of the loop.
746		754
747	This is useful if you are waiting for some external event in conjunction	755	This is useful if you are waiting for some external event in conjunction
748	with something not expressible using other libev watchers (i.e. "roll your	756	with something not expressible using other libev watchers (i.e. "roll your
749	own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is	757	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
750	usually a better approach for this kind of thing.	758	usually a better approach for this kind of thing.
751		759
752	Here are the gory details of what C<ev_loop> does:	760	Here are the gory details of what C<ev_run> does:
753		761
		762	- Increment loop depth.
		763	- Reset the ev_break status.
754	- Before the first iteration, call any pending watchers.	764	- Before the first iteration, call any pending watchers.
		765	LOOP:
755	* If EVFLAG_FORKCHECK was used, check for a fork.	766	- If EVFLAG_FORKCHECK was used, check for a fork.
756	- If a fork was detected (by any means), queue and call all fork watchers.	767	- If a fork was detected (by any means), queue and call all fork watchers.
757	- Queue and call all prepare watchers.	768	- Queue and call all prepare watchers.
		769	- If ev_break was called, goto FINISH.
758	- If we have been forked, detach and recreate the kernel state	770	- If we have been forked, detach and recreate the kernel state
759	as to not disturb the other process.	771	as to not disturb the other process.
760	- Update the kernel state with all outstanding changes.	772	- Update the kernel state with all outstanding changes.
761	- Update the "event loop time" (ev_now ()).	773	- Update the "event loop time" (ev_now ()).
762	- Calculate for how long to sleep or block, if at all	774	- Calculate for how long to sleep or block, if at all
763	(active idle watchers, EVLOOP_NONBLOCK or not having	775	(active idle watchers, EVRUN_NOWAIT or not having
764	any active watchers at all will result in not sleeping).	776	any active watchers at all will result in not sleeping).
765	- Sleep if the I/O and timer collect interval say so.	777	- Sleep if the I/O and timer collect interval say so.
		778	- Increment loop iteration counter.
766	- Block the process, waiting for any events.	779	- Block the process, waiting for any events.
767	- Queue all outstanding I/O (fd) events.	780	- Queue all outstanding I/O (fd) events.
768	- Update the "event loop time" (ev_now ()), and do time jump adjustments.	781	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
769	- Queue all expired timers.	782	- Queue all expired timers.
770	- Queue all expired periodics.	783	- Queue all expired periodics.
771	- Unless any events are pending now, queue all idle watchers.	784	- Queue all idle watchers with priority higher than that of pending events.
772	- Queue all check watchers.	785	- Queue all check watchers.
773	- Call all queued watchers in reverse order (i.e. check watchers first).	786	- Call all queued watchers in reverse order (i.e. check watchers first).
774	Signals and child watchers are implemented as I/O watchers, and will	787	Signals and child watchers are implemented as I/O watchers, and will
775	be handled here by queueing them when their watcher gets executed.	788	be handled here by queueing them when their watcher gets executed.
776	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	789	- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
777	were used, or there are no active watchers, return, otherwise	790	were used, or there are no active watchers, goto FINISH, otherwise
778	continue with step *.	791	continue with step LOOP.
		792	FINISH:
		793	- Reset the ev_break status iff it was EVBREAK_ONE.
		794	- Decrement the loop depth.
		795	- Return.
779		796
780	Example: Queue some jobs and then loop until no events are outstanding	797	Example: Queue some jobs and then loop until no events are outstanding
781	anymore.	798	anymore.
782		799
783	... queue jobs here, make sure they register event watchers as long	800	... queue jobs here, make sure they register event watchers as long
784	... as they still have work to do (even an idle watcher will do..)	801	... as they still have work to do (even an idle watcher will do..)
785	ev_loop (my_loop, 0);	802	ev_run (my_loop, 0);
786	... jobs done or somebody called unloop. yeah!	803	... jobs done or somebody called unloop. yeah!
787		804
788	=item ev_unloop (loop, how)	805	=item ev_break (loop, how)
789		806
790	Can be used to make a call to C<ev_loop> return early (but only after it	807	Can be used to make a call to C<ev_run> return early (but only after it
791	has processed all outstanding events). The C<how> argument must be either	808	has processed all outstanding events). The C<how> argument must be either
792	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	809	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
793	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	810	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
794		811
795	This "unloop state" will be cleared when entering C<ev_loop> again.	812	This "unloop state" will be cleared when entering C<ev_run> again.
796		813
797	It is safe to call C<ev_unloop> from outside any C<ev_loop> calls.	814	It is safe to call C<ev_break> from outside any C<ev_run> calls. ##TODO##
798		815
799	=item ev_ref (loop)	816	=item ev_ref (loop)
800		817
801	=item ev_unref (loop)	818	=item ev_unref (loop)
802		819
803	Ref/unref can be used to add or remove a reference count on the event	820	Ref/unref can be used to add or remove a reference count on the event
804	loop: Every watcher keeps one reference, and as long as the reference	821	loop: Every watcher keeps one reference, and as long as the reference
805	count is nonzero, C<ev_loop> will not return on its own.	822	count is nonzero, C<ev_run> will not return on its own.
806		823
807	This is useful when you have a watcher that you never intend to	824	This is useful when you have a watcher that you never intend to
808	unregister, but that nevertheless should not keep C<ev_loop> from	825	unregister, but that nevertheless should not keep C<ev_run> from
809	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>	826	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
810	before stopping it.	827	before stopping it.
811		828
812	As an example, libev itself uses this for its internal signal pipe: It	829	As an example, libev itself uses this for its internal signal pipe: It
813	is not visible to the libev user and should not keep C<ev_loop> from	830	is not visible to the libev user and should not keep C<ev_run> from
814	exiting if no event watchers registered by it are active. It is also an	831	exiting if no event watchers registered by it are active. It is also an
815	excellent way to do this for generic recurring timers or from within	832	excellent way to do this for generic recurring timers or from within
816	third-party libraries. Just remember to I<unref after start> and I<ref	833	third-party libraries. Just remember to I<unref after start> and I<ref
817	before stop> (but only if the watcher wasn't active before, or was active	834	before stop> (but only if the watcher wasn't active before, or was active
818	before, respectively. Note also that libev might stop watchers itself	835	before, respectively. Note also that libev might stop watchers itself
819	(e.g. non-repeating timers) in which case you have to C<ev_ref>	836	(e.g. non-repeating timers) in which case you have to C<ev_ref>
820	in the callback).	837	in the callback).
821		838
822	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	839	Example: Create a signal watcher, but keep it from keeping C<ev_run>
823	running when nothing else is active.	840	running when nothing else is active.
824		841
825	ev_signal exitsig;	842	ev_signal exitsig;
826	ev_signal_init (&exitsig, sig_cb, SIGINT);	843	ev_signal_init (&exitsig, sig_cb, SIGINT);
827	ev_signal_start (loop, &exitsig);	844	ev_signal_start (loop, &exitsig);
…		…
890	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);	907	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
891		908
892	=item ev_invoke_pending (loop)	909	=item ev_invoke_pending (loop)
893		910
894	This call will simply invoke all pending watchers while resetting their	911	This call will simply invoke all pending watchers while resetting their
895	pending state. Normally, C<ev_loop> does this automatically when required,	912	pending state. Normally, C<ev_run> does this automatically when required,
896	but when overriding the invoke callback this call comes handy.	913	but when overriding the invoke callback this call comes handy.
897		914
898	=item int ev_pending_count (loop)	915	=item int ev_pending_count (loop)
899		916
900	Returns the number of pending watchers - zero indicates that no watchers	917	Returns the number of pending watchers - zero indicates that no watchers
901	are pending.	918	are pending.
902		919
903	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))	920	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
904		921
905	This overrides the invoke pending functionality of the loop: Instead of	922	This overrides the invoke pending functionality of the loop: Instead of
906	invoking all pending watchers when there are any, C<ev_loop> will call	923	invoking all pending watchers when there are any, C<ev_run> will call
907	this callback instead. This is useful, for example, when you want to	924	this callback instead. This is useful, for example, when you want to
908	invoke the actual watchers inside another context (another thread etc.).	925	invoke the actual watchers inside another context (another thread etc.).
909		926
910	If you want to reset the callback, use C<ev_invoke_pending> as new	927	If you want to reset the callback, use C<ev_invoke_pending> as new
911	callback.	928	callback.
…		…
914		931
915	Sometimes you want to share the same loop between multiple threads. This	932	Sometimes you want to share the same loop between multiple threads. This
916	can be done relatively simply by putting mutex_lock/unlock calls around	933	can be done relatively simply by putting mutex_lock/unlock calls around
917	each call to a libev function.	934	each call to a libev function.
918		935
919	However, C<ev_loop> can run an indefinite time, so it is not feasible to	936	However, C<ev_run> can run an indefinite time, so it is not feasible
920	wait for it to return. One way around this is to wake up the loop via	937	to wait for it to return. One way around this is to wake up the event
921	C<ev_unloop> and C<av_async_send>, another way is to set these I<release>	938	loop via C<ev_break> and C<av_async_send>, another way is to set these
922	and I<acquire> callbacks on the loop.	939	I<release> and I<acquire> callbacks on the loop.
923		940
924	When set, then C<release> will be called just before the thread is	941	When set, then C<release> will be called just before the thread is
925	suspended waiting for new events, and C<acquire> is called just	942	suspended waiting for new events, and C<acquire> is called just
926	afterwards.	943	afterwards.
927		944
…		…
930		947
931	While event loop modifications are allowed between invocations of	948	While event loop modifications are allowed between invocations of
932	C<release> and C<acquire> (that's their only purpose after all), no	949	C<release> and C<acquire> (that's their only purpose after all), no
933	modifications done will affect the event loop, i.e. adding watchers will	950	modifications done will affect the event loop, i.e. adding watchers will
934	have no effect on the set of file descriptors being watched, or the time	951	have no effect on the set of file descriptors being watched, or the time
935	waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it	952	waited. Use an C<ev_async> watcher to wake up C<ev_run> when you want it
936	to take note of any changes you made.	953	to take note of any changes you made.
937		954
938	In theory, threads executing C<ev_loop> will be async-cancel safe between	955	In theory, threads executing C<ev_run> will be async-cancel safe between
939	invocations of C<release> and C<acquire>.	956	invocations of C<release> and C<acquire>.
940		957
941	See also the locking example in the C<THREADS> section later in this	958	See also the locking example in the C<THREADS> section later in this
942	document.	959	document.
943		960
…		…
952	These two functions can be used to associate arbitrary data with a loop,	969	These two functions can be used to associate arbitrary data with a loop,
953	and are intended solely for the C<invoke_pending_cb>, C<release> and	970	and are intended solely for the C<invoke_pending_cb>, C<release> and
954	C<acquire> callbacks described above, but of course can be (ab-)used for	971	C<acquire> callbacks described above, but of course can be (ab-)used for
955	any other purpose as well.	972	any other purpose as well.
956		973
957	=item ev_loop_verify (loop)	974	=item ev_verify (loop)
958		975
959	This function only does something when C<EV_VERIFY> support has been	976	This function only does something when C<EV_VERIFY> support has been
960	compiled in, which is the default for non-minimal builds. It tries to go	977	compiled in, which is the default for non-minimal builds. It tries to go
961	through all internal structures and checks them for validity. If anything	978	through all internal structures and checks them for validity. If anything
962	is found to be inconsistent, it will print an error message to standard	979	is found to be inconsistent, it will print an error message to standard
…		…
980	become readable, you would create an C<ev_io> watcher for that:	997	become readable, you would create an C<ev_io> watcher for that:
981		998
982	static void my_cb (struct ev_loop loop, ev_io w, int revents)	999	static void my_cb (struct ev_loop loop, ev_io w, int revents)
983	{	1000	{
984	ev_io_stop (w);	1001	ev_io_stop (w);
985	ev_unloop (loop, EVUNLOOP_ALL);	1002	ev_break (loop, EVBREAK_ALL);
986	}	1003	}
987		1004
988	struct ev_loop *loop = ev_default_loop (0);	1005	struct ev_loop *loop = ev_default_loop (0);
989		1006
990	ev_io stdin_watcher;	1007	ev_io stdin_watcher;
991		1008
992	ev_init (&stdin_watcher, my_cb);	1009	ev_init (&stdin_watcher, my_cb);
993	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1010	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
994	ev_io_start (loop, &stdin_watcher);	1011	ev_io_start (loop, &stdin_watcher);
995		1012
996	ev_loop (loop, 0);	1013	ev_run (loop, 0);
997		1014
998	As you can see, you are responsible for allocating the memory for your	1015	As you can see, you are responsible for allocating the memory for your
999	watcher structures (and it is I<usually> a bad idea to do this on the	1016	watcher structures (and it is I<usually> a bad idea to do this on the
1000	stack).	1017	stack).
1001		1018
…		…
1065		1082
1066	=item C<EV_PREPARE>	1083	=item C<EV_PREPARE>
1067		1084
1068	=item C<EV_CHECK>	1085	=item C<EV_CHECK>
1069		1086
1070	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts	1087	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts
1071	to gather new events, and all C<ev_check> watchers are invoked just after	1088	to gather new events, and all C<ev_check> watchers are invoked just after
1072	C<ev_loop> has gathered them, but before it invokes any callbacks for any	1089	C<ev_run> has gathered them, but before it invokes any callbacks for any
1073	received events. Callbacks of both watcher types can start and stop as	1090	received events. Callbacks of both watcher types can start and stop as
1074	many watchers as they want, and all of them will be taken into account	1091	many watchers as they want, and all of them will be taken into account
1075	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	1092	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
1076	C<ev_loop> from blocking).	1093	C<ev_run> from blocking).
1077		1094
1078	=item C<EV_EMBED>	1095	=item C<EV_EMBED>
1079		1096
1080	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1097	The embedded event loop specified in the C<ev_embed> watcher needs attention.
1081		1098
…		…
1622	...	1639	...
1623	struct ev_loop *loop = ev_default_init (0);	1640	struct ev_loop *loop = ev_default_init (0);
1624	ev_io stdin_readable;	1641	ev_io stdin_readable;
1625	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1642	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1626	ev_io_start (loop, &stdin_readable);	1643	ev_io_start (loop, &stdin_readable);
1627	ev_loop (loop, 0);	1644	ev_run (loop, 0);
1628		1645
1629		1646
1630	=head2 C<ev_timer> - relative and optionally repeating timeouts	1647	=head2 C<ev_timer> - relative and optionally repeating timeouts
1631		1648
1632	Timer watchers are simple relative timers that generate an event after a	1649	Timer watchers are simple relative timers that generate an event after a
…		…
1641	The callback is guaranteed to be invoked only I<after> its timeout has	1658	The callback is guaranteed to be invoked only I<after> its timeout has
1642	passed (not I<at>, so on systems with very low-resolution clocks this	1659	passed (not I<at>, so on systems with very low-resolution clocks this
1643	might introduce a small delay). If multiple timers become ready during the	1660	might introduce a small delay). If multiple timers become ready during the
1644	same loop iteration then the ones with earlier time-out values are invoked	1661	same loop iteration then the ones with earlier time-out values are invoked
1645	before ones of the same priority with later time-out values (but this is	1662	before ones of the same priority with later time-out values (but this is
1646	no longer true when a callback calls C<ev_loop> recursively).	1663	no longer true when a callback calls C<ev_run> recursively).
1647		1664
1648	=head3 Be smart about timeouts	1665	=head3 Be smart about timeouts
1649		1666
1650	Many real-world problems involve some kind of timeout, usually for error	1667	Many real-world problems involve some kind of timeout, usually for error
1651	recovery. A typical example is an HTTP request - if the other side hangs,	1668	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1822		1839
1823	=head3 The special problem of time updates	1840	=head3 The special problem of time updates
1824		1841
1825	Establishing the current time is a costly operation (it usually takes at	1842	Establishing the current time is a costly operation (it usually takes at
1826	least two system calls): EV therefore updates its idea of the current	1843	least two system calls): EV therefore updates its idea of the current
1827	time only before and after C<ev_loop> collects new events, which causes a	1844	time only before and after C<ev_run> collects new events, which causes a
1828	growing difference between C<ev_now ()> and C<ev_time ()> when handling	1845	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1829	lots of events in one iteration.	1846	lots of events in one iteration.
1830		1847
1831	The relative timeouts are calculated relative to the C<ev_now ()>	1848	The relative timeouts are calculated relative to the C<ev_now ()>
1832	time. This is usually the right thing as this timestamp refers to the time	1849	time. This is usually the right thing as this timestamp refers to the time
…		…
1949	}	1966	}
1950		1967
1951	ev_timer mytimer;	1968	ev_timer mytimer;
1952	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	1969	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1953	ev_timer_again (&mytimer); /* start timer */	1970	ev_timer_again (&mytimer); /* start timer */
1954	ev_loop (loop, 0);	1971	ev_run (loop, 0);
1955		1972
1956	// and in some piece of code that gets executed on any "activity":	1973	// and in some piece of code that gets executed on any "activity":
1957	// reset the timeout to start ticking again at 10 seconds	1974	// reset the timeout to start ticking again at 10 seconds
1958	ev_timer_again (&mytimer);	1975	ev_timer_again (&mytimer);
1959		1976
…		…
1985		2002
1986	As with timers, the callback is guaranteed to be invoked only when the	2003	As with timers, the callback is guaranteed to be invoked only when the
1987	point in time where it is supposed to trigger has passed. If multiple	2004	point in time where it is supposed to trigger has passed. If multiple
1988	timers become ready during the same loop iteration then the ones with	2005	timers become ready during the same loop iteration then the ones with
1989	earlier time-out values are invoked before ones with later time-out values	2006	earlier time-out values are invoked before ones with later time-out values
1990	(but this is no longer true when a callback calls C<ev_loop> recursively).	2007	(but this is no longer true when a callback calls C<ev_run> recursively).
1991		2008
1992	=head3 Watcher-Specific Functions and Data Members	2009	=head3 Watcher-Specific Functions and Data Members
1993		2010
1994	=over 4	2011	=over 4
1995		2012
…		…
2233	Example: Try to exit cleanly on SIGINT.	2250	Example: Try to exit cleanly on SIGINT.
2234		2251
2235	static void	2252	static void
2236	sigint_cb (struct ev_loop loop, ev_signal w, int revents)	2253	sigint_cb (struct ev_loop loop, ev_signal w, int revents)
2237	{	2254	{
2238	ev_unloop (loop, EVUNLOOP_ALL);	2255	ev_break (loop, EVBREAK_ALL);
2239	}	2256	}
2240		2257
2241	ev_signal signal_watcher;	2258	ev_signal signal_watcher;
2242	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2259	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2243	ev_signal_start (loop, &signal_watcher);	2260	ev_signal_start (loop, &signal_watcher);
…		…
2629		2646
2630	Prepare and check watchers are usually (but not always) used in pairs:	2647	Prepare and check watchers are usually (but not always) used in pairs:
2631	prepare watchers get invoked before the process blocks and check watchers	2648	prepare watchers get invoked before the process blocks and check watchers
2632	afterwards.	2649	afterwards.
2633		2650
2634	You I<must not> call C<ev_loop> or similar functions that enter	2651	You I<must not> call C<ev_run> or similar functions that enter
2635	the current event loop from either C<ev_prepare> or C<ev_check>	2652	the current event loop from either C<ev_prepare> or C<ev_check>
2636	watchers. Other loops than the current one are fine, however. The	2653	watchers. Other loops than the current one are fine, however. The
2637	rationale behind this is that you do not need to check for recursion in	2654	rationale behind this is that you do not need to check for recursion in
2638	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2655	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
2639	C<ev_check> so if you have one watcher of each kind they will always be	2656	C<ev_check> so if you have one watcher of each kind they will always be
…		…
2807		2824
2808	if (timeout >= 0)	2825	if (timeout >= 0)
2809	// create/start timer	2826	// create/start timer
2810		2827
2811	// poll	2828	// poll
2812	ev_loop (EV_A_ 0);	2829	ev_run (EV_A_ 0);
2813		2830
2814	// stop timer again	2831	// stop timer again
2815	if (timeout >= 0)	2832	if (timeout >= 0)
2816	ev_timer_stop (EV_A_ &to);	2833	ev_timer_stop (EV_A_ &to);
2817		2834
…		…
2895	if you do not want that, you need to temporarily stop the embed watcher).	2912	if you do not want that, you need to temporarily stop the embed watcher).
2896		2913
2897	=item ev_embed_sweep (loop, ev_embed *)	2914	=item ev_embed_sweep (loop, ev_embed *)
2898		2915
2899	Make a single, non-blocking sweep over the embedded loop. This works	2916	Make a single, non-blocking sweep over the embedded loop. This works
2900	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	2917	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2901	appropriate way for embedded loops.	2918	appropriate way for embedded loops.
2902		2919
2903	=item struct ev_loop *other [read-only]	2920	=item struct ev_loop *other [read-only]
2904		2921
2905	The embedded event loop.	2922	The embedded event loop.
…		…
3011	=back	3028	=back
3012		3029
3013		3030
3014	=head2 C<ev_async> - how to wake up an event loop	3031	=head2 C<ev_async> - how to wake up an event loop
3015		3032
3016	In general, you cannot use an C<ev_loop> from multiple threads or other	3033	In general, you cannot use an C<ev_run> from multiple threads or other
3017	asynchronous sources such as signal handlers (as opposed to multiple event	3034	asynchronous sources such as signal handlers (as opposed to multiple event
3018	loops - those are of course safe to use in different threads).	3035	loops - those are of course safe to use in different threads).
3019		3036
3020	Sometimes, however, you need to wake up an event loop you do not control,	3037	Sometimes, however, you need to wake up an event loop you do not control,
3021	for example because it belongs to another thread. This is what C<ev_async>	3038	for example because it belongs to another thread. This is what C<ev_async>
…		…
3389	Associates a different C<struct ev_loop> with this watcher. You can only	3406	Associates a different C<struct ev_loop> with this watcher. You can only
3390	do this when the watcher is inactive (and not pending either).	3407	do this when the watcher is inactive (and not pending either).
3391		3408
3392	=item w->set ([arguments])	3409	=item w->set ([arguments])
3393		3410
3394	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be	3411	Basically the same as C<ev_TYPE_set>, with the same arguments. Either this
3395	called at least once. Unlike the C counterpart, an active watcher gets	3412	method or a suitable start method must be called at least once. Unlike the
3396	automatically stopped and restarted when reconfiguring it with this	3413	C counterpart, an active watcher gets automatically stopped and restarted
3397	method.	3414	when reconfiguring it with this method.
3398		3415
3399	=item w->start ()	3416	=item w->start ()
3400		3417
3401	Starts the watcher. Note that there is no C<loop> argument, as the	3418	Starts the watcher. Note that there is no C<loop> argument, as the
3402	constructor already stores the event loop.	3419	constructor already stores the event loop.
3403		3420
		3421	=item w->start ([arguments])
		3422
		3423	Instead of calling C<set> and C<start> methods separately, it is often
		3424	convenient to wrap them in one call. Uses the same type of arguments as
		3425	the configure C<set> method of the watcher.
		3426
3404	=item w->stop ()	3427	=item w->stop ()
3405		3428
3406	Stops the watcher if it is active. Again, no C<loop> argument.	3429	Stops the watcher if it is active. Again, no C<loop> argument.
3407		3430
3408	=item w->again () (C<ev::timer>, C<ev::periodic> only)	3431	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
3420		3443
3421	=back	3444	=back
3422		3445
3423	=back	3446	=back
3424		3447
3425	Example: Define a class with an IO and idle watcher, start one of them in	3448	Example: Define a class with two I/O and idle watchers, start the I/O
3426	the constructor.	3449	watchers in the constructor.
3427		3450
3428	class myclass	3451	class myclass
3429	{	3452	{
3430	ev::io io ; void io_cb (ev::io &w, int revents);	3453	ev::io io ; void io_cb (ev::io &w, int revents);
		3454	ev::io2 io2 ; void io2_cb (ev::io &w, int revents);
3431	ev::idle idle; void idle_cb (ev::idle &w, int revents);	3455	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3432		3456
3433	myclass (int fd)	3457	myclass (int fd)
3434	{	3458	{
3435	io .set <myclass, &myclass::io_cb > (this);	3459	io .set <myclass, &myclass::io_cb > (this);
		3460	io2 .set <myclass, &myclass::io2_cb > (this);
3436	idle.set <myclass, &myclass::idle_cb> (this);	3461	idle.set <myclass, &myclass::idle_cb> (this);
3437		3462
3438	io.start (fd, ev::READ);	3463	io.set (fd, ev::WRITE); // configure the watcher
		3464	io.start (); // start it whenever convenient
		3465
		3466	io2.start (fd, ev::READ); // set + start in one call
3439	}	3467	}
3440	};	3468	};
3441		3469
3442		3470
3443	=head1 OTHER LANGUAGE BINDINGS	3471	=head1 OTHER LANGUAGE BINDINGS
…		…
3517	loop argument"). The C<EV_A> form is used when this is the sole argument,	3545	loop argument"). The C<EV_A> form is used when this is the sole argument,
3518	C<EV_A_> is used when other arguments are following. Example:	3546	C<EV_A_> is used when other arguments are following. Example:
3519		3547
3520	ev_unref (EV_A);	3548	ev_unref (EV_A);
3521	ev_timer_add (EV_A_ watcher);	3549	ev_timer_add (EV_A_ watcher);
3522	ev_loop (EV_A_ 0);	3550	ev_run (EV_A_ 0);
3523		3551
3524	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	3552	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
3525	which is often provided by the following macro.	3553	which is often provided by the following macro.
3526		3554
3527	=item C<EV_P>, C<EV_P_>	3555	=item C<EV_P>, C<EV_P_>
…		…
3567	}	3595	}
3568		3596
3569	ev_check check;	3597	ev_check check;
3570	ev_check_init (&check, check_cb);	3598	ev_check_init (&check, check_cb);
3571	ev_check_start (EV_DEFAULT_ &check);	3599	ev_check_start (EV_DEFAULT_ &check);
3572	ev_loop (EV_DEFAULT_ 0);	3600	ev_run (EV_DEFAULT_ 0);
3573		3601
3574	=head1 EMBEDDING	3602	=head1 EMBEDDING
3575		3603
3576	Libev can (and often is) directly embedded into host	3604	Libev can (and often is) directly embedded into host
3577	applications. Examples of applications that embed it include the Deliantra	3605	applications. Examples of applications that embed it include the Deliantra
…		…
3668	to a compiled library. All other symbols change the ABI, which means all	3696	to a compiled library. All other symbols change the ABI, which means all
3669	users of libev and the libev code itself must be compiled with compatible	3697	users of libev and the libev code itself must be compiled with compatible
3670	settings.	3698	settings.
3671		3699
3672	=over 4	3700	=over 4
		3701
		3702	=item EV_COMPAT3 (h)
		3703
		3704	Backwards compatibility is a major concern for libev. This is why this
		3705	release of libev comes with wrappers for the functions and symbols that
		3706	have been renamed between libev version 3 and 4.
		3707
		3708	You can disable these wrappers (to test compatibility with future
		3709	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		3710	sources. This has the additional advantage that you can drop the C<struct>
		3711	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		3712	typedef in that case.
		3713
		3714	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		3715	and in some even more future version the compatibility code will be
		3716	removed completely.
3673		3717
3674	=item EV_STANDALONE (h)	3718	=item EV_STANDALONE (h)
3675		3719
3676	Must always be C<1> if you do not use autoconf configuration, which	3720	Must always be C<1> if you do not use autoconf configuration, which
3677	keeps libev from including F<config.h>, and it also defines dummy	3721	keeps libev from including F<config.h>, and it also defines dummy
…		…
4027	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it	4071	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4028	will be C<0>.	4072	will be C<0>.
4029		4073
4030	=item EV_VERIFY	4074	=item EV_VERIFY
4031		4075
4032	Controls how much internal verification (see C<ev_loop_verify ()>) will	4076	Controls how much internal verification (see C<ev_verify ()>) will
4033	be done: If set to C<0>, no internal verification code will be compiled	4077	be done: If set to C<0>, no internal verification code will be compiled
4034	in. If set to C<1>, then verification code will be compiled in, but not	4078	in. If set to C<1>, then verification code will be compiled in, but not
4035	called. If set to C<2>, then the internal verification code will be	4079	called. If set to C<2>, then the internal verification code will be
4036	called once per loop, which can slow down libev. If set to C<3>, then the	4080	called once per loop, which can slow down libev. If set to C<3>, then the
4037	verification code will be called very frequently, which will slow down	4081	verification code will be called very frequently, which will slow down
…		…
4252	userdata *u = ev_userdata (EV_A);	4296	userdata *u = ev_userdata (EV_A);
4253	pthread_mutex_lock (&u->lock);	4297	pthread_mutex_lock (&u->lock);
4254	}	4298	}
4255		4299
4256	The event loop thread first acquires the mutex, and then jumps straight	4300	The event loop thread first acquires the mutex, and then jumps straight
4257	into C<ev_loop>:	4301	into C<ev_run>:
4258		4302
4259	void *	4303	void *
4260	l_run (void *thr_arg)	4304	l_run (void *thr_arg)
4261	{	4305	{
4262	struct ev_loop loop = (struct ev_loop )thr_arg;	4306	struct ev_loop loop = (struct ev_loop )thr_arg;
4263		4307
4264	l_acquire (EV_A);	4308	l_acquire (EV_A);
4265	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);	4309	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4266	ev_loop (EV_A_ 0);	4310	ev_run (EV_A_ 0);
4267	l_release (EV_A);	4311	l_release (EV_A);
4268		4312
4269	return 0;	4313	return 0;
4270	}	4314	}
4271		4315
…		…
4323		4367
4324	=head3 COROUTINES	4368	=head3 COROUTINES
4325		4369
4326	Libev is very accommodating to coroutines ("cooperative threads"):	4370	Libev is very accommodating to coroutines ("cooperative threads"):
4327	libev fully supports nesting calls to its functions from different	4371	libev fully supports nesting calls to its functions from different
4328	coroutines (e.g. you can call C<ev_loop> on the same loop from two	4372	coroutines (e.g. you can call C<ev_run> on the same loop from two
4329	different coroutines, and switch freely between both coroutines running	4373	different coroutines, and switch freely between both coroutines running
4330	the loop, as long as you don't confuse yourself). The only exception is	4374	the loop, as long as you don't confuse yourself). The only exception is
4331	that you must not do this from C<ev_periodic> reschedule callbacks.	4375	that you must not do this from C<ev_periodic> reschedule callbacks.
4332		4376
4333	Care has been taken to ensure that libev does not keep local state inside	4377	Care has been taken to ensure that libev does not keep local state inside
4334	C<ev_loop>, and other calls do not usually allow for coroutine switches as	4378	C<ev_run>, and other calls do not usually allow for coroutine switches as
4335	they do not call any callbacks.	4379	they do not call any callbacks.
4336		4380
4337	=head2 COMPILER WARNINGS	4381	=head2 COMPILER WARNINGS
4338		4382
4339	Depending on your compiler and compiler settings, you might get no or a	4383	Depending on your compiler and compiler settings, you might get no or a
…		…
4624	watchers.	4668	watchers.
4625		4669
4626	=item C<double> must hold a time value in seconds with enough accuracy	4670	=item C<double> must hold a time value in seconds with enough accuracy
4627		4671
4628	The type C<double> is used to represent timestamps. It is required to	4672	The type C<double> is used to represent timestamps. It is required to
4629	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	4673	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4630	enough for at least into the year 4000. This requirement is fulfilled by	4674	good enough for at least into the year 4000 with millisecond accuracy
		4675	(the design goal for libev). This requirement is overfulfilled by
4631	implementations implementing IEEE 754, which is basically all existing	4676	implementations using IEEE 754, which is basically all existing ones. With
4632	ones. With IEEE 754 doubles, you get microsecond accuracy until at least	4677	IEEE 754 doubles, you get microsecond accuracy until at least 2200.
4633	2200.
4634		4678
4635	=back	4679	=back
4636		4680
4637	If you know of other additional requirements drop me a note.	4681	If you know of other additional requirements drop me a note.
4638		4682
…		…
4716	compatibility, so most programs should still compile. Those might be	4760	compatibility, so most programs should still compile. Those might be
4717	removed in later versions of libev, so better update early than late.	4761	removed in later versions of libev, so better update early than late.
4718		4762
4719	=over 4	4763	=over 4
4720		4764
4721	=item C<ev_loop_count> renamed to C<ev_iteration>	4765	=item function/symbol renames
4722		4766
4723	=item C<ev_loop_depth> renamed to C<ev_depth>	4767	A number of functions and symbols have been renamed:
4724		4768
4725	=item C<ev_loop_verify> renamed to C<ev_verify>	4769	ev_loop => ev_run
		4770	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		4771	EVLOOP_ONESHOT => EVRUN_ONCE
		4772
		4773	ev_unloop => ev_break
		4774	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		4775	EVUNLOOP_ONE => EVBREAK_ONE
		4776	EVUNLOOP_ALL => EVBREAK_ALL
		4777
		4778	EV_TIMEOUT => EV_TIMER
		4779
		4780	ev_loop_count => ev_iteration
		4781	ev_loop_depth => ev_depth
		4782	ev_loop_verify => ev_verify
4726		4783
4727	Most functions working on C<struct ev_loop> objects don't have an	4784	Most functions working on C<struct ev_loop> objects don't have an
4728	C<ev_loop_> prefix, so it was removed. Note that C<ev_loop_fork> is	4785	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		4786	associated constants have been renamed to not collide with the C<struct
		4787	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		4788	as all other watcher types. Note that C<ev_loop_fork> is still called
4729	still called C<ev_loop_fork> because it would otherwise clash with the	4789	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
4730	C<ev_fork> typedef.	4790	typedef.
4731		4791
4732	=item C<EV_TIMEOUT> renamed to C<EV_TIMER> in C<revents>	4792	=item C<EV_COMPAT3> backwards compatibility mechanism
4733		4793
4734	This is a simple rename - all other watcher types use their name	4794	The backward compatibility mechanism can be controlled by
4735	as revents flag, and now C<ev_timer> does, too.	4795	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
4736		4796	section.
4737	Both C<EV_TIMER> and C<EV_TIMEOUT> symbols were present in 3.x versions
4738	and continue to be present for the foreseeable future, so this is mostly a
4739	documentation change.
4740		4797
4741	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>	4798	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
4742		4799
4743	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different	4800	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
4744	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile	4801	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.305 by root, Thu Oct 14 05:07:04 2010 UTC vs. Revision 1.310 by root, Thu Oct 21 12:32:47 2010 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.305 by root, Thu Oct 14 05:07:04 2010 UTC vs.
Revision 1.310 by root, Thu Oct 21 12:32:47 2010 UTC