[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.319 by root, Fri Oct 22 10:09:12 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
…		…
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 interetsing 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
…		…
213	assert (("sorry, no epoll, no sex",	214	assert (("sorry, no epoll, no sex",
214	ev_supported_backends () & EVBACKEND_EPOLL));	215	ev_supported_backends () & EVBACKEND_EPOLL));
215		216
216	=item unsigned int ev_recommended_backends ()	217	=item unsigned int ev_recommended_backends ()
217		218
218	Return the set of all backends compiled into this binary of libev and also	219	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	220	also recommended for this platform, meaning it will work for most file
		221	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	222	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	223	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	224	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.	225	probe for if you specify no backends explicitly.
224		226
225	=item unsigned int ev_embeddable_backends ()	227	=item unsigned int ev_embeddable_backends ()
226		228
227	Returns the set of backends that are embeddable in other event loops. This	229	Returns the set of backends that are embeddable in other event loops. This
228	is the theoretical, all-platform, value. To find which backends	230	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	231	current system. To find which embeddable backends might be supported on
230	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	232	the current system, you would need to look at C<ev_embeddable_backends ()
231	recommended ones.	233	& ev_supported_backends ()>, likewise for recommended ones.
232		234
233	See the description of C<ev_embed> watchers for more info.	235	See the description of C<ev_embed> watchers for more info.
234		236
235	=item ev_set_allocator (void (cb)(void *ptr, long size)) [NOT REENTRANT]	237	=item ev_set_allocator (void (cb)(void *ptr, long size)) [NOT REENTRANT]
236		238
…		…
292		294
293	=back	295	=back
294		296
295	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	297	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
296		298
297	An event loop is described by a C<struct ev_loop *> (the C<struct>	299	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>	300	I<not> optional in this case unless libev 3 compatibility is disabled, as
299	I<function>).	301	libev 3 had an C<ev_loop> function colliding with the struct name).
300		302
301	The library knows two types of such loops, the I<default> loop, which	303	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	304	supports signals and child events, and dynamically created event loops
303	not.	305	which do not.
304		306
305	=over 4	307	=over 4
306		308
307	=item struct ev_loop *ev_default_loop (unsigned int flags)	309	=item struct ev_loop *ev_default_loop (unsigned int flags)
308		310
…		…
606	Like C<ev_default_destroy>, but destroys an event loop created by an	608	Like C<ev_default_destroy>, but destroys an event loop created by an
607	earlier call to C<ev_loop_new>.	609	earlier call to C<ev_loop_new>.
608		610
609	=item ev_default_fork ()	611	=item ev_default_fork ()
610		612
611	This function sets a flag that causes subsequent C<ev_loop> iterations	613	This function sets a flag that causes subsequent C<ev_run> iterations
612	to reinitialise the kernel state for backends that have one. Despite the	614	to 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	615	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	616	the child process (or both child and parent, but that again makes little
615	sense). You I<must> call it in the child before using any of the libev	617	sense). You I<must> call it in the child before using any of the libev
616	functions, and it will only take effect at the next C<ev_loop> iteration.	618	functions, and it will only take effect at the next C<ev_run> iteration.
617		619
618	Again, you I<have> to call it on I<any> loop that you want to re-use after	620	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	621	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	622	because some kernel interfaces cough I<kqueue> cough do funny things
621	during fork.	623	during fork.
622		624
623	On the other hand, you only need to call this function in the child	625	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	626	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	627	you just fork+exec or create a new loop in the child, you don't have to
626	it at all.	628	call it at all (in fact, C<epoll> is so badly broken that it makes a
		629	difference, but libev will usually detect this case on its own and do a
		630	costly reset of the backend).
627		631
628	The function itself is quite fast and it's usually not a problem to call	632	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	633	it just in case after a fork. To make this easy, the function will fit in
630	quite nicely into a call to C<pthread_atfork>:	634	quite nicely into a call to C<pthread_atfork>:
631		635
…		…
643	Returns true when the given loop is, in fact, the default loop, and false	647	Returns true when the given loop is, in fact, the default loop, and false
644	otherwise.	648	otherwise.
645		649
646	=item unsigned int ev_iteration (loop)	650	=item unsigned int ev_iteration (loop)
647		651
648	Returns the current iteration count for the loop, which is identical to	652	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	653	to the number of times libev did poll for new events. It starts at C<0>
650	happily wraps around with enough iterations.	654	and happily wraps around with enough iterations.
651		655
652	This value can sometimes be useful as a generation counter of sorts (it	656	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	657	"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	658	C<ev_prepare> and C<ev_check> calls - and is incremented between the
655	prepare and check phases.	659	prepare and check phases.
656		660
657	=item unsigned int ev_depth (loop)	661	=item unsigned int ev_depth (loop)
658		662
659	Returns the number of times C<ev_loop> was entered minus the number of	663	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.	664	times C<ev_run> was exited, in other words, the recursion depth.
661		665
662	Outside C<ev_loop>, this number is zero. In a callback, this number is	666	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),	667	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
664	in which case it is higher.	668	in which case it is higher.
665		669
666	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread	670	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	671	etc.), doesn't count as "exit" - consider this as a hint to avoid such
668	ungentleman behaviour unless it's really convenient.	672	ungentleman-like behaviour unless it's really convenient.
669		673
670	=item unsigned int ev_backend (loop)	674	=item unsigned int ev_backend (loop)
671		675
672	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	676	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
673	use.	677	use.
…		…
682		686
683	=item ev_now_update (loop)	687	=item ev_now_update (loop)
684		688
685	Establishes the current time by querying the kernel, updating the time	689	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	690	returned by C<ev_now ()> in the progress. This is a costly operation and
687	is usually done automatically within C<ev_loop ()>.	691	is usually done automatically within C<ev_run ()>.
688		692
689	This function is rarely useful, but when some event callback runs for a	693	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	694	very long time without entering the event loop, updating libev's idea of
691	the current time is a good idea.	695	the current time is a good idea.
692		696
…		…
694		698
695	=item ev_suspend (loop)	699	=item ev_suspend (loop)
696		700
697	=item ev_resume (loop)	701	=item ev_resume (loop)
698		702
699	These two functions suspend and resume a loop, for use when the loop is	703	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.	704	loop is not used for a while and timeouts should not be processed.
701		705
702	A typical use case would be an interactive program such as a game: When	706	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	707	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	708	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>	709	the program was suspended. This can be achieved by calling C<ev_suspend>
…		…
716	without a previous call to C<ev_suspend>.	720	without a previous call to C<ev_suspend>.
717		721
718	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the	722	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
719	event loop time (see C<ev_now_update>).	723	event loop time (see C<ev_now_update>).
720		724
721	=item ev_loop (loop, int flags)	725	=item ev_run (loop, int flags)
722		726
723	Finally, this is it, the event handler. This function usually is called	727	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	728	after you have initialised all your watchers and you want to start
725	handling events.	729	handling events. It will ask the operating system for any new events, call
		730	the watcher callbacks, an then repeat the whole process indefinitely: This
		731	is why event loops are called I<loops>.
726		732
727	If the flags argument is specified as C<0>, it will not return until	733	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.	734	until either no event watchers are active anymore or C<ev_break> was
		735	called.
729		736
730	Please note that an explicit C<ev_unloop> is usually better than	737	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	738	relying on all watchers to be stopped when deciding when a program has
732	finished (especially in interactive programs), but having a program	739	finished (especially in interactive programs), but having a program
733	that automatically loops as long as it has to and no longer by virtue	740	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	741	of relying on its watchers stopping correctly, that is truly a thing of
735	beauty.	742	beauty.
736		743
737	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	744	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	745	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	746	block your process in case there are no events and will return after one
740	the loop.	747	iteration of the loop. This is sometimes useful to poll and handle new
		748	events while doing lengthy calculations, to keep the program responsive.
741		749
742	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	750	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	751	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	752	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	753	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	754	user-registered callback will be called), and will return after one
747	iteration of the loop.	755	iteration of the loop.
748		756
749	This is useful if you are waiting for some external event in conjunction	757	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	758	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	759	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.	760	usually a better approach for this kind of thing.
753		761
754	Here are the gory details of what C<ev_loop> does:	762	Here are the gory details of what C<ev_run> does:
755		763
		764	- Increment loop depth.
		765	- Reset the ev_break status.
756	- Before the first iteration, call any pending watchers.	766	- Before the first iteration, call any pending watchers.
		767	LOOP:
757	* If EVFLAG_FORKCHECK was used, check for a fork.	768	- If EVFLAG_FORKCHECK was used, check for a fork.
758	- If a fork was detected (by any means), queue and call all fork watchers.	769	- If a fork was detected (by any means), queue and call all fork watchers.
759	- Queue and call all prepare watchers.	770	- Queue and call all prepare watchers.
		771	- If ev_break was called, goto FINISH.
760	- If we have been forked, detach and recreate the kernel state	772	- If we have been forked, detach and recreate the kernel state
761	as to not disturb the other process.	773	as to not disturb the other process.
762	- Update the kernel state with all outstanding changes.	774	- Update the kernel state with all outstanding changes.
763	- Update the "event loop time" (ev_now ()).	775	- Update the "event loop time" (ev_now ()).
764	- Calculate for how long to sleep or block, if at all	776	- Calculate for how long to sleep or block, if at all
765	(active idle watchers, EVLOOP_NONBLOCK or not having	777	(active idle watchers, EVRUN_NOWAIT or not having
766	any active watchers at all will result in not sleeping).	778	any active watchers at all will result in not sleeping).
767	- Sleep if the I/O and timer collect interval say so.	779	- Sleep if the I/O and timer collect interval say so.
		780	- Increment loop iteration counter.
768	- Block the process, waiting for any events.	781	- Block the process, waiting for any events.
769	- Queue all outstanding I/O (fd) events.	782	- Queue all outstanding I/O (fd) events.
770	- Update the "event loop time" (ev_now ()), and do time jump adjustments.	783	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
771	- Queue all expired timers.	784	- Queue all expired timers.
772	- Queue all expired periodics.	785	- Queue all expired periodics.
773	- Unless any events are pending now, queue all idle watchers.	786	- Queue all idle watchers with priority higher than that of pending events.
774	- Queue all check watchers.	787	- Queue all check watchers.
775	- Call all queued watchers in reverse order (i.e. check watchers first).	788	- 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	789	Signals and child watchers are implemented as I/O watchers, and will
777	be handled here by queueing them when their watcher gets executed.	790	be handled here by queueing them when their watcher gets executed.
778	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	791	- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
779	were used, or there are no active watchers, return, otherwise	792	were used, or there are no active watchers, goto FINISH, otherwise
780	continue with step *.	793	continue with step LOOP.
		794	FINISH:
		795	- Reset the ev_break status iff it was EVBREAK_ONE.
		796	- Decrement the loop depth.
		797	- Return.
781		798
782	Example: Queue some jobs and then loop until no events are outstanding	799	Example: Queue some jobs and then loop until no events are outstanding
783	anymore.	800	anymore.
784		801
785	... queue jobs here, make sure they register event watchers as long	802	... 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..)	803	... as they still have work to do (even an idle watcher will do..)
787	ev_loop (my_loop, 0);	804	ev_run (my_loop, 0);
788	... jobs done or somebody called unloop. yeah!	805	... jobs done or somebody called unloop. yeah!
789		806
790	=item ev_unloop (loop, how)	807	=item ev_break (loop, how)
791		808
792	Can be used to make a call to C<ev_loop> return early (but only after it	809	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	810	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	811	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.	812	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
796		813
797	This "unloop state" will be cleared when entering C<ev_loop> again.	814	This "unloop state" will be cleared when entering C<ev_run> again.
798		815
799	It is safe to call C<ev_unloop> from outside any C<ev_loop> calls.	816	It is safe to call C<ev_break> from outside any C<ev_run> calls. ##TODO##
800		817
801	=item ev_ref (loop)	818	=item ev_ref (loop)
802		819
803	=item ev_unref (loop)	820	=item ev_unref (loop)
804		821
805	Ref/unref can be used to add or remove a reference count on the event	822	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	823	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.	824	count is nonzero, C<ev_run> will not return on its own.
808		825
809	This is useful when you have a watcher that you never intend to	826	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	827	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>	828	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
812	before stopping it.	829	before stopping it.
813		830
814	As an example, libev itself uses this for its internal signal pipe: It	831	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	832	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	833	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	834	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	835	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	836	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	837	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>	838	(e.g. non-repeating timers) in which case you have to C<ev_ref>
822	in the callback).	839	in the callback).
823		840
824	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	841	Example: Create a signal watcher, but keep it from keeping C<ev_run>
825	running when nothing else is active.	842	running when nothing else is active.
826		843
827	ev_signal exitsig;	844	ev_signal exitsig;
828	ev_signal_init (&exitsig, sig_cb, SIGINT);	845	ev_signal_init (&exitsig, sig_cb, SIGINT);
829	ev_signal_start (loop, &exitsig);	846	ev_signal_start (loop, &exitsig);
…		…
892	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);	909	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
893		910
894	=item ev_invoke_pending (loop)	911	=item ev_invoke_pending (loop)
895		912
896	This call will simply invoke all pending watchers while resetting their	913	This call will simply invoke all pending watchers while resetting their
897	pending state. Normally, C<ev_loop> does this automatically when required,	914	pending state. Normally, C<ev_run> does this automatically when required,
898	but when overriding the invoke callback this call comes handy.	915	but when overriding the invoke callback this call comes handy. This
		916	function can be invoked from a watcher - this can be useful for example
		917	when you want to do some lengthy calculation and want to pass further
		918	event handling to another thread (you still have to make sure only one
		919	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
899		920
900	=item int ev_pending_count (loop)	921	=item int ev_pending_count (loop)
901		922
902	Returns the number of pending watchers - zero indicates that no watchers	923	Returns the number of pending watchers - zero indicates that no watchers
903	are pending.	924	are pending.
904		925
905	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))	926	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
906		927
907	This overrides the invoke pending functionality of the loop: Instead of	928	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	929	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	930	this callback instead. This is useful, for example, when you want to
910	invoke the actual watchers inside another context (another thread etc.).	931	invoke the actual watchers inside another context (another thread etc.).
911		932
912	If you want to reset the callback, use C<ev_invoke_pending> as new	933	If you want to reset the callback, use C<ev_invoke_pending> as new
913	callback.	934	callback.
…		…
916		937
917	Sometimes you want to share the same loop between multiple threads. This	938	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	939	can be done relatively simply by putting mutex_lock/unlock calls around
919	each call to a libev function.	940	each call to a libev function.
920		941
921	However, C<ev_loop> can run an indefinite time, so it is not feasible to	942	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	943	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>	944	loop via C<ev_break> and C<av_async_send>, another way is to set these
924	and I<acquire> callbacks on the loop.	945	I<release> and I<acquire> callbacks on the loop.
925		946
926	When set, then C<release> will be called just before the thread is	947	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	948	suspended waiting for new events, and C<acquire> is called just
928	afterwards.	949	afterwards.
929		950
…		…
932		953
933	While event loop modifications are allowed between invocations of	954	While event loop modifications are allowed between invocations of
934	C<release> and C<acquire> (that's their only purpose after all), no	955	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	956	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	957	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	958	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.	959	to take note of any changes you made.
939		960
940	In theory, threads executing C<ev_loop> will be async-cancel safe between	961	In theory, threads executing C<ev_run> will be async-cancel safe between
941	invocations of C<release> and C<acquire>.	962	invocations of C<release> and C<acquire>.
942		963
943	See also the locking example in the C<THREADS> section later in this	964	See also the locking example in the C<THREADS> section later in this
944	document.	965	document.
945		966
…		…
954	These two functions can be used to associate arbitrary data with a loop,	975	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	976	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	977	C<acquire> callbacks described above, but of course can be (ab-)used for
957	any other purpose as well.	978	any other purpose as well.
958		979
959	=item ev_loop_verify (loop)	980	=item ev_verify (loop)
960		981
961	This function only does something when C<EV_VERIFY> support has been	982	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	983	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	984	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	985	is found to be inconsistent, it will print an error message to standard
…		…
975		996
976	In the following description, uppercase C<TYPE> in names stands for the	997	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	998	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.	999	watchers and C<ev_io_start> for I/O watchers.
979		1000
980	A watcher is a structure that you create and register to record your	1001	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	1002	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:	1003	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1004	for that:
983		1005
984	static void my_cb (struct ev_loop loop, ev_io w, int revents)	1006	static void my_cb (struct ev_loop loop, ev_io w, int revents)
985	{	1007	{
986	ev_io_stop (w);	1008	ev_io_stop (w);
987	ev_unloop (loop, EVUNLOOP_ALL);	1009	ev_break (loop, EVBREAK_ALL);
988	}	1010	}
989		1011
990	struct ev_loop *loop = ev_default_loop (0);	1012	struct ev_loop *loop = ev_default_loop (0);
991		1013
992	ev_io stdin_watcher;	1014	ev_io stdin_watcher;
993		1015
994	ev_init (&stdin_watcher, my_cb);	1016	ev_init (&stdin_watcher, my_cb);
995	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1017	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
996	ev_io_start (loop, &stdin_watcher);	1018	ev_io_start (loop, &stdin_watcher);
997		1019
998	ev_loop (loop, 0);	1020	ev_run (loop, 0);
999		1021
1000	As you can see, you are responsible for allocating the memory for your	1022	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	1023	watcher structures (and it is I<usually> a bad idea to do this on the
1002	stack).	1024	stack).
1003		1025
1004	Each watcher has an associated watcher structure (called C<struct ev_TYPE>	1026	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).	1027	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
1006		1028
1007	Each watcher structure must be initialised by a call to C<ev_init	1029	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	1030	*, 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	1031	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	1032	time the event loop detects that the file descriptor given is readable
1011	is readable and/or writable).	1033	and/or writable).
1012		1034
1013	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>	1035	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	1036	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<<	1037	is also a macro to combine initialisation and setting in one call: C<<
1016	ev_TYPE_init (watcher *, callback, ...) >>.	1038	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
1067		1089
1068	=item C<EV_PREPARE>	1090	=item C<EV_PREPARE>
1069		1091
1070	=item C<EV_CHECK>	1092	=item C<EV_CHECK>
1071		1093
1072	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts	1094	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	1095	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	1096	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	1097	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	1098	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	1099	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
1078	C<ev_loop> from blocking).	1100	C<ev_run> from blocking).
1079		1101
1080	=item C<EV_EMBED>	1102	=item C<EV_EMBED>
1081		1103
1082	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1104	The embedded event loop specified in the C<ev_embed> watcher needs attention.
1083		1105
…		…
1111	example it might indicate that a fd is readable or writable, and if your	1133	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	1134	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	1135	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	1136	programs, though, as the fd could already be closed and reused for another
1115	thing, so beware.	1137	thing, so beware.
		1138
		1139	=back
		1140
		1141	=head2 WATCHER STATES
		1142
		1143	There are various watcher states mentioned throughout this manual -
		1144	active, pending and so on. In this section these states and the rules to
		1145	transition between them will be described in more detail - and while these
		1146	rules might look complicated, they usually do "the right thing".
		1147
		1148	=over 4
		1149
		1150	=item initialiased
		1151
		1152	Before a watcher can be registered with the event looop it has to be
		1153	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1154	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
		1155
		1156	In this state it is simply some block of memory that is suitable for use
		1157	in an event loop. It can be moved around, freed, reused etc. at will.
		1158
		1159	=item started/running/active
		1160
		1161	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
		1162	property of the event loop, and is actively waiting for events. While in
		1163	this state it cannot be accessed (except in a few documented ways), moved,
		1164	freed or anything else - the only legal thing is to keep a pointer to it,
		1165	and call libev functions on it that are documented to work on active watchers.
		1166
		1167	=item pending
		1168
		1169	If a watcher is active and libev determines that an event it is interested
		1170	in has occurred (such as a timer expiring), it will become pending. It will
		1171	stay in this pending state until either it is stopped or its callback is
		1172	about to be invoked, so it is not normally pending inside the watcher
		1173	callback.
		1174
		1175	The watcher might or might not be active while it is pending (for example,
		1176	an expired non-repeating timer can be pending but no longer active). If it
		1177	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1178	but it is still property of the event loop at this time, so cannot be
		1179	moved, freed or reused. And if it is active the rules described in the
		1180	previous item still apply.
		1181
		1182	It is also possible to feed an event on a watcher that is not active (e.g.
		1183	via C<ev_feed_event>), in which case it becomes pending without being
		1184	active.
		1185
		1186	=item stopped
		1187
		1188	A watcher can be stopped implicitly by libev (in which case it might still
		1189	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
		1190	latter will clear any pending state the watcher might be in, regardless
		1191	of whether it was active or not, so stopping a watcher explicitly before
		1192	freeing it is often a good idea.
		1193
		1194	While stopped (and not pending) the watcher is essentially in the
		1195	initialised state, that is it can be reused, moved, modified in any way
		1196	you wish.
1116		1197
1117	=back	1198	=back
1118		1199
1119	=head2 GENERIC WATCHER FUNCTIONS	1200	=head2 GENERIC WATCHER FUNCTIONS
1120		1201
…		…
1624	...	1705	...
1625	struct ev_loop *loop = ev_default_init (0);	1706	struct ev_loop *loop = ev_default_init (0);
1626	ev_io stdin_readable;	1707	ev_io stdin_readable;
1627	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1708	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1628	ev_io_start (loop, &stdin_readable);	1709	ev_io_start (loop, &stdin_readable);
1629	ev_loop (loop, 0);	1710	ev_run (loop, 0);
1630		1711
1631		1712
1632	=head2 C<ev_timer> - relative and optionally repeating timeouts	1713	=head2 C<ev_timer> - relative and optionally repeating timeouts
1633		1714
1634	Timer watchers are simple relative timers that generate an event after a	1715	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	1724	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	1725	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	1726	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	1727	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	1728	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).	1729	no longer true when a callback calls C<ev_run> recursively).
1649		1730
1650	=head3 Be smart about timeouts	1731	=head3 Be smart about timeouts
1651		1732
1652	Many real-world problems involve some kind of timeout, usually for error	1733	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,	1734	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1824		1905
1825	=head3 The special problem of time updates	1906	=head3 The special problem of time updates
1826		1907
1827	Establishing the current time is a costly operation (it usually takes at	1908	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	1909	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	1910	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	1911	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1831	lots of events in one iteration.	1912	lots of events in one iteration.
1832		1913
1833	The relative timeouts are calculated relative to the C<ev_now ()>	1914	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	1915	time. This is usually the right thing as this timestamp refers to the time
…		…
1951	}	2032	}
1952		2033
1953	ev_timer mytimer;	2034	ev_timer mytimer;
1954	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	2035	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1955	ev_timer_again (&mytimer); /* start timer */	2036	ev_timer_again (&mytimer); /* start timer */
1956	ev_loop (loop, 0);	2037	ev_run (loop, 0);
1957		2038
1958	// and in some piece of code that gets executed on any "activity":	2039	// and in some piece of code that gets executed on any "activity":
1959	// reset the timeout to start ticking again at 10 seconds	2040	// reset the timeout to start ticking again at 10 seconds
1960	ev_timer_again (&mytimer);	2041	ev_timer_again (&mytimer);
1961		2042
…		…
1987		2068
1988	As with timers, the callback is guaranteed to be invoked only when the	2069	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	2070	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	2071	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	2072	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).	2073	(but this is no longer true when a callback calls C<ev_run> recursively).
1993		2074
1994	=head3 Watcher-Specific Functions and Data Members	2075	=head3 Watcher-Specific Functions and Data Members
1995		2076
1996	=over 4	2077	=over 4
1997		2078
…		…
2235	Example: Try to exit cleanly on SIGINT.	2316	Example: Try to exit cleanly on SIGINT.
2236		2317
2237	static void	2318	static void
2238	sigint_cb (struct ev_loop loop, ev_signal w, int revents)	2319	sigint_cb (struct ev_loop loop, ev_signal w, int revents)
2239	{	2320	{
2240	ev_unloop (loop, EVUNLOOP_ALL);	2321	ev_break (loop, EVBREAK_ALL);
2241	}	2322	}
2242		2323
2243	ev_signal signal_watcher;	2324	ev_signal signal_watcher;
2244	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2325	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2245	ev_signal_start (loop, &signal_watcher);	2326	ev_signal_start (loop, &signal_watcher);
…		…
2631		2712
2632	Prepare and check watchers are usually (but not always) used in pairs:	2713	Prepare and check watchers are usually (but not always) used in pairs:
2633	prepare watchers get invoked before the process blocks and check watchers	2714	prepare watchers get invoked before the process blocks and check watchers
2634	afterwards.	2715	afterwards.
2635		2716
2636	You I<must not> call C<ev_loop> or similar functions that enter	2717	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>	2718	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	2719	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	2720	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,	2721	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	2722	C<ev_check> so if you have one watcher of each kind they will always be
…		…
2809		2890
2810	if (timeout >= 0)	2891	if (timeout >= 0)
2811	// create/start timer	2892	// create/start timer
2812		2893
2813	// poll	2894	// poll
2814	ev_loop (EV_A_ 0);	2895	ev_run (EV_A_ 0);
2815		2896
2816	// stop timer again	2897	// stop timer again
2817	if (timeout >= 0)	2898	if (timeout >= 0)
2818	ev_timer_stop (EV_A_ &to);	2899	ev_timer_stop (EV_A_ &to);
2819		2900
…		…
2897	if you do not want that, you need to temporarily stop the embed watcher).	2978	if you do not want that, you need to temporarily stop the embed watcher).
2898		2979
2899	=item ev_embed_sweep (loop, ev_embed *)	2980	=item ev_embed_sweep (loop, ev_embed *)
2900		2981
2901	Make a single, non-blocking sweep over the embedded loop. This works	2982	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	2983	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2903	appropriate way for embedded loops.	2984	appropriate way for embedded loops.
2904		2985
2905	=item struct ev_loop *other [read-only]	2986	=item struct ev_loop *other [read-only]
2906		2987
2907	The embedded event loop.	2988	The embedded event loop.
…		…
3013	=back	3094	=back
3014		3095
3015		3096
3016	=head2 C<ev_async> - how to wake up an event loop	3097	=head2 C<ev_async> - how to wake up an event loop
3017		3098
3018	In general, you cannot use an C<ev_loop> from multiple threads or other	3099	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	3100	asynchronous sources such as signal handlers (as opposed to multiple event
3020	loops - those are of course safe to use in different threads).	3101	loops - those are of course safe to use in different threads).
3021		3102
3022	Sometimes, however, you need to wake up an event loop you do not control,	3103	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>	3104	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	3472	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).	3473	do this when the watcher is inactive (and not pending either).
3393		3474
3394	=item w->set ([arguments])	3475	=item w->set ([arguments])
3395		3476
3396	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be	3477	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	3478	method or a suitable start method must be called at least once. Unlike the
3398	automatically stopped and restarted when reconfiguring it with this	3479	C counterpart, an active watcher gets automatically stopped and restarted
3399	method.	3480	when reconfiguring it with this method.
3400		3481
3401	=item w->start ()	3482	=item w->start ()
3402		3483
3403	Starts the watcher. Note that there is no C<loop> argument, as the	3484	Starts the watcher. Note that there is no C<loop> argument, as the
3404	constructor already stores the event loop.	3485	constructor already stores the event loop.
3405		3486
		3487	=item w->start ([arguments])
		3488
		3489	Instead of calling C<set> and C<start> methods separately, it is often
		3490	convenient to wrap them in one call. Uses the same type of arguments as
		3491	the configure C<set> method of the watcher.
		3492
3406	=item w->stop ()	3493	=item w->stop ()
3407		3494
3408	Stops the watcher if it is active. Again, no C<loop> argument.	3495	Stops the watcher if it is active. Again, no C<loop> argument.
3409		3496
3410	=item w->again () (C<ev::timer>, C<ev::periodic> only)	3497	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
3422		3509
3423	=back	3510	=back
3424		3511
3425	=back	3512	=back
3426		3513
3427	Example: Define a class with an IO and idle watcher, start one of them in	3514	Example: Define a class with two I/O and idle watchers, start the I/O
3428	the constructor.	3515	watchers in the constructor.
3429		3516
3430	class myclass	3517	class myclass
3431	{	3518	{
3432	ev::io io ; void io_cb (ev::io &w, int revents);	3519	ev::io io ; void io_cb (ev::io &w, int revents);
		3520	ev::io2 io2 ; void io2_cb (ev::io &w, int revents);
3433	ev::idle idle; void idle_cb (ev::idle &w, int revents);	3521	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3434		3522
3435	myclass (int fd)	3523	myclass (int fd)
3436	{	3524	{
3437	io .set <myclass, &myclass::io_cb > (this);	3525	io .set <myclass, &myclass::io_cb > (this);
		3526	io2 .set <myclass, &myclass::io2_cb > (this);
3438	idle.set <myclass, &myclass::idle_cb> (this);	3527	idle.set <myclass, &myclass::idle_cb> (this);
3439		3528
3440	io.start (fd, ev::READ);	3529	io.set (fd, ev::WRITE); // configure the watcher
		3530	io.start (); // start it whenever convenient
		3531
		3532	io2.start (fd, ev::READ); // set + start in one call
3441	}	3533	}
3442	};	3534	};
3443		3535
3444		3536
3445	=head1 OTHER LANGUAGE BINDINGS	3537	=head1 OTHER LANGUAGE BINDINGS
…		…
3519	loop argument"). The C<EV_A> form is used when this is the sole argument,	3611	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:	3612	C<EV_A_> is used when other arguments are following. Example:
3521		3613
3522	ev_unref (EV_A);	3614	ev_unref (EV_A);
3523	ev_timer_add (EV_A_ watcher);	3615	ev_timer_add (EV_A_ watcher);
3524	ev_loop (EV_A_ 0);	3616	ev_run (EV_A_ 0);
3525		3617
3526	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	3618	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
3527	which is often provided by the following macro.	3619	which is often provided by the following macro.
3528		3620
3529	=item C<EV_P>, C<EV_P_>	3621	=item C<EV_P>, C<EV_P_>
…		…
3569	}	3661	}
3570		3662
3571	ev_check check;	3663	ev_check check;
3572	ev_check_init (&check, check_cb);	3664	ev_check_init (&check, check_cb);
3573	ev_check_start (EV_DEFAULT_ &check);	3665	ev_check_start (EV_DEFAULT_ &check);
3574	ev_loop (EV_DEFAULT_ 0);	3666	ev_run (EV_DEFAULT_ 0);
3575		3667
3576	=head1 EMBEDDING	3668	=head1 EMBEDDING
3577		3669
3578	Libev can (and often is) directly embedded into host	3670	Libev can (and often is) directly embedded into host
3579	applications. Examples of applications that embed it include the Deliantra	3671	applications. Examples of applications that embed it include the Deliantra
…		…
3670	to a compiled library. All other symbols change the ABI, which means all	3762	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	3763	users of libev and the libev code itself must be compiled with compatible
3672	settings.	3764	settings.
3673		3765
3674	=over 4	3766	=over 4
		3767
		3768	=item EV_COMPAT3 (h)
		3769
		3770	Backwards compatibility is a major concern for libev. This is why this
		3771	release of libev comes with wrappers for the functions and symbols that
		3772	have been renamed between libev version 3 and 4.
		3773
		3774	You can disable these wrappers (to test compatibility with future
		3775	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		3776	sources. This has the additional advantage that you can drop the C<struct>
		3777	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		3778	typedef in that case.
		3779
		3780	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		3781	and in some even more future version the compatibility code will be
		3782	removed completely.
3675		3783
3676	=item EV_STANDALONE (h)	3784	=item EV_STANDALONE (h)
3677		3785
3678	Must always be C<1> if you do not use autoconf configuration, which	3786	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	3787	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	4137	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4030	will be C<0>.	4138	will be C<0>.
4031		4139
4032	=item EV_VERIFY	4140	=item EV_VERIFY
4033		4141
4034	Controls how much internal verification (see C<ev_loop_verify ()>) will	4142	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	4143	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	4144	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	4145	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	4146	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	4147	verification code will be called very frequently, which will slow down
…		…
4254	userdata *u = ev_userdata (EV_A);	4362	userdata *u = ev_userdata (EV_A);
4255	pthread_mutex_lock (&u->lock);	4363	pthread_mutex_lock (&u->lock);
4256	}	4364	}
4257		4365
4258	The event loop thread first acquires the mutex, and then jumps straight	4366	The event loop thread first acquires the mutex, and then jumps straight
4259	into C<ev_loop>:	4367	into C<ev_run>:
4260		4368
4261	void *	4369	void *
4262	l_run (void *thr_arg)	4370	l_run (void *thr_arg)
4263	{	4371	{
4264	struct ev_loop loop = (struct ev_loop )thr_arg;	4372	struct ev_loop loop = (struct ev_loop )thr_arg;
4265		4373
4266	l_acquire (EV_A);	4374	l_acquire (EV_A);
4267	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);	4375	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4268	ev_loop (EV_A_ 0);	4376	ev_run (EV_A_ 0);
4269	l_release (EV_A);	4377	l_release (EV_A);
4270		4378
4271	return 0;	4379	return 0;
4272	}	4380	}
4273		4381
…		…
4325		4433
4326	=head3 COROUTINES	4434	=head3 COROUTINES
4327		4435
4328	Libev is very accommodating to coroutines ("cooperative threads"):	4436	Libev is very accommodating to coroutines ("cooperative threads"):
4329	libev fully supports nesting calls to its functions from different	4437	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	4438	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	4439	different coroutines, and switch freely between both coroutines running
4332	the loop, as long as you don't confuse yourself). The only exception is	4440	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.	4441	that you must not do this from C<ev_periodic> reschedule callbacks.
4334		4442
4335	Care has been taken to ensure that libev does not keep local state inside	4443	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	4444	C<ev_run>, and other calls do not usually allow for coroutine switches as
4337	they do not call any callbacks.	4445	they do not call any callbacks.
4338		4446
4339	=head2 COMPILER WARNINGS	4447	=head2 COMPILER WARNINGS
4340		4448
4341	Depending on your compiler and compiler settings, you might get no or a	4449	Depending on your compiler and compiler settings, you might get no or a
…		…
4425	=head3 C<kqueue> is buggy	4533	=head3 C<kqueue> is buggy
4426		4534
4427	The kqueue syscall is broken in all known versions - most versions support	4535	The kqueue syscall is broken in all known versions - most versions support
4428	only sockets, many support pipes.	4536	only sockets, many support pipes.
4429		4537
4430	Libev tries to work around this by not using C<kqueue> by default on	4538	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	4539	rotten platform, but of course you can still ask for it when creating a
4432	a loop.	4540	loop - embedding a socket-only kqueue loop into a select-based one is
		4541	probably going to work well.
4433		4542
4434	=head3 C<poll> is buggy	4543	=head3 C<poll> is buggy
4435		4544
4436	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>	4545	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
4437	implementation by something calling C<kqueue> internally around the 10.5.6	4546	implementation by something calling C<kqueue> internally around the 10.5.6
…		…
4456		4565
4457	=head3 C<errno> reentrancy	4566	=head3 C<errno> reentrancy
4458		4567
4459	The default compile environment on Solaris is unfortunately so	4568	The default compile environment on Solaris is unfortunately so
4460	thread-unsafe that you can't even use components/libraries compiled	4569	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,	4570	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
4462	isn't defined by default.	4571	defined by default. A valid, if stupid, implementation choice.
4463		4572
4464	If you want to use libev in threaded environments you have to make sure	4573	If you want to use libev in threaded environments you have to make sure
4465	it's compiled with C<_REENTRANT> defined.	4574	it's compiled with C<_REENTRANT> defined.
4466		4575
4467	=head3 Event port backend	4576	=head3 Event port backend
4468		4577
4469	The scalable event interface for Solaris is called "event ports". Unfortunately,	4578	The scalable event interface for Solaris is called "event
4470	this mechanism is very buggy. If you run into high CPU usage, your program	4579	ports". Unfortunately, this mechanism is very buggy in all major
		4580	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	4581	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	4582	and latest kernel patches applied. No, I don't know which ones, but there
4473	ones, but there are multiple ones.	4583	are multiple ones to apply, and afterwards, event ports actually work
		4584	great.
4474		4585
4475	If you can't get it to work, you can try running the program by setting	4586	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	4587	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
4477	C<select> backends.	4588	C<select> backends.
4478		4589
4479	=head2 AIX POLL BUG	4590	=head2 AIX POLL BUG
4480		4591
4481	AIX unfortunately has a broken C<poll.h> header. Libev works around	4592	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	4593	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	4594	compiled in), which normally isn't a big problem as C<select> works fine
4484	with large bitsets, and AIX is dead anyway.	4595	with large bitsets on AIX, and AIX is dead anyway.
4485		4596
4486	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	4597	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
4487		4598
4488	=head3 General issues	4599	=head3 General issues
4489		4600
…		…
4626	watchers.	4737	watchers.
4627		4738
4628	=item C<double> must hold a time value in seconds with enough accuracy	4739	=item C<double> must hold a time value in seconds with enough accuracy
4629		4740
4630	The type C<double> is used to represent timestamps. It is required to	4741	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	4742	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	4743	good enough for at least into the year 4000 with millisecond accuracy
		4744	(the design goal for libev). This requirement is overfulfilled by
4633	implementations implementing IEEE 754, which is basically all existing	4745	implementations using IEEE 754, which is basically all existing ones. With
4634	ones. With IEEE 754 doubles, you get microsecond accuracy until at least	4746	IEEE 754 doubles, you get microsecond accuracy until at least 2200.
4635	2200.
4636		4747
4637	=back	4748	=back
4638		4749
4639	If you know of other additional requirements drop me a note.	4750	If you know of other additional requirements drop me a note.
4640		4751
…		…
4718	compatibility, so most programs should still compile. Those might be	4829	compatibility, so most programs should still compile. Those might be
4719	removed in later versions of libev, so better update early than late.	4830	removed in later versions of libev, so better update early than late.
4720		4831
4721	=over 4	4832	=over 4
4722		4833
4723	=item C<ev_loop_count> renamed to C<ev_iteration>	4834	=item function/symbol renames
4724		4835
4725	=item C<ev_loop_depth> renamed to C<ev_depth>	4836	A number of functions and symbols have been renamed:
4726		4837
4727	=item C<ev_loop_verify> renamed to C<ev_verify>	4838	ev_loop => ev_run
		4839	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		4840	EVLOOP_ONESHOT => EVRUN_ONCE
		4841
		4842	ev_unloop => ev_break
		4843	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		4844	EVUNLOOP_ONE => EVBREAK_ONE
		4845	EVUNLOOP_ALL => EVBREAK_ALL
		4846
		4847	EV_TIMEOUT => EV_TIMER
		4848
		4849	ev_loop_count => ev_iteration
		4850	ev_loop_depth => ev_depth
		4851	ev_loop_verify => ev_verify
4728		4852
4729	Most functions working on C<struct ev_loop> objects don't have an	4853	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	4854	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		4855	associated constants have been renamed to not collide with the C<struct
		4856	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		4857	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	4858	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
4732	C<ev_fork> typedef.	4859	typedef.
4733		4860
4734	=item C<EV_TIMEOUT> renamed to C<EV_TIMER> in C<revents>	4861	=item C<EV_COMPAT3> backwards compatibility mechanism
4735		4862
4736	This is a simple rename - all other watcher types use their name	4863	The backward compatibility mechanism can be controlled by
4737	as revents flag, and now C<ev_timer> does, too.	4864	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
4738		4865	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		4866
4743	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>	4867	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
4744		4868
4745	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different	4869	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
4746	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile	4870	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
…		…
4753		4877
4754	=over 4	4878	=over 4
4755		4879
4756	=item active	4880	=item active
4757		4881
4758	A watcher is active as long as it has been started (has been attached to	4882	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).	4883	See L<WATCHER STATES> for details.
4760		4884
4761	=item application	4885	=item application
4762		4886
4763	In this document, an application is whatever is using libev.	4887	In this document, an application is whatever is using libev.
		4888
		4889	=item backend
		4890
		4891	The part of the code dealing with the operating system interfaces.
4764		4892
4765	=item callback	4893	=item callback
4766		4894
4767	The address of a function that is called when some event has been	4895	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	4896	detected. Callbacks are being passed the event loop, the watcher that
4769	received the event, and the actual event bitset.	4897	received the event, and the actual event bitset.
4770		4898
4771	=item callback invocation	4899	=item callback/watcher invocation
4772		4900
4773	The act of calling the callback associated with a watcher.	4901	The act of calling the callback associated with a watcher.
4774		4902
4775	=item event	4903	=item event
4776		4904
…		…
4795	The model used to describe how an event loop handles and processes	4923	The model used to describe how an event loop handles and processes
4796	watchers and events.	4924	watchers and events.
4797		4925
4798	=item pending	4926	=item pending
4799		4927
4800	A watcher is pending as soon as the corresponding event has been detected,	4928	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	4929	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		4930
4807	=item real time	4931	=item real time
4808		4932
4809	The physical time that is observed. It is apparently strictly monotonic :)	4933	The physical time that is observed. It is apparently strictly monotonic :)
4810		4934
…		…
4817	=item watcher	4941	=item watcher
4818		4942
4819	A data structure that describes interest in certain events. Watchers need	4943	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.	4944	to be started (attached to an event loop) before they can receive events.
4821		4945
4822	=item watcher invocation
4823
4824	The act of calling the callback associated with a watcher.
4825
4826	=back	4946	=back
4827		4947
4828	=head1 AUTHOR	4948	=head1 AUTHOR
4829		4949
4830	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	4950	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.319 by root, Fri Oct 22 10:09:12 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.319 by root, Fri Oct 22 10:09:12 2010 UTC