ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.284 by root, Sun Mar 14 21:05:52 2010 UTC vs.
Revision 1.335 by root, Mon Oct 25 10:32:05 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
…		…
439	of course I<doesn't>, and epoll just loves to report events for totally	475	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	476	I<different> file descriptors (even already closed ones, so one cannot
441	even remove them from the set) than registered in the set (especially	477	even remove them from the set) than registered in the set (especially
442	on SMP systems). Libev tries to counter these spurious notifications by	478	on SMP systems). Libev tries to counter these spurious notifications by
443	employing an additional generation counter and comparing that against the	479	employing an additional generation counter and comparing that against the
444	events to filter out spurious ones, recreating the set when required.	480	events to filter out spurious ones, recreating the set when required. Last
		481	not least, it also refuses to work with some file descriptors which work
		482	perfectly fine with C<select> (files, many character devices...).
445		483
446	While stopping, setting and starting an I/O watcher in the same iteration	484	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	485	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	486	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	487	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,	585	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	586	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	587	here). If none are specified, all backends in C<ev_recommended_backends
550	()> will be tried.	588	()> will be tried.
551		589
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.	590	Example: Try to create a event loop that uses epoll and nothing else.
581		591
582	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	592	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
583	if (!epoller)	593	if (!epoller)
584	fatal ("no epoll found here, maybe it hides under your chair");	594	fatal ("no epoll found here, maybe it hides under your chair");
585		595
		596	Example: Use whatever libev has to offer, but make sure that kqueue is
		597	used if available.
		598
		599	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
		600
586	=item ev_default_destroy ()	601	=item ev_loop_destroy (loop)
587		602
588	Destroys the default loop again (frees all memory and kernel state	603	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	604	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	605	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>	606	responsibility to either stop all watchers cleanly yourself I<before>
592	calling this function, or cope with the fact afterwards (which is usually	607	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	608	the easiest thing, you can just ignore the watchers and/or C<free ()> them
…		…
595		610
596	Note that certain global state, such as signal state (and installed signal	611	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	612	handlers), will not be freed by this function, and related watchers (such
598	as signal and child watchers) would need to be stopped manually.	613	as signal and child watchers) would need to be stopped manually.
599		614
600	In general it is not advisable to call this function except in the	615	This function is normally used on loop objects allocated by
601	rare occasion where you really need to free e.g. the signal handling	616	C<ev_loop_new>, but it can also be used on the default loop returned by
		617	C<ev_default_loop>, in which case it is not thread-safe.
		618
		619	Note that it is not advisable to call this function on the default loop
		620	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	621	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>.	622	and C<ev_loop_destroy>.
604		623
605	=item ev_loop_destroy (loop)	624	=item ev_loop_fork (loop)
606		625
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	626	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	627	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	628	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	629	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	630	child before resuming or calling C<ev_run>.
617	functions, and it will only take effect at the next C<ev_loop> iteration.	631
		632	Again, you I<have> to call it on I<any> loop that you want to re-use after
		633	a fork, I<even if you do not plan to use the loop in the parent>. This is
		634	because some kernel interfaces *cough* I<kqueue> *cough* do funny things
		635	during fork.
618		636
619	On the other hand, you only need to call this function in the child	637	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	638	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.	639	you just fork+exec or create a new loop in the child, you don't have to
		640	call it at all (in fact, C<epoll> is so badly broken that it makes a
		641	difference, but libev will usually detect this case on its own and do a
		642	costly reset of the backend).
622		643
623	The function itself is quite fast and it's usually not a problem to call	644	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	645	it just in case after a fork.
625	quite nicely into a call to C<pthread_atfork>:
626		646
		647	Example: Automate calling C<ev_loop_fork> on the default loop when
		648	using pthreads.
		649
		650	static void
		651	post_fork_child (void)
		652	{
		653	ev_loop_fork (EV_DEFAULT);
		654	}
		655
		656	...
627	pthread_atfork (0, 0, ev_default_fork);	657	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		658
636	=item int ev_is_default_loop (loop)	659	=item int ev_is_default_loop (loop)
637		660
638	Returns true when the given loop is, in fact, the default loop, and false	661	Returns true when the given loop is, in fact, the default loop, and false
639	otherwise.	662	otherwise.
640		663
641	=item unsigned int ev_loop_count (loop)	664	=item unsigned int ev_iteration (loop)
642		665
643	Returns the count of loop iterations for the loop, which is identical to	666	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	667	to the number of times libev did poll for new events. It starts at C<0>
645	happily wraps around with enough iterations.	668	and happily wraps around with enough iterations.
646		669
647	This value can sometimes be useful as a generation counter of sorts (it	670	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	671	"ticks" the number of loop iterations), as it roughly corresponds with
649	C<ev_prepare> and C<ev_check> calls.	672	C<ev_prepare> and C<ev_check> calls - and is incremented between the
		673	prepare and check phases.
650		674
651	=item unsigned int ev_loop_depth (loop)	675	=item unsigned int ev_depth (loop)
652		676
653	Returns the number of times C<ev_loop> was entered minus the number of	677	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.	678	times C<ev_run> was exited, in other words, the recursion depth.
655		679
656	Outside C<ev_loop>, this number is zero. In a callback, this number is	680	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),	681	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
658	in which case it is higher.	682	in which case it is higher.
659		683
660	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread	684	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread
661	etc.), doesn't count as exit.	685	etc.), doesn't count as "exit" - consider this as a hint to avoid such
		686	ungentleman-like behaviour unless it's really convenient.
662		687
663	=item unsigned int ev_backend (loop)	688	=item unsigned int ev_backend (loop)
664		689
665	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	690	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
666	use.	691	use.
…		…
675		700
676	=item ev_now_update (loop)	701	=item ev_now_update (loop)
677		702
678	Establishes the current time by querying the kernel, updating the time	703	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	704	returned by C<ev_now ()> in the progress. This is a costly operation and
680	is usually done automatically within C<ev_loop ()>.	705	is usually done automatically within C<ev_run ()>.
681		706
682	This function is rarely useful, but when some event callback runs for a	707	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	708	very long time without entering the event loop, updating libev's idea of
684	the current time is a good idea.	709	the current time is a good idea.
685		710
…		…
687		712
688	=item ev_suspend (loop)	713	=item ev_suspend (loop)
689		714
690	=item ev_resume (loop)	715	=item ev_resume (loop)
691		716
692	These two functions suspend and resume a loop, for use when the loop is	717	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.	718	loop is not used for a while and timeouts should not be processed.
694		719
695	A typical use case would be an interactive program such as a game: When	720	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	721	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	722	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>	723	the program was suspended. This can be achieved by calling C<ev_suspend>
…		…
700	C<ev_resume> directly afterwards to resume timer processing.	725	C<ev_resume> directly afterwards to resume timer processing.
701		726
702	Effectively, all C<ev_timer> watchers will be delayed by the time spend	727	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	728	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	729	will be rescheduled (that is, they will lose any events that would have
705	occured while suspended).	730	occurred while suspended).
706		731
707	After calling C<ev_suspend> you B<must not> call I<any> function on the	732	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>	733	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>.	734	without a previous call to C<ev_suspend>.
710		735
711	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the	736	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
712	event loop time (see C<ev_now_update>).	737	event loop time (see C<ev_now_update>).
713		738
714	=item ev_loop (loop, int flags)	739	=item ev_run (loop, int flags)
715		740
716	Finally, this is it, the event handler. This function usually is called	741	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	742	after you have initialised all your watchers and you want to start
718	handling events.	743	handling events. It will ask the operating system for any new events, call
		744	the watcher callbacks, an then repeat the whole process indefinitely: This
		745	is why event loops are called I<loops>.
719		746
720	If the flags argument is specified as C<0>, it will not return until	747	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.	748	until either no event watchers are active anymore or C<ev_break> was
		749	called.
722		750
723	Please note that an explicit C<ev_unloop> is usually better than	751	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	752	relying on all watchers to be stopped when deciding when a program has
725	finished (especially in interactive programs), but having a program	753	finished (especially in interactive programs), but having a program
726	that automatically loops as long as it has to and no longer by virtue	754	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	755	of relying on its watchers stopping correctly, that is truly a thing of
728	beauty.	756	beauty.
729		757
730	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	758	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	759	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	760	block your process in case there are no events and will return after one
733	the loop.	761	iteration of the loop. This is sometimes useful to poll and handle new
		762	events while doing lengthy calculations, to keep the program responsive.
734		763
735	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	764	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	765	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	766	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	767	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	768	user-registered callback will be called), and will return after one
740	iteration of the loop.	769	iteration of the loop.
741		770
742	This is useful if you are waiting for some external event in conjunction	771	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	772	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	773	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.	774	usually a better approach for this kind of thing.
746		775
747	Here are the gory details of what C<ev_loop> does:	776	Here are the gory details of what C<ev_run> does:
748		777
		778	- Increment loop depth.
		779	- Reset the ev_break status.
749	- Before the first iteration, call any pending watchers.	780	- Before the first iteration, call any pending watchers.
		781	LOOP:
750	* If EVFLAG_FORKCHECK was used, check for a fork.	782	- If EVFLAG_FORKCHECK was used, check for a fork.
751	- If a fork was detected (by any means), queue and call all fork watchers.	783	- If a fork was detected (by any means), queue and call all fork watchers.
752	- Queue and call all prepare watchers.	784	- Queue and call all prepare watchers.
		785	- If ev_break was called, goto FINISH.
753	- If we have been forked, detach and recreate the kernel state	786	- If we have been forked, detach and recreate the kernel state
754	as to not disturb the other process.	787	as to not disturb the other process.
755	- Update the kernel state with all outstanding changes.	788	- Update the kernel state with all outstanding changes.
756	- Update the "event loop time" (ev_now ()).	789	- Update the "event loop time" (ev_now ()).
757	- Calculate for how long to sleep or block, if at all	790	- Calculate for how long to sleep or block, if at all
758	(active idle watchers, EVLOOP_NONBLOCK or not having	791	(active idle watchers, EVRUN_NOWAIT or not having
759	any active watchers at all will result in not sleeping).	792	any active watchers at all will result in not sleeping).
760	- Sleep if the I/O and timer collect interval say so.	793	- Sleep if the I/O and timer collect interval say so.
		794	- Increment loop iteration counter.
761	- Block the process, waiting for any events.	795	- Block the process, waiting for any events.
762	- Queue all outstanding I/O (fd) events.	796	- Queue all outstanding I/O (fd) events.
763	- Update the "event loop time" (ev_now ()), and do time jump adjustments.	797	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
764	- Queue all expired timers.	798	- Queue all expired timers.
765	- Queue all expired periodics.	799	- Queue all expired periodics.
766	- Unless any events are pending now, queue all idle watchers.	800	- Queue all idle watchers with priority higher than that of pending events.
767	- Queue all check watchers.	801	- Queue all check watchers.
768	- Call all queued watchers in reverse order (i.e. check watchers first).	802	- 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	803	Signals and child watchers are implemented as I/O watchers, and will
770	be handled here by queueing them when their watcher gets executed.	804	be handled here by queueing them when their watcher gets executed.
771	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	805	- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
772	were used, or there are no active watchers, return, otherwise	806	were used, or there are no active watchers, goto FINISH, otherwise
773	continue with step *.	807	continue with step LOOP.
		808	FINISH:
		809	- Reset the ev_break status iff it was EVBREAK_ONE.
		810	- Decrement the loop depth.
		811	- Return.
774		812
775	Example: Queue some jobs and then loop until no events are outstanding	813	Example: Queue some jobs and then loop until no events are outstanding
776	anymore.	814	anymore.
777		815
778	... queue jobs here, make sure they register event watchers as long	816	... 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..)	817	... as they still have work to do (even an idle watcher will do..)
780	ev_loop (my_loop, 0);	818	ev_run (my_loop, 0);
781	... jobs done or somebody called unloop. yeah!	819	... jobs done or somebody called unloop. yeah!
782		820
783	=item ev_unloop (loop, how)	821	=item ev_break (loop, how)
784		822
785	Can be used to make a call to C<ev_loop> return early (but only after it	823	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	824	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	825	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.	826	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
789		827
790	This "unloop state" will be cleared when entering C<ev_loop> again.	828	This "unloop state" will be cleared when entering C<ev_run> again.
791		829
792	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.	830	It is safe to call C<ev_break> from outside any C<ev_run> calls. ##TODO##
793		831
794	=item ev_ref (loop)	832	=item ev_ref (loop)
795		833
796	=item ev_unref (loop)	834	=item ev_unref (loop)
797		835
798	Ref/unref can be used to add or remove a reference count on the event	836	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	837	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.	838	count is nonzero, C<ev_run> will not return on its own.
801		839
802	This is useful when you have a watcher that you never intend to	840	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	841	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>	842	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
805	before stopping it.	843	before stopping it.
806		844
807	As an example, libev itself uses this for its internal signal pipe: It	845	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	846	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	847	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	848	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	849	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	850	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	851	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>	852	(e.g. non-repeating timers) in which case you have to C<ev_ref>
815	in the callback).	853	in the callback).
816		854
817	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	855	Example: Create a signal watcher, but keep it from keeping C<ev_run>
818	running when nothing else is active.	856	running when nothing else is active.
819		857
820	ev_signal exitsig;	858	ev_signal exitsig;
821	ev_signal_init (&exitsig, sig_cb, SIGINT);	859	ev_signal_init (&exitsig, sig_cb, SIGINT);
822	ev_signal_start (loop, &exitsig);	860	ev_signal_start (loop, &exitsig);
…		…
867	usually doesn't make much sense to set it to a lower value than C<0.01>,	905	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	906	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	907	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	908	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,	909	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).	910	then you can't do more than 100 transactions per second).
873		911
874	Setting the I<timeout collect interval> can improve the opportunity for	912	Setting the I<timeout collect interval> can improve the opportunity for
875	saving power, as the program will "bundle" timer callback invocations that	913	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	914	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	915	times the process sleeps and wakes up again. Another useful technique to
…		…
885	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);	923	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
886		924
887	=item ev_invoke_pending (loop)	925	=item ev_invoke_pending (loop)
888		926
889	This call will simply invoke all pending watchers while resetting their	927	This call will simply invoke all pending watchers while resetting their
890	pending state. Normally, C<ev_loop> does this automatically when required,	928	pending state. Normally, C<ev_run> does this automatically when required,
891	but when overriding the invoke callback this call comes handy.	929	but when overriding the invoke callback this call comes handy. This
		930	function can be invoked from a watcher - this can be useful for example
		931	when you want to do some lengthy calculation and want to pass further
		932	event handling to another thread (you still have to make sure only one
		933	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
892		934
893	=item int ev_pending_count (loop)	935	=item int ev_pending_count (loop)
894		936
895	Returns the number of pending watchers - zero indicates that no watchers	937	Returns the number of pending watchers - zero indicates that no watchers
896	are pending.	938	are pending.
897		939
898	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))	940	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
899		941
900	This overrides the invoke pending functionality of the loop: Instead of	942	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	943	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	944	this callback instead. This is useful, for example, when you want to
903	invoke the actual watchers inside another context (another thread etc.).	945	invoke the actual watchers inside another context (another thread etc.).
904		946
905	If you want to reset the callback, use C<ev_invoke_pending> as new	947	If you want to reset the callback, use C<ev_invoke_pending> as new
906	callback.	948	callback.
…		…
909		951
910	Sometimes you want to share the same loop between multiple threads. This	952	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	953	can be done relatively simply by putting mutex_lock/unlock calls around
912	each call to a libev function.	954	each call to a libev function.
913		955
914	However, C<ev_loop> can run an indefinite time, so it is not feasible to	956	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	957	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>	958	loop via C<ev_break> and C<av_async_send>, another way is to set these
917	and I<acquire> callbacks on the loop.	959	I<release> and I<acquire> callbacks on the loop.
918		960
919	When set, then C<release> will be called just before the thread is	961	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	962	suspended waiting for new events, and C<acquire> is called just
921	afterwards.	963	afterwards.
922		964
…		…
925		967
926	While event loop modifications are allowed between invocations of	968	While event loop modifications are allowed between invocations of
927	C<release> and C<acquire> (that's their only purpose after all), no	969	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	970	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	971	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	972	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.	973	to take note of any changes you made.
932		974
933	In theory, threads executing C<ev_loop> will be async-cancel safe between	975	In theory, threads executing C<ev_run> will be async-cancel safe between
934	invocations of C<release> and C<acquire>.	976	invocations of C<release> and C<acquire>.
935		977
936	See also the locking example in the C<THREADS> section later in this	978	See also the locking example in the C<THREADS> section later in this
937	document.	979	document.
938		980
…		…
947	These two functions can be used to associate arbitrary data with a loop,	989	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	990	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	991	C<acquire> callbacks described above, but of course can be (ab-)used for
950	any other purpose as well.	992	any other purpose as well.
951		993
952	=item ev_loop_verify (loop)	994	=item ev_verify (loop)
953		995
954	This function only does something when C<EV_VERIFY> support has been	996	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	997	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	998	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	999	is found to be inconsistent, it will print an error message to standard
…		…
968		1010
969	In the following description, uppercase C<TYPE> in names stands for the	1011	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	1012	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.	1013	watchers and C<ev_io_start> for I/O watchers.
972		1014
973	A watcher is a structure that you create and register to record your	1015	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	1016	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:	1017	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1018	for that:
976		1019
977	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)	1020	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
978	{	1021	{
979	ev_io_stop (w);	1022	ev_io_stop (w);
980	ev_unloop (loop, EVUNLOOP_ALL);	1023	ev_break (loop, EVBREAK_ALL);
981	}	1024	}
982		1025
983	struct ev_loop *loop = ev_default_loop (0);	1026	struct ev_loop *loop = ev_default_loop (0);
984		1027
985	ev_io stdin_watcher;	1028	ev_io stdin_watcher;
986		1029
987	ev_init (&stdin_watcher, my_cb);	1030	ev_init (&stdin_watcher, my_cb);
988	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1031	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
989	ev_io_start (loop, &stdin_watcher);	1032	ev_io_start (loop, &stdin_watcher);
990		1033
991	ev_loop (loop, 0);	1034	ev_run (loop, 0);
992		1035
993	As you can see, you are responsible for allocating the memory for your	1036	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	1037	watcher structures (and it is I<usually> a bad idea to do this on the
995	stack).	1038	stack).
996		1039
997	Each watcher has an associated watcher structure (called C<struct ev_TYPE>	1040	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).	1041	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
999		1042
1000	Each watcher structure must be initialised by a call to C<ev_init	1043	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	1044	*, 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	1045	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	1046	time the event loop detects that the file descriptor given is readable
1004	is readable and/or writable).	1047	and/or writable).
1005		1048
1006	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>	1049	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	1050	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<<	1051	is also a macro to combine initialisation and setting in one call: C<<
1009	ev_TYPE_init (watcher *, callback, ...) >>.	1052	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
1032	=item C<EV_WRITE>	1075	=item C<EV_WRITE>
1033		1076
1034	The file descriptor in the C<ev_io> watcher has become readable and/or	1077	The file descriptor in the C<ev_io> watcher has become readable and/or
1035	writable.	1078	writable.
1036		1079
1037	=item C<EV_TIMEOUT>	1080	=item C<EV_TIMER>
1038		1081
1039	The C<ev_timer> watcher has timed out.	1082	The C<ev_timer> watcher has timed out.
1040		1083
1041	=item C<EV_PERIODIC>	1084	=item C<EV_PERIODIC>
1042		1085
…		…
1060		1103
1061	=item C<EV_PREPARE>	1104	=item C<EV_PREPARE>
1062		1105
1063	=item C<EV_CHECK>	1106	=item C<EV_CHECK>
1064		1107
1065	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts	1108	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	1109	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	1110	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	1111	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	1112	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	1113	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
1071	C<ev_loop> from blocking).	1114	C<ev_run> from blocking).
1072		1115
1073	=item C<EV_EMBED>	1116	=item C<EV_EMBED>
1074		1117
1075	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1118	The embedded event loop specified in the C<ev_embed> watcher needs attention.
1076		1119
1077	=item C<EV_FORK>	1120	=item C<EV_FORK>
1078		1121
1079	The event loop has been resumed in the child process after fork (see	1122	The event loop has been resumed in the child process after fork (see
1080	C<ev_fork>).	1123	C<ev_fork>).
		1124
		1125	=item C<EV_CLEANUP>
		1126
		1127	The event loop is about to be destroyed (see C<ev_cleanup>).
1081		1128
1082	=item C<EV_ASYNC>	1129	=item C<EV_ASYNC>
1083		1130
1084	The given async watcher has been asynchronously notified (see C<ev_async>).	1131	The given async watcher has been asynchronously notified (see C<ev_async>).
1085		1132
…		…
1257		1304
1258	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related	1305	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1259	functions that do not need a watcher.	1306	functions that do not need a watcher.
1260		1307
1261	=back	1308	=back
1262
1263		1309
1264	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1310	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
1265		1311
1266	Each watcher has, by default, a member C<void *data> that you can change	1312	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	1313	and read at any time: libev will completely ignore it. This can be used
…		…
1323	t2_cb (EV_P_ ev_timer *w, int revents)	1369	t2_cb (EV_P_ ev_timer *w, int revents)
1324	{	1370	{
1325	struct my_biggy big = (struct my_biggy *)	1371	struct my_biggy big = (struct my_biggy *)
1326	(((char *)w) - offsetof (struct my_biggy, t2));	1372	(((char *)w) - offsetof (struct my_biggy, t2));
1327	}	1373	}
		1374
		1375	=head2 WATCHER STATES
		1376
		1377	There are various watcher states mentioned throughout this manual -
		1378	active, pending and so on. In this section these states and the rules to
		1379	transition between them will be described in more detail - and while these
		1380	rules might look complicated, they usually do "the right thing".
		1381
		1382	=over 4
		1383
		1384	=item initialiased
		1385
		1386	Before a watcher can be registered with the event looop it has to be
		1387	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1388	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
		1389
		1390	In this state it is simply some block of memory that is suitable for use
		1391	in an event loop. It can be moved around, freed, reused etc. at will.
		1392
		1393	=item started/running/active
		1394
		1395	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
		1396	property of the event loop, and is actively waiting for events. While in
		1397	this state it cannot be accessed (except in a few documented ways), moved,
		1398	freed or anything else - the only legal thing is to keep a pointer to it,
		1399	and call libev functions on it that are documented to work on active watchers.
		1400
		1401	=item pending
		1402
		1403	If a watcher is active and libev determines that an event it is interested
		1404	in has occurred (such as a timer expiring), it will become pending. It will
		1405	stay in this pending state until either it is stopped or its callback is
		1406	about to be invoked, so it is not normally pending inside the watcher
		1407	callback.
		1408
		1409	The watcher might or might not be active while it is pending (for example,
		1410	an expired non-repeating timer can be pending but no longer active). If it
		1411	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1412	but it is still property of the event loop at this time, so cannot be
		1413	moved, freed or reused. And if it is active the rules described in the
		1414	previous item still apply.
		1415
		1416	It is also possible to feed an event on a watcher that is not active (e.g.
		1417	via C<ev_feed_event>), in which case it becomes pending without being
		1418	active.
		1419
		1420	=item stopped
		1421
		1422	A watcher can be stopped implicitly by libev (in which case it might still
		1423	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
		1424	latter will clear any pending state the watcher might be in, regardless
		1425	of whether it was active or not, so stopping a watcher explicitly before
		1426	freeing it is often a good idea.
		1427
		1428	While stopped (and not pending) the watcher is essentially in the
		1429	initialised state, that is it can be reused, moved, modified in any way
		1430	you wish.
		1431
		1432	=back
1328		1433
1329	=head2 WATCHER PRIORITY MODELS	1434	=head2 WATCHER PRIORITY MODELS
1330		1435
1331	Many event loops support I<watcher priorities>, which are usually small	1436	Many event loops support I<watcher priorities>, which are usually small
1332	integers that influence the ordering of event callback invocation	1437	integers that influence the ordering of event callback invocation
…		…
1375		1480
1376	For example, to emulate how many other event libraries handle priorities,	1481	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	1482	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	1483	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	1484	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	1485	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	1486	the lock-out case is known to be rare (which in turn is rare :), this is
1382	workable.	1487	workable.
1383		1488
1384	Usually, however, the lock-out model implemented that way will perform	1489	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,	1490	miserably under the type of load it was designed to handle. In that case,
…		…
1399	{	1504	{
1400	// stop the I/O watcher, we received the event, but	1505	// stop the I/O watcher, we received the event, but
1401	// are not yet ready to handle it.	1506	// are not yet ready to handle it.
1402	ev_io_stop (EV_A_ w);	1507	ev_io_stop (EV_A_ w);
1403		1508
1404	// start the idle watcher to ahndle the actual event.	1509	// start the idle watcher to handle the actual event.
1405	// it will not be executed as long as other watchers	1510	// it will not be executed as long as other watchers
1406	// with the default priority are receiving events.	1511	// with the default priority are receiving events.
1407	ev_idle_start (EV_A_ &idle);	1512	ev_idle_start (EV_A_ &idle);
1408	}	1513	}
1409		1514
…		…
1463		1568
1464	If you cannot use non-blocking mode, then force the use of a	1569	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	1570	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	1571	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1467	descriptors for which non-blocking operation makes no sense (such as	1572	descriptors for which non-blocking operation makes no sense (such as
1468	files) - libev doesn't guarentee any specific behaviour in that case.	1573	files) - libev doesn't guarantee any specific behaviour in that case.
1469		1574
1470	Another thing you have to watch out for is that it is quite easy to	1575	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	1576	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	1577	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	1578	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).	1646	somewhere, as that would have given you a big clue).
1542		1647
1543	=head3 The special problem of accept()ing when you can't	1648	=head3 The special problem of accept()ing when you can't
1544		1649
1545	Many implementations of the POSIX C<accept> function (for example,	1650	Many implementations of the POSIX C<accept> function (for example,
1546	found in port-2004 Linux) have the peculiar behaviour of not removing a	1651	found in post-2004 Linux) have the peculiar behaviour of not removing a
1547	connection from the pending queue in all error cases.	1652	connection from the pending queue in all error cases.
1548		1653
1549	For example, larger servers often run out of file descriptors (because	1654	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	1655	of resource limits), causing C<accept> to fail with C<ENFILE> but not
1551	rejecting the connection, leading to libev signalling readiness on	1656	rejecting the connection, leading to libev signalling readiness on
…		…
1617	...	1722	...
1618	struct ev_loop *loop = ev_default_init (0);	1723	struct ev_loop *loop = ev_default_init (0);
1619	ev_io stdin_readable;	1724	ev_io stdin_readable;
1620	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1725	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1621	ev_io_start (loop, &stdin_readable);	1726	ev_io_start (loop, &stdin_readable);
1622	ev_loop (loop, 0);	1727	ev_run (loop, 0);
1623		1728
1624		1729
1625	=head2 C<ev_timer> - relative and optionally repeating timeouts	1730	=head2 C<ev_timer> - relative and optionally repeating timeouts
1626		1731
1627	Timer watchers are simple relative timers that generate an event after a	1732	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	1741	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	1742	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	1743	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	1744	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	1745	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).	1746	no longer true when a callback calls C<ev_run> recursively).
1642		1747
1643	=head3 Be smart about timeouts	1748	=head3 Be smart about timeouts
1644		1749
1645	Many real-world problems involve some kind of timeout, usually for error	1750	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,	1751	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1732	ev_tstamp timeout = last_activity + 60.;	1837	ev_tstamp timeout = last_activity + 60.;
1733		1838
1734	// if last_activity + 60. is older than now, we did time out	1839	// if last_activity + 60. is older than now, we did time out
1735	if (timeout < now)	1840	if (timeout < now)
1736	{	1841	{
1737	// timeout occured, take action	1842	// timeout occurred, take action
1738	}	1843	}
1739	else	1844	else
1740	{	1845	{
1741	// callback was invoked, but there was some activity, re-arm	1846	// callback was invoked, but there was some activity, re-arm
1742	// the watcher to fire in last_activity + 60, which is	1847	// the watcher to fire in last_activity + 60, which is
…		…
1764	to the current time (meaning we just have some activity :), then call the	1869	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:	1870	callback, which will "do the right thing" and start the timer:
1766		1871
1767	ev_init (timer, callback);	1872	ev_init (timer, callback);
1768	last_activity = ev_now (loop);	1873	last_activity = ev_now (loop);
1769	callback (loop, timer, EV_TIMEOUT);	1874	callback (loop, timer, EV_TIMER);
1770		1875
1771	And when there is some activity, simply store the current time in	1876	And when there is some activity, simply store the current time in
1772	C<last_activity>, no libev calls at all:	1877	C<last_activity>, no libev calls at all:
1773		1878
1774	last_actiivty = ev_now (loop);	1879	last_activity = ev_now (loop);
1775		1880
1776	This technique is slightly more complex, but in most cases where the	1881	This technique is slightly more complex, but in most cases where the
1777	time-out is unlikely to be triggered, much more efficient.	1882	time-out is unlikely to be triggered, much more efficient.
1778		1883
1779	Changing the timeout is trivial as well (if it isn't hard-coded in the	1884	Changing the timeout is trivial as well (if it isn't hard-coded in the
…		…
1817		1922
1818	=head3 The special problem of time updates	1923	=head3 The special problem of time updates
1819		1924
1820	Establishing the current time is a costly operation (it usually takes at	1925	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	1926	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	1927	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	1928	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1824	lots of events in one iteration.	1929	lots of events in one iteration.
1825		1930
1826	The relative timeouts are calculated relative to the C<ev_now ()>	1931	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	1932	time. This is usually the right thing as this timestamp refers to the time
…		…
1944	}	2049	}
1945		2050
1946	ev_timer mytimer;	2051	ev_timer mytimer;
1947	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	2052	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1948	ev_timer_again (&mytimer); /* start timer */	2053	ev_timer_again (&mytimer); /* start timer */
1949	ev_loop (loop, 0);	2054	ev_run (loop, 0);
1950		2055
1951	// and in some piece of code that gets executed on any "activity":	2056	// and in some piece of code that gets executed on any "activity":
1952	// reset the timeout to start ticking again at 10 seconds	2057	// reset the timeout to start ticking again at 10 seconds
1953	ev_timer_again (&mytimer);	2058	ev_timer_again (&mytimer);
1954		2059
…		…
1980		2085
1981	As with timers, the callback is guaranteed to be invoked only when the	2086	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	2087	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	2088	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	2089	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).	2090	(but this is no longer true when a callback calls C<ev_run> recursively).
1986		2091
1987	=head3 Watcher-Specific Functions and Data Members	2092	=head3 Watcher-Specific Functions and Data Members
1988		2093
1989	=over 4	2094	=over 4
1990		2095
…		…
2118	Example: Call a callback every hour, or, more precisely, whenever the	2223	Example: Call a callback every hour, or, more precisely, whenever the
2119	system time is divisible by 3600. The callback invocation times have	2224	system time is divisible by 3600. The callback invocation times have
2120	potentially a lot of jitter, but good long-term stability.	2225	potentially a lot of jitter, but good long-term stability.
2121		2226
2122	static void	2227	static void
2123	clock_cb (struct ev_loop *loop, ev_io *w, int revents)	2228	clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
2124	{	2229	{
2125	... its now a full hour (UTC, or TAI or whatever your clock follows)	2230	... its now a full hour (UTC, or TAI or whatever your clock follows)
2126	}	2231	}
2127		2232
2128	ev_periodic hourly_tick;	2233	ev_periodic hourly_tick;
…		…
2228	Example: Try to exit cleanly on SIGINT.	2333	Example: Try to exit cleanly on SIGINT.
2229		2334
2230	static void	2335	static void
2231	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)	2336	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2232	{	2337	{
2233	ev_unloop (loop, EVUNLOOP_ALL);	2338	ev_break (loop, EVBREAK_ALL);
2234	}	2339	}
2235		2340
2236	ev_signal signal_watcher;	2341	ev_signal signal_watcher;
2237	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2342	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2238	ev_signal_start (loop, &signal_watcher);	2343	ev_signal_start (loop, &signal_watcher);
…		…
2624		2729
2625	Prepare and check watchers are usually (but not always) used in pairs:	2730	Prepare and check watchers are usually (but not always) used in pairs:
2626	prepare watchers get invoked before the process blocks and check watchers	2731	prepare watchers get invoked before the process blocks and check watchers
2627	afterwards.	2732	afterwards.
2628		2733
2629	You I<must not> call C<ev_loop> or similar functions that enter	2734	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>	2735	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	2736	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	2737	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,	2738	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	2739	C<ev_check> so if you have one watcher of each kind they will always be
…		…
2802		2907
2803	if (timeout >= 0)	2908	if (timeout >= 0)
2804	// create/start timer	2909	// create/start timer
2805		2910
2806	// poll	2911	// poll
2807	ev_loop (EV_A_ 0);	2912	ev_run (EV_A_ 0);
2808		2913
2809	// stop timer again	2914	// stop timer again
2810	if (timeout >= 0)	2915	if (timeout >= 0)
2811	ev_timer_stop (EV_A_ &to);	2916	ev_timer_stop (EV_A_ &to);
2812		2917
…		…
2890	if you do not want that, you need to temporarily stop the embed watcher).	2995	if you do not want that, you need to temporarily stop the embed watcher).
2891		2996
2892	=item ev_embed_sweep (loop, ev_embed *)	2997	=item ev_embed_sweep (loop, ev_embed *)
2893		2998
2894	Make a single, non-blocking sweep over the embedded loop. This works	2999	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	3000	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2896	appropriate way for embedded loops.	3001	appropriate way for embedded loops.
2897		3002
2898	=item struct ev_loop *other [read-only]	3003	=item struct ev_loop *other [read-only]
2899		3004
2900	The embedded event loop.	3005	The embedded event loop.
…		…
2960	C<ev_default_fork> cheats and calls it in the wrong process, the fork	3065	C<ev_default_fork> cheats and calls it in the wrong process, the fork
2961	handlers will be invoked, too, of course.	3066	handlers will be invoked, too, of course.
2962		3067
2963	=head3 The special problem of life after fork - how is it possible?	3068	=head3 The special problem of life after fork - how is it possible?
2964		3069
2965	Most uses of C<fork()> consist of forking, then some simple calls to ste	3070	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	3071	up/change the process environment, followed by a call to C<exec()>. This
2967	sequence should be handled by libev without any problems.	3072	sequence should be handled by libev without any problems.
2968		3073
2969	This changes when the application actually wants to do event handling	3074	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	3075	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	3091	disadvantage of having to use multiple event loops (which do not support
2987	signal watchers).	3092	signal watchers).
2988		3093
2989	When this is not possible, or you want to use the default loop for	3094	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	3095	other reasons, then in the process that wants to start "fresh", call
2991	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3096	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	3097	Destroying the default loop will "orphan" (not stop) all registered
2993	have to be careful not to execute code that modifies those watchers. Note	3098	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.	3099	those watchers. Note also that in that case, you have to re-register any
		3100	signal watchers.
2995		3101
2996	=head3 Watcher-Specific Functions and Data Members	3102	=head3 Watcher-Specific Functions and Data Members
2997		3103
2998	=over 4	3104	=over 4
2999		3105
3000	=item ev_fork_init (ev_signal *, callback)	3106	=item ev_fork_init (ev_fork *, callback)
3001		3107
3002	Initialises and configures the fork watcher - it has no parameters of any	3108	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,	3109	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
3004	believe me.	3110	really.
3005		3111
3006	=back	3112	=back
3007		3113
3008		3114
		3115	=head2 C<ev_cleanup> - even the best things end
		3116
		3117	Cleanup watchers are called just before the event loop is being destroyed
		3118	by a call to C<ev_loop_destroy>.
		3119
		3120	While there is no guarantee that the event loop gets destroyed, cleanup
		3121	watchers provide a convenient method to install cleanup hooks for your
		3122	program, worker threads and so on - you just to make sure to destroy the
		3123	loop when you want them to be invoked.
		3124
		3125	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3126	all other watchers, they do not keep a reference to the event loop (which
		3127	makes a lot of sense if you think about it). Like all other watchers, you
		3128	can call libev functions in the callback, except C<ev_cleanup_start>.
		3129
		3130	=head3 Watcher-Specific Functions and Data Members
		3131
		3132	=over 4
		3133
		3134	=item ev_cleanup_init (ev_cleanup *, callback)
		3135
		3136	Initialises and configures the cleanup watcher - it has no parameters of
		3137	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3138	pointless, I assure you.
		3139
		3140	=back
		3141
		3142	Example: Register an atexit handler to destroy the default loop, so any
		3143	cleanup functions are called.
		3144
		3145	static void
		3146	program_exits (void)
		3147	{
		3148	ev_loop_destroy (EV_DEFAULT_UC);
		3149	}
		3150
		3151	...
		3152	atexit (program_exits);
		3153
		3154
3009	=head2 C<ev_async> - how to wake up another event loop	3155	=head2 C<ev_async> - how to wake up an event loop
3010		3156
3011	In general, you cannot use an C<ev_loop> from multiple threads or other	3157	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	3158	asynchronous sources such as signal handlers (as opposed to multiple event
3013	loops - those are of course safe to use in different threads).	3159	loops - those are of course safe to use in different threads).
3014		3160
3015	Sometimes, however, you need to wake up another event loop you do not	3161	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	3162	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	3163	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	3164	it by calling C<ev_async_send>, which is thread- and signal safe.
3019	safe.
3020		3165
3021	This functionality is very similar to C<ev_signal> watchers, as signals,	3166	This functionality is very similar to C<ev_signal> watchers, as signals,
3022	too, are asynchronous in nature, and signals, too, will be compressed	3167	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	3168	(i.e. the number of callback invocations may be less than the number of
3024	C<ev_async_sent> calls).	3169	C<ev_async_sent> calls).
…		…
3179		3324
3180	If C<timeout> is less than 0, then no timeout watcher will be	3325	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	3326	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
3182	repeat = 0) will be started. C<0> is a valid timeout.	3327	repeat = 0) will be started. C<0> is a valid timeout.
3183		3328
3184	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	3329	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	3330	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>	3331	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>	3332	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	3333	a timeout and an io event at the same time - you probably should give io
3189	events precedence.	3334	events precedence.
3190		3335
3191	Example: wait up to ten seconds for data to appear on STDIN_FILENO.	3336	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
3192		3337
3193	static void stdin_ready (int revents, void *arg)	3338	static void stdin_ready (int revents, void *arg)
3194	{	3339	{
3195	if (revents & EV_READ)	3340	if (revents & EV_READ)
3196	/* stdin might have data for us, joy! */;	3341	/* stdin might have data for us, joy! */;
3197	else if (revents & EV_TIMEOUT)	3342	else if (revents & EV_TIMER)
3198	/* doh, nothing entered */;	3343	/* doh, nothing entered */;
3199	}	3344	}
3200		3345
3201	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3346	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3202		3347
…		…
3336	myclass obj;	3481	myclass obj;
3337	ev::io iow;	3482	ev::io iow;
3338	iow.set <myclass, &myclass::io_cb> (&obj);	3483	iow.set <myclass, &myclass::io_cb> (&obj);
3339		3484
3340	=item w->set (object *)	3485	=item w->set (object *)
3341
3342	This is an B<experimental> feature that might go away in a future version.
3343		3486
3344	This is a variation of a method callback - leaving out the method to call	3487	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	3488	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	3489	functor objects without having to manually specify the C<operator ()> all
3347	the time. Incidentally, you can then also leave out the template argument	3490	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	3530	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).	3531	do this when the watcher is inactive (and not pending either).
3389		3532
3390	=item w->set ([arguments])	3533	=item w->set ([arguments])
3391		3534
3392	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be	3535	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	3536	method or a suitable start method must be called at least once. Unlike the
3394	automatically stopped and restarted when reconfiguring it with this	3537	C counterpart, an active watcher gets automatically stopped and restarted
3395	method.	3538	when reconfiguring it with this method.
3396		3539
3397	=item w->start ()	3540	=item w->start ()
3398		3541
3399	Starts the watcher. Note that there is no C<loop> argument, as the	3542	Starts the watcher. Note that there is no C<loop> argument, as the
3400	constructor already stores the event loop.	3543	constructor already stores the event loop.
3401		3544
		3545	=item w->start ([arguments])
		3546
		3547	Instead of calling C<set> and C<start> methods separately, it is often
		3548	convenient to wrap them in one call. Uses the same type of arguments as
		3549	the configure C<set> method of the watcher.
		3550
3402	=item w->stop ()	3551	=item w->stop ()
3403		3552
3404	Stops the watcher if it is active. Again, no C<loop> argument.	3553	Stops the watcher if it is active. Again, no C<loop> argument.
3405		3554
3406	=item w->again () (C<ev::timer>, C<ev::periodic> only)	3555	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
3418		3567
3419	=back	3568	=back
3420		3569
3421	=back	3570	=back
3422		3571
3423	Example: Define a class with an IO and idle watcher, start one of them in	3572	Example: Define a class with two I/O and idle watchers, start the I/O
3424	the constructor.	3573	watchers in the constructor.
3425		3574
3426	class myclass	3575	class myclass
3427	{	3576	{
3428	ev::io io ; void io_cb (ev::io &w, int revents);	3577	ev::io io ; void io_cb (ev::io &w, int revents);
		3578	ev::io2 io2 ; void io2_cb (ev::io &w, int revents);
3429	ev::idle idle; void idle_cb (ev::idle &w, int revents);	3579	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3430		3580
3431	myclass (int fd)	3581	myclass (int fd)
3432	{	3582	{
3433	io .set <myclass, &myclass::io_cb > (this);	3583	io .set <myclass, &myclass::io_cb > (this);
		3584	io2 .set <myclass, &myclass::io2_cb > (this);
3434	idle.set <myclass, &myclass::idle_cb> (this);	3585	idle.set <myclass, &myclass::idle_cb> (this);
3435		3586
3436	io.start (fd, ev::READ);	3587	io.set (fd, ev::WRITE); // configure the watcher
		3588	io.start (); // start it whenever convenient
		3589
		3590	io2.start (fd, ev::READ); // set + start in one call
3437	}	3591	}
3438	};	3592	};
3439		3593
3440		3594
3441	=head1 OTHER LANGUAGE BINDINGS	3595	=head1 OTHER LANGUAGE BINDINGS
…		…
3515	loop argument"). The C<EV_A> form is used when this is the sole argument,	3669	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:	3670	C<EV_A_> is used when other arguments are following. Example:
3517		3671
3518	ev_unref (EV_A);	3672	ev_unref (EV_A);
3519	ev_timer_add (EV_A_ watcher);	3673	ev_timer_add (EV_A_ watcher);
3520	ev_loop (EV_A_ 0);	3674	ev_run (EV_A_ 0);
3521		3675
3522	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	3676	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
3523	which is often provided by the following macro.	3677	which is often provided by the following macro.
3524		3678
3525	=item C<EV_P>, C<EV_P_>	3679	=item C<EV_P>, C<EV_P_>
…		…
3565	}	3719	}
3566		3720
3567	ev_check check;	3721	ev_check check;
3568	ev_check_init (&check, check_cb);	3722	ev_check_init (&check, check_cb);
3569	ev_check_start (EV_DEFAULT_ &check);	3723	ev_check_start (EV_DEFAULT_ &check);
3570	ev_loop (EV_DEFAULT_ 0);	3724	ev_run (EV_DEFAULT_ 0);
3571		3725
3572	=head1 EMBEDDING	3726	=head1 EMBEDDING
3573		3727
3574	Libev can (and often is) directly embedded into host	3728	Libev can (and often is) directly embedded into host
3575	applications. Examples of applications that embed it include the Deliantra	3729	applications. Examples of applications that embed it include the Deliantra
…		…
3660	define before including (or compiling) any of its files. The default in	3814	define before including (or compiling) any of its files. The default in
3661	the absence of autoconf is documented for every option.	3815	the absence of autoconf is documented for every option.
3662		3816
3663	Symbols marked with "(h)" do not change the ABI, and can have different	3817	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	3818	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	3819	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	3820	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	3821	users of libev and the libev code itself must be compiled with compatible
3668	settings.	3822	settings.
3669		3823
3670	=over 4	3824	=over 4
		3825
		3826	=item EV_COMPAT3 (h)
		3827
		3828	Backwards compatibility is a major concern for libev. This is why this
		3829	release of libev comes with wrappers for the functions and symbols that
		3830	have been renamed between libev version 3 and 4.
		3831
		3832	You can disable these wrappers (to test compatibility with future
		3833	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		3834	sources. This has the additional advantage that you can drop the C<struct>
		3835	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		3836	typedef in that case.
		3837
		3838	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		3839	and in some even more future version the compatibility code will be
		3840	removed completely.
3671		3841
3672	=item EV_STANDALONE (h)	3842	=item EV_STANDALONE (h)
3673		3843
3674	Must always be C<1> if you do not use autoconf configuration, which	3844	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	3845	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,	4052	EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
3883	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.	4053	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3884		4054
3885	If undefined or defined to be C<1> (and the platform supports it), then	4055	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	4056	the respective watcher type is supported. If defined to be C<0>, then it
3887	is not. Disabling watcher types mainly saves codesize.	4057	is not. Disabling watcher types mainly saves code size.
3888		4058
3889	=item EV_MINIMAL	4059	=item EV_FEATURES
3890		4060
3891	If you need to shave off some kilobytes of code at the expense of some	4061	If you need to shave off some kilobytes of code at the expense of some
3892	speed (but with the full API), define this symbol to C<1>. Currently this	4062	speed (but with the full API), you can define this symbol to request
3893	is used to override some inlining decisions, saves roughly 30% code size	4063	certain subsets of functionality. The default is to enable all features
3894	on amd64. It also selects a much smaller 2-heap for timer management over	4064	that can be enabled on the platform.
3895	the default 4-heap.
3896		4065
3897	You can save even more by disabling watcher types you do not need	4066	A typical way to use this symbol is to define it to C<0> (or to a bitset
3898	and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>	4067	with some broad features you want) and then selectively re-enable
3899	(C<-DNDEBUG>) will usually reduce code size a lot. Disabling inotify,	4068	additional parts you want, for example if you want everything minimal,
3900	eventfd and signalfd will further help, and disabling backends one doesn't	4069	but multiple event loop support, async and child watchers and the poll
3901	need (e.g. poll, epoll, kqueue, ports) will help further.	4070	backend, use this:
3902		4071
3903	Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to	4072	#define EV_FEATURES 0
3904	provide a bare-bones event library. See C<ev.h> for details on what parts
3905	of the API are still available, and do not complain if this subset changes
3906	over time.
3907
3908	This example set of settings reduces the compiled size of libev from
3909	23.9Kb to 7.7Kb on my GNU/Linux amd64 system (and leaves little
3910	in - there is also an effect on the amount of memory used). With
3911	an intelligent-enough linker (gcc+binutils do this when you use
3912	C<-Wl,--gc-sections -ffunction-sections>) further unused functions might
3913	be left out as well automatically - a binary starting a timer and an I/O
3914	watcher then might come out at only 5Kb.
3915
3916	// tuning and API changes
3917	#define EV_MINIMAL 2
3918	#define EV_MULTIPLICITY 0	4073	#define EV_MULTIPLICITY 1
3919	#define EV_MINPRI 0
3920	#define EV_MAXPRI 0
3921
3922	// OS-specific backends
3923	#define EV_USE_INOTIFY 0
3924	#define EV_USE_EVENTFD 0
3925	#define EV_USE_SIGNALFD 0
3926	#define EV_USE_REALTIME 0
3927	#define EV_USE_MONOTONIC 0
3928	#define EV_USE_CLOCK_SYSCALL 0
3929
3930	// disable all backends except select
3931	#define EV_USE_POLL 0	4074	#define EV_USE_POLL 1
3932	#define EV_USE_PORT 0
3933	#define EV_USE_KQUEUE 0
3934	#define EV_USE_EPOLL 0
3935
3936	// disable all watcher types that cna be disabled
3937	#define EV_STAT_ENABLE 0
3938	#define EV_PERIODIC_ENABLE 0
3939	#define EV_IDLE_ENABLE 0
3940	#define EV_CHECK_ENABLE 0
3941	#define EV_PREPARE_ENABLE 0
3942	#define EV_FORK_ENABLE 0
3943	#define EV_SIGNAL_ENABLE 0
3944	#define EV_CHILD_ENABLE 0	4075	#define EV_CHILD_ENABLE 1
3945	#define EV_ASYNC_ENABLE 0	4076	#define EV_ASYNC_ENABLE 1
3946	#define EV_EMBED_ENABLE 0	4077
		4078	The actual value is a bitset, it can be a combination of the following
		4079	values:
		4080
		4081	=over 4
		4082
		4083	=item C<1> - faster/larger code
		4084
		4085	Use larger code to speed up some operations.
		4086
		4087	Currently this is used to override some inlining decisions (enlarging the
		4088	code size by roughly 30% on amd64).
		4089
		4090	When optimising for size, use of compiler flags such as C<-Os> with
		4091	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
		4092	assertions.
		4093
		4094	=item C<2> - faster/larger data structures
		4095
		4096	Replaces the small 2-heap for timer management by a faster 4-heap, larger
		4097	hash table sizes and so on. This will usually further increase code size
		4098	and can additionally have an effect on the size of data structures at
		4099	runtime.
		4100
		4101	=item C<4> - full API configuration
		4102
		4103	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
		4104	enables multiplicity (C<EV_MULTIPLICITY>=1).
		4105
		4106	=item C<8> - full API
		4107
		4108	This enables a lot of the "lesser used" API functions. See C<ev.h> for
		4109	details on which parts of the API are still available without this
		4110	feature, and do not complain if this subset changes over time.
		4111
		4112	=item C<16> - enable all optional watcher types
		4113
		4114	Enables all optional watcher types. If you want to selectively enable
		4115	only some watcher types other than I/O and timers (e.g. prepare,
		4116	embed, async, child...) you can enable them manually by defining
		4117	C<EV_watchertype_ENABLE> to C<1> instead.
		4118
		4119	=item C<32> - enable all backends
		4120
		4121	This enables all backends - without this feature, you need to enable at
		4122	least one backend manually (C<EV_USE_SELECT> is a good choice).
		4123
		4124	=item C<64> - enable OS-specific "helper" APIs
		4125
		4126	Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
		4127	default.
		4128
		4129	=back
		4130
		4131	Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
		4132	reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
		4133	code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
		4134	watchers, timers and monotonic clock support.
		4135
		4136	With an intelligent-enough linker (gcc+binutils are intelligent enough
		4137	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
		4138	your program might be left out as well - a binary starting a timer and an
		4139	I/O watcher then might come out at only 5Kb.
3947		4140
3948	=item EV_AVOID_STDIO	4141	=item EV_AVOID_STDIO
3949		4142
3950	If this is set to C<1> at compiletime, then libev will avoid using stdio	4143	If this is set to C<1> at compiletime, then libev will avoid using stdio
3951	functions (printf, scanf, perror etc.). This will increase the codesize	4144	functions (printf, scanf, perror etc.). This will increase the code size
3952	somewhat, but if your program doesn't otherwise depend on stdio and your	4145	somewhat, but if your program doesn't otherwise depend on stdio and your
3953	libc allows it, this avoids linking in the stdio library which is quite	4146	libc allows it, this avoids linking in the stdio library which is quite
3954	big.	4147	big.
3955		4148
3956	Note that error messages might become less precise when this option is	4149	Note that error messages might become less precise when this option is
…		…
3960		4153
3961	The highest supported signal number, +1 (or, the number of	4154	The highest supported signal number, +1 (or, the number of
3962	signals): Normally, libev tries to deduce the maximum number of signals	4155	signals): Normally, libev tries to deduce the maximum number of signals
3963	automatically, but sometimes this fails, in which case it can be	4156	automatically, but sometimes this fails, in which case it can be
3964	specified. Also, using a lower number than detected (C<32> should be	4157	specified. Also, using a lower number than detected (C<32> should be
3965	good for about any system in existance) can save some memory, as libev	4158	good for about any system in existence) can save some memory, as libev
3966	statically allocates some 12-24 bytes per signal number.	4159	statically allocates some 12-24 bytes per signal number.
3967		4160
3968	=item EV_PID_HASHSIZE	4161	=item EV_PID_HASHSIZE
3969		4162
3970	C<ev_child> watchers use a small hash table to distribute workload by	4163	C<ev_child> watchers use a small hash table to distribute workload by
3971	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	4164	pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled),
3972	than enough. If you need to manage thousands of children you might want to	4165	usually more than enough. If you need to manage thousands of children you
3973	increase this value (I<must> be a power of two).	4166	might want to increase this value (I<must> be a power of two).
3974		4167
3975	=item EV_INOTIFY_HASHSIZE	4168	=item EV_INOTIFY_HASHSIZE
3976		4169
3977	C<ev_stat> watchers use a small hash table to distribute workload by	4170	C<ev_stat> watchers use a small hash table to distribute workload by
3978	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	4171	inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES>
3979	usually more than enough. If you need to manage thousands of C<ev_stat>	4172	disabled), usually more than enough. If you need to manage thousands of
3980	watchers you might want to increase this value (I<must> be a power of	4173	C<ev_stat> watchers you might want to increase this value (I<must> be a
3981	two).	4174	power of two).
3982		4175
3983	=item EV_USE_4HEAP	4176	=item EV_USE_4HEAP
3984		4177
3985	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4178	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3986	timer and periodics heaps, libev uses a 4-heap when this symbol is defined	4179	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3987	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably	4180	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3988	faster performance with many (thousands) of watchers.	4181	faster performance with many (thousands) of watchers.
3989		4182
3990	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4183	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3991	(disabled).	4184	will be C<0>.
3992		4185
3993	=item EV_HEAP_CACHE_AT	4186	=item EV_HEAP_CACHE_AT
3994		4187
3995	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4188	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3996	timer and periodics heaps, libev can cache the timestamp (I<at>) within	4189	timer and periodics heaps, libev can cache the timestamp (I<at>) within
3997	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),	4190	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3998	which uses 8-12 bytes more per watcher and a few hundred bytes more code,	4191	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3999	but avoids random read accesses on heap changes. This improves performance	4192	but avoids random read accesses on heap changes. This improves performance
4000	noticeably with many (hundreds) of watchers.	4193	noticeably with many (hundreds) of watchers.
4001		4194
4002	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4195	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4003	(disabled).	4196	will be C<0>.
4004		4197
4005	=item EV_VERIFY	4198	=item EV_VERIFY
4006		4199
4007	Controls how much internal verification (see C<ev_loop_verify ()>) will	4200	Controls how much internal verification (see C<ev_verify ()>) will
4008	be done: If set to C<0>, no internal verification code will be compiled	4201	be done: If set to C<0>, no internal verification code will be compiled
4009	in. If set to C<1>, then verification code will be compiled in, but not	4202	in. If set to C<1>, then verification code will be compiled in, but not
4010	called. If set to C<2>, then the internal verification code will be	4203	called. If set to C<2>, then the internal verification code will be
4011	called once per loop, which can slow down libev. If set to C<3>, then the	4204	called once per loop, which can slow down libev. If set to C<3>, then the
4012	verification code will be called very frequently, which will slow down	4205	verification code will be called very frequently, which will slow down
4013	libev considerably.	4206	libev considerably.
4014		4207
4015	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be	4208	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
4016	C<0>.	4209	will be C<0>.
4017		4210
4018	=item EV_COMMON	4211	=item EV_COMMON
4019		4212
4020	By default, all watchers have a C<void *data> member. By redefining	4213	By default, all watchers have a C<void *data> member. By redefining
4021	this macro to a something else you can include more and other types of	4214	this macro to something else you can include more and other types of
4022	members. You have to define it each time you include one of the files,	4215	members. You have to define it each time you include one of the files,
4023	though, and it must be identical each time.	4216	though, and it must be identical each time.
4024		4217
4025	For example, the perl EV module uses something like this:	4218	For example, the perl EV module uses something like this:
4026		4219
…		…
4079	file.	4272	file.
4080		4273
4081	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	4274	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
4082	that everybody includes and which overrides some configure choices:	4275	that everybody includes and which overrides some configure choices:
4083		4276
4084	#define EV_MINIMAL 1	4277	#define EV_FEATURES 8
4085	#define EV_USE_POLL 0	4278	#define EV_USE_SELECT 1
4086	#define EV_MULTIPLICITY 0
4087	#define EV_PERIODIC_ENABLE 0	4279	#define EV_PREPARE_ENABLE 1
		4280	#define EV_IDLE_ENABLE 1
4088	#define EV_STAT_ENABLE 0	4281	#define EV_SIGNAL_ENABLE 1
4089	#define EV_FORK_ENABLE 0	4282	#define EV_CHILD_ENABLE 1
		4283	#define EV_USE_STDEXCEPT 0
4090	#define EV_CONFIG_H <config.h>	4284	#define EV_CONFIG_H <config.h>
4091	#define EV_MINPRI 0
4092	#define EV_MAXPRI 0
4093		4285
4094	#include "ev++.h"	4286	#include "ev++.h"
4095		4287
4096	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4288	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
4097		4289
…		…
4228	userdata *u = ev_userdata (EV_A);	4420	userdata *u = ev_userdata (EV_A);
4229	pthread_mutex_lock (&u->lock);	4421	pthread_mutex_lock (&u->lock);
4230	}	4422	}
4231		4423
4232	The event loop thread first acquires the mutex, and then jumps straight	4424	The event loop thread first acquires the mutex, and then jumps straight
4233	into C<ev_loop>:	4425	into C<ev_run>:
4234		4426
4235	void *	4427	void *
4236	l_run (void *thr_arg)	4428	l_run (void *thr_arg)
4237	{	4429	{
4238	struct ev_loop *loop = (struct ev_loop *)thr_arg;	4430	struct ev_loop *loop = (struct ev_loop *)thr_arg;
4239		4431
4240	l_acquire (EV_A);	4432	l_acquire (EV_A);
4241	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);	4433	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4242	ev_loop (EV_A_ 0);	4434	ev_run (EV_A_ 0);
4243	l_release (EV_A);	4435	l_release (EV_A);
4244		4436
4245	return 0;	4437	return 0;
4246	}	4438	}
4247		4439
…		…
4299		4491
4300	=head3 COROUTINES	4492	=head3 COROUTINES
4301		4493
4302	Libev is very accommodating to coroutines ("cooperative threads"):	4494	Libev is very accommodating to coroutines ("cooperative threads"):
4303	libev fully supports nesting calls to its functions from different	4495	libev fully supports nesting calls to its functions from different
4304	coroutines (e.g. you can call C<ev_loop> on the same loop from two	4496	coroutines (e.g. you can call C<ev_run> on the same loop from two
4305	different coroutines, and switch freely between both coroutines running	4497	different coroutines, and switch freely between both coroutines running
4306	the loop, as long as you don't confuse yourself). The only exception is	4498	the loop, as long as you don't confuse yourself). The only exception is
4307	that you must not do this from C<ev_periodic> reschedule callbacks.	4499	that you must not do this from C<ev_periodic> reschedule callbacks.
4308		4500
4309	Care has been taken to ensure that libev does not keep local state inside	4501	Care has been taken to ensure that libev does not keep local state inside
4310	C<ev_loop>, and other calls do not usually allow for coroutine switches as	4502	C<ev_run>, and other calls do not usually allow for coroutine switches as
4311	they do not call any callbacks.	4503	they do not call any callbacks.
4312		4504
4313	=head2 COMPILER WARNINGS	4505	=head2 COMPILER WARNINGS
4314		4506
4315	Depending on your compiler and compiler settings, you might get no or a	4507	Depending on your compiler and compiler settings, you might get no or a
…		…
4326	maintainable.	4518	maintainable.
4327		4519
4328	And of course, some compiler warnings are just plain stupid, or simply	4520	And of course, some compiler warnings are just plain stupid, or simply
4329	wrong (because they don't actually warn about the condition their message	4521	wrong (because they don't actually warn about the condition their message
4330	seems to warn about). For example, certain older gcc versions had some	4522	seems to warn about). For example, certain older gcc versions had some
4331	warnings that resulted an extreme number of false positives. These have	4523	warnings that resulted in an extreme number of false positives. These have
4332	been fixed, but some people still insist on making code warn-free with	4524	been fixed, but some people still insist on making code warn-free with
4333	such buggy versions.	4525	such buggy versions.
4334		4526
4335	While libev is written to generate as few warnings as possible,	4527	While libev is written to generate as few warnings as possible,
4336	"warn-free" code is not a goal, and it is recommended not to build libev	4528	"warn-free" code is not a goal, and it is recommended not to build libev
…		…
4372	I suggest using suppression lists.	4564	I suggest using suppression lists.
4373		4565
4374		4566
4375	=head1 PORTABILITY NOTES	4567	=head1 PORTABILITY NOTES
4376		4568
		4569	=head2 GNU/LINUX 32 BIT LIMITATIONS
		4570
		4571	GNU/Linux is the only common platform that supports 64 bit file/large file
		4572	interfaces but I<disables> them by default.
		4573
		4574	That means that libev compiled in the default environment doesn't support
		4575	files larger than 2GiB or so, which mainly affects C<ev_stat> watchers.
		4576
		4577	Unfortunately, many programs try to work around this GNU/Linux issue
		4578	by enabling the large file API, which makes them incompatible with the
		4579	standard libev compiled for their system.
		4580
		4581	Likewise, libev cannot enable the large file API itself as this would
		4582	suddenly make it incompatible to the default compile time environment,
		4583	i.e. all programs not using special compile switches.
		4584
		4585	=head2 OS/X AND DARWIN BUGS
		4586
		4587	The whole thing is a bug if you ask me - basically any system interface
		4588	you touch is broken, whether it is locales, poll, kqueue or even the
		4589	OpenGL drivers.
		4590
		4591	=head3 C<kqueue> is buggy
		4592
		4593	The kqueue syscall is broken in all known versions - most versions support
		4594	only sockets, many support pipes.
		4595
		4596	Libev tries to work around this by not using C<kqueue> by default on this
		4597	rotten platform, but of course you can still ask for it when creating a
		4598	loop - embedding a socket-only kqueue loop into a select-based one is
		4599	probably going to work well.
		4600
		4601	=head3 C<poll> is buggy
		4602
		4603	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
		4604	implementation by something calling C<kqueue> internally around the 10.5.6
		4605	release, so now C<kqueue> I<and> C<poll> are broken.
		4606
		4607	Libev tries to work around this by not using C<poll> by default on
		4608	this rotten platform, but of course you can still ask for it when creating
		4609	a loop.
		4610
		4611	=head3 C<select> is buggy
		4612
		4613	All that's left is C<select>, and of course Apple found a way to fuck this
		4614	one up as well: On OS/X, C<select> actively limits the number of file
		4615	descriptors you can pass in to 1024 - your program suddenly crashes when
		4616	you use more.
		4617
		4618	There is an undocumented "workaround" for this - defining
		4619	C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should>
		4620	work on OS/X.
		4621
		4622	=head2 SOLARIS PROBLEMS AND WORKAROUNDS
		4623
		4624	=head3 C<errno> reentrancy
		4625
		4626	The default compile environment on Solaris is unfortunately so
		4627	thread-unsafe that you can't even use components/libraries compiled
		4628	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
		4629	defined by default. A valid, if stupid, implementation choice.
		4630
		4631	If you want to use libev in threaded environments you have to make sure
		4632	it's compiled with C<_REENTRANT> defined.
		4633
		4634	=head3 Event port backend
		4635
		4636	The scalable event interface for Solaris is called "event
		4637	ports". Unfortunately, this mechanism is very buggy in all major
		4638	releases. If you run into high CPU usage, your program freezes or you get
		4639	a large number of spurious wakeups, make sure you have all the relevant
		4640	and latest kernel patches applied. No, I don't know which ones, but there
		4641	are multiple ones to apply, and afterwards, event ports actually work
		4642	great.
		4643
		4644	If you can't get it to work, you can try running the program by setting
		4645	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
		4646	C<select> backends.
		4647
		4648	=head2 AIX POLL BUG
		4649
		4650	AIX unfortunately has a broken C<poll.h> header. Libev works around
		4651	this by trying to avoid the poll backend altogether (i.e. it's not even
		4652	compiled in), which normally isn't a big problem as C<select> works fine
		4653	with large bitsets on AIX, and AIX is dead anyway.
		4654
4377	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	4655	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
		4656
		4657	=head3 General issues
4378		4658
4379	Win32 doesn't support any of the standards (e.g. POSIX) that libev	4659	Win32 doesn't support any of the standards (e.g. POSIX) that libev
4380	requires, and its I/O model is fundamentally incompatible with the POSIX	4660	requires, and its I/O model is fundamentally incompatible with the POSIX
4381	model. Libev still offers limited functionality on this platform in	4661	model. Libev still offers limited functionality on this platform in
4382	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	4662	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4383	descriptors. This only applies when using Win32 natively, not when using	4663	descriptors. This only applies when using Win32 natively, not when using
4384	e.g. cygwin.	4664	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
		4665	as every compielr comes with a slightly differently broken/incompatible
		4666	environment.
4385		4667
4386	Lifting these limitations would basically require the full	4668	Lifting these limitations would basically require the full
4387	re-implementation of the I/O system. If you are into these kinds of	4669	re-implementation of the I/O system. If you are into this kind of thing,
4388	things, then note that glib does exactly that for you in a very portable	4670	then note that glib does exactly that for you in a very portable way (note
4389	way (note also that glib is the slowest event library known to man).	4671	also that glib is the slowest event library known to man).
4390		4672
4391	There is no supported compilation method available on windows except	4673	There is no supported compilation method available on windows except
4392	embedding it into other applications.	4674	embedding it into other applications.
4393		4675
4394	Sensible signal handling is officially unsupported by Microsoft - libev	4676	Sensible signal handling is officially unsupported by Microsoft - libev
…		…
4422	you do I<not> compile the F<ev.c> or any other embedded source files!):	4704	you do I<not> compile the F<ev.c> or any other embedded source files!):
4423		4705
4424	#include "evwrap.h"	4706	#include "evwrap.h"
4425	#include "ev.c"	4707	#include "ev.c"
4426		4708
4427	=over 4
4428
4429	=item The winsocket select function	4709	=head3 The winsocket C<select> function
4430		4710
4431	The winsocket C<select> function doesn't follow POSIX in that it	4711	The winsocket C<select> function doesn't follow POSIX in that it
4432	requires socket I<handles> and not socket I<file descriptors> (it is	4712	requires socket I<handles> and not socket I<file descriptors> (it is
4433	also extremely buggy). This makes select very inefficient, and also	4713	also extremely buggy). This makes select very inefficient, and also
4434	requires a mapping from file descriptors to socket handles (the Microsoft	4714	requires a mapping from file descriptors to socket handles (the Microsoft
…		…
4443	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	4723	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
4444		4724
4445	Note that winsockets handling of fd sets is O(n), so you can easily get a	4725	Note that winsockets handling of fd sets is O(n), so you can easily get a
4446	complexity in the O(n²) range when using win32.	4726	complexity in the O(n²) range when using win32.
4447		4727
4448	=item Limited number of file descriptors	4728	=head3 Limited number of file descriptors
4449		4729
4450	Windows has numerous arbitrary (and low) limits on things.	4730	Windows has numerous arbitrary (and low) limits on things.
4451		4731
4452	Early versions of winsocket's select only supported waiting for a maximum	4732	Early versions of winsocket's select only supported waiting for a maximum
4453	of C<64> handles (probably owning to the fact that all windows kernels	4733	of C<64> handles (probably owning to the fact that all windows kernels
…		…
4468	runtime libraries. This might get you to about C<512> or C<2048> sockets	4748	runtime libraries. This might get you to about C<512> or C<2048> sockets
4469	(depending on windows version and/or the phase of the moon). To get more,	4749	(depending on windows version and/or the phase of the moon). To get more,
4470	you need to wrap all I/O functions and provide your own fd management, but	4750	you need to wrap all I/O functions and provide your own fd management, but
4471	the cost of calling select (O(n²)) will likely make this unworkable.	4751	the cost of calling select (O(n²)) will likely make this unworkable.
4472		4752
4473	=back
4474
4475	=head2 PORTABILITY REQUIREMENTS	4753	=head2 PORTABILITY REQUIREMENTS
4476		4754
4477	In addition to a working ISO-C implementation and of course the	4755	In addition to a working ISO-C implementation and of course the
4478	backend-specific APIs, libev relies on a few additional extensions:	4756	backend-specific APIs, libev relies on a few additional extensions:
4479		4757
…		…
4485	Libev assumes not only that all watcher pointers have the same internal	4763	Libev assumes not only that all watcher pointers have the same internal
4486	structure (guaranteed by POSIX but not by ISO C for example), but it also	4764	structure (guaranteed by POSIX but not by ISO C for example), but it also
4487	assumes that the same (machine) code can be used to call any watcher	4765	assumes that the same (machine) code can be used to call any watcher
4488	callback: The watcher callbacks have different type signatures, but libev	4766	callback: The watcher callbacks have different type signatures, but libev
4489	calls them using an C<ev_watcher *> internally.	4767	calls them using an C<ev_watcher *> internally.
		4768
		4769	=item pointer accesses must be thread-atomic
		4770
		4771	Accessing a pointer value must be atomic, it must both be readable and
		4772	writable in one piece - this is the case on all current architectures.
4490		4773
4491	=item C<sig_atomic_t volatile> must be thread-atomic as well	4774	=item C<sig_atomic_t volatile> must be thread-atomic as well
4492		4775
4493	The type C<sig_atomic_t volatile> (or whatever is defined as	4776	The type C<sig_atomic_t volatile> (or whatever is defined as
4494	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different	4777	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
…		…
4517	watchers.	4800	watchers.
4518		4801
4519	=item C<double> must hold a time value in seconds with enough accuracy	4802	=item C<double> must hold a time value in seconds with enough accuracy
4520		4803
4521	The type C<double> is used to represent timestamps. It is required to	4804	The type C<double> is used to represent timestamps. It is required to
4522	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	4805	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4523	enough for at least into the year 4000. This requirement is fulfilled by	4806	good enough for at least into the year 4000 with millisecond accuracy
		4807	(the design goal for libev). This requirement is overfulfilled by
4524	implementations implementing IEEE 754, which is basically all existing	4808	implementations using IEEE 754, which is basically all existing ones. With
4525	ones. With IEEE 754 doubles, you get microsecond accuracy until at least	4809	IEEE 754 doubles, you get microsecond accuracy until at least 2200.
4526	2200.
4527		4810
4528	=back	4811	=back
4529		4812
4530	If you know of other additional requirements drop me a note.	4813	If you know of other additional requirements drop me a note.
4531		4814
…		…
4599	involves iterating over all running async watchers or all signal numbers.	4882	involves iterating over all running async watchers or all signal numbers.
4600		4883
4601	=back	4884	=back
4602		4885
4603		4886
		4887	=head1 PORTING FROM LIBEV 3.X TO 4.X
		4888
		4889	The major version 4 introduced some incompatible changes to the API.
		4890
		4891	At the moment, the C<ev.h> header file provides compatibility definitions
		4892	for all changes, so most programs should still compile. The compatibility
		4893	layer might be removed in later versions of libev, so better update to the
		4894	new API early than late.
		4895
		4896	=over 4
		4897
		4898	=item C<EV_COMPAT3> backwards compatibility mechanism
		4899
		4900	The backward compatibility mechanism can be controlled by
		4901	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		4902	section.
		4903
		4904	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		4905
		4906	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		4907
		4908	ev_loop_destroy (EV_DEFAULT_UC);
		4909	ev_loop_fork (EV_DEFAULT);
		4910
		4911	=item function/symbol renames
		4912
		4913	A number of functions and symbols have been renamed:
		4914
		4915	ev_loop => ev_run
		4916	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		4917	EVLOOP_ONESHOT => EVRUN_ONCE
		4918
		4919	ev_unloop => ev_break
		4920	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		4921	EVUNLOOP_ONE => EVBREAK_ONE
		4922	EVUNLOOP_ALL => EVBREAK_ALL
		4923
		4924	EV_TIMEOUT => EV_TIMER
		4925
		4926	ev_loop_count => ev_iteration
		4927	ev_loop_depth => ev_depth
		4928	ev_loop_verify => ev_verify
		4929
		4930	Most functions working on C<struct ev_loop> objects don't have an
		4931	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		4932	associated constants have been renamed to not collide with the C<struct
		4933	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		4934	as all other watcher types. Note that C<ev_loop_fork> is still called
		4935	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
		4936	typedef.
		4937
		4938	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
		4939
		4940	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
		4941	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
		4942	and work, but the library code will of course be larger.
		4943
		4944	=back
		4945
		4946
4604	=head1 GLOSSARY	4947	=head1 GLOSSARY
4605		4948
4606	=over 4	4949	=over 4
4607		4950
4608	=item active	4951	=item active
4609		4952
4610	A watcher is active as long as it has been started (has been attached to	4953	A watcher is active as long as it has been started and not yet stopped.
4611	an event loop) but not yet stopped (disassociated from the event loop).	4954	See L<WATCHER STATES> for details.
4612		4955
4613	=item application	4956	=item application
4614		4957
4615	In this document, an application is whatever is using libev.	4958	In this document, an application is whatever is using libev.
		4959
		4960	=item backend
		4961
		4962	The part of the code dealing with the operating system interfaces.
4616		4963
4617	=item callback	4964	=item callback
4618		4965
4619	The address of a function that is called when some event has been	4966	The address of a function that is called when some event has been
4620	detected. Callbacks are being passed the event loop, the watcher that	4967	detected. Callbacks are being passed the event loop, the watcher that
4621	received the event, and the actual event bitset.	4968	received the event, and the actual event bitset.
4622		4969
4623	=item callback invocation	4970	=item callback/watcher invocation
4624		4971
4625	The act of calling the callback associated with a watcher.	4972	The act of calling the callback associated with a watcher.
4626		4973
4627	=item event	4974	=item event
4628		4975
4629	A change of state of some external event, such as data now being available	4976	A change of state of some external event, such as data now being available
4630	for reading on a file descriptor, time having passed or simply not having	4977	for reading on a file descriptor, time having passed or simply not having
4631	any other events happening anymore.	4978	any other events happening anymore.
4632		4979
4633	In libev, events are represented as single bits (such as C<EV_READ> or	4980	In libev, events are represented as single bits (such as C<EV_READ> or
4634	C<EV_TIMEOUT>).	4981	C<EV_TIMER>).
4635		4982
4636	=item event library	4983	=item event library
4637		4984
4638	A software package implementing an event model and loop.	4985	A software package implementing an event model and loop.
4639		4986
…		…
4647	The model used to describe how an event loop handles and processes	4994	The model used to describe how an event loop handles and processes
4648	watchers and events.	4995	watchers and events.
4649		4996
4650	=item pending	4997	=item pending
4651		4998
4652	A watcher is pending as soon as the corresponding event has been detected,	4999	A watcher is pending as soon as the corresponding event has been
4653	and stops being pending as soon as the watcher will be invoked or its	5000	detected. See L<WATCHER STATES> for details.
4654	pending status is explicitly cleared by the application.
4655
4656	A watcher can be pending, but not active. Stopping a watcher also clears
4657	its pending status.
4658		5001
4659	=item real time	5002	=item real time
4660		5003
4661	The physical time that is observed. It is apparently strictly monotonic :)	5004	The physical time that is observed. It is apparently strictly monotonic :)
4662		5005
…		…
4669	=item watcher	5012	=item watcher
4670		5013
4671	A data structure that describes interest in certain events. Watchers need	5014	A data structure that describes interest in certain events. Watchers need
4672	to be started (attached to an event loop) before they can receive events.	5015	to be started (attached to an event loop) before they can receive events.
4673		5016
4674	=item watcher invocation
4675
4676	The act of calling the callback associated with a watcher.
4677
4678	=back	5017	=back
4679		5018
4680	=head1 AUTHOR	5019	=head1 AUTHOR
4681		5020
4682	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5021	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5022	Magnusson and Emanuele Giaquinta.
4683		5023

Diff Legend

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