ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.285 by root, Tue Mar 16 00:20:17 2010 UTC vs.
Revision 1.337 by root, Sun Oct 31 20:20:20 2010 UTC

…		…
26	puts ("stdin ready");	26	puts ("stdin ready");
27	// for one-shot events, one must manually stop the watcher	27	// for one-shot events, one must manually stop the watcher
28	// with its corresponding stop function.	28	// with its corresponding stop function.
29	ev_io_stop (EV_A_ w);	29	ev_io_stop (EV_A_ w);
30		30
31	// this causes all nested ev_loop's to stop iterating	31	// this causes all nested ev_run's to stop iterating
32	ev_unloop (EV_A_ EVUNLOOP_ALL);	32	ev_break (EV_A_ EVBREAK_ALL);
33	}	33	}
34		34
35	// another callback, this time for a time-out	35	// another callback, this time for a time-out
36	static void	36	static void
37	timeout_cb (EV_P_ ev_timer *w, int revents)	37	timeout_cb (EV_P_ ev_timer *w, int revents)
38	{	38	{
39	puts ("timeout");	39	puts ("timeout");
40	// this causes the innermost ev_loop to stop iterating	40	// this causes the innermost ev_run to stop iterating
41	ev_unloop (EV_A_ EVUNLOOP_ONE);	41	ev_break (EV_A_ EVBREAK_ONE);
42	}	42	}
43		43
44	int	44	int
45	main (void)	45	main (void)
46	{	46	{
47	// use the default event loop unless you have special needs	47	// use the default event loop unless you have special needs
48	struct ev_loop *loop = ev_default_loop (0);	48	struct ev_loop *loop = EV_DEFAULT;
49		49
50	// initialise an io watcher, then start it	50	// initialise an io watcher, then start it
51	// this one will watch for stdin to become readable	51	// this one will watch for stdin to become readable
52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);	52	ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
53	ev_io_start (loop, &stdin_watcher);	53	ev_io_start (loop, &stdin_watcher);
…		…
56	// simple non-repeating 5.5 second timeout	56	// simple non-repeating 5.5 second timeout
57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);	57	ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
58	ev_timer_start (loop, &timeout_watcher);	58	ev_timer_start (loop, &timeout_watcher);
59		59
60	// now wait for events to arrive	60	// now wait for events to arrive
61	ev_loop (loop, 0);	61	ev_run (loop, 0);
62		62
63	// unloop was called, so exit	63	// unloop was called, so exit
64	return 0;	64	return 0;
65	}	65	}
66		66
…		…
75	While this document tries to be as complete as possible in documenting	75	While this document tries to be as complete as possible in documenting
76	libev, its usage and the rationale behind its design, it is not a tutorial	76	libev, its usage and the rationale behind its design, it is not a tutorial
77	on event-based programming, nor will it introduce event-based programming	77	on event-based programming, nor will it introduce event-based programming
78	with libev.	78	with libev.
79		79
80	Familarity with event based programming techniques in general is assumed	80	Familiarity with event based programming techniques in general is assumed
81	throughout this document.	81	throughout this document.
		82
		83	=head1 WHAT TO READ WHEN IN A HURRY
		84
		85	This manual tries to be very detailed, but unfortunately, this also makes
		86	it very long. If you just want to know the basics of libev, I suggest
		87	reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and
		88	look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and
		89	C<ev_timer> sections in L<WATCHER TYPES>.
82		90
83	=head1 ABOUT LIBEV	91	=head1 ABOUT LIBEV
84		92
85	Libev is an event loop: you register interest in certain events (such as a	93	Libev is an event loop: you register interest in certain events (such as a
86	file descriptor being readable or a timeout occurring), and it will manage	94	file descriptor being readable or a timeout occurring), and it will manage
…		…
124	this argument.	132	this argument.
125		133
126	=head2 TIME REPRESENTATION	134	=head2 TIME REPRESENTATION
127		135
128	Libev represents time as a single floating point number, representing	136	Libev represents time as a single floating point number, representing
129	the (fractional) number of seconds since the (POSIX) epoch (somewhere	137	the (fractional) number of seconds since the (POSIX) epoch (in practice
130	near the beginning of 1970, details are complicated, don't ask). This	138	somewhere near the beginning of 1970, details are complicated, don't
131	type is called C<ev_tstamp>, which is what you should use too. It usually	139	ask). This type is called C<ev_tstamp>, which is what you should use
132	aliases to the C<double> type in C. When you need to do any calculations	140	too. It usually aliases to the C<double> type in C. When you need to do
133	on it, you should treat it as some floating point value. Unlike the name	141	any calculations on it, you should treat it as some floating point value.
		142
134	component C<stamp> might indicate, it is also used for time differences	143	Unlike the name component C<stamp> might indicate, it is also used for
135	throughout libev.	144	time differences (e.g. delays) throughout libev.
136		145
137	=head1 ERROR HANDLING	146	=head1 ERROR HANDLING
138		147
139	Libev knows three classes of errors: operating system errors, usage errors	148	Libev knows three classes of errors: operating system errors, usage errors
140	and internal errors (bugs).	149	and internal errors (bugs).
…		…
164		173
165	=item ev_tstamp ev_time ()	174	=item ev_tstamp ev_time ()
166		175
167	Returns the current time as libev would use it. Please note that the	176	Returns the current time as libev would use it. Please note that the
168	C<ev_now> function is usually faster and also often returns the timestamp	177	C<ev_now> function is usually faster and also often returns the timestamp
169	you actually want to know.	178	you actually want to know. Also interesting is the combination of
		179	C<ev_update_now> and C<ev_now>.
170		180
171	=item ev_sleep (ev_tstamp interval)	181	=item ev_sleep (ev_tstamp interval)
172		182
173	Sleep for the given interval: The current thread will be blocked until	183	Sleep for the given interval: The current thread will be blocked until
174	either it is interrupted or the given time interval has passed. Basically	184	either it is interrupted or the given time interval has passed. Basically
…		…
191	as this indicates an incompatible change. Minor versions are usually	201	as this indicates an incompatible change. Minor versions are usually
192	compatible to older versions, so a larger minor version alone is usually	202	compatible to older versions, so a larger minor version alone is usually
193	not a problem.	203	not a problem.
194		204
195	Example: Make sure we haven't accidentally been linked against the wrong	205	Example: Make sure we haven't accidentally been linked against the wrong
196	version.	206	version (note, however, that this will not detect other ABI mismatches,
		207	such as LFS or reentrancy).
197		208
198	assert (("libev version mismatch",	209	assert (("libev version mismatch",
199	ev_version_major () == EV_VERSION_MAJOR	210	ev_version_major () == EV_VERSION_MAJOR
200	&& ev_version_minor () >= EV_VERSION_MINOR));	211	&& ev_version_minor () >= EV_VERSION_MINOR));
201		212
…		…
212	assert (("sorry, no epoll, no sex",	223	assert (("sorry, no epoll, no sex",
213	ev_supported_backends () & EVBACKEND_EPOLL));	224	ev_supported_backends () & EVBACKEND_EPOLL));
214		225
215	=item unsigned int ev_recommended_backends ()	226	=item unsigned int ev_recommended_backends ()
216		227
217	Return the set of all backends compiled into this binary of libev and also	228	Return the set of all backends compiled into this binary of libev and
218	recommended for this platform. This set is often smaller than the one	229	also recommended for this platform, meaning it will work for most file
		230	descriptor types. This set is often smaller than the one returned by
219	returned by C<ev_supported_backends>, as for example kqueue is broken on	231	C<ev_supported_backends>, as for example kqueue is broken on most BSDs
220	most BSDs and will not be auto-detected unless you explicitly request it	232	and will not be auto-detected unless you explicitly request it (assuming
221	(assuming you know what you are doing). This is the set of backends that	233	you know what you are doing). This is the set of backends that libev will
222	libev will probe for if you specify no backends explicitly.	234	probe for if you specify no backends explicitly.
223		235
224	=item unsigned int ev_embeddable_backends ()	236	=item unsigned int ev_embeddable_backends ()
225		237
226	Returns the set of backends that are embeddable in other event loops. This	238	Returns the set of backends that are embeddable in other event loops. This
227	is the theoretical, all-platform, value. To find which backends	239	value is platform-specific but can include backends not available on the
228	might be supported on the current system, you would need to look at	240	current system. To find which embeddable backends might be supported on
229	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	241	the current system, you would need to look at C<ev_embeddable_backends ()
230	recommended ones.	242	& ev_supported_backends ()>, likewise for recommended ones.
231		243
232	See the description of C<ev_embed> watchers for more info.	244	See the description of C<ev_embed> watchers for more info.
233		245
234	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]	246	=item ev_set_allocator (void *(*cb)(void *ptr, long size)) [NOT REENTRANT]
235		247
…		…
289	...	301	...
290	ev_set_syserr_cb (fatal_error);	302	ev_set_syserr_cb (fatal_error);
291		303
292	=back	304	=back
293		305
294	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	306	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
295		307
296	An event loop is described by a C<struct ev_loop *> (the C<struct>	308	An event loop is described by a C<struct ev_loop *> (the C<struct> is
297	is I<not> optional in this case, as there is also an C<ev_loop>	309	I<not> optional in this case unless libev 3 compatibility is disabled, as
298	I<function>).	310	libev 3 had an C<ev_loop> function colliding with the struct name).
299		311
300	The library knows two types of such loops, the I<default> loop, which	312	The library knows two types of such loops, the I<default> loop, which
301	supports signals and child events, and dynamically created loops which do	313	supports child process events, and dynamically created event loops which
302	not.	314	do not.
303		315
304	=over 4	316	=over 4
305		317
306	=item struct ev_loop *ev_default_loop (unsigned int flags)	318	=item struct ev_loop *ev_default_loop (unsigned int flags)
307		319
308	This will initialise the default event loop if it hasn't been initialised	320	This returns the "default" event loop object, which is what you should
309	yet and return it. If the default loop could not be initialised, returns	321	normally use when you just need "the event loop". Event loop objects and
310	false. If it already was initialised it simply returns it (and ignores the	322	the C<flags> parameter are described in more detail in the entry for
311	flags. If that is troubling you, check C<ev_backend ()> afterwards).	323	C<ev_loop_new>.
		324
		325	If the default loop is already initialised then this function simply
		326	returns it (and ignores the flags. If that is troubling you, check
		327	C<ev_backend ()> afterwards). Otherwise it will create it with the given
		328	flags, which should almost always be C<0>, unless the caller is also the
		329	one calling C<ev_run> or otherwise qualifies as "the main program".
312		330
313	If you don't know what event loop to use, use the one returned from this	331	If you don't know what event loop to use, use the one returned from this
314	function.	332	function (or via the C<EV_DEFAULT> macro).
315		333
316	Note that this function is I<not> thread-safe, so if you want to use it	334	Note that this function is I<not> thread-safe, so if you want to use it
317	from multiple threads, you have to lock (note also that this is unlikely,	335	from multiple threads, you have to employ some kind of mutex (note also
318	as loops cannot be shared easily between threads anyway).	336	that this case is unlikely, as loops cannot be shared easily between
		337	threads anyway).
319		338
320	The default loop is the only loop that can handle C<ev_signal> and	339	The default loop is the only loop that can handle C<ev_child> watchers,
321	C<ev_child> watchers, and to do this, it always registers a handler	340	and to do this, it always registers a handler for C<SIGCHLD>. If this is
322	for C<SIGCHLD>. If this is a problem for your application you can either	341	a problem for your application you can either create a dynamic loop with
323	create a dynamic loop with C<ev_loop_new> that doesn't do that, or you	342	C<ev_loop_new> which doesn't do that, or you can simply overwrite the
324	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	343	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
325	C<ev_default_init>.	344
		345	Example: This is the most typical usage.
		346
		347	if (!ev_default_loop (0))
		348	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
		349
		350	Example: Restrict libev to the select and poll backends, and do not allow
		351	environment settings to be taken into account:
		352
		353	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
		354
		355	=item struct ev_loop *ev_loop_new (unsigned int flags)
		356
		357	This will create and initialise a new event loop object. If the loop
		358	could not be initialised, returns false.
		359
		360	Note that this function I<is> thread-safe, and one common way to use
		361	libev with threads is indeed to create one loop per thread, and using the
		362	default loop in the "main" or "initial" thread.
326		363
327	The flags argument can be used to specify special behaviour or specific	364	The flags argument can be used to specify special behaviour or specific
328	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).	365	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
329		366
330	The following flags are supported:	367	The following flags are supported:
…		…
345	useful to try out specific backends to test their performance, or to work	382	useful to try out specific backends to test their performance, or to work
346	around bugs.	383	around bugs.
347		384
348	=item C<EVFLAG_FORKCHECK>	385	=item C<EVFLAG_FORKCHECK>
349		386
350	Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after	387	Instead of calling C<ev_loop_fork> manually after a fork, you can also
351	a fork, you can also make libev check for a fork in each iteration by	388	make libev check for a fork in each iteration by enabling this flag.
352	enabling this flag.
353		389
354	This works by calling C<getpid ()> on every iteration of the loop,	390	This works by calling C<getpid ()> on every iteration of the loop,
355	and thus this might slow down your event loop if you do a lot of loop	391	and thus this might slow down your event loop if you do a lot of loop
356	iterations and little real work, but is usually not noticeable (on my	392	iterations and little real work, but is usually not noticeable (on my
357	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence	393	GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
…		…
427	epoll scales either O(1) or O(active_fds).	463	epoll scales either O(1) or O(active_fds).
428		464
429	The epoll mechanism deserves honorable mention as the most misdesigned	465	The epoll mechanism deserves honorable mention as the most misdesigned
430	of the more advanced event mechanisms: mere annoyances include silently	466	of the more advanced event mechanisms: mere annoyances include silently
431	dropping file descriptors, requiring a system call per change per file	467	dropping file descriptors, requiring a system call per change per file
432	descriptor (and unnecessary guessing of parameters), problems with dup and	468	descriptor (and unnecessary guessing of parameters), problems with dup,
		469	returning before the timeout value requiring additional iterations and so
433	so on. The biggest issue is fork races, however - if a program forks then	470	on. The biggest issue is fork races, however - if a program forks then
434	I<both> parent and child process have to recreate the epoll set, which can	471	I<both> parent and child process have to recreate the epoll set, which can
435	take considerable time (one syscall per file descriptor) and is of course	472	take considerable time (one syscall per file descriptor) and is of course
436	hard to detect.	473	hard to detect.
437		474
438	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	475	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
439	of course I<doesn't>, and epoll just loves to report events for totally	476	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	477	I<different> file descriptors (even already closed ones, so one cannot
441	even remove them from the set) than registered in the set (especially	478	even remove them from the set) than registered in the set (especially
442	on SMP systems). Libev tries to counter these spurious notifications by	479	on SMP systems). Libev tries to counter these spurious notifications by
443	employing an additional generation counter and comparing that against the	480	employing an additional generation counter and comparing that against the
444	events to filter out spurious ones, recreating the set when required.	481	events to filter out spurious ones, recreating the set when required. Last
		482	not least, it also refuses to work with some file descriptors which work
		483	perfectly fine with C<select> (files, many character devices...).
445		484
446	While stopping, setting and starting an I/O watcher in the same iteration	485	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	486	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	487	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	488	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
…		…
547	If one or more of the backend flags are or'ed into the flags value,	586	If one or more of the backend flags are or'ed into the flags value,
548	then only these backends will be tried (in the reverse order as listed	587	then only these backends will be tried (in the reverse order as listed
549	here). If none are specified, all backends in C<ev_recommended_backends	588	here). If none are specified, all backends in C<ev_recommended_backends
550	()> will be tried.	589	()> will be tried.
551		590
552	Example: This is the most typical usage.
553
554	if (!ev_default_loop (0))
555	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
556
557	Example: Restrict libev to the select and poll backends, and do not allow
558	environment settings to be taken into account:
559
560	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
561
562	Example: Use whatever libev has to offer, but make sure that kqueue is
563	used if available (warning, breaks stuff, best use only with your own
564	private event loop and only if you know the OS supports your types of
565	fds):
566
567	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
568
569	=item struct ev_loop *ev_loop_new (unsigned int flags)
570
571	Similar to C<ev_default_loop>, but always creates a new event loop that is
572	always distinct from the default loop. Unlike the default loop, it cannot
573	handle signal and child watchers, and attempts to do so will be greeted by
574	undefined behaviour (or a failed assertion if assertions are enabled).
575
576	Note that this function I<is> thread-safe, and the recommended way to use
577	libev with threads is indeed to create one loop per thread, and using the
578	default loop in the "main" or "initial" thread.
579
580	Example: Try to create a event loop that uses epoll and nothing else.	591	Example: Try to create a event loop that uses epoll and nothing else.
581		592
582	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	593	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
583	if (!epoller)	594	if (!epoller)
584	fatal ("no epoll found here, maybe it hides under your chair");	595	fatal ("no epoll found here, maybe it hides under your chair");
585		596
		597	Example: Use whatever libev has to offer, but make sure that kqueue is
		598	used if available.
		599
		600	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
		601
586	=item ev_default_destroy ()	602	=item ev_loop_destroy (loop)
587		603
588	Destroys the default loop again (frees all memory and kernel state	604	Destroys an event loop object (frees all memory and kernel state
589	etc.). None of the active event watchers will be stopped in the normal	605	etc.). None of the active event watchers will be stopped in the normal
590	sense, so e.g. C<ev_is_active> might still return true. It is your	606	sense, so e.g. C<ev_is_active> might still return true. It is your
591	responsibility to either stop all watchers cleanly yourself I<before>	607	responsibility to either stop all watchers cleanly yourself I<before>
592	calling this function, or cope with the fact afterwards (which is usually	608	calling this function, or cope with the fact afterwards (which is usually
593	the easiest thing, you can just ignore the watchers and/or C<free ()> them	609	the easiest thing, you can just ignore the watchers and/or C<free ()> them
…		…
595		611
596	Note that certain global state, such as signal state (and installed signal	612	Note that certain global state, such as signal state (and installed signal
597	handlers), will not be freed by this function, and related watchers (such	613	handlers), will not be freed by this function, and related watchers (such
598	as signal and child watchers) would need to be stopped manually.	614	as signal and child watchers) would need to be stopped manually.
599		615
600	In general it is not advisable to call this function except in the	616	This function is normally used on loop objects allocated by
601	rare occasion where you really need to free e.g. the signal handling	617	C<ev_loop_new>, but it can also be used on the default loop returned by
		618	C<ev_default_loop>, in which case it is not thread-safe.
		619
		620	Note that it is not advisable to call this function on the default loop
		621	except in the rare occasion where you really need to free it's resources.
602	pipe fds. If you need dynamically allocated loops it is better to use	622	If you need dynamically allocated loops it is better to use C<ev_loop_new>
603	C<ev_loop_new> and C<ev_loop_destroy>.	623	and C<ev_loop_destroy>.
604		624
605	=item ev_loop_destroy (loop)	625	=item ev_loop_fork (loop)
606		626
607	Like C<ev_default_destroy>, but destroys an event loop created by an
608	earlier call to C<ev_loop_new>.
609
610	=item ev_default_fork ()
611
612	This function sets a flag that causes subsequent C<ev_loop> iterations	627	This function sets a flag that causes subsequent C<ev_run> iterations to
613	to reinitialise the kernel state for backends that have one. Despite the	628	reinitialise the kernel state for backends that have one. Despite the
614	name, you can call it anytime, but it makes most sense after forking, in	629	name, you can call it anytime, but it makes most sense after forking, in
615	the child process (or both child and parent, but that again makes little	630	the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the
616	sense). You I<must> call it in the child before using any of the libev	631	child before resuming or calling C<ev_run>.
617	functions, and it will only take effect at the next C<ev_loop> iteration.	632
		633	Again, you I<have> to call it on I<any> loop that you want to re-use after
		634	a fork, I<even if you do not plan to use the loop in the parent>. This is
		635	because some kernel interfaces *cough* I<kqueue> *cough* do funny things
		636	during fork.
618		637
619	On the other hand, you only need to call this function in the child	638	On the other hand, you only need to call this function in the child
620	process if and only if you want to use the event library in the child. If	639	process if and only if you want to use the event loop in the child. If
621	you just fork+exec, you don't have to call it at all.	640	you just fork+exec or create a new loop in the child, you don't have to
		641	call it at all (in fact, C<epoll> is so badly broken that it makes a
		642	difference, but libev will usually detect this case on its own and do a
		643	costly reset of the backend).
622		644
623	The function itself is quite fast and it's usually not a problem to call	645	The function itself is quite fast and it's usually not a problem to call
624	it just in case after a fork. To make this easy, the function will fit in	646	it just in case after a fork.
625	quite nicely into a call to C<pthread_atfork>:
626		647
		648	Example: Automate calling C<ev_loop_fork> on the default loop when
		649	using pthreads.
		650
		651	static void
		652	post_fork_child (void)
		653	{
		654	ev_loop_fork (EV_DEFAULT);
		655	}
		656
		657	...
627	pthread_atfork (0, 0, ev_default_fork);	658	pthread_atfork (0, 0, post_fork_child);
628
629	=item ev_loop_fork (loop)
630
631	Like C<ev_default_fork>, but acts on an event loop created by
632	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
633	after fork that you want to re-use in the child, and how you do this is
634	entirely your own problem.
635		659
636	=item int ev_is_default_loop (loop)	660	=item int ev_is_default_loop (loop)
637		661
638	Returns true when the given loop is, in fact, the default loop, and false	662	Returns true when the given loop is, in fact, the default loop, and false
639	otherwise.	663	otherwise.
640		664
641	=item unsigned int ev_loop_count (loop)	665	=item unsigned int ev_iteration (loop)
642		666
643	Returns the count of loop iterations for the loop, which is identical to	667	Returns the current iteration count for the event loop, which is identical
644	the number of times libev did poll for new events. It starts at C<0> and	668	to the number of times libev did poll for new events. It starts at C<0>
645	happily wraps around with enough iterations.	669	and happily wraps around with enough iterations.
646		670
647	This value can sometimes be useful as a generation counter of sorts (it	671	This value can sometimes be useful as a generation counter of sorts (it
648	"ticks" the number of loop iterations), as it roughly corresponds with	672	"ticks" the number of loop iterations), as it roughly corresponds with
649	C<ev_prepare> and C<ev_check> calls.	673	C<ev_prepare> and C<ev_check> calls - and is incremented between the
		674	prepare and check phases.
650		675
651	=item unsigned int ev_loop_depth (loop)	676	=item unsigned int ev_depth (loop)
652		677
653	Returns the number of times C<ev_loop> was entered minus the number of	678	Returns the number of times C<ev_run> was entered minus the number of
654	times C<ev_loop> was exited, in other words, the recursion depth.	679	times C<ev_run> was exited, in other words, the recursion depth.
655		680
656	Outside C<ev_loop>, this number is zero. In a callback, this number is	681	Outside C<ev_run>, this number is zero. In a callback, this number is
657	C<1>, unless C<ev_loop> was invoked recursively (or from another thread),	682	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
658	in which case it is higher.	683	in which case it is higher.
659		684
660	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread	685	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread
661	etc.), doesn't count as exit.	686	etc.), doesn't count as "exit" - consider this as a hint to avoid such
		687	ungentleman-like behaviour unless it's really convenient.
662		688
663	=item unsigned int ev_backend (loop)	689	=item unsigned int ev_backend (loop)
664		690
665	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	691	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
666	use.	692	use.
…		…
675		701
676	=item ev_now_update (loop)	702	=item ev_now_update (loop)
677		703
678	Establishes the current time by querying the kernel, updating the time	704	Establishes the current time by querying the kernel, updating the time
679	returned by C<ev_now ()> in the progress. This is a costly operation and	705	returned by C<ev_now ()> in the progress. This is a costly operation and
680	is usually done automatically within C<ev_loop ()>.	706	is usually done automatically within C<ev_run ()>.
681		707
682	This function is rarely useful, but when some event callback runs for a	708	This function is rarely useful, but when some event callback runs for a
683	very long time without entering the event loop, updating libev's idea of	709	very long time without entering the event loop, updating libev's idea of
684	the current time is a good idea.	710	the current time is a good idea.
685		711
…		…
687		713
688	=item ev_suspend (loop)	714	=item ev_suspend (loop)
689		715
690	=item ev_resume (loop)	716	=item ev_resume (loop)
691		717
692	These two functions suspend and resume a loop, for use when the loop is	718	These two functions suspend and resume an event loop, for use when the
693	not used for a while and timeouts should not be processed.	719	loop is not used for a while and timeouts should not be processed.
694		720
695	A typical use case would be an interactive program such as a game: When	721	A typical use case would be an interactive program such as a game: When
696	the user presses C<^Z> to suspend the game and resumes it an hour later it	722	the user presses C<^Z> to suspend the game and resumes it an hour later it
697	would be best to handle timeouts as if no time had actually passed while	723	would be best to handle timeouts as if no time had actually passed while
698	the program was suspended. This can be achieved by calling C<ev_suspend>	724	the program was suspended. This can be achieved by calling C<ev_suspend>
…		…
700	C<ev_resume> directly afterwards to resume timer processing.	726	C<ev_resume> directly afterwards to resume timer processing.
701		727
702	Effectively, all C<ev_timer> watchers will be delayed by the time spend	728	Effectively, all C<ev_timer> watchers will be delayed by the time spend
703	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers	729	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
704	will be rescheduled (that is, they will lose any events that would have	730	will be rescheduled (that is, they will lose any events that would have
705	occured while suspended).	731	occurred while suspended).
706		732
707	After calling C<ev_suspend> you B<must not> call I<any> function on the	733	After calling C<ev_suspend> you B<must not> call I<any> function on the
708	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>	734	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
709	without a previous call to C<ev_suspend>.	735	without a previous call to C<ev_suspend>.
710		736
711	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the	737	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
712	event loop time (see C<ev_now_update>).	738	event loop time (see C<ev_now_update>).
713		739
714	=item ev_loop (loop, int flags)	740	=item ev_run (loop, int flags)
715		741
716	Finally, this is it, the event handler. This function usually is called	742	Finally, this is it, the event handler. This function usually is called
717	after you have initialised all your watchers and you want to start	743	after you have initialised all your watchers and you want to start
718	handling events.	744	handling events. It will ask the operating system for any new events, call
		745	the watcher callbacks, an then repeat the whole process indefinitely: This
		746	is why event loops are called I<loops>.
719		747
720	If the flags argument is specified as C<0>, it will not return until	748	If the flags argument is specified as C<0>, it will keep handling events
721	either no event watchers are active anymore or C<ev_unloop> was called.	749	until either no event watchers are active anymore or C<ev_break> was
		750	called.
722		751
723	Please note that an explicit C<ev_unloop> is usually better than	752	Please note that an explicit C<ev_break> is usually better than
724	relying on all watchers to be stopped when deciding when a program has	753	relying on all watchers to be stopped when deciding when a program has
725	finished (especially in interactive programs), but having a program	754	finished (especially in interactive programs), but having a program
726	that automatically loops as long as it has to and no longer by virtue	755	that automatically loops as long as it has to and no longer by virtue
727	of relying on its watchers stopping correctly, that is truly a thing of	756	of relying on its watchers stopping correctly, that is truly a thing of
728	beauty.	757	beauty.
729		758
730	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	759	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
731	those events and any already outstanding ones, but will not block your	760	those events and any already outstanding ones, but will not wait and
732	process in case there are no events and will return after one iteration of	761	block your process in case there are no events and will return after one
733	the loop.	762	iteration of the loop. This is sometimes useful to poll and handle new
		763	events while doing lengthy calculations, to keep the program responsive.
734		764
735	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	765	A flags value of C<EVRUN_ONCE> will look for new events (waiting if
736	necessary) and will handle those and any already outstanding ones. It	766	necessary) and will handle those and any already outstanding ones. It
737	will block your process until at least one new event arrives (which could	767	will block your process until at least one new event arrives (which could
738	be an event internal to libev itself, so there is no guarantee that a	768	be an event internal to libev itself, so there is no guarantee that a
739	user-registered callback will be called), and will return after one	769	user-registered callback will be called), and will return after one
740	iteration of the loop.	770	iteration of the loop.
741		771
742	This is useful if you are waiting for some external event in conjunction	772	This is useful if you are waiting for some external event in conjunction
743	with something not expressible using other libev watchers (i.e. "roll your	773	with something not expressible using other libev watchers (i.e. "roll your
744	own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is	774	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
745	usually a better approach for this kind of thing.	775	usually a better approach for this kind of thing.
746		776
747	Here are the gory details of what C<ev_loop> does:	777	Here are the gory details of what C<ev_run> does:
748		778
		779	- Increment loop depth.
		780	- Reset the ev_break status.
749	- Before the first iteration, call any pending watchers.	781	- Before the first iteration, call any pending watchers.
		782	LOOP:
750	* If EVFLAG_FORKCHECK was used, check for a fork.	783	- If EVFLAG_FORKCHECK was used, check for a fork.
751	- If a fork was detected (by any means), queue and call all fork watchers.	784	- If a fork was detected (by any means), queue and call all fork watchers.
752	- Queue and call all prepare watchers.	785	- Queue and call all prepare watchers.
		786	- If ev_break was called, goto FINISH.
753	- If we have been forked, detach and recreate the kernel state	787	- If we have been forked, detach and recreate the kernel state
754	as to not disturb the other process.	788	as to not disturb the other process.
755	- Update the kernel state with all outstanding changes.	789	- Update the kernel state with all outstanding changes.
756	- Update the "event loop time" (ev_now ()).	790	- Update the "event loop time" (ev_now ()).
757	- Calculate for how long to sleep or block, if at all	791	- Calculate for how long to sleep or block, if at all
758	(active idle watchers, EVLOOP_NONBLOCK or not having	792	(active idle watchers, EVRUN_NOWAIT or not having
759	any active watchers at all will result in not sleeping).	793	any active watchers at all will result in not sleeping).
760	- Sleep if the I/O and timer collect interval say so.	794	- Sleep if the I/O and timer collect interval say so.
		795	- Increment loop iteration counter.
761	- Block the process, waiting for any events.	796	- Block the process, waiting for any events.
762	- Queue all outstanding I/O (fd) events.	797	- Queue all outstanding I/O (fd) events.
763	- Update the "event loop time" (ev_now ()), and do time jump adjustments.	798	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
764	- Queue all expired timers.	799	- Queue all expired timers.
765	- Queue all expired periodics.	800	- Queue all expired periodics.
766	- Unless any events are pending now, queue all idle watchers.	801	- Queue all idle watchers with priority higher than that of pending events.
767	- Queue all check watchers.	802	- Queue all check watchers.
768	- Call all queued watchers in reverse order (i.e. check watchers first).	803	- Call all queued watchers in reverse order (i.e. check watchers first).
769	Signals and child watchers are implemented as I/O watchers, and will	804	Signals and child watchers are implemented as I/O watchers, and will
770	be handled here by queueing them when their watcher gets executed.	805	be handled here by queueing them when their watcher gets executed.
771	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	806	- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
772	were used, or there are no active watchers, return, otherwise	807	were used, or there are no active watchers, goto FINISH, otherwise
773	continue with step *.	808	continue with step LOOP.
		809	FINISH:
		810	- Reset the ev_break status iff it was EVBREAK_ONE.
		811	- Decrement the loop depth.
		812	- Return.
774		813
775	Example: Queue some jobs and then loop until no events are outstanding	814	Example: Queue some jobs and then loop until no events are outstanding
776	anymore.	815	anymore.
777		816
778	... queue jobs here, make sure they register event watchers as long	817	... queue jobs here, make sure they register event watchers as long
779	... as they still have work to do (even an idle watcher will do..)	818	... as they still have work to do (even an idle watcher will do..)
780	ev_loop (my_loop, 0);	819	ev_run (my_loop, 0);
781	... jobs done or somebody called unloop. yeah!	820	... jobs done or somebody called unloop. yeah!
782		821
783	=item ev_unloop (loop, how)	822	=item ev_break (loop, how)
784		823
785	Can be used to make a call to C<ev_loop> return early (but only after it	824	Can be used to make a call to C<ev_run> return early (but only after it
786	has processed all outstanding events). The C<how> argument must be either	825	has processed all outstanding events). The C<how> argument must be either
787	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	826	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
788	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	827	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
789		828
790	This "unloop state" will be cleared when entering C<ev_loop> again.	829	This "break state" will be cleared when entering C<ev_run> again.
791		830
792	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.	831	It is safe to call C<ev_break> from outside any C<ev_run> calls, too.
793		832
794	=item ev_ref (loop)	833	=item ev_ref (loop)
795		834
796	=item ev_unref (loop)	835	=item ev_unref (loop)
797		836
798	Ref/unref can be used to add or remove a reference count on the event	837	Ref/unref can be used to add or remove a reference count on the event
799	loop: Every watcher keeps one reference, and as long as the reference	838	loop: Every watcher keeps one reference, and as long as the reference
800	count is nonzero, C<ev_loop> will not return on its own.	839	count is nonzero, C<ev_run> will not return on its own.
801		840
802	This is useful when you have a watcher that you never intend to	841	This is useful when you have a watcher that you never intend to
803	unregister, but that nevertheless should not keep C<ev_loop> from	842	unregister, but that nevertheless should not keep C<ev_run> from
804	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>	843	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
805	before stopping it.	844	before stopping it.
806		845
807	As an example, libev itself uses this for its internal signal pipe: It	846	As an example, libev itself uses this for its internal signal pipe: It
808	is not visible to the libev user and should not keep C<ev_loop> from	847	is not visible to the libev user and should not keep C<ev_run> from
809	exiting if no event watchers registered by it are active. It is also an	848	exiting if no event watchers registered by it are active. It is also an
810	excellent way to do this for generic recurring timers or from within	849	excellent way to do this for generic recurring timers or from within
811	third-party libraries. Just remember to I<unref after start> and I<ref	850	third-party libraries. Just remember to I<unref after start> and I<ref
812	before stop> (but only if the watcher wasn't active before, or was active	851	before stop> (but only if the watcher wasn't active before, or was active
813	before, respectively. Note also that libev might stop watchers itself	852	before, respectively. Note also that libev might stop watchers itself
814	(e.g. non-repeating timers) in which case you have to C<ev_ref>	853	(e.g. non-repeating timers) in which case you have to C<ev_ref>
815	in the callback).	854	in the callback).
816		855
817	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	856	Example: Create a signal watcher, but keep it from keeping C<ev_run>
818	running when nothing else is active.	857	running when nothing else is active.
819		858
820	ev_signal exitsig;	859	ev_signal exitsig;
821	ev_signal_init (&exitsig, sig_cb, SIGINT);	860	ev_signal_init (&exitsig, sig_cb, SIGINT);
822	ev_signal_start (loop, &exitsig);	861	ev_signal_start (loop, &exitsig);
…		…
867	usually doesn't make much sense to set it to a lower value than C<0.01>,	906	usually doesn't make much sense to set it to a lower value than C<0.01>,
868	as this approaches the timing granularity of most systems. Note that if	907	as this approaches the timing granularity of most systems. Note that if
869	you do transactions with the outside world and you can't increase the	908	you do transactions with the outside world and you can't increase the
870	parallelity, then this setting will limit your transaction rate (if you	909	parallelity, then this setting will limit your transaction rate (if you
871	need to poll once per transaction and the I/O collect interval is 0.01,	910	need to poll once per transaction and the I/O collect interval is 0.01,
872	then you can't do more than 100 transations per second).	911	then you can't do more than 100 transactions per second).
873		912
874	Setting the I<timeout collect interval> can improve the opportunity for	913	Setting the I<timeout collect interval> can improve the opportunity for
875	saving power, as the program will "bundle" timer callback invocations that	914	saving power, as the program will "bundle" timer callback invocations that
876	are "near" in time together, by delaying some, thus reducing the number of	915	are "near" in time together, by delaying some, thus reducing the number of
877	times the process sleeps and wakes up again. Another useful technique to	916	times the process sleeps and wakes up again. Another useful technique to
…		…
885	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);	924	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
886		925
887	=item ev_invoke_pending (loop)	926	=item ev_invoke_pending (loop)
888		927
889	This call will simply invoke all pending watchers while resetting their	928	This call will simply invoke all pending watchers while resetting their
890	pending state. Normally, C<ev_loop> does this automatically when required,	929	pending state. Normally, C<ev_run> does this automatically when required,
891	but when overriding the invoke callback this call comes handy.	930	but when overriding the invoke callback this call comes handy. This
		931	function can be invoked from a watcher - this can be useful for example
		932	when you want to do some lengthy calculation and want to pass further
		933	event handling to another thread (you still have to make sure only one
		934	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
892		935
893	=item int ev_pending_count (loop)	936	=item int ev_pending_count (loop)
894		937
895	Returns the number of pending watchers - zero indicates that no watchers	938	Returns the number of pending watchers - zero indicates that no watchers
896	are pending.	939	are pending.
897		940
898	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))	941	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
899		942
900	This overrides the invoke pending functionality of the loop: Instead of	943	This overrides the invoke pending functionality of the loop: Instead of
901	invoking all pending watchers when there are any, C<ev_loop> will call	944	invoking all pending watchers when there are any, C<ev_run> will call
902	this callback instead. This is useful, for example, when you want to	945	this callback instead. This is useful, for example, when you want to
903	invoke the actual watchers inside another context (another thread etc.).	946	invoke the actual watchers inside another context (another thread etc.).
904		947
905	If you want to reset the callback, use C<ev_invoke_pending> as new	948	If you want to reset the callback, use C<ev_invoke_pending> as new
906	callback.	949	callback.
…		…
909		952
910	Sometimes you want to share the same loop between multiple threads. This	953	Sometimes you want to share the same loop between multiple threads. This
911	can be done relatively simply by putting mutex_lock/unlock calls around	954	can be done relatively simply by putting mutex_lock/unlock calls around
912	each call to a libev function.	955	each call to a libev function.
913		956
914	However, C<ev_loop> can run an indefinite time, so it is not feasible to	957	However, C<ev_run> can run an indefinite time, so it is not feasible
915	wait for it to return. One way around this is to wake up the loop via	958	to wait for it to return. One way around this is to wake up the event
916	C<ev_unloop> and C<av_async_send>, another way is to set these I<release>	959	loop via C<ev_break> and C<av_async_send>, another way is to set these
917	and I<acquire> callbacks on the loop.	960	I<release> and I<acquire> callbacks on the loop.
918		961
919	When set, then C<release> will be called just before the thread is	962	When set, then C<release> will be called just before the thread is
920	suspended waiting for new events, and C<acquire> is called just	963	suspended waiting for new events, and C<acquire> is called just
921	afterwards.	964	afterwards.
922		965
…		…
925		968
926	While event loop modifications are allowed between invocations of	969	While event loop modifications are allowed between invocations of
927	C<release> and C<acquire> (that's their only purpose after all), no	970	C<release> and C<acquire> (that's their only purpose after all), no
928	modifications done will affect the event loop, i.e. adding watchers will	971	modifications done will affect the event loop, i.e. adding watchers will
929	have no effect on the set of file descriptors being watched, or the time	972	have no effect on the set of file descriptors being watched, or the time
930	waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it	973	waited. Use an C<ev_async> watcher to wake up C<ev_run> when you want it
931	to take note of any changes you made.	974	to take note of any changes you made.
932		975
933	In theory, threads executing C<ev_loop> will be async-cancel safe between	976	In theory, threads executing C<ev_run> will be async-cancel safe between
934	invocations of C<release> and C<acquire>.	977	invocations of C<release> and C<acquire>.
935		978
936	See also the locking example in the C<THREADS> section later in this	979	See also the locking example in the C<THREADS> section later in this
937	document.	980	document.
938		981
…		…
947	These two functions can be used to associate arbitrary data with a loop,	990	These two functions can be used to associate arbitrary data with a loop,
948	and are intended solely for the C<invoke_pending_cb>, C<release> and	991	and are intended solely for the C<invoke_pending_cb>, C<release> and
949	C<acquire> callbacks described above, but of course can be (ab-)used for	992	C<acquire> callbacks described above, but of course can be (ab-)used for
950	any other purpose as well.	993	any other purpose as well.
951		994
952	=item ev_loop_verify (loop)	995	=item ev_verify (loop)
953		996
954	This function only does something when C<EV_VERIFY> support has been	997	This function only does something when C<EV_VERIFY> support has been
955	compiled in, which is the default for non-minimal builds. It tries to go	998	compiled in, which is the default for non-minimal builds. It tries to go
956	through all internal structures and checks them for validity. If anything	999	through all internal structures and checks them for validity. If anything
957	is found to be inconsistent, it will print an error message to standard	1000	is found to be inconsistent, it will print an error message to standard
…		…
968		1011
969	In the following description, uppercase C<TYPE> in names stands for the	1012	In the following description, uppercase C<TYPE> in names stands for the
970	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer	1013	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
971	watchers and C<ev_io_start> for I/O watchers.	1014	watchers and C<ev_io_start> for I/O watchers.
972		1015
973	A watcher is a structure that you create and register to record your	1016	A watcher is an opaque structure that you allocate and register to record
974	interest in some event. For instance, if you want to wait for STDIN to	1017	your interest in some event. To make a concrete example, imagine you want
975	become readable, you would create an C<ev_io> watcher for that:	1018	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1019	for that:
976		1020
977	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)	1021	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
978	{	1022	{
979	ev_io_stop (w);	1023	ev_io_stop (w);
980	ev_unloop (loop, EVUNLOOP_ALL);	1024	ev_break (loop, EVBREAK_ALL);
981	}	1025	}
982		1026
983	struct ev_loop *loop = ev_default_loop (0);	1027	struct ev_loop *loop = ev_default_loop (0);
984		1028
985	ev_io stdin_watcher;	1029	ev_io stdin_watcher;
986		1030
987	ev_init (&stdin_watcher, my_cb);	1031	ev_init (&stdin_watcher, my_cb);
988	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1032	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
989	ev_io_start (loop, &stdin_watcher);	1033	ev_io_start (loop, &stdin_watcher);
990		1034
991	ev_loop (loop, 0);	1035	ev_run (loop, 0);
992		1036
993	As you can see, you are responsible for allocating the memory for your	1037	As you can see, you are responsible for allocating the memory for your
994	watcher structures (and it is I<usually> a bad idea to do this on the	1038	watcher structures (and it is I<usually> a bad idea to do this on the
995	stack).	1039	stack).
996		1040
997	Each watcher has an associated watcher structure (called C<struct ev_TYPE>	1041	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
998	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).	1042	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
999		1043
1000	Each watcher structure must be initialised by a call to C<ev_init	1044	Each watcher structure must be initialised by a call to C<ev_init (watcher
1001	(watcher *, callback)>, which expects a callback to be provided. This	1045	*, callback)>, which expects a callback to be provided. This callback is
1002	callback gets invoked each time the event occurs (or, in the case of I/O	1046	invoked each time the event occurs (or, in the case of I/O watchers, each
1003	watchers, each time the event loop detects that the file descriptor given	1047	time the event loop detects that the file descriptor given is readable
1004	is readable and/or writable).	1048	and/or writable).
1005		1049
1006	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>	1050	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
1007	macro to configure it, with arguments specific to the watcher type. There	1051	macro to configure it, with arguments specific to the watcher type. There
1008	is also a macro to combine initialisation and setting in one call: C<<	1052	is also a macro to combine initialisation and setting in one call: C<<
1009	ev_TYPE_init (watcher *, callback, ...) >>.	1053	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
1032	=item C<EV_WRITE>	1076	=item C<EV_WRITE>
1033		1077
1034	The file descriptor in the C<ev_io> watcher has become readable and/or	1078	The file descriptor in the C<ev_io> watcher has become readable and/or
1035	writable.	1079	writable.
1036		1080
1037	=item C<EV_TIMEOUT>	1081	=item C<EV_TIMER>
1038		1082
1039	The C<ev_timer> watcher has timed out.	1083	The C<ev_timer> watcher has timed out.
1040		1084
1041	=item C<EV_PERIODIC>	1085	=item C<EV_PERIODIC>
1042		1086
…		…
1060		1104
1061	=item C<EV_PREPARE>	1105	=item C<EV_PREPARE>
1062		1106
1063	=item C<EV_CHECK>	1107	=item C<EV_CHECK>
1064		1108
1065	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts	1109	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts
1066	to gather new events, and all C<ev_check> watchers are invoked just after	1110	to gather new events, and all C<ev_check> watchers are invoked just after
1067	C<ev_loop> has gathered them, but before it invokes any callbacks for any	1111	C<ev_run> has gathered them, but before it invokes any callbacks for any
1068	received events. Callbacks of both watcher types can start and stop as	1112	received events. Callbacks of both watcher types can start and stop as
1069	many watchers as they want, and all of them will be taken into account	1113	many watchers as they want, and all of them will be taken into account
1070	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	1114	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
1071	C<ev_loop> from blocking).	1115	C<ev_run> from blocking).
1072		1116
1073	=item C<EV_EMBED>	1117	=item C<EV_EMBED>
1074		1118
1075	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1119	The embedded event loop specified in the C<ev_embed> watcher needs attention.
1076		1120
1077	=item C<EV_FORK>	1121	=item C<EV_FORK>
1078		1122
1079	The event loop has been resumed in the child process after fork (see	1123	The event loop has been resumed in the child process after fork (see
1080	C<ev_fork>).	1124	C<ev_fork>).
		1125
		1126	=item C<EV_CLEANUP>
		1127
		1128	The event loop is about to be destroyed (see C<ev_cleanup>).
1081		1129
1082	=item C<EV_ASYNC>	1130	=item C<EV_ASYNC>
1083		1131
1084	The given async watcher has been asynchronously notified (see C<ev_async>).	1132	The given async watcher has been asynchronously notified (see C<ev_async>).
1085		1133
…		…
1257		1305
1258	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related	1306	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1259	functions that do not need a watcher.	1307	functions that do not need a watcher.
1260		1308
1261	=back	1309	=back
1262
1263		1310
1264	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1311	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
1265		1312
1266	Each watcher has, by default, a member C<void *data> that you can change	1313	Each watcher has, by default, a member C<void *data> that you can change
1267	and read at any time: libev will completely ignore it. This can be used	1314	and read at any time: libev will completely ignore it. This can be used
…		…
1323	t2_cb (EV_P_ ev_timer *w, int revents)	1370	t2_cb (EV_P_ ev_timer *w, int revents)
1324	{	1371	{
1325	struct my_biggy big = (struct my_biggy *)	1372	struct my_biggy big = (struct my_biggy *)
1326	(((char *)w) - offsetof (struct my_biggy, t2));	1373	(((char *)w) - offsetof (struct my_biggy, t2));
1327	}	1374	}
		1375
		1376	=head2 WATCHER STATES
		1377
		1378	There are various watcher states mentioned throughout this manual -
		1379	active, pending and so on. In this section these states and the rules to
		1380	transition between them will be described in more detail - and while these
		1381	rules might look complicated, they usually do "the right thing".
		1382
		1383	=over 4
		1384
		1385	=item initialiased
		1386
		1387	Before a watcher can be registered with the event looop it has to be
		1388	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1389	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
		1390
		1391	In this state it is simply some block of memory that is suitable for use
		1392	in an event loop. It can be moved around, freed, reused etc. at will.
		1393
		1394	=item started/running/active
		1395
		1396	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
		1397	property of the event loop, and is actively waiting for events. While in
		1398	this state it cannot be accessed (except in a few documented ways), moved,
		1399	freed or anything else - the only legal thing is to keep a pointer to it,
		1400	and call libev functions on it that are documented to work on active watchers.
		1401
		1402	=item pending
		1403
		1404	If a watcher is active and libev determines that an event it is interested
		1405	in has occurred (such as a timer expiring), it will become pending. It will
		1406	stay in this pending state until either it is stopped or its callback is
		1407	about to be invoked, so it is not normally pending inside the watcher
		1408	callback.
		1409
		1410	The watcher might or might not be active while it is pending (for example,
		1411	an expired non-repeating timer can be pending but no longer active). If it
		1412	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1413	but it is still property of the event loop at this time, so cannot be
		1414	moved, freed or reused. And if it is active the rules described in the
		1415	previous item still apply.
		1416
		1417	It is also possible to feed an event on a watcher that is not active (e.g.
		1418	via C<ev_feed_event>), in which case it becomes pending without being
		1419	active.
		1420
		1421	=item stopped
		1422
		1423	A watcher can be stopped implicitly by libev (in which case it might still
		1424	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
		1425	latter will clear any pending state the watcher might be in, regardless
		1426	of whether it was active or not, so stopping a watcher explicitly before
		1427	freeing it is often a good idea.
		1428
		1429	While stopped (and not pending) the watcher is essentially in the
		1430	initialised state, that is it can be reused, moved, modified in any way
		1431	you wish.
		1432
		1433	=back
1328		1434
1329	=head2 WATCHER PRIORITY MODELS	1435	=head2 WATCHER PRIORITY MODELS
1330		1436
1331	Many event loops support I<watcher priorities>, which are usually small	1437	Many event loops support I<watcher priorities>, which are usually small
1332	integers that influence the ordering of event callback invocation	1438	integers that influence the ordering of event callback invocation
…		…
1375		1481
1376	For example, to emulate how many other event libraries handle priorities,	1482	For example, to emulate how many other event libraries handle priorities,
1377	you can associate an C<ev_idle> watcher to each such watcher, and in	1483	you can associate an C<ev_idle> watcher to each such watcher, and in
1378	the normal watcher callback, you just start the idle watcher. The real	1484	the normal watcher callback, you just start the idle watcher. The real
1379	processing is done in the idle watcher callback. This causes libev to	1485	processing is done in the idle watcher callback. This causes libev to
1380	continously poll and process kernel event data for the watcher, but when	1486	continuously poll and process kernel event data for the watcher, but when
1381	the lock-out case is known to be rare (which in turn is rare :), this is	1487	the lock-out case is known to be rare (which in turn is rare :), this is
1382	workable.	1488	workable.
1383		1489
1384	Usually, however, the lock-out model implemented that way will perform	1490	Usually, however, the lock-out model implemented that way will perform
1385	miserably under the type of load it was designed to handle. In that case,	1491	miserably under the type of load it was designed to handle. In that case,
…		…
1399	{	1505	{
1400	// stop the I/O watcher, we received the event, but	1506	// stop the I/O watcher, we received the event, but
1401	// are not yet ready to handle it.	1507	// are not yet ready to handle it.
1402	ev_io_stop (EV_A_ w);	1508	ev_io_stop (EV_A_ w);
1403		1509
1404	// start the idle watcher to ahndle the actual event.	1510	// start the idle watcher to handle the actual event.
1405	// it will not be executed as long as other watchers	1511	// it will not be executed as long as other watchers
1406	// with the default priority are receiving events.	1512	// with the default priority are receiving events.
1407	ev_idle_start (EV_A_ &idle);	1513	ev_idle_start (EV_A_ &idle);
1408	}	1514	}
1409		1515
…		…
1463		1569
1464	If you cannot use non-blocking mode, then force the use of a	1570	If you cannot use non-blocking mode, then force the use of a
1465	known-to-be-good backend (at the time of this writing, this includes only	1571	known-to-be-good backend (at the time of this writing, this includes only
1466	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file	1572	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1467	descriptors for which non-blocking operation makes no sense (such as	1573	descriptors for which non-blocking operation makes no sense (such as
1468	files) - libev doesn't guarentee any specific behaviour in that case.	1574	files) - libev doesn't guarantee any specific behaviour in that case.
1469		1575
1470	Another thing you have to watch out for is that it is quite easy to	1576	Another thing you have to watch out for is that it is quite easy to
1471	receive "spurious" readiness notifications, that is your callback might	1577	receive "spurious" readiness notifications, that is your callback might
1472	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1578	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1473	because there is no data. Not only are some backends known to create a	1579	because there is no data. Not only are some backends known to create a
…		…
1541	somewhere, as that would have given you a big clue).	1647	somewhere, as that would have given you a big clue).
1542		1648
1543	=head3 The special problem of accept()ing when you can't	1649	=head3 The special problem of accept()ing when you can't
1544		1650
1545	Many implementations of the POSIX C<accept> function (for example,	1651	Many implementations of the POSIX C<accept> function (for example,
1546	found in port-2004 Linux) have the peculiar behaviour of not removing a	1652	found in post-2004 Linux) have the peculiar behaviour of not removing a
1547	connection from the pending queue in all error cases.	1653	connection from the pending queue in all error cases.
1548		1654
1549	For example, larger servers often run out of file descriptors (because	1655	For example, larger servers often run out of file descriptors (because
1550	of resource limits), causing C<accept> to fail with C<ENFILE> but not	1656	of resource limits), causing C<accept> to fail with C<ENFILE> but not
1551	rejecting the connection, leading to libev signalling readiness on	1657	rejecting the connection, leading to libev signalling readiness on
…		…
1617	...	1723	...
1618	struct ev_loop *loop = ev_default_init (0);	1724	struct ev_loop *loop = ev_default_init (0);
1619	ev_io stdin_readable;	1725	ev_io stdin_readable;
1620	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1726	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1621	ev_io_start (loop, &stdin_readable);	1727	ev_io_start (loop, &stdin_readable);
1622	ev_loop (loop, 0);	1728	ev_run (loop, 0);
1623		1729
1624		1730
1625	=head2 C<ev_timer> - relative and optionally repeating timeouts	1731	=head2 C<ev_timer> - relative and optionally repeating timeouts
1626		1732
1627	Timer watchers are simple relative timers that generate an event after a	1733	Timer watchers are simple relative timers that generate an event after a
…		…
1636	The callback is guaranteed to be invoked only I<after> its timeout has	1742	The callback is guaranteed to be invoked only I<after> its timeout has
1637	passed (not I<at>, so on systems with very low-resolution clocks this	1743	passed (not I<at>, so on systems with very low-resolution clocks this
1638	might introduce a small delay). If multiple timers become ready during the	1744	might introduce a small delay). If multiple timers become ready during the
1639	same loop iteration then the ones with earlier time-out values are invoked	1745	same loop iteration then the ones with earlier time-out values are invoked
1640	before ones of the same priority with later time-out values (but this is	1746	before ones of the same priority with later time-out values (but this is
1641	no longer true when a callback calls C<ev_loop> recursively).	1747	no longer true when a callback calls C<ev_run> recursively).
1642		1748
1643	=head3 Be smart about timeouts	1749	=head3 Be smart about timeouts
1644		1750
1645	Many real-world problems involve some kind of timeout, usually for error	1751	Many real-world problems involve some kind of timeout, usually for error
1646	recovery. A typical example is an HTTP request - if the other side hangs,	1752	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1732	ev_tstamp timeout = last_activity + 60.;	1838	ev_tstamp timeout = last_activity + 60.;
1733		1839
1734	// if last_activity + 60. is older than now, we did time out	1840	// if last_activity + 60. is older than now, we did time out
1735	if (timeout < now)	1841	if (timeout < now)
1736	{	1842	{
1737	// timeout occured, take action	1843	// timeout occurred, take action
1738	}	1844	}
1739	else	1845	else
1740	{	1846	{
1741	// callback was invoked, but there was some activity, re-arm	1847	// callback was invoked, but there was some activity, re-arm
1742	// the watcher to fire in last_activity + 60, which is	1848	// the watcher to fire in last_activity + 60, which is
…		…
1764	to the current time (meaning we just have some activity :), then call the	1870	to the current time (meaning we just have some activity :), then call the
1765	callback, which will "do the right thing" and start the timer:	1871	callback, which will "do the right thing" and start the timer:
1766		1872
1767	ev_init (timer, callback);	1873	ev_init (timer, callback);
1768	last_activity = ev_now (loop);	1874	last_activity = ev_now (loop);
1769	callback (loop, timer, EV_TIMEOUT);	1875	callback (loop, timer, EV_TIMER);
1770		1876
1771	And when there is some activity, simply store the current time in	1877	And when there is some activity, simply store the current time in
1772	C<last_activity>, no libev calls at all:	1878	C<last_activity>, no libev calls at all:
1773		1879
1774	last_actiivty = ev_now (loop);	1880	last_activity = ev_now (loop);
1775		1881
1776	This technique is slightly more complex, but in most cases where the	1882	This technique is slightly more complex, but in most cases where the
1777	time-out is unlikely to be triggered, much more efficient.	1883	time-out is unlikely to be triggered, much more efficient.
1778		1884
1779	Changing the timeout is trivial as well (if it isn't hard-coded in the	1885	Changing the timeout is trivial as well (if it isn't hard-coded in the
…		…
1817		1923
1818	=head3 The special problem of time updates	1924	=head3 The special problem of time updates
1819		1925
1820	Establishing the current time is a costly operation (it usually takes at	1926	Establishing the current time is a costly operation (it usually takes at
1821	least two system calls): EV therefore updates its idea of the current	1927	least two system calls): EV therefore updates its idea of the current
1822	time only before and after C<ev_loop> collects new events, which causes a	1928	time only before and after C<ev_run> collects new events, which causes a
1823	growing difference between C<ev_now ()> and C<ev_time ()> when handling	1929	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1824	lots of events in one iteration.	1930	lots of events in one iteration.
1825		1931
1826	The relative timeouts are calculated relative to the C<ev_now ()>	1932	The relative timeouts are calculated relative to the C<ev_now ()>
1827	time. This is usually the right thing as this timestamp refers to the time	1933	time. This is usually the right thing as this timestamp refers to the time
…		…
1944	}	2050	}
1945		2051
1946	ev_timer mytimer;	2052	ev_timer mytimer;
1947	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	2053	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1948	ev_timer_again (&mytimer); /* start timer */	2054	ev_timer_again (&mytimer); /* start timer */
1949	ev_loop (loop, 0);	2055	ev_run (loop, 0);
1950		2056
1951	// and in some piece of code that gets executed on any "activity":	2057	// and in some piece of code that gets executed on any "activity":
1952	// reset the timeout to start ticking again at 10 seconds	2058	// reset the timeout to start ticking again at 10 seconds
1953	ev_timer_again (&mytimer);	2059	ev_timer_again (&mytimer);
1954		2060
…		…
1980		2086
1981	As with timers, the callback is guaranteed to be invoked only when the	2087	As with timers, the callback is guaranteed to be invoked only when the
1982	point in time where it is supposed to trigger has passed. If multiple	2088	point in time where it is supposed to trigger has passed. If multiple
1983	timers become ready during the same loop iteration then the ones with	2089	timers become ready during the same loop iteration then the ones with
1984	earlier time-out values are invoked before ones with later time-out values	2090	earlier time-out values are invoked before ones with later time-out values
1985	(but this is no longer true when a callback calls C<ev_loop> recursively).	2091	(but this is no longer true when a callback calls C<ev_run> recursively).
1986		2092
1987	=head3 Watcher-Specific Functions and Data Members	2093	=head3 Watcher-Specific Functions and Data Members
1988		2094
1989	=over 4	2095	=over 4
1990		2096
…		…
2118	Example: Call a callback every hour, or, more precisely, whenever the	2224	Example: Call a callback every hour, or, more precisely, whenever the
2119	system time is divisible by 3600. The callback invocation times have	2225	system time is divisible by 3600. The callback invocation times have
2120	potentially a lot of jitter, but good long-term stability.	2226	potentially a lot of jitter, but good long-term stability.
2121		2227
2122	static void	2228	static void
2123	clock_cb (struct ev_loop *loop, ev_io *w, int revents)	2229	clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
2124	{	2230	{
2125	... its now a full hour (UTC, or TAI or whatever your clock follows)	2231	... its now a full hour (UTC, or TAI or whatever your clock follows)
2126	}	2232	}
2127		2233
2128	ev_periodic hourly_tick;	2234	ev_periodic hourly_tick;
…		…
2228	Example: Try to exit cleanly on SIGINT.	2334	Example: Try to exit cleanly on SIGINT.
2229		2335
2230	static void	2336	static void
2231	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)	2337	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2232	{	2338	{
2233	ev_unloop (loop, EVUNLOOP_ALL);	2339	ev_break (loop, EVBREAK_ALL);
2234	}	2340	}
2235		2341
2236	ev_signal signal_watcher;	2342	ev_signal signal_watcher;
2237	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2343	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2238	ev_signal_start (loop, &signal_watcher);	2344	ev_signal_start (loop, &signal_watcher);
…		…
2624		2730
2625	Prepare and check watchers are usually (but not always) used in pairs:	2731	Prepare and check watchers are usually (but not always) used in pairs:
2626	prepare watchers get invoked before the process blocks and check watchers	2732	prepare watchers get invoked before the process blocks and check watchers
2627	afterwards.	2733	afterwards.
2628		2734
2629	You I<must not> call C<ev_loop> or similar functions that enter	2735	You I<must not> call C<ev_run> or similar functions that enter
2630	the current event loop from either C<ev_prepare> or C<ev_check>	2736	the current event loop from either C<ev_prepare> or C<ev_check>
2631	watchers. Other loops than the current one are fine, however. The	2737	watchers. Other loops than the current one are fine, however. The
2632	rationale behind this is that you do not need to check for recursion in	2738	rationale behind this is that you do not need to check for recursion in
2633	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2739	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
2634	C<ev_check> so if you have one watcher of each kind they will always be	2740	C<ev_check> so if you have one watcher of each kind they will always be
…		…
2802		2908
2803	if (timeout >= 0)	2909	if (timeout >= 0)
2804	// create/start timer	2910	// create/start timer
2805		2911
2806	// poll	2912	// poll
2807	ev_loop (EV_A_ 0);	2913	ev_run (EV_A_ 0);
2808		2914
2809	// stop timer again	2915	// stop timer again
2810	if (timeout >= 0)	2916	if (timeout >= 0)
2811	ev_timer_stop (EV_A_ &to);	2917	ev_timer_stop (EV_A_ &to);
2812		2918
…		…
2890	if you do not want that, you need to temporarily stop the embed watcher).	2996	if you do not want that, you need to temporarily stop the embed watcher).
2891		2997
2892	=item ev_embed_sweep (loop, ev_embed *)	2998	=item ev_embed_sweep (loop, ev_embed *)
2893		2999
2894	Make a single, non-blocking sweep over the embedded loop. This works	3000	Make a single, non-blocking sweep over the embedded loop. This works
2895	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	3001	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2896	appropriate way for embedded loops.	3002	appropriate way for embedded loops.
2897		3003
2898	=item struct ev_loop *other [read-only]	3004	=item struct ev_loop *other [read-only]
2899		3005
2900	The embedded event loop.	3006	The embedded event loop.
…		…
2960	C<ev_default_fork> cheats and calls it in the wrong process, the fork	3066	C<ev_default_fork> cheats and calls it in the wrong process, the fork
2961	handlers will be invoked, too, of course.	3067	handlers will be invoked, too, of course.
2962		3068
2963	=head3 The special problem of life after fork - how is it possible?	3069	=head3 The special problem of life after fork - how is it possible?
2964		3070
2965	Most uses of C<fork()> consist of forking, then some simple calls to ste	3071	Most uses of C<fork()> consist of forking, then some simple calls to set
2966	up/change the process environment, followed by a call to C<exec()>. This	3072	up/change the process environment, followed by a call to C<exec()>. This
2967	sequence should be handled by libev without any problems.	3073	sequence should be handled by libev without any problems.
2968		3074
2969	This changes when the application actually wants to do event handling	3075	This changes when the application actually wants to do event handling
2970	in the child, or both parent in child, in effect "continuing" after the	3076	in the child, or both parent in child, in effect "continuing" after the
…		…
2986	disadvantage of having to use multiple event loops (which do not support	3092	disadvantage of having to use multiple event loops (which do not support
2987	signal watchers).	3093	signal watchers).
2988		3094
2989	When this is not possible, or you want to use the default loop for	3095	When this is not possible, or you want to use the default loop for
2990	other reasons, then in the process that wants to start "fresh", call	3096	other reasons, then in the process that wants to start "fresh", call
2991	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3097	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
2992	the default loop will "orphan" (not stop) all registered watchers, so you	3098	Destroying the default loop will "orphan" (not stop) all registered
2993	have to be careful not to execute code that modifies those watchers. Note	3099	watchers, so you have to be careful not to execute code that modifies
2994	also that in that case, you have to re-register any signal watchers.	3100	those watchers. Note also that in that case, you have to re-register any
		3101	signal watchers.
2995		3102
2996	=head3 Watcher-Specific Functions and Data Members	3103	=head3 Watcher-Specific Functions and Data Members
2997		3104
2998	=over 4	3105	=over 4
2999		3106
3000	=item ev_fork_init (ev_signal *, callback)	3107	=item ev_fork_init (ev_fork *, callback)
3001		3108
3002	Initialises and configures the fork watcher - it has no parameters of any	3109	Initialises and configures the fork watcher - it has no parameters of any
3003	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3110	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
3004	believe me.	3111	really.
3005		3112
3006	=back	3113	=back
3007		3114
3008		3115
		3116	=head2 C<ev_cleanup> - even the best things end
		3117
		3118	Cleanup watchers are called just before the event loop is being destroyed
		3119	by a call to C<ev_loop_destroy>.
		3120
		3121	While there is no guarantee that the event loop gets destroyed, cleanup
		3122	watchers provide a convenient method to install cleanup hooks for your
		3123	program, worker threads and so on - you just to make sure to destroy the
		3124	loop when you want them to be invoked.
		3125
		3126	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3127	all other watchers, they do not keep a reference to the event loop (which
		3128	makes a lot of sense if you think about it). Like all other watchers, you
		3129	can call libev functions in the callback, except C<ev_cleanup_start>.
		3130
		3131	=head3 Watcher-Specific Functions and Data Members
		3132
		3133	=over 4
		3134
		3135	=item ev_cleanup_init (ev_cleanup *, callback)
		3136
		3137	Initialises and configures the cleanup watcher - it has no parameters of
		3138	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3139	pointless, I assure you.
		3140
		3141	=back
		3142
		3143	Example: Register an atexit handler to destroy the default loop, so any
		3144	cleanup functions are called.
		3145
		3146	static void
		3147	program_exits (void)
		3148	{
		3149	ev_loop_destroy (EV_DEFAULT_UC);
		3150	}
		3151
		3152	...
		3153	atexit (program_exits);
		3154
		3155
3009	=head2 C<ev_async> - how to wake up another event loop	3156	=head2 C<ev_async> - how to wake up an event loop
3010		3157
3011	In general, you cannot use an C<ev_loop> from multiple threads or other	3158	In general, you cannot use an C<ev_run> from multiple threads or other
3012	asynchronous sources such as signal handlers (as opposed to multiple event	3159	asynchronous sources such as signal handlers (as opposed to multiple event
3013	loops - those are of course safe to use in different threads).	3160	loops - those are of course safe to use in different threads).
3014		3161
3015	Sometimes, however, you need to wake up another event loop you do not	3162	Sometimes, however, you need to wake up an event loop you do not control,
3016	control, for example because it belongs to another thread. This is what	3163	for example because it belongs to another thread. This is what C<ev_async>
3017	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you	3164	watchers do: as long as the C<ev_async> watcher is active, you can signal
3018	can signal it by calling C<ev_async_send>, which is thread- and signal	3165	it by calling C<ev_async_send>, which is thread- and signal safe.
3019	safe.
3020		3166
3021	This functionality is very similar to C<ev_signal> watchers, as signals,	3167	This functionality is very similar to C<ev_signal> watchers, as signals,
3022	too, are asynchronous in nature, and signals, too, will be compressed	3168	too, are asynchronous in nature, and signals, too, will be compressed
3023	(i.e. the number of callback invocations may be less than the number of	3169	(i.e. the number of callback invocations may be less than the number of
3024	C<ev_async_sent> calls).	3170	C<ev_async_sent> calls).
…		…
3179		3325
3180	If C<timeout> is less than 0, then no timeout watcher will be	3326	If C<timeout> is less than 0, then no timeout watcher will be
3181	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	3327	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
3182	repeat = 0) will be started. C<0> is a valid timeout.	3328	repeat = 0) will be started. C<0> is a valid timeout.
3183		3329
3184	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	3330	The callback has the type C<void (*cb)(int revents, void *arg)> and is
3185	passed an C<revents> set like normal event callbacks (a combination of	3331	passed an C<revents> set like normal event callbacks (a combination of
3186	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	3332	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg>
3187	value passed to C<ev_once>. Note that it is possible to receive I<both>	3333	value passed to C<ev_once>. Note that it is possible to receive I<both>
3188	a timeout and an io event at the same time - you probably should give io	3334	a timeout and an io event at the same time - you probably should give io
3189	events precedence.	3335	events precedence.
3190		3336
3191	Example: wait up to ten seconds for data to appear on STDIN_FILENO.	3337	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
3192		3338
3193	static void stdin_ready (int revents, void *arg)	3339	static void stdin_ready (int revents, void *arg)
3194	{	3340	{
3195	if (revents & EV_READ)	3341	if (revents & EV_READ)
3196	/* stdin might have data for us, joy! */;	3342	/* stdin might have data for us, joy! */;
3197	else if (revents & EV_TIMEOUT)	3343	else if (revents & EV_TIMER)
3198	/* doh, nothing entered */;	3344	/* doh, nothing entered */;
3199	}	3345	}
3200		3346
3201	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3347	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3202		3348
…		…
3336	myclass obj;	3482	myclass obj;
3337	ev::io iow;	3483	ev::io iow;
3338	iow.set <myclass, &myclass::io_cb> (&obj);	3484	iow.set <myclass, &myclass::io_cb> (&obj);
3339		3485
3340	=item w->set (object *)	3486	=item w->set (object *)
3341
3342	This is an B<experimental> feature that might go away in a future version.
3343		3487
3344	This is a variation of a method callback - leaving out the method to call	3488	This is a variation of a method callback - leaving out the method to call
3345	will default the method to C<operator ()>, which makes it possible to use	3489	will default the method to C<operator ()>, which makes it possible to use
3346	functor objects without having to manually specify the C<operator ()> all	3490	functor objects without having to manually specify the C<operator ()> all
3347	the time. Incidentally, you can then also leave out the template argument	3491	the time. Incidentally, you can then also leave out the template argument
…		…
3387	Associates a different C<struct ev_loop> with this watcher. You can only	3531	Associates a different C<struct ev_loop> with this watcher. You can only
3388	do this when the watcher is inactive (and not pending either).	3532	do this when the watcher is inactive (and not pending either).
3389		3533
3390	=item w->set ([arguments])	3534	=item w->set ([arguments])
3391		3535
3392	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be	3536	Basically the same as C<ev_TYPE_set>, with the same arguments. Either this
3393	called at least once. Unlike the C counterpart, an active watcher gets	3537	method or a suitable start method must be called at least once. Unlike the
3394	automatically stopped and restarted when reconfiguring it with this	3538	C counterpart, an active watcher gets automatically stopped and restarted
3395	method.	3539	when reconfiguring it with this method.
3396		3540
3397	=item w->start ()	3541	=item w->start ()
3398		3542
3399	Starts the watcher. Note that there is no C<loop> argument, as the	3543	Starts the watcher. Note that there is no C<loop> argument, as the
3400	constructor already stores the event loop.	3544	constructor already stores the event loop.
3401		3545
		3546	=item w->start ([arguments])
		3547
		3548	Instead of calling C<set> and C<start> methods separately, it is often
		3549	convenient to wrap them in one call. Uses the same type of arguments as
		3550	the configure C<set> method of the watcher.
		3551
3402	=item w->stop ()	3552	=item w->stop ()
3403		3553
3404	Stops the watcher if it is active. Again, no C<loop> argument.	3554	Stops the watcher if it is active. Again, no C<loop> argument.
3405		3555
3406	=item w->again () (C<ev::timer>, C<ev::periodic> only)	3556	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
3418		3568
3419	=back	3569	=back
3420		3570
3421	=back	3571	=back
3422		3572
3423	Example: Define a class with an IO and idle watcher, start one of them in	3573	Example: Define a class with two I/O and idle watchers, start the I/O
3424	the constructor.	3574	watchers in the constructor.
3425		3575
3426	class myclass	3576	class myclass
3427	{	3577	{
3428	ev::io io ; void io_cb (ev::io &w, int revents);	3578	ev::io io ; void io_cb (ev::io &w, int revents);
		3579	ev::io2 io2 ; void io2_cb (ev::io &w, int revents);
3429	ev::idle idle; void idle_cb (ev::idle &w, int revents);	3580	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3430		3581
3431	myclass (int fd)	3582	myclass (int fd)
3432	{	3583	{
3433	io .set <myclass, &myclass::io_cb > (this);	3584	io .set <myclass, &myclass::io_cb > (this);
		3585	io2 .set <myclass, &myclass::io2_cb > (this);
3434	idle.set <myclass, &myclass::idle_cb> (this);	3586	idle.set <myclass, &myclass::idle_cb> (this);
3435		3587
3436	io.start (fd, ev::READ);	3588	io.set (fd, ev::WRITE); // configure the watcher
		3589	io.start (); // start it whenever convenient
		3590
		3591	io2.start (fd, ev::READ); // set + start in one call
3437	}	3592	}
3438	};	3593	};
3439		3594
3440		3595
3441	=head1 OTHER LANGUAGE BINDINGS	3596	=head1 OTHER LANGUAGE BINDINGS
…		…
3515	loop argument"). The C<EV_A> form is used when this is the sole argument,	3670	loop argument"). The C<EV_A> form is used when this is the sole argument,
3516	C<EV_A_> is used when other arguments are following. Example:	3671	C<EV_A_> is used when other arguments are following. Example:
3517		3672
3518	ev_unref (EV_A);	3673	ev_unref (EV_A);
3519	ev_timer_add (EV_A_ watcher);	3674	ev_timer_add (EV_A_ watcher);
3520	ev_loop (EV_A_ 0);	3675	ev_run (EV_A_ 0);
3521		3676
3522	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	3677	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
3523	which is often provided by the following macro.	3678	which is often provided by the following macro.
3524		3679
3525	=item C<EV_P>, C<EV_P_>	3680	=item C<EV_P>, C<EV_P_>
…		…
3565	}	3720	}
3566		3721
3567	ev_check check;	3722	ev_check check;
3568	ev_check_init (&check, check_cb);	3723	ev_check_init (&check, check_cb);
3569	ev_check_start (EV_DEFAULT_ &check);	3724	ev_check_start (EV_DEFAULT_ &check);
3570	ev_loop (EV_DEFAULT_ 0);	3725	ev_run (EV_DEFAULT_ 0);
3571		3726
3572	=head1 EMBEDDING	3727	=head1 EMBEDDING
3573		3728
3574	Libev can (and often is) directly embedded into host	3729	Libev can (and often is) directly embedded into host
3575	applications. Examples of applications that embed it include the Deliantra	3730	applications. Examples of applications that embed it include the Deliantra
…		…
3660	define before including (or compiling) any of its files. The default in	3815	define before including (or compiling) any of its files. The default in
3661	the absence of autoconf is documented for every option.	3816	the absence of autoconf is documented for every option.
3662		3817
3663	Symbols marked with "(h)" do not change the ABI, and can have different	3818	Symbols marked with "(h)" do not change the ABI, and can have different
3664	values when compiling libev vs. including F<ev.h>, so it is permissible	3819	values when compiling libev vs. including F<ev.h>, so it is permissible
3665	to redefine them before including F<ev.h> without breakign compatibility	3820	to redefine them before including F<ev.h> without breaking compatibility
3666	to a compiled library. All other symbols change the ABI, which means all	3821	to a compiled library. All other symbols change the ABI, which means all
3667	users of libev and the libev code itself must be compiled with compatible	3822	users of libev and the libev code itself must be compiled with compatible
3668	settings.	3823	settings.
3669		3824
3670	=over 4	3825	=over 4
		3826
		3827	=item EV_COMPAT3 (h)
		3828
		3829	Backwards compatibility is a major concern for libev. This is why this
		3830	release of libev comes with wrappers for the functions and symbols that
		3831	have been renamed between libev version 3 and 4.
		3832
		3833	You can disable these wrappers (to test compatibility with future
		3834	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		3835	sources. This has the additional advantage that you can drop the C<struct>
		3836	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		3837	typedef in that case.
		3838
		3839	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		3840	and in some even more future version the compatibility code will be
		3841	removed completely.
3671		3842
3672	=item EV_STANDALONE (h)	3843	=item EV_STANDALONE (h)
3673		3844
3674	Must always be C<1> if you do not use autoconf configuration, which	3845	Must always be C<1> if you do not use autoconf configuration, which
3675	keeps libev from including F<config.h>, and it also defines dummy	3846	keeps libev from including F<config.h>, and it also defines dummy
…		…
3882	EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,	4053	EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
3883	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.	4054	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3884		4055
3885	If undefined or defined to be C<1> (and the platform supports it), then	4056	If undefined or defined to be C<1> (and the platform supports it), then
3886	the respective watcher type is supported. If defined to be C<0>, then it	4057	the respective watcher type is supported. If defined to be C<0>, then it
3887	is not. Disabling watcher types mainly saves codesize.	4058	is not. Disabling watcher types mainly saves code size.
3888		4059
3889	=item EV_FEATURES	4060	=item EV_FEATURES
3890		4061
3891	If you need to shave off some kilobytes of code at the expense of some	4062	If you need to shave off some kilobytes of code at the expense of some
3892	speed (but with the full API), you can define this symbol to request	4063	speed (but with the full API), you can define this symbol to request
3893	certain subsets of functionality. The default is to enable all features	4064	certain subsets of functionality. The default is to enable all features
3894	that can be enabled on the platform.	4065	that can be enabled on the platform.
3895
3896	Note that using autoconf will usually override most of the features, so
3897	using this symbol makes sense mostly when embedding libev.
3898		4066
3899	A typical way to use this symbol is to define it to C<0> (or to a bitset	4067	A typical way to use this symbol is to define it to C<0> (or to a bitset
3900	with some broad features you want) and then selectively re-enable	4068	with some broad features you want) and then selectively re-enable
3901	additional parts you want, for example if you want everything minimal,	4069	additional parts you want, for example if you want everything minimal,
3902	but multiple event loop support, async and child watchers and the poll	4070	but multiple event loop support, async and child watchers and the poll
…		…
3915		4083
3916	=item C<1> - faster/larger code	4084	=item C<1> - faster/larger code
3917		4085
3918	Use larger code to speed up some operations.	4086	Use larger code to speed up some operations.
3919		4087
3920	Currently this is used to override some inlining decisions (enlarging the roughly	4088	Currently this is used to override some inlining decisions (enlarging the
3921	30% code size on amd64.	4089	code size by roughly 30% on amd64).
3922		4090
3923	Also disables C<assert>'s in the code, unless you define C<NDEBUG>	4091	When optimising for size, use of compiler flags such as C<-Os> with
3924	explicitly to C<0>.	4092	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
3925		4093	assertions.
3926	Use of compiler flags such as C<-Os> with gcc that optimise for size are
3927	recommended when disabling this feature.
3928		4094
3929	=item C<2> - faster/larger data structures	4095	=item C<2> - faster/larger data structures
3930		4096
3931	Replaces the small 2-heap for timer management by a faster 4-heap, larger	4097	Replaces the small 2-heap for timer management by a faster 4-heap, larger
3932	hash table sizes and so on. This will usually further increase codesize	4098	hash table sizes and so on. This will usually further increase code size
3933	and can additionally have an effect on the size of data structures at	4099	and can additionally have an effect on the size of data structures at
3934	runtime.	4100	runtime.
3935		4101
3936	=item C<4> - full API configuration	4102	=item C<4> - full API configuration
3937		4103
3938	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and	4104	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
3939	enables multiplicity (C<EV_MULTIPLICITY>=1).	4105	enables multiplicity (C<EV_MULTIPLICITY>=1).
3940		4106
		4107	=item C<8> - full API
		4108
3941	It also enables a lot of the "lesser used" core API functions. See C<ev.h>	4109	This enables a lot of the "lesser used" API functions. See C<ev.h> for
3942	for details on which parts of the API are still available without this	4110	details on which parts of the API are still available without this
3943	feature, and do not complain if this subset changes over time.	4111	feature, and do not complain if this subset changes over time.
3944		4112
3945	=item C<8> - enable all optional watcher types	4113	=item C<16> - enable all optional watcher types
3946		4114
3947	Enables all optional watcher types. If you want to selectively enable	4115	Enables all optional watcher types. If you want to selectively enable
3948	only some watcher types other than I/O and timers (e.g. prepare,	4116	only some watcher types other than I/O and timers (e.g. prepare,
3949	embed, async, child...) you can enable them manually by defining	4117	embed, async, child...) you can enable them manually by defining
3950	C<EV_watchertype_ENABLE> to C<1> instead.	4118	C<EV_watchertype_ENABLE> to C<1> instead.
3951		4119
3952	=item C<16> - enable all backends	4120	=item C<32> - enable all backends
3953		4121
3954	This enables all backends - without this feature, you need to enable at	4122	This enables all backends - without this feature, you need to enable at
3955	least one backend manually (C<EV_USE_SELECT> is a good choice).	4123	least one backend manually (C<EV_USE_SELECT> is a good choice).
3956		4124
3957	=item C<32> - enable OS-specific "helper" APIs	4125	=item C<64> - enable OS-specific "helper" APIs
3958		4126
3959	Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by	4127	Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
3960	default.	4128	default.
3961		4129
3962	=back	4130	=back
3963		4131
3964	Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>	4132	Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
3965	reduces the compiled size of libev from 24.7Kb to 6.5Kb on my GNU/Linux	4133	reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
3966	amd64 system, while still giving you I/O watchers, timers and monotonic	4134	code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
3967	clock support.	4135	watchers, timers and monotonic clock support.
3968		4136
3969	With an intelligent-enough linker (gcc+binutils are intelligent enough	4137	With an intelligent-enough linker (gcc+binutils are intelligent enough
3970	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by	4138	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
3971	your program might be left out as well - a binary starting a timer and an	4139	your program might be left out as well - a binary starting a timer and an
3972	I/O watcher then might come out at only 5Kb.	4140	I/O watcher then might come out at only 5Kb.
3973		4141
3974	=item EV_AVOID_STDIO	4142	=item EV_AVOID_STDIO
3975		4143
3976	If this is set to C<1> at compiletime, then libev will avoid using stdio	4144	If this is set to C<1> at compiletime, then libev will avoid using stdio
3977	functions (printf, scanf, perror etc.). This will increase the codesize	4145	functions (printf, scanf, perror etc.). This will increase the code size
3978	somewhat, but if your program doesn't otherwise depend on stdio and your	4146	somewhat, but if your program doesn't otherwise depend on stdio and your
3979	libc allows it, this avoids linking in the stdio library which is quite	4147	libc allows it, this avoids linking in the stdio library which is quite
3980	big.	4148	big.
3981		4149
3982	Note that error messages might become less precise when this option is	4150	Note that error messages might become less precise when this option is
…		…
3986		4154
3987	The highest supported signal number, +1 (or, the number of	4155	The highest supported signal number, +1 (or, the number of
3988	signals): Normally, libev tries to deduce the maximum number of signals	4156	signals): Normally, libev tries to deduce the maximum number of signals
3989	automatically, but sometimes this fails, in which case it can be	4157	automatically, but sometimes this fails, in which case it can be
3990	specified. Also, using a lower number than detected (C<32> should be	4158	specified. Also, using a lower number than detected (C<32> should be
3991	good for about any system in existance) can save some memory, as libev	4159	good for about any system in existence) can save some memory, as libev
3992	statically allocates some 12-24 bytes per signal number.	4160	statically allocates some 12-24 bytes per signal number.
3993		4161
3994	=item EV_PID_HASHSIZE	4162	=item EV_PID_HASHSIZE
3995		4163
3996	C<ev_child> watchers use a small hash table to distribute workload by	4164	C<ev_child> watchers use a small hash table to distribute workload by
…		…
4028	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it	4196	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4029	will be C<0>.	4197	will be C<0>.
4030		4198
4031	=item EV_VERIFY	4199	=item EV_VERIFY
4032		4200
4033	Controls how much internal verification (see C<ev_loop_verify ()>) will	4201	Controls how much internal verification (see C<ev_verify ()>) will
4034	be done: If set to C<0>, no internal verification code will be compiled	4202	be done: If set to C<0>, no internal verification code will be compiled
4035	in. If set to C<1>, then verification code will be compiled in, but not	4203	in. If set to C<1>, then verification code will be compiled in, but not
4036	called. If set to C<2>, then the internal verification code will be	4204	called. If set to C<2>, then the internal verification code will be
4037	called once per loop, which can slow down libev. If set to C<3>, then the	4205	called once per loop, which can slow down libev. If set to C<3>, then the
4038	verification code will be called very frequently, which will slow down	4206	verification code will be called very frequently, which will slow down
…		…
4042	will be C<0>.	4210	will be C<0>.
4043		4211
4044	=item EV_COMMON	4212	=item EV_COMMON
4045		4213
4046	By default, all watchers have a C<void *data> member. By redefining	4214	By default, all watchers have a C<void *data> member. By redefining
4047	this macro to a something else you can include more and other types of	4215	this macro to something else you can include more and other types of
4048	members. You have to define it each time you include one of the files,	4216	members. You have to define it each time you include one of the files,
4049	though, and it must be identical each time.	4217	though, and it must be identical each time.
4050		4218
4051	For example, the perl EV module uses something like this:	4219	For example, the perl EV module uses something like this:
4052		4220
…		…
4105	file.	4273	file.
4106		4274
4107	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	4275	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
4108	that everybody includes and which overrides some configure choices:	4276	that everybody includes and which overrides some configure choices:
4109		4277
4110	#define EV_FEATURES 0	4278	#define EV_FEATURES 8
4111	#define EV_USE_SELECT 1	4279	#define EV_USE_SELECT 1
		4280	#define EV_PREPARE_ENABLE 1
		4281	#define EV_IDLE_ENABLE 1
		4282	#define EV_SIGNAL_ENABLE 1
		4283	#define EV_CHILD_ENABLE 1
		4284	#define EV_USE_STDEXCEPT 0
4112	#define EV_CONFIG_H <config.h>	4285	#define EV_CONFIG_H <config.h>
4113		4286
4114	#include "ev++.h"	4287	#include "ev++.h"
4115		4288
4116	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4289	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
…		…
4248	userdata *u = ev_userdata (EV_A);	4421	userdata *u = ev_userdata (EV_A);
4249	pthread_mutex_lock (&u->lock);	4422	pthread_mutex_lock (&u->lock);
4250	}	4423	}
4251		4424
4252	The event loop thread first acquires the mutex, and then jumps straight	4425	The event loop thread first acquires the mutex, and then jumps straight
4253	into C<ev_loop>:	4426	into C<ev_run>:
4254		4427
4255	void *	4428	void *
4256	l_run (void *thr_arg)	4429	l_run (void *thr_arg)
4257	{	4430	{
4258	struct ev_loop *loop = (struct ev_loop *)thr_arg;	4431	struct ev_loop *loop = (struct ev_loop *)thr_arg;
4259		4432
4260	l_acquire (EV_A);	4433	l_acquire (EV_A);
4261	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);	4434	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4262	ev_loop (EV_A_ 0);	4435	ev_run (EV_A_ 0);
4263	l_release (EV_A);	4436	l_release (EV_A);
4264		4437
4265	return 0;	4438	return 0;
4266	}	4439	}
4267		4440
…		…
4319		4492
4320	=head3 COROUTINES	4493	=head3 COROUTINES
4321		4494
4322	Libev is very accommodating to coroutines ("cooperative threads"):	4495	Libev is very accommodating to coroutines ("cooperative threads"):
4323	libev fully supports nesting calls to its functions from different	4496	libev fully supports nesting calls to its functions from different
4324	coroutines (e.g. you can call C<ev_loop> on the same loop from two	4497	coroutines (e.g. you can call C<ev_run> on the same loop from two
4325	different coroutines, and switch freely between both coroutines running	4498	different coroutines, and switch freely between both coroutines running
4326	the loop, as long as you don't confuse yourself). The only exception is	4499	the loop, as long as you don't confuse yourself). The only exception is
4327	that you must not do this from C<ev_periodic> reschedule callbacks.	4500	that you must not do this from C<ev_periodic> reschedule callbacks.
4328		4501
4329	Care has been taken to ensure that libev does not keep local state inside	4502	Care has been taken to ensure that libev does not keep local state inside
4330	C<ev_loop>, and other calls do not usually allow for coroutine switches as	4503	C<ev_run>, and other calls do not usually allow for coroutine switches as
4331	they do not call any callbacks.	4504	they do not call any callbacks.
4332		4505
4333	=head2 COMPILER WARNINGS	4506	=head2 COMPILER WARNINGS
4334		4507
4335	Depending on your compiler and compiler settings, you might get no or a	4508	Depending on your compiler and compiler settings, you might get no or a
…		…
4346	maintainable.	4519	maintainable.
4347		4520
4348	And of course, some compiler warnings are just plain stupid, or simply	4521	And of course, some compiler warnings are just plain stupid, or simply
4349	wrong (because they don't actually warn about the condition their message	4522	wrong (because they don't actually warn about the condition their message
4350	seems to warn about). For example, certain older gcc versions had some	4523	seems to warn about). For example, certain older gcc versions had some
4351	warnings that resulted an extreme number of false positives. These have	4524	warnings that resulted in an extreme number of false positives. These have
4352	been fixed, but some people still insist on making code warn-free with	4525	been fixed, but some people still insist on making code warn-free with
4353	such buggy versions.	4526	such buggy versions.
4354		4527
4355	While libev is written to generate as few warnings as possible,	4528	While libev is written to generate as few warnings as possible,
4356	"warn-free" code is not a goal, and it is recommended not to build libev	4529	"warn-free" code is not a goal, and it is recommended not to build libev
…		…
4392	I suggest using suppression lists.	4565	I suggest using suppression lists.
4393		4566
4394		4567
4395	=head1 PORTABILITY NOTES	4568	=head1 PORTABILITY NOTES
4396		4569
		4570	=head2 GNU/LINUX 32 BIT LIMITATIONS
		4571
		4572	GNU/Linux is the only common platform that supports 64 bit file/large file
		4573	interfaces but I<disables> them by default.
		4574
		4575	That means that libev compiled in the default environment doesn't support
		4576	files larger than 2GiB or so, which mainly affects C<ev_stat> watchers.
		4577
		4578	Unfortunately, many programs try to work around this GNU/Linux issue
		4579	by enabling the large file API, which makes them incompatible with the
		4580	standard libev compiled for their system.
		4581
		4582	Likewise, libev cannot enable the large file API itself as this would
		4583	suddenly make it incompatible to the default compile time environment,
		4584	i.e. all programs not using special compile switches.
		4585
		4586	=head2 OS/X AND DARWIN BUGS
		4587
		4588	The whole thing is a bug if you ask me - basically any system interface
		4589	you touch is broken, whether it is locales, poll, kqueue or even the
		4590	OpenGL drivers.
		4591
		4592	=head3 C<kqueue> is buggy
		4593
		4594	The kqueue syscall is broken in all known versions - most versions support
		4595	only sockets, many support pipes.
		4596
		4597	Libev tries to work around this by not using C<kqueue> by default on this
		4598	rotten platform, but of course you can still ask for it when creating a
		4599	loop - embedding a socket-only kqueue loop into a select-based one is
		4600	probably going to work well.
		4601
		4602	=head3 C<poll> is buggy
		4603
		4604	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
		4605	implementation by something calling C<kqueue> internally around the 10.5.6
		4606	release, so now C<kqueue> I<and> C<poll> are broken.
		4607
		4608	Libev tries to work around this by not using C<poll> by default on
		4609	this rotten platform, but of course you can still ask for it when creating
		4610	a loop.
		4611
		4612	=head3 C<select> is buggy
		4613
		4614	All that's left is C<select>, and of course Apple found a way to fuck this
		4615	one up as well: On OS/X, C<select> actively limits the number of file
		4616	descriptors you can pass in to 1024 - your program suddenly crashes when
		4617	you use more.
		4618
		4619	There is an undocumented "workaround" for this - defining
		4620	C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should>
		4621	work on OS/X.
		4622
		4623	=head2 SOLARIS PROBLEMS AND WORKAROUNDS
		4624
		4625	=head3 C<errno> reentrancy
		4626
		4627	The default compile environment on Solaris is unfortunately so
		4628	thread-unsafe that you can't even use components/libraries compiled
		4629	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
		4630	defined by default. A valid, if stupid, implementation choice.
		4631
		4632	If you want to use libev in threaded environments you have to make sure
		4633	it's compiled with C<_REENTRANT> defined.
		4634
		4635	=head3 Event port backend
		4636
		4637	The scalable event interface for Solaris is called "event
		4638	ports". Unfortunately, this mechanism is very buggy in all major
		4639	releases. If you run into high CPU usage, your program freezes or you get
		4640	a large number of spurious wakeups, make sure you have all the relevant
		4641	and latest kernel patches applied. No, I don't know which ones, but there
		4642	are multiple ones to apply, and afterwards, event ports actually work
		4643	great.
		4644
		4645	If you can't get it to work, you can try running the program by setting
		4646	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
		4647	C<select> backends.
		4648
		4649	=head2 AIX POLL BUG
		4650
		4651	AIX unfortunately has a broken C<poll.h> header. Libev works around
		4652	this by trying to avoid the poll backend altogether (i.e. it's not even
		4653	compiled in), which normally isn't a big problem as C<select> works fine
		4654	with large bitsets on AIX, and AIX is dead anyway.
		4655
4397	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	4656	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
		4657
		4658	=head3 General issues
4398		4659
4399	Win32 doesn't support any of the standards (e.g. POSIX) that libev	4660	Win32 doesn't support any of the standards (e.g. POSIX) that libev
4400	requires, and its I/O model is fundamentally incompatible with the POSIX	4661	requires, and its I/O model is fundamentally incompatible with the POSIX
4401	model. Libev still offers limited functionality on this platform in	4662	model. Libev still offers limited functionality on this platform in
4402	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	4663	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4403	descriptors. This only applies when using Win32 natively, not when using	4664	descriptors. This only applies when using Win32 natively, not when using
4404	e.g. cygwin.	4665	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
		4666	as every compielr comes with a slightly differently broken/incompatible
		4667	environment.
4405		4668
4406	Lifting these limitations would basically require the full	4669	Lifting these limitations would basically require the full
4407	re-implementation of the I/O system. If you are into these kinds of	4670	re-implementation of the I/O system. If you are into this kind of thing,
4408	things, then note that glib does exactly that for you in a very portable	4671	then note that glib does exactly that for you in a very portable way (note
4409	way (note also that glib is the slowest event library known to man).	4672	also that glib is the slowest event library known to man).
4410		4673
4411	There is no supported compilation method available on windows except	4674	There is no supported compilation method available on windows except
4412	embedding it into other applications.	4675	embedding it into other applications.
4413		4676
4414	Sensible signal handling is officially unsupported by Microsoft - libev	4677	Sensible signal handling is officially unsupported by Microsoft - libev
…		…
4442	you do I<not> compile the F<ev.c> or any other embedded source files!):	4705	you do I<not> compile the F<ev.c> or any other embedded source files!):
4443		4706
4444	#include "evwrap.h"	4707	#include "evwrap.h"
4445	#include "ev.c"	4708	#include "ev.c"
4446		4709
4447	=over 4
4448
4449	=item The winsocket select function	4710	=head3 The winsocket C<select> function
4450		4711
4451	The winsocket C<select> function doesn't follow POSIX in that it	4712	The winsocket C<select> function doesn't follow POSIX in that it
4452	requires socket I<handles> and not socket I<file descriptors> (it is	4713	requires socket I<handles> and not socket I<file descriptors> (it is
4453	also extremely buggy). This makes select very inefficient, and also	4714	also extremely buggy). This makes select very inefficient, and also
4454	requires a mapping from file descriptors to socket handles (the Microsoft	4715	requires a mapping from file descriptors to socket handles (the Microsoft
…		…
4463	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	4724	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
4464		4725
4465	Note that winsockets handling of fd sets is O(n), so you can easily get a	4726	Note that winsockets handling of fd sets is O(n), so you can easily get a
4466	complexity in the O(n²) range when using win32.	4727	complexity in the O(n²) range when using win32.
4467		4728
4468	=item Limited number of file descriptors	4729	=head3 Limited number of file descriptors
4469		4730
4470	Windows has numerous arbitrary (and low) limits on things.	4731	Windows has numerous arbitrary (and low) limits on things.
4471		4732
4472	Early versions of winsocket's select only supported waiting for a maximum	4733	Early versions of winsocket's select only supported waiting for a maximum
4473	of C<64> handles (probably owning to the fact that all windows kernels	4734	of C<64> handles (probably owning to the fact that all windows kernels
…		…
4488	runtime libraries. This might get you to about C<512> or C<2048> sockets	4749	runtime libraries. This might get you to about C<512> or C<2048> sockets
4489	(depending on windows version and/or the phase of the moon). To get more,	4750	(depending on windows version and/or the phase of the moon). To get more,
4490	you need to wrap all I/O functions and provide your own fd management, but	4751	you need to wrap all I/O functions and provide your own fd management, but
4491	the cost of calling select (O(n²)) will likely make this unworkable.	4752	the cost of calling select (O(n²)) will likely make this unworkable.
4492		4753
4493	=back
4494
4495	=head2 PORTABILITY REQUIREMENTS	4754	=head2 PORTABILITY REQUIREMENTS
4496		4755
4497	In addition to a working ISO-C implementation and of course the	4756	In addition to a working ISO-C implementation and of course the
4498	backend-specific APIs, libev relies on a few additional extensions:	4757	backend-specific APIs, libev relies on a few additional extensions:
4499		4758
…		…
4505	Libev assumes not only that all watcher pointers have the same internal	4764	Libev assumes not only that all watcher pointers have the same internal
4506	structure (guaranteed by POSIX but not by ISO C for example), but it also	4765	structure (guaranteed by POSIX but not by ISO C for example), but it also
4507	assumes that the same (machine) code can be used to call any watcher	4766	assumes that the same (machine) code can be used to call any watcher
4508	callback: The watcher callbacks have different type signatures, but libev	4767	callback: The watcher callbacks have different type signatures, but libev
4509	calls them using an C<ev_watcher *> internally.	4768	calls them using an C<ev_watcher *> internally.
		4769
		4770	=item pointer accesses must be thread-atomic
		4771
		4772	Accessing a pointer value must be atomic, it must both be readable and
		4773	writable in one piece - this is the case on all current architectures.
4510		4774
4511	=item C<sig_atomic_t volatile> must be thread-atomic as well	4775	=item C<sig_atomic_t volatile> must be thread-atomic as well
4512		4776
4513	The type C<sig_atomic_t volatile> (or whatever is defined as	4777	The type C<sig_atomic_t volatile> (or whatever is defined as
4514	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different	4778	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
…		…
4537	watchers.	4801	watchers.
4538		4802
4539	=item C<double> must hold a time value in seconds with enough accuracy	4803	=item C<double> must hold a time value in seconds with enough accuracy
4540		4804
4541	The type C<double> is used to represent timestamps. It is required to	4805	The type C<double> is used to represent timestamps. It is required to
4542	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	4806	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4543	enough for at least into the year 4000. This requirement is fulfilled by	4807	good enough for at least into the year 4000 with millisecond accuracy
		4808	(the design goal for libev). This requirement is overfulfilled by
4544	implementations implementing IEEE 754, which is basically all existing	4809	implementations using IEEE 754, which is basically all existing ones. With
4545	ones. With IEEE 754 doubles, you get microsecond accuracy until at least	4810	IEEE 754 doubles, you get microsecond accuracy until at least 2200.
4546	2200.
4547		4811
4548	=back	4812	=back
4549		4813
4550	If you know of other additional requirements drop me a note.	4814	If you know of other additional requirements drop me a note.
4551		4815
…		…
4619	involves iterating over all running async watchers or all signal numbers.	4883	involves iterating over all running async watchers or all signal numbers.
4620		4884
4621	=back	4885	=back
4622		4886
4623		4887
		4888	=head1 PORTING FROM LIBEV 3.X TO 4.X
		4889
		4890	The major version 4 introduced some incompatible changes to the API.
		4891
		4892	At the moment, the C<ev.h> header file provides compatibility definitions
		4893	for all changes, so most programs should still compile. The compatibility
		4894	layer might be removed in later versions of libev, so better update to the
		4895	new API early than late.
		4896
		4897	=over 4
		4898
		4899	=item C<EV_COMPAT3> backwards compatibility mechanism
		4900
		4901	The backward compatibility mechanism can be controlled by
		4902	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		4903	section.
		4904
		4905	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		4906
		4907	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		4908
		4909	ev_loop_destroy (EV_DEFAULT_UC);
		4910	ev_loop_fork (EV_DEFAULT);
		4911
		4912	=item function/symbol renames
		4913
		4914	A number of functions and symbols have been renamed:
		4915
		4916	ev_loop => ev_run
		4917	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		4918	EVLOOP_ONESHOT => EVRUN_ONCE
		4919
		4920	ev_unloop => ev_break
		4921	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		4922	EVUNLOOP_ONE => EVBREAK_ONE
		4923	EVUNLOOP_ALL => EVBREAK_ALL
		4924
		4925	EV_TIMEOUT => EV_TIMER
		4926
		4927	ev_loop_count => ev_iteration
		4928	ev_loop_depth => ev_depth
		4929	ev_loop_verify => ev_verify
		4930
		4931	Most functions working on C<struct ev_loop> objects don't have an
		4932	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		4933	associated constants have been renamed to not collide with the C<struct
		4934	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		4935	as all other watcher types. Note that C<ev_loop_fork> is still called
		4936	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
		4937	typedef.
		4938
		4939	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
		4940
		4941	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
		4942	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
		4943	and work, but the library code will of course be larger.
		4944
		4945	=back
		4946
		4947
4624	=head1 GLOSSARY	4948	=head1 GLOSSARY
4625		4949
4626	=over 4	4950	=over 4
4627		4951
4628	=item active	4952	=item active
4629		4953
4630	A watcher is active as long as it has been started (has been attached to	4954	A watcher is active as long as it has been started and not yet stopped.
4631	an event loop) but not yet stopped (disassociated from the event loop).	4955	See L<WATCHER STATES> for details.
4632		4956
4633	=item application	4957	=item application
4634		4958
4635	In this document, an application is whatever is using libev.	4959	In this document, an application is whatever is using libev.
		4960
		4961	=item backend
		4962
		4963	The part of the code dealing with the operating system interfaces.
4636		4964
4637	=item callback	4965	=item callback
4638		4966
4639	The address of a function that is called when some event has been	4967	The address of a function that is called when some event has been
4640	detected. Callbacks are being passed the event loop, the watcher that	4968	detected. Callbacks are being passed the event loop, the watcher that
4641	received the event, and the actual event bitset.	4969	received the event, and the actual event bitset.
4642		4970
4643	=item callback invocation	4971	=item callback/watcher invocation
4644		4972
4645	The act of calling the callback associated with a watcher.	4973	The act of calling the callback associated with a watcher.
4646		4974
4647	=item event	4975	=item event
4648		4976
4649	A change of state of some external event, such as data now being available	4977	A change of state of some external event, such as data now being available
4650	for reading on a file descriptor, time having passed or simply not having	4978	for reading on a file descriptor, time having passed or simply not having
4651	any other events happening anymore.	4979	any other events happening anymore.
4652		4980
4653	In libev, events are represented as single bits (such as C<EV_READ> or	4981	In libev, events are represented as single bits (such as C<EV_READ> or
4654	C<EV_TIMEOUT>).	4982	C<EV_TIMER>).
4655		4983
4656	=item event library	4984	=item event library
4657		4985
4658	A software package implementing an event model and loop.	4986	A software package implementing an event model and loop.
4659		4987
…		…
4667	The model used to describe how an event loop handles and processes	4995	The model used to describe how an event loop handles and processes
4668	watchers and events.	4996	watchers and events.
4669		4997
4670	=item pending	4998	=item pending
4671		4999
4672	A watcher is pending as soon as the corresponding event has been detected,	5000	A watcher is pending as soon as the corresponding event has been
4673	and stops being pending as soon as the watcher will be invoked or its	5001	detected. See L<WATCHER STATES> for details.
4674	pending status is explicitly cleared by the application.
4675
4676	A watcher can be pending, but not active. Stopping a watcher also clears
4677	its pending status.
4678		5002
4679	=item real time	5003	=item real time
4680		5004
4681	The physical time that is observed. It is apparently strictly monotonic :)	5005	The physical time that is observed. It is apparently strictly monotonic :)
4682		5006
…		…
4689	=item watcher	5013	=item watcher
4690		5014
4691	A data structure that describes interest in certain events. Watchers need	5015	A data structure that describes interest in certain events. Watchers need
4692	to be started (attached to an event loop) before they can receive events.	5016	to be started (attached to an event loop) before they can receive events.
4693		5017
4694	=item watcher invocation
4695
4696	The act of calling the callback associated with a watcher.
4697
4698	=back	5018	=back
4699		5019
4700	=head1 AUTHOR	5020	=head1 AUTHOR
4701		5021
4702	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5022	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5023	Magnusson and Emanuele Giaquinta.
4703		5024

Diff Legend

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