ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/libev/ev.pod

Comparing libev/ev.pod (file contents):
Revision 1.273 by root, Tue Nov 24 14:46:59 2009 UTC vs.
Revision 1.342 by root, Wed Nov 10 13:16:44 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
…		…
118	Libev is very configurable. In this manual the default (and most common)	126	Libev is very configurable. In this manual the default (and most common)
119	configuration will be described, which supports multiple event loops. For	127	configuration will be described, which supports multiple event loops. For
120	more info about various configuration options please have a look at	128	more info about various configuration options please have a look at
121	B<EMBED> section in this manual. If libev was configured without support	129	B<EMBED> section in this manual. If libev was configured without support
122	for multiple event loops, then all functions taking an initial argument of	130	for multiple event loops, then all functions taking an initial argument of
123	name C<loop> (which is always of type C<ev_loop *>) will not have	131	name C<loop> (which is always of type C<struct ev_loop *>) will not have
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))
235		247
236	Sets the allocation function to use (the prototype is similar - the	248	Sets the allocation function to use (the prototype is similar - the
237	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is	249	semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
238	used to allocate and free memory (no surprises here). If it returns zero	250	used to allocate and free memory (no surprises here). If it returns zero
239	when memory needs to be allocated (C<size != 0>), the library might abort	251	when memory needs to be allocated (C<size != 0>), the library might abort
…		…
265	}	277	}
266		278
267	...	279	...
268	ev_set_allocator (persistent_realloc);	280	ev_set_allocator (persistent_realloc);
269		281
270	=item ev_set_syserr_cb (void (*cb)(const char *msg)); [NOT REENTRANT]	282	=item ev_set_syserr_cb (void (*cb)(const char *msg))
271		283
272	Set the callback function to call on a retryable system call error (such	284	Set the callback function to call on a retryable system call error (such
273	as failed select, poll, epoll_wait). The message is a printable string	285	as failed select, poll, epoll_wait). The message is a printable string
274	indicating the system call or subsystem causing the problem. If this	286	indicating the system call or subsystem causing the problem. If this
275	callback is set, then libev will expect it to remedy the situation, no	287	callback is set, then libev will expect it to remedy the situation, no
…		…
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
…		…
366	environment variable.	402	environment variable.
367		403
368	=item C<EVFLAG_NOINOTIFY>	404	=item C<EVFLAG_NOINOTIFY>
369		405
370	When this flag is specified, then libev will not attempt to use the	406	When this flag is specified, then libev will not attempt to use the
371	I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and	407	I<inotify> API for its C<ev_stat> watchers. Apart from debugging and
372	testing, this flag can be useful to conserve inotify file descriptors, as	408	testing, this flag can be useful to conserve inotify file descriptors, as
373	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.	409	otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
374		410
375	=item C<EVFLAG_NOSIGFD>	411	=item C<EVFLAG_SIGNALFD>
376		412
377	When this flag is specified, then libev will not attempt to use the	413	When this flag is specified, then libev will attempt to use the
378	I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This is	414	I<signalfd> API for its C<ev_signal> (and C<ev_child>) watchers. This API
379	probably only useful to work around any bugs in libev. Consequently, this	415	delivers signals synchronously, which makes it both faster and might make
380	flag might go away once the signalfd functionality is considered stable,	416	it possible to get the queued signal data. It can also simplify signal
381	so it's useful mostly in environment variables and not in program code.	417	handling with threads, as long as you properly block signals in your
		418	threads that are not interested in handling them.
		419
		420	Signalfd will not be used by default as this changes your signal mask, and
		421	there are a lot of shoddy libraries and programs (glib's threadpool for
		422	example) that can't properly initialise their signal masks.
382		423
383	=item C<EVBACKEND_SELECT> (value 1, portable select backend)	424	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
384		425
385	This is your standard select(2) backend. Not I<completely> standard, as	426	This is your standard select(2) backend. Not I<completely> standard, as
386	libev tries to roll its own fd_set with no limits on the number of fds,	427	libev tries to roll its own fd_set with no limits on the number of fds,
…		…
422	epoll scales either O(1) or O(active_fds).	463	epoll scales either O(1) or O(active_fds).
423		464
424	The epoll mechanism deserves honorable mention as the most misdesigned	465	The epoll mechanism deserves honorable mention as the most misdesigned
425	of the more advanced event mechanisms: mere annoyances include silently	466	of the more advanced event mechanisms: mere annoyances include silently
426	dropping file descriptors, requiring a system call per change per file	467	dropping file descriptors, requiring a system call per change per file
427	descriptor (and unnecessary guessing of parameters), problems with dup and	468	descriptor (and unnecessary guessing of parameters), problems with dup,
		469	returning before the timeout value, resulting in additional iterations
		470	(and only giving 5ms accuracy while select on the same platform gives
428	so on. The biggest issue is fork races, however - if a program forks then	471	0.1ms) and so on. The biggest issue is fork races, however - if a program
429	I<both> parent and child process have to recreate the epoll set, which can	472	forks then I<both> parent and child process have to recreate the epoll
430	take considerable time (one syscall per file descriptor) and is of course	473	set, which can take considerable time (one syscall per file descriptor)
431	hard to detect.	474	and is of course hard to detect.
432		475
433	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	476	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
434	of course I<doesn't>, and epoll just loves to report events for totally	477	of course I<doesn't>, and epoll just loves to report events for totally
435	I<different> file descriptors (even already closed ones, so one cannot	478	I<different> file descriptors (even already closed ones, so one cannot
436	even remove them from the set) than registered in the set (especially	479	even remove them from the set) than registered in the set (especially
437	on SMP systems). Libev tries to counter these spurious notifications by	480	on SMP systems). Libev tries to counter these spurious notifications by
438	employing an additional generation counter and comparing that against the	481	employing an additional generation counter and comparing that against the
439	events to filter out spurious ones, recreating the set when required.	482	events to filter out spurious ones, recreating the set when required. Last
		483	not least, it also refuses to work with some file descriptors which work
		484	perfectly fine with C<select> (files, many character devices...).
		485
		486	Epoll is truly the train wreck analog among event poll mechanisms.
440		487
441	While stopping, setting and starting an I/O watcher in the same iteration	488	While stopping, setting and starting an I/O watcher in the same iteration
442	will result in some caching, there is still a system call per such	489	will result in some caching, there is still a system call per such
443	incident (because the same I<file descriptor> could point to a different	490	incident (because the same I<file descriptor> could point to a different
444	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed	491	I<file description> now), so its best to avoid that. Also, C<dup ()>'ed
…		…
542	If one or more of the backend flags are or'ed into the flags value,	589	If one or more of the backend flags are or'ed into the flags value,
543	then only these backends will be tried (in the reverse order as listed	590	then only these backends will be tried (in the reverse order as listed
544	here). If none are specified, all backends in C<ev_recommended_backends	591	here). If none are specified, all backends in C<ev_recommended_backends
545	()> will be tried.	592	()> will be tried.
546		593
547	Example: This is the most typical usage.
548
549	if (!ev_default_loop (0))
550	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
551
552	Example: Restrict libev to the select and poll backends, and do not allow
553	environment settings to be taken into account:
554
555	ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
556
557	Example: Use whatever libev has to offer, but make sure that kqueue is
558	used if available (warning, breaks stuff, best use only with your own
559	private event loop and only if you know the OS supports your types of
560	fds):
561
562	ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
563
564	=item struct ev_loop *ev_loop_new (unsigned int flags)
565
566	Similar to C<ev_default_loop>, but always creates a new event loop that is
567	always distinct from the default loop. Unlike the default loop, it cannot
568	handle signal and child watchers, and attempts to do so will be greeted by
569	undefined behaviour (or a failed assertion if assertions are enabled).
570
571	Note that this function I<is> thread-safe, and the recommended way to use
572	libev with threads is indeed to create one loop per thread, and using the
573	default loop in the "main" or "initial" thread.
574
575	Example: Try to create a event loop that uses epoll and nothing else.	594	Example: Try to create a event loop that uses epoll and nothing else.
576		595
577	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);	596	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
578	if (!epoller)	597	if (!epoller)
579	fatal ("no epoll found here, maybe it hides under your chair");	598	fatal ("no epoll found here, maybe it hides under your chair");
580		599
		600	Example: Use whatever libev has to offer, but make sure that kqueue is
		601	used if available.
		602
		603	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () | EVBACKEND_KQUEUE);
		604
581	=item ev_default_destroy ()	605	=item ev_loop_destroy (loop)
582		606
583	Destroys the default loop again (frees all memory and kernel state	607	Destroys an event loop object (frees all memory and kernel state
584	etc.). None of the active event watchers will be stopped in the normal	608	etc.). None of the active event watchers will be stopped in the normal
585	sense, so e.g. C<ev_is_active> might still return true. It is your	609	sense, so e.g. C<ev_is_active> might still return true. It is your
586	responsibility to either stop all watchers cleanly yourself I<before>	610	responsibility to either stop all watchers cleanly yourself I<before>
587	calling this function, or cope with the fact afterwards (which is usually	611	calling this function, or cope with the fact afterwards (which is usually
588	the easiest thing, you can just ignore the watchers and/or C<free ()> them	612	the easiest thing, you can just ignore the watchers and/or C<free ()> them
…		…
590		614
591	Note that certain global state, such as signal state (and installed signal	615	Note that certain global state, such as signal state (and installed signal
592	handlers), will not be freed by this function, and related watchers (such	616	handlers), will not be freed by this function, and related watchers (such
593	as signal and child watchers) would need to be stopped manually.	617	as signal and child watchers) would need to be stopped manually.
594		618
595	In general it is not advisable to call this function except in the	619	This function is normally used on loop objects allocated by
596	rare occasion where you really need to free e.g. the signal handling	620	C<ev_loop_new>, but it can also be used on the default loop returned by
		621	C<ev_default_loop>, in which case it is not thread-safe.
		622
		623	Note that it is not advisable to call this function on the default loop
		624	except in the rare occasion where you really need to free its resources.
597	pipe fds. If you need dynamically allocated loops it is better to use	625	If you need dynamically allocated loops it is better to use C<ev_loop_new>
598	C<ev_loop_new> and C<ev_loop_destroy>.	626	and C<ev_loop_destroy>.
599		627
600	=item ev_loop_destroy (loop)	628	=item ev_loop_fork (loop)
601		629
602	Like C<ev_default_destroy>, but destroys an event loop created by an
603	earlier call to C<ev_loop_new>.
604
605	=item ev_default_fork ()
606
607	This function sets a flag that causes subsequent C<ev_loop> iterations	630	This function sets a flag that causes subsequent C<ev_run> iterations to
608	to reinitialise the kernel state for backends that have one. Despite the	631	reinitialise the kernel state for backends that have one. Despite the
609	name, you can call it anytime, but it makes most sense after forking, in	632	name, you can call it anytime, but it makes most sense after forking, in
610	the child process (or both child and parent, but that again makes little	633	the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the
611	sense). You I<must> call it in the child before using any of the libev	634	child before resuming or calling C<ev_run>.
612	functions, and it will only take effect at the next C<ev_loop> iteration.	635
		636	Again, you I<have> to call it on I<any> loop that you want to re-use after
		637	a fork, I<even if you do not plan to use the loop in the parent>. This is
		638	because some kernel interfaces *cough* I<kqueue> *cough* do funny things
		639	during fork.
613		640
614	On the other hand, you only need to call this function in the child	641	On the other hand, you only need to call this function in the child
615	process if and only if you want to use the event library in the child. If	642	process if and only if you want to use the event loop in the child. If
616	you just fork+exec, you don't have to call it at all.	643	you just fork+exec or create a new loop in the child, you don't have to
		644	call it at all (in fact, C<epoll> is so badly broken that it makes a
		645	difference, but libev will usually detect this case on its own and do a
		646	costly reset of the backend).
617		647
618	The function itself is quite fast and it's usually not a problem to call	648	The function itself is quite fast and it's usually not a problem to call
619	it just in case after a fork. To make this easy, the function will fit in	649	it just in case after a fork.
620	quite nicely into a call to C<pthread_atfork>:
621		650
		651	Example: Automate calling C<ev_loop_fork> on the default loop when
		652	using pthreads.
		653
		654	static void
		655	post_fork_child (void)
		656	{
		657	ev_loop_fork (EV_DEFAULT);
		658	}
		659
		660	...
622	pthread_atfork (0, 0, ev_default_fork);	661	pthread_atfork (0, 0, post_fork_child);
623
624	=item ev_loop_fork (loop)
625
626	Like C<ev_default_fork>, but acts on an event loop created by
627	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
628	after fork that you want to re-use in the child, and how you do this is
629	entirely your own problem.
630		662
631	=item int ev_is_default_loop (loop)	663	=item int ev_is_default_loop (loop)
632		664
633	Returns true when the given loop is, in fact, the default loop, and false	665	Returns true when the given loop is, in fact, the default loop, and false
634	otherwise.	666	otherwise.
635		667
636	=item unsigned int ev_loop_count (loop)	668	=item unsigned int ev_iteration (loop)
637		669
638	Returns the count of loop iterations for the loop, which is identical to	670	Returns the current iteration count for the event loop, which is identical
639	the number of times libev did poll for new events. It starts at C<0> and	671	to the number of times libev did poll for new events. It starts at C<0>
640	happily wraps around with enough iterations.	672	and happily wraps around with enough iterations.
641		673
642	This value can sometimes be useful as a generation counter of sorts (it	674	This value can sometimes be useful as a generation counter of sorts (it
643	"ticks" the number of loop iterations), as it roughly corresponds with	675	"ticks" the number of loop iterations), as it roughly corresponds with
644	C<ev_prepare> and C<ev_check> calls.	676	C<ev_prepare> and C<ev_check> calls - and is incremented between the
		677	prepare and check phases.
645		678
646	=item unsigned int ev_loop_depth (loop)	679	=item unsigned int ev_depth (loop)
647		680
648	Returns the number of times C<ev_loop> was entered minus the number of	681	Returns the number of times C<ev_run> was entered minus the number of
649	times C<ev_loop> was exited, in other words, the recursion depth.	682	times C<ev_run> was exited, in other words, the recursion depth.
650		683
651	Outside C<ev_loop>, this number is zero. In a callback, this number is	684	Outside C<ev_run>, this number is zero. In a callback, this number is
652	C<1>, unless C<ev_loop> was invoked recursively (or from another thread),	685	C<1>, unless C<ev_run> was invoked recursively (or from another thread),
653	in which case it is higher.	686	in which case it is higher.
654		687
655	Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread	688	Leaving C<ev_run> abnormally (setjmp/longjmp, cancelling the thread
656	etc.), doesn't count as exit.	689	etc.), doesn't count as "exit" - consider this as a hint to avoid such
		690	ungentleman-like behaviour unless it's really convenient.
657		691
658	=item unsigned int ev_backend (loop)	692	=item unsigned int ev_backend (loop)
659		693
660	Returns one of the C<EVBACKEND_*> flags indicating the event backend in	694	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
661	use.	695	use.
…		…
670		704
671	=item ev_now_update (loop)	705	=item ev_now_update (loop)
672		706
673	Establishes the current time by querying the kernel, updating the time	707	Establishes the current time by querying the kernel, updating the time
674	returned by C<ev_now ()> in the progress. This is a costly operation and	708	returned by C<ev_now ()> in the progress. This is a costly operation and
675	is usually done automatically within C<ev_loop ()>.	709	is usually done automatically within C<ev_run ()>.
676		710
677	This function is rarely useful, but when some event callback runs for a	711	This function is rarely useful, but when some event callback runs for a
678	very long time without entering the event loop, updating libev's idea of	712	very long time without entering the event loop, updating libev's idea of
679	the current time is a good idea.	713	the current time is a good idea.
680		714
…		…
682		716
683	=item ev_suspend (loop)	717	=item ev_suspend (loop)
684		718
685	=item ev_resume (loop)	719	=item ev_resume (loop)
686		720
687	These two functions suspend and resume a loop, for use when the loop is	721	These two functions suspend and resume an event loop, for use when the
688	not used for a while and timeouts should not be processed.	722	loop is not used for a while and timeouts should not be processed.
689		723
690	A typical use case would be an interactive program such as a game: When	724	A typical use case would be an interactive program such as a game: When
691	the user presses C<^Z> to suspend the game and resumes it an hour later it	725	the user presses C<^Z> to suspend the game and resumes it an hour later it
692	would be best to handle timeouts as if no time had actually passed while	726	would be best to handle timeouts as if no time had actually passed while
693	the program was suspended. This can be achieved by calling C<ev_suspend>	727	the program was suspended. This can be achieved by calling C<ev_suspend>
…		…
695	C<ev_resume> directly afterwards to resume timer processing.	729	C<ev_resume> directly afterwards to resume timer processing.
696		730
697	Effectively, all C<ev_timer> watchers will be delayed by the time spend	731	Effectively, all C<ev_timer> watchers will be delayed by the time spend
698	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers	732	between C<ev_suspend> and C<ev_resume>, and all C<ev_periodic> watchers
699	will be rescheduled (that is, they will lose any events that would have	733	will be rescheduled (that is, they will lose any events that would have
700	occured while suspended).	734	occurred while suspended).
701		735
702	After calling C<ev_suspend> you B<must not> call I<any> function on the	736	After calling C<ev_suspend> you B<must not> call I<any> function on the
703	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>	737	given loop other than C<ev_resume>, and you B<must not> call C<ev_resume>
704	without a previous call to C<ev_suspend>.	738	without a previous call to C<ev_suspend>.
705		739
706	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the	740	Calling C<ev_suspend>/C<ev_resume> has the side effect of updating the
707	event loop time (see C<ev_now_update>).	741	event loop time (see C<ev_now_update>).
708		742
709	=item ev_loop (loop, int flags)	743	=item ev_run (loop, int flags)
710		744
711	Finally, this is it, the event handler. This function usually is called	745	Finally, this is it, the event handler. This function usually is called
712	after you have initialised all your watchers and you want to start	746	after you have initialised all your watchers and you want to start
713	handling events.	747	handling events. It will ask the operating system for any new events, call
		748	the watcher callbacks, an then repeat the whole process indefinitely: This
		749	is why event loops are called I<loops>.
714		750
715	If the flags argument is specified as C<0>, it will not return until	751	If the flags argument is specified as C<0>, it will keep handling events
716	either no event watchers are active anymore or C<ev_unloop> was called.	752	until either no event watchers are active anymore or C<ev_break> was
		753	called.
717		754
718	Please note that an explicit C<ev_unloop> is usually better than	755	Please note that an explicit C<ev_break> is usually better than
719	relying on all watchers to be stopped when deciding when a program has	756	relying on all watchers to be stopped when deciding when a program has
720	finished (especially in interactive programs), but having a program	757	finished (especially in interactive programs), but having a program
721	that automatically loops as long as it has to and no longer by virtue	758	that automatically loops as long as it has to and no longer by virtue
722	of relying on its watchers stopping correctly, that is truly a thing of	759	of relying on its watchers stopping correctly, that is truly a thing of
723	beauty.	760	beauty.
724		761
725	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	762	A flags value of C<EVRUN_NOWAIT> will look for new events, will handle
726	those events and any already outstanding ones, but will not block your	763	those events and any already outstanding ones, but will not wait and
727	process in case there are no events and will return after one iteration of	764	block your process in case there are no events and will return after one
728	the loop.	765	iteration of the loop. This is sometimes useful to poll and handle new
		766	events while doing lengthy calculations, to keep the program responsive.
729		767
730	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	768	A flags value of C<EVRUN_ONCE> will look for new events (waiting if
731	necessary) and will handle those and any already outstanding ones. It	769	necessary) and will handle those and any already outstanding ones. It
732	will block your process until at least one new event arrives (which could	770	will block your process until at least one new event arrives (which could
733	be an event internal to libev itself, so there is no guarantee that a	771	be an event internal to libev itself, so there is no guarantee that a
734	user-registered callback will be called), and will return after one	772	user-registered callback will be called), and will return after one
735	iteration of the loop.	773	iteration of the loop.
736		774
737	This is useful if you are waiting for some external event in conjunction	775	This is useful if you are waiting for some external event in conjunction
738	with something not expressible using other libev watchers (i.e. "roll your	776	with something not expressible using other libev watchers (i.e. "roll your
739	own C<ev_loop>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is	777	own C<ev_run>"). However, a pair of C<ev_prepare>/C<ev_check> watchers is
740	usually a better approach for this kind of thing.	778	usually a better approach for this kind of thing.
741		779
742	Here are the gory details of what C<ev_loop> does:	780	Here are the gory details of what C<ev_run> does:
743		781
		782	- Increment loop depth.
		783	- Reset the ev_break status.
744	- Before the first iteration, call any pending watchers.	784	- Before the first iteration, call any pending watchers.
		785	LOOP:
745	* If EVFLAG_FORKCHECK was used, check for a fork.	786	- If EVFLAG_FORKCHECK was used, check for a fork.
746	- If a fork was detected (by any means), queue and call all fork watchers.	787	- If a fork was detected (by any means), queue and call all fork watchers.
747	- Queue and call all prepare watchers.	788	- Queue and call all prepare watchers.
		789	- If ev_break was called, goto FINISH.
748	- If we have been forked, detach and recreate the kernel state	790	- If we have been forked, detach and recreate the kernel state
749	as to not disturb the other process.	791	as to not disturb the other process.
750	- Update the kernel state with all outstanding changes.	792	- Update the kernel state with all outstanding changes.
751	- Update the "event loop time" (ev_now ()).	793	- Update the "event loop time" (ev_now ()).
752	- Calculate for how long to sleep or block, if at all	794	- Calculate for how long to sleep or block, if at all
753	(active idle watchers, EVLOOP_NONBLOCK or not having	795	(active idle watchers, EVRUN_NOWAIT or not having
754	any active watchers at all will result in not sleeping).	796	any active watchers at all will result in not sleeping).
755	- Sleep if the I/O and timer collect interval say so.	797	- Sleep if the I/O and timer collect interval say so.
		798	- Increment loop iteration counter.
756	- Block the process, waiting for any events.	799	- Block the process, waiting for any events.
757	- Queue all outstanding I/O (fd) events.	800	- Queue all outstanding I/O (fd) events.
758	- Update the "event loop time" (ev_now ()), and do time jump adjustments.	801	- Update the "event loop time" (ev_now ()), and do time jump adjustments.
759	- Queue all expired timers.	802	- Queue all expired timers.
760	- Queue all expired periodics.	803	- Queue all expired periodics.
761	- Unless any events are pending now, queue all idle watchers.	804	- Queue all idle watchers with priority higher than that of pending events.
762	- Queue all check watchers.	805	- Queue all check watchers.
763	- Call all queued watchers in reverse order (i.e. check watchers first).	806	- Call all queued watchers in reverse order (i.e. check watchers first).
764	Signals and child watchers are implemented as I/O watchers, and will	807	Signals and child watchers are implemented as I/O watchers, and will
765	be handled here by queueing them when their watcher gets executed.	808	be handled here by queueing them when their watcher gets executed.
766	- If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	809	- If ev_break has been called, or EVRUN_ONCE or EVRUN_NOWAIT
767	were used, or there are no active watchers, return, otherwise	810	were used, or there are no active watchers, goto FINISH, otherwise
768	continue with step *.	811	continue with step LOOP.
		812	FINISH:
		813	- Reset the ev_break status iff it was EVBREAK_ONE.
		814	- Decrement the loop depth.
		815	- Return.
769		816
770	Example: Queue some jobs and then loop until no events are outstanding	817	Example: Queue some jobs and then loop until no events are outstanding
771	anymore.	818	anymore.
772		819
773	... queue jobs here, make sure they register event watchers as long	820	... queue jobs here, make sure they register event watchers as long
774	... as they still have work to do (even an idle watcher will do..)	821	... as they still have work to do (even an idle watcher will do..)
775	ev_loop (my_loop, 0);	822	ev_run (my_loop, 0);
776	... jobs done or somebody called unloop. yeah!	823	... jobs done or somebody called unloop. yeah!
777		824
778	=item ev_unloop (loop, how)	825	=item ev_break (loop, how)
779		826
780	Can be used to make a call to C<ev_loop> return early (but only after it	827	Can be used to make a call to C<ev_run> return early (but only after it
781	has processed all outstanding events). The C<how> argument must be either	828	has processed all outstanding events). The C<how> argument must be either
782	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or	829	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
783	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	830	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
784		831
785	This "unloop state" will be cleared when entering C<ev_loop> again.	832	This "break state" will be cleared when entering C<ev_run> again.
786		833
787	It is safe to call C<ev_unloop> from otuside any C<ev_loop> calls.	834	It is safe to call C<ev_break> from outside any C<ev_run> calls, too.
788		835
789	=item ev_ref (loop)	836	=item ev_ref (loop)
790		837
791	=item ev_unref (loop)	838	=item ev_unref (loop)
792		839
793	Ref/unref can be used to add or remove a reference count on the event	840	Ref/unref can be used to add or remove a reference count on the event
794	loop: Every watcher keeps one reference, and as long as the reference	841	loop: Every watcher keeps one reference, and as long as the reference
795	count is nonzero, C<ev_loop> will not return on its own.	842	count is nonzero, C<ev_run> will not return on its own.
796		843
797	If you have a watcher you never unregister that should not keep C<ev_loop>	844	This is useful when you have a watcher that you never intend to
798	from returning, call ev_unref() after starting, and ev_ref() before	845	unregister, but that nevertheless should not keep C<ev_run> from
		846	returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
799	stopping it.	847	before stopping it.
800		848
801	As an example, libev itself uses this for its internal signal pipe: It	849	As an example, libev itself uses this for its internal signal pipe: It
802	is not visible to the libev user and should not keep C<ev_loop> from	850	is not visible to the libev user and should not keep C<ev_run> from
803	exiting if no event watchers registered by it are active. It is also an	851	exiting if no event watchers registered by it are active. It is also an
804	excellent way to do this for generic recurring timers or from within	852	excellent way to do this for generic recurring timers or from within
805	third-party libraries. Just remember to I<unref after start> and I<ref	853	third-party libraries. Just remember to I<unref after start> and I<ref
806	before stop> (but only if the watcher wasn't active before, or was active	854	before stop> (but only if the watcher wasn't active before, or was active
807	before, respectively. Note also that libev might stop watchers itself	855	before, respectively. Note also that libev might stop watchers itself
808	(e.g. non-repeating timers) in which case you have to C<ev_ref>	856	(e.g. non-repeating timers) in which case you have to C<ev_ref>
809	in the callback).	857	in the callback).
810		858
811	Example: Create a signal watcher, but keep it from keeping C<ev_loop>	859	Example: Create a signal watcher, but keep it from keeping C<ev_run>
812	running when nothing else is active.	860	running when nothing else is active.
813		861
814	ev_signal exitsig;	862	ev_signal exitsig;
815	ev_signal_init (&exitsig, sig_cb, SIGINT);	863	ev_signal_init (&exitsig, sig_cb, SIGINT);
816	ev_signal_start (loop, &exitsig);	864	ev_signal_start (loop, &exitsig);
…		…
861	usually doesn't make much sense to set it to a lower value than C<0.01>,	909	usually doesn't make much sense to set it to a lower value than C<0.01>,
862	as this approaches the timing granularity of most systems. Note that if	910	as this approaches the timing granularity of most systems. Note that if
863	you do transactions with the outside world and you can't increase the	911	you do transactions with the outside world and you can't increase the
864	parallelity, then this setting will limit your transaction rate (if you	912	parallelity, then this setting will limit your transaction rate (if you
865	need to poll once per transaction and the I/O collect interval is 0.01,	913	need to poll once per transaction and the I/O collect interval is 0.01,
866	then you can't do more than 100 transations per second).	914	then you can't do more than 100 transactions per second).
867		915
868	Setting the I<timeout collect interval> can improve the opportunity for	916	Setting the I<timeout collect interval> can improve the opportunity for
869	saving power, as the program will "bundle" timer callback invocations that	917	saving power, as the program will "bundle" timer callback invocations that
870	are "near" in time together, by delaying some, thus reducing the number of	918	are "near" in time together, by delaying some, thus reducing the number of
871	times the process sleeps and wakes up again. Another useful technique to	919	times the process sleeps and wakes up again. Another useful technique to
…		…
879	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);	927	ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
880		928
881	=item ev_invoke_pending (loop)	929	=item ev_invoke_pending (loop)
882		930
883	This call will simply invoke all pending watchers while resetting their	931	This call will simply invoke all pending watchers while resetting their
884	pending state. Normally, C<ev_loop> does this automatically when required,	932	pending state. Normally, C<ev_run> does this automatically when required,
885	but when overriding the invoke callback this call comes handy.	933	but when overriding the invoke callback this call comes handy. This
		934	function can be invoked from a watcher - this can be useful for example
		935	when you want to do some lengthy calculation and want to pass further
		936	event handling to another thread (you still have to make sure only one
		937	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
886		938
887	=item int ev_pending_count (loop)	939	=item int ev_pending_count (loop)
888		940
889	Returns the number of pending watchers - zero indicates that no watchers	941	Returns the number of pending watchers - zero indicates that no watchers
890	are pending.	942	are pending.
891		943
892	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))	944	=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
893		945
894	This overrides the invoke pending functionality of the loop: Instead of	946	This overrides the invoke pending functionality of the loop: Instead of
895	invoking all pending watchers when there are any, C<ev_loop> will call	947	invoking all pending watchers when there are any, C<ev_run> will call
896	this callback instead. This is useful, for example, when you want to	948	this callback instead. This is useful, for example, when you want to
897	invoke the actual watchers inside another context (another thread etc.).	949	invoke the actual watchers inside another context (another thread etc.).
898		950
899	If you want to reset the callback, use C<ev_invoke_pending> as new	951	If you want to reset the callback, use C<ev_invoke_pending> as new
900	callback.	952	callback.
…		…
903		955
904	Sometimes you want to share the same loop between multiple threads. This	956	Sometimes you want to share the same loop between multiple threads. This
905	can be done relatively simply by putting mutex_lock/unlock calls around	957	can be done relatively simply by putting mutex_lock/unlock calls around
906	each call to a libev function.	958	each call to a libev function.
907		959
908	However, C<ev_loop> can run an indefinite time, so it is not feasible to	960	However, C<ev_run> can run an indefinite time, so it is not feasible
909	wait for it to return. One way around this is to wake up the loop via	961	to wait for it to return. One way around this is to wake up the event
910	C<ev_unloop> and C<av_async_send>, another way is to set these I<release>	962	loop via C<ev_break> and C<av_async_send>, another way is to set these
911	and I<acquire> callbacks on the loop.	963	I<release> and I<acquire> callbacks on the loop.
912		964
913	When set, then C<release> will be called just before the thread is	965	When set, then C<release> will be called just before the thread is
914	suspended waiting for new events, and C<acquire> is called just	966	suspended waiting for new events, and C<acquire> is called just
915	afterwards.	967	afterwards.
916		968
…		…
919		971
920	While event loop modifications are allowed between invocations of	972	While event loop modifications are allowed between invocations of
921	C<release> and C<acquire> (that's their only purpose after all), no	973	C<release> and C<acquire> (that's their only purpose after all), no
922	modifications done will affect the event loop, i.e. adding watchers will	974	modifications done will affect the event loop, i.e. adding watchers will
923	have no effect on the set of file descriptors being watched, or the time	975	have no effect on the set of file descriptors being watched, or the time
924	waited. USe an C<ev_async> watcher to wake up C<ev_loop> when you want it	976	waited. Use an C<ev_async> watcher to wake up C<ev_run> when you want it
925	to take note of any changes you made.	977	to take note of any changes you made.
926		978
927	In theory, threads executing C<ev_loop> will be async-cancel safe between	979	In theory, threads executing C<ev_run> will be async-cancel safe between
928	invocations of C<release> and C<acquire>.	980	invocations of C<release> and C<acquire>.
929		981
930	See also the locking example in the C<THREADS> section later in this	982	See also the locking example in the C<THREADS> section later in this
931	document.	983	document.
932		984
…		…
934		986
935	=item ev_userdata (loop)	987	=item ev_userdata (loop)
936		988
937	Set and retrieve a single C<void *> associated with a loop. When	989	Set and retrieve a single C<void *> associated with a loop. When
938	C<ev_set_userdata> has never been called, then C<ev_userdata> returns	990	C<ev_set_userdata> has never been called, then C<ev_userdata> returns
939	C<0.>	991	C<0>.
940		992
941	These two functions can be used to associate arbitrary data with a loop,	993	These two functions can be used to associate arbitrary data with a loop,
942	and are intended solely for the C<invoke_pending_cb>, C<release> and	994	and are intended solely for the C<invoke_pending_cb>, C<release> and
943	C<acquire> callbacks described above, but of course can be (ab-)used for	995	C<acquire> callbacks described above, but of course can be (ab-)used for
944	any other purpose as well.	996	any other purpose as well.
945		997
946	=item ev_loop_verify (loop)	998	=item ev_verify (loop)
947		999
948	This function only does something when C<EV_VERIFY> support has been	1000	This function only does something when C<EV_VERIFY> support has been
949	compiled in, which is the default for non-minimal builds. It tries to go	1001	compiled in, which is the default for non-minimal builds. It tries to go
950	through all internal structures and checks them for validity. If anything	1002	through all internal structures and checks them for validity. If anything
951	is found to be inconsistent, it will print an error message to standard	1003	is found to be inconsistent, it will print an error message to standard
…		…
962		1014
963	In the following description, uppercase C<TYPE> in names stands for the	1015	In the following description, uppercase C<TYPE> in names stands for the
964	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer	1016	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
965	watchers and C<ev_io_start> for I/O watchers.	1017	watchers and C<ev_io_start> for I/O watchers.
966		1018
967	A watcher is a structure that you create and register to record your	1019	A watcher is an opaque structure that you allocate and register to record
968	interest in some event. For instance, if you want to wait for STDIN to	1020	your interest in some event. To make a concrete example, imagine you want
969	become readable, you would create an C<ev_io> watcher for that:	1021	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1022	for that:
970		1023
971	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)	1024	static void my_cb (struct ev_loop *loop, ev_io *w, int revents)
972	{	1025	{
973	ev_io_stop (w);	1026	ev_io_stop (w);
974	ev_unloop (loop, EVUNLOOP_ALL);	1027	ev_break (loop, EVBREAK_ALL);
975	}	1028	}
976		1029
977	struct ev_loop *loop = ev_default_loop (0);	1030	struct ev_loop *loop = ev_default_loop (0);
978		1031
979	ev_io stdin_watcher;	1032	ev_io stdin_watcher;
980		1033
981	ev_init (&stdin_watcher, my_cb);	1034	ev_init (&stdin_watcher, my_cb);
982	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);	1035	ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
983	ev_io_start (loop, &stdin_watcher);	1036	ev_io_start (loop, &stdin_watcher);
984		1037
985	ev_loop (loop, 0);	1038	ev_run (loop, 0);
986		1039
987	As you can see, you are responsible for allocating the memory for your	1040	As you can see, you are responsible for allocating the memory for your
988	watcher structures (and it is I<usually> a bad idea to do this on the	1041	watcher structures (and it is I<usually> a bad idea to do this on the
989	stack).	1042	stack).
990		1043
991	Each watcher has an associated watcher structure (called C<struct ev_TYPE>	1044	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
992	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).	1045	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
993		1046
994	Each watcher structure must be initialised by a call to C<ev_init	1047	Each watcher structure must be initialised by a call to C<ev_init (watcher
995	(watcher *, callback)>, which expects a callback to be provided. This	1048	*, callback)>, which expects a callback to be provided. This callback is
996	callback gets invoked each time the event occurs (or, in the case of I/O	1049	invoked each time the event occurs (or, in the case of I/O watchers, each
997	watchers, each time the event loop detects that the file descriptor given	1050	time the event loop detects that the file descriptor given is readable
998	is readable and/or writable).	1051	and/or writable).
999		1052
1000	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>	1053	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
1001	macro to configure it, with arguments specific to the watcher type. There	1054	macro to configure it, with arguments specific to the watcher type. There
1002	is also a macro to combine initialisation and setting in one call: C<<	1055	is also a macro to combine initialisation and setting in one call: C<<
1003	ev_TYPE_init (watcher *, callback, ...) >>.	1056	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
1026	=item C<EV_WRITE>	1079	=item C<EV_WRITE>
1027		1080
1028	The file descriptor in the C<ev_io> watcher has become readable and/or	1081	The file descriptor in the C<ev_io> watcher has become readable and/or
1029	writable.	1082	writable.
1030		1083
1031	=item C<EV_TIMEOUT>	1084	=item C<EV_TIMER>
1032		1085
1033	The C<ev_timer> watcher has timed out.	1086	The C<ev_timer> watcher has timed out.
1034		1087
1035	=item C<EV_PERIODIC>	1088	=item C<EV_PERIODIC>
1036		1089
…		…
1054		1107
1055	=item C<EV_PREPARE>	1108	=item C<EV_PREPARE>
1056		1109
1057	=item C<EV_CHECK>	1110	=item C<EV_CHECK>
1058		1111
1059	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts	1112	All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts
1060	to gather new events, and all C<ev_check> watchers are invoked just after	1113	to gather new events, and all C<ev_check> watchers are invoked just after
1061	C<ev_loop> has gathered them, but before it invokes any callbacks for any	1114	C<ev_run> has gathered them, but before it invokes any callbacks for any
1062	received events. Callbacks of both watcher types can start and stop as	1115	received events. Callbacks of both watcher types can start and stop as
1063	many watchers as they want, and all of them will be taken into account	1116	many watchers as they want, and all of them will be taken into account
1064	(for example, a C<ev_prepare> watcher might start an idle watcher to keep	1117	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
1065	C<ev_loop> from blocking).	1118	C<ev_run> from blocking).
1066		1119
1067	=item C<EV_EMBED>	1120	=item C<EV_EMBED>
1068		1121
1069	The embedded event loop specified in the C<ev_embed> watcher needs attention.	1122	The embedded event loop specified in the C<ev_embed> watcher needs attention.
1070		1123
1071	=item C<EV_FORK>	1124	=item C<EV_FORK>
1072		1125
1073	The event loop has been resumed in the child process after fork (see	1126	The event loop has been resumed in the child process after fork (see
1074	C<ev_fork>).	1127	C<ev_fork>).
		1128
		1129	=item C<EV_CLEANUP>
		1130
		1131	The event loop is about to be destroyed (see C<ev_cleanup>).
1075		1132
1076	=item C<EV_ASYNC>	1133	=item C<EV_ASYNC>
1077		1134
1078	The given async watcher has been asynchronously notified (see C<ev_async>).	1135	The given async watcher has been asynchronously notified (see C<ev_async>).
1079		1136
…		…
1126		1183
1127	ev_io w;	1184	ev_io w;
1128	ev_init (&w, my_cb);	1185	ev_init (&w, my_cb);
1129	ev_io_set (&w, STDIN_FILENO, EV_READ);	1186	ev_io_set (&w, STDIN_FILENO, EV_READ);
1130		1187
1131	=item C<ev_TYPE_set> (ev_TYPE *, [args])	1188	=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
1132		1189
1133	This macro initialises the type-specific parts of a watcher. You need to	1190	This macro initialises the type-specific parts of a watcher. You need to
1134	call C<ev_init> at least once before you call this macro, but you can	1191	call C<ev_init> at least once before you call this macro, but you can
1135	call C<ev_TYPE_set> any number of times. You must not, however, call this	1192	call C<ev_TYPE_set> any number of times. You must not, however, call this
1136	macro on a watcher that is active (it can be pending, however, which is a	1193	macro on a watcher that is active (it can be pending, however, which is a
…		…
1149		1206
1150	Example: Initialise and set an C<ev_io> watcher in one step.	1207	Example: Initialise and set an C<ev_io> watcher in one step.
1151		1208
1152	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);	1209	ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1153		1210
1154	=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher)	1211	=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1155		1212
1156	Starts (activates) the given watcher. Only active watchers will receive	1213	Starts (activates) the given watcher. Only active watchers will receive
1157	events. If the watcher is already active nothing will happen.	1214	events. If the watcher is already active nothing will happen.
1158		1215
1159	Example: Start the C<ev_io> watcher that is being abused as example in this	1216	Example: Start the C<ev_io> watcher that is being abused as example in this
1160	whole section.	1217	whole section.
1161		1218
1162	ev_io_start (EV_DEFAULT_UC, &w);	1219	ev_io_start (EV_DEFAULT_UC, &w);
1163		1220
1164	=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher)	1221	=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1165		1222
1166	Stops the given watcher if active, and clears the pending status (whether	1223	Stops the given watcher if active, and clears the pending status (whether
1167	the watcher was active or not).	1224	the watcher was active or not).
1168		1225
1169	It is possible that stopped watchers are pending - for example,	1226	It is possible that stopped watchers are pending - for example,
…		…
1194	=item ev_cb_set (ev_TYPE *watcher, callback)	1251	=item ev_cb_set (ev_TYPE *watcher, callback)
1195		1252
1196	Change the callback. You can change the callback at virtually any time	1253	Change the callback. You can change the callback at virtually any time
1197	(modulo threads).	1254	(modulo threads).
1198		1255
1199	=item ev_set_priority (ev_TYPE *watcher, priority)	1256	=item ev_set_priority (ev_TYPE *watcher, int priority)
1200		1257
1201	=item int ev_priority (ev_TYPE *watcher)	1258	=item int ev_priority (ev_TYPE *watcher)
1202		1259
1203	Set and query the priority of the watcher. The priority is a small	1260	Set and query the priority of the watcher. The priority is a small
1204	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>	1261	integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
…		…
1236	watcher isn't pending it does nothing and returns C<0>.	1293	watcher isn't pending it does nothing and returns C<0>.
1237		1294
1238	Sometimes it can be useful to "poll" a watcher instead of waiting for its	1295	Sometimes it can be useful to "poll" a watcher instead of waiting for its
1239	callback to be invoked, which can be accomplished with this function.	1296	callback to be invoked, which can be accomplished with this function.
1240		1297
1241	=item ev_feed_event (struct ev_loop *, watcher *, int revents)	1298	=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
1242		1299
1243	Feeds the given event set into the event loop, as if the specified event	1300	Feeds the given event set into the event loop, as if the specified event
1244	had happened for the specified watcher (which must be a pointer to an	1301	had happened for the specified watcher (which must be a pointer to an
1245	initialised but not necessarily started event watcher). Obviously you must	1302	initialised but not necessarily started event watcher). Obviously you must
1246	not free the watcher as long as it has pending events.	1303	not free the watcher as long as it has pending events.
…		…
1251		1308
1252	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related	1309	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1253	functions that do not need a watcher.	1310	functions that do not need a watcher.
1254		1311
1255	=back	1312	=back
1256
1257		1313
1258	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1314	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
1259		1315
1260	Each watcher has, by default, a member C<void *data> that you can change	1316	Each watcher has, by default, a member C<void *data> that you can change
1261	and read at any time: libev will completely ignore it. This can be used	1317	and read at any time: libev will completely ignore it. This can be used
…		…
1317	t2_cb (EV_P_ ev_timer *w, int revents)	1373	t2_cb (EV_P_ ev_timer *w, int revents)
1318	{	1374	{
1319	struct my_biggy big = (struct my_biggy *)	1375	struct my_biggy big = (struct my_biggy *)
1320	(((char *)w) - offsetof (struct my_biggy, t2));	1376	(((char *)w) - offsetof (struct my_biggy, t2));
1321	}	1377	}
		1378
		1379	=head2 WATCHER STATES
		1380
		1381	There are various watcher states mentioned throughout this manual -
		1382	active, pending and so on. In this section these states and the rules to
		1383	transition between them will be described in more detail - and while these
		1384	rules might look complicated, they usually do "the right thing".
		1385
		1386	=over 4
		1387
		1388	=item initialiased
		1389
		1390	Before a watcher can be registered with the event looop it has to be
		1391	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1392	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
		1393
		1394	In this state it is simply some block of memory that is suitable for use
		1395	in an event loop. It can be moved around, freed, reused etc. at will.
		1396
		1397	=item started/running/active
		1398
		1399	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
		1400	property of the event loop, and is actively waiting for events. While in
		1401	this state it cannot be accessed (except in a few documented ways), moved,
		1402	freed or anything else - the only legal thing is to keep a pointer to it,
		1403	and call libev functions on it that are documented to work on active watchers.
		1404
		1405	=item pending
		1406
		1407	If a watcher is active and libev determines that an event it is interested
		1408	in has occurred (such as a timer expiring), it will become pending. It will
		1409	stay in this pending state until either it is stopped or its callback is
		1410	about to be invoked, so it is not normally pending inside the watcher
		1411	callback.
		1412
		1413	The watcher might or might not be active while it is pending (for example,
		1414	an expired non-repeating timer can be pending but no longer active). If it
		1415	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1416	but it is still property of the event loop at this time, so cannot be
		1417	moved, freed or reused. And if it is active the rules described in the
		1418	previous item still apply.
		1419
		1420	It is also possible to feed an event on a watcher that is not active (e.g.
		1421	via C<ev_feed_event>), in which case it becomes pending without being
		1422	active.
		1423
		1424	=item stopped
		1425
		1426	A watcher can be stopped implicitly by libev (in which case it might still
		1427	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
		1428	latter will clear any pending state the watcher might be in, regardless
		1429	of whether it was active or not, so stopping a watcher explicitly before
		1430	freeing it is often a good idea.
		1431
		1432	While stopped (and not pending) the watcher is essentially in the
		1433	initialised state, that is it can be reused, moved, modified in any way
		1434	you wish.
		1435
		1436	=back
1322		1437
1323	=head2 WATCHER PRIORITY MODELS	1438	=head2 WATCHER PRIORITY MODELS
1324		1439
1325	Many event loops support I<watcher priorities>, which are usually small	1440	Many event loops support I<watcher priorities>, which are usually small
1326	integers that influence the ordering of event callback invocation	1441	integers that influence the ordering of event callback invocation
…		…
1369		1484
1370	For example, to emulate how many other event libraries handle priorities,	1485	For example, to emulate how many other event libraries handle priorities,
1371	you can associate an C<ev_idle> watcher to each such watcher, and in	1486	you can associate an C<ev_idle> watcher to each such watcher, and in
1372	the normal watcher callback, you just start the idle watcher. The real	1487	the normal watcher callback, you just start the idle watcher. The real
1373	processing is done in the idle watcher callback. This causes libev to	1488	processing is done in the idle watcher callback. This causes libev to
1374	continously poll and process kernel event data for the watcher, but when	1489	continuously poll and process kernel event data for the watcher, but when
1375	the lock-out case is known to be rare (which in turn is rare :), this is	1490	the lock-out case is known to be rare (which in turn is rare :), this is
1376	workable.	1491	workable.
1377		1492
1378	Usually, however, the lock-out model implemented that way will perform	1493	Usually, however, the lock-out model implemented that way will perform
1379	miserably under the type of load it was designed to handle. In that case,	1494	miserably under the type of load it was designed to handle. In that case,
…		…
1393	{	1508	{
1394	// stop the I/O watcher, we received the event, but	1509	// stop the I/O watcher, we received the event, but
1395	// are not yet ready to handle it.	1510	// are not yet ready to handle it.
1396	ev_io_stop (EV_A_ w);	1511	ev_io_stop (EV_A_ w);
1397		1512
1398	// start the idle watcher to ahndle the actual event.	1513	// start the idle watcher to handle the actual event.
1399	// it will not be executed as long as other watchers	1514	// it will not be executed as long as other watchers
1400	// with the default priority are receiving events.	1515	// with the default priority are receiving events.
1401	ev_idle_start (EV_A_ &idle);	1516	ev_idle_start (EV_A_ &idle);
1402	}	1517	}
1403		1518
…		…
1457		1572
1458	If you cannot use non-blocking mode, then force the use of a	1573	If you cannot use non-blocking mode, then force the use of a
1459	known-to-be-good backend (at the time of this writing, this includes only	1574	known-to-be-good backend (at the time of this writing, this includes only
1460	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file	1575	C<EVBACKEND_SELECT> and C<EVBACKEND_POLL>). The same applies to file
1461	descriptors for which non-blocking operation makes no sense (such as	1576	descriptors for which non-blocking operation makes no sense (such as
1462	files) - libev doesn't guarentee any specific behaviour in that case.	1577	files) - libev doesn't guarantee any specific behaviour in that case.
1463		1578
1464	Another thing you have to watch out for is that it is quite easy to	1579	Another thing you have to watch out for is that it is quite easy to
1465	receive "spurious" readiness notifications, that is your callback might	1580	receive "spurious" readiness notifications, that is your callback might
1466	be called with C<EV_READ> but a subsequent C<read>(2) will actually block	1581	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
1467	because there is no data. Not only are some backends known to create a	1582	because there is no data. Not only are some backends known to create a
…		…
1532		1647
1533	So when you encounter spurious, unexplained daemon exits, make sure you	1648	So when you encounter spurious, unexplained daemon exits, make sure you
1534	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon	1649	ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1535	somewhere, as that would have given you a big clue).	1650	somewhere, as that would have given you a big clue).
1536		1651
		1652	=head3 The special problem of accept()ing when you can't
		1653
		1654	Many implementations of the POSIX C<accept> function (for example,
		1655	found in post-2004 Linux) have the peculiar behaviour of not removing a
		1656	connection from the pending queue in all error cases.
		1657
		1658	For example, larger servers often run out of file descriptors (because
		1659	of resource limits), causing C<accept> to fail with C<ENFILE> but not
		1660	rejecting the connection, leading to libev signalling readiness on
		1661	the next iteration again (the connection still exists after all), and
		1662	typically causing the program to loop at 100% CPU usage.
		1663
		1664	Unfortunately, the set of errors that cause this issue differs between
		1665	operating systems, there is usually little the app can do to remedy the
		1666	situation, and no known thread-safe method of removing the connection to
		1667	cope with overload is known (to me).
		1668
		1669	One of the easiest ways to handle this situation is to just ignore it
		1670	- when the program encounters an overload, it will just loop until the
		1671	situation is over. While this is a form of busy waiting, no OS offers an
		1672	event-based way to handle this situation, so it's the best one can do.
		1673
		1674	A better way to handle the situation is to log any errors other than
		1675	C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such
		1676	messages, and continue as usual, which at least gives the user an idea of
		1677	what could be wrong ("raise the ulimit!"). For extra points one could stop
		1678	the C<ev_io> watcher on the listening fd "for a while", which reduces CPU
		1679	usage.
		1680
		1681	If your program is single-threaded, then you could also keep a dummy file
		1682	descriptor for overload situations (e.g. by opening F</dev/null>), and
		1683	when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>,
		1684	close that fd, and create a new dummy fd. This will gracefully refuse
		1685	clients under typical overload conditions.
		1686
		1687	The last way to handle it is to simply log the error and C<exit>, as
		1688	is often done with C<malloc> failures, but this results in an easy
		1689	opportunity for a DoS attack.
1537		1690
1538	=head3 Watcher-Specific Functions	1691	=head3 Watcher-Specific Functions
1539		1692
1540	=over 4	1693	=over 4
1541		1694
…		…
1573	...	1726	...
1574	struct ev_loop *loop = ev_default_init (0);	1727	struct ev_loop *loop = ev_default_init (0);
1575	ev_io stdin_readable;	1728	ev_io stdin_readable;
1576	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);	1729	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
1577	ev_io_start (loop, &stdin_readable);	1730	ev_io_start (loop, &stdin_readable);
1578	ev_loop (loop, 0);	1731	ev_run (loop, 0);
1579		1732
1580		1733
1581	=head2 C<ev_timer> - relative and optionally repeating timeouts	1734	=head2 C<ev_timer> - relative and optionally repeating timeouts
1582		1735
1583	Timer watchers are simple relative timers that generate an event after a	1736	Timer watchers are simple relative timers that generate an event after a
…		…
1592	The callback is guaranteed to be invoked only I<after> its timeout has	1745	The callback is guaranteed to be invoked only I<after> its timeout has
1593	passed (not I<at>, so on systems with very low-resolution clocks this	1746	passed (not I<at>, so on systems with very low-resolution clocks this
1594	might introduce a small delay). If multiple timers become ready during the	1747	might introduce a small delay). If multiple timers become ready during the
1595	same loop iteration then the ones with earlier time-out values are invoked	1748	same loop iteration then the ones with earlier time-out values are invoked
1596	before ones of the same priority with later time-out values (but this is	1749	before ones of the same priority with later time-out values (but this is
1597	no longer true when a callback calls C<ev_loop> recursively).	1750	no longer true when a callback calls C<ev_run> recursively).
1598		1751
1599	=head3 Be smart about timeouts	1752	=head3 Be smart about timeouts
1600		1753
1601	Many real-world problems involve some kind of timeout, usually for error	1754	Many real-world problems involve some kind of timeout, usually for error
1602	recovery. A typical example is an HTTP request - if the other side hangs,	1755	recovery. A typical example is an HTTP request - if the other side hangs,
…		…
1688	ev_tstamp timeout = last_activity + 60.;	1841	ev_tstamp timeout = last_activity + 60.;
1689		1842
1690	// if last_activity + 60. is older than now, we did time out	1843	// if last_activity + 60. is older than now, we did time out
1691	if (timeout < now)	1844	if (timeout < now)
1692	{	1845	{
1693	// timeout occured, take action	1846	// timeout occurred, take action
1694	}	1847	}
1695	else	1848	else
1696	{	1849	{
1697	// callback was invoked, but there was some activity, re-arm	1850	// callback was invoked, but there was some activity, re-arm
1698	// the watcher to fire in last_activity + 60, which is	1851	// the watcher to fire in last_activity + 60, which is
…		…
1720	to the current time (meaning we just have some activity :), then call the	1873	to the current time (meaning we just have some activity :), then call the
1721	callback, which will "do the right thing" and start the timer:	1874	callback, which will "do the right thing" and start the timer:
1722		1875
1723	ev_init (timer, callback);	1876	ev_init (timer, callback);
1724	last_activity = ev_now (loop);	1877	last_activity = ev_now (loop);
1725	callback (loop, timer, EV_TIMEOUT);	1878	callback (loop, timer, EV_TIMER);
1726		1879
1727	And when there is some activity, simply store the current time in	1880	And when there is some activity, simply store the current time in
1728	C<last_activity>, no libev calls at all:	1881	C<last_activity>, no libev calls at all:
1729		1882
1730	last_actiivty = ev_now (loop);	1883	last_activity = ev_now (loop);
1731		1884
1732	This technique is slightly more complex, but in most cases where the	1885	This technique is slightly more complex, but in most cases where the
1733	time-out is unlikely to be triggered, much more efficient.	1886	time-out is unlikely to be triggered, much more efficient.
1734		1887
1735	Changing the timeout is trivial as well (if it isn't hard-coded in the	1888	Changing the timeout is trivial as well (if it isn't hard-coded in the
…		…
1773		1926
1774	=head3 The special problem of time updates	1927	=head3 The special problem of time updates
1775		1928
1776	Establishing the current time is a costly operation (it usually takes at	1929	Establishing the current time is a costly operation (it usually takes at
1777	least two system calls): EV therefore updates its idea of the current	1930	least two system calls): EV therefore updates its idea of the current
1778	time only before and after C<ev_loop> collects new events, which causes a	1931	time only before and after C<ev_run> collects new events, which causes a
1779	growing difference between C<ev_now ()> and C<ev_time ()> when handling	1932	growing difference between C<ev_now ()> and C<ev_time ()> when handling
1780	lots of events in one iteration.	1933	lots of events in one iteration.
1781		1934
1782	The relative timeouts are calculated relative to the C<ev_now ()>	1935	The relative timeouts are calculated relative to the C<ev_now ()>
1783	time. This is usually the right thing as this timestamp refers to the time	1936	time. This is usually the right thing as this timestamp refers to the time
…		…
1854	C<repeat> value), or reset the running timer to the C<repeat> value.	2007	C<repeat> value), or reset the running timer to the C<repeat> value.
1855		2008
1856	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a	2009	This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1857	usage example.	2010	usage example.
1858		2011
1859	=item ev_timer_remaining (loop, ev_timer *)	2012	=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
1860		2013
1861	Returns the remaining time until a timer fires. If the timer is active,	2014	Returns the remaining time until a timer fires. If the timer is active,
1862	then this time is relative to the current event loop time, otherwise it's	2015	then this time is relative to the current event loop time, otherwise it's
1863	the timeout value currently configured.	2016	the timeout value currently configured.
1864		2017
1865	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns	2018	That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
1866	C<5>. When the timer is started and one second passes, C<ev_timer_remain>	2019	C<5>. When the timer is started and one second passes, C<ev_timer_remaining>
1867	will return C<4>. When the timer expires and is restarted, it will return	2020	will return C<4>. When the timer expires and is restarted, it will return
1868	roughly C<7> (likely slightly less as callback invocation takes some time,	2021	roughly C<7> (likely slightly less as callback invocation takes some time,
1869	too), and so on.	2022	too), and so on.
1870		2023
1871	=item ev_tstamp repeat [read-write]	2024	=item ev_tstamp repeat [read-write]
…		…
1900	}	2053	}
1901		2054
1902	ev_timer mytimer;	2055	ev_timer mytimer;
1903	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */	2056	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
1904	ev_timer_again (&mytimer); /* start timer */	2057	ev_timer_again (&mytimer); /* start timer */
1905	ev_loop (loop, 0);	2058	ev_run (loop, 0);
1906		2059
1907	// and in some piece of code that gets executed on any "activity":	2060	// and in some piece of code that gets executed on any "activity":
1908	// reset the timeout to start ticking again at 10 seconds	2061	// reset the timeout to start ticking again at 10 seconds
1909	ev_timer_again (&mytimer);	2062	ev_timer_again (&mytimer);
1910		2063
…		…
1936		2089
1937	As with timers, the callback is guaranteed to be invoked only when the	2090	As with timers, the callback is guaranteed to be invoked only when the
1938	point in time where it is supposed to trigger has passed. If multiple	2091	point in time where it is supposed to trigger has passed. If multiple
1939	timers become ready during the same loop iteration then the ones with	2092	timers become ready during the same loop iteration then the ones with
1940	earlier time-out values are invoked before ones with later time-out values	2093	earlier time-out values are invoked before ones with later time-out values
1941	(but this is no longer true when a callback calls C<ev_loop> recursively).	2094	(but this is no longer true when a callback calls C<ev_run> recursively).
1942		2095
1943	=head3 Watcher-Specific Functions and Data Members	2096	=head3 Watcher-Specific Functions and Data Members
1944		2097
1945	=over 4	2098	=over 4
1946		2099
…		…
2074	Example: Call a callback every hour, or, more precisely, whenever the	2227	Example: Call a callback every hour, or, more precisely, whenever the
2075	system time is divisible by 3600. The callback invocation times have	2228	system time is divisible by 3600. The callback invocation times have
2076	potentially a lot of jitter, but good long-term stability.	2229	potentially a lot of jitter, but good long-term stability.
2077		2230
2078	static void	2231	static void
2079	clock_cb (struct ev_loop *loop, ev_io *w, int revents)	2232	clock_cb (struct ev_loop *loop, ev_periodic *w, int revents)
2080	{	2233	{
2081	... its now a full hour (UTC, or TAI or whatever your clock follows)	2234	... its now a full hour (UTC, or TAI or whatever your clock follows)
2082	}	2235	}
2083		2236
2084	ev_periodic hourly_tick;	2237	ev_periodic hourly_tick;
…		…
2107		2260
2108	=head2 C<ev_signal> - signal me when a signal gets signalled!	2261	=head2 C<ev_signal> - signal me when a signal gets signalled!
2109		2262
2110	Signal watchers will trigger an event when the process receives a specific	2263	Signal watchers will trigger an event when the process receives a specific
2111	signal one or more times. Even though signals are very asynchronous, libev	2264	signal one or more times. Even though signals are very asynchronous, libev
2112	will try it's best to deliver signals synchronously, i.e. as part of the	2265	will try its best to deliver signals synchronously, i.e. as part of the
2113	normal event processing, like any other event.	2266	normal event processing, like any other event.
2114		2267
2115	If you want signals to be delivered truly asynchronously, just use	2268	If you want signals to be delivered truly asynchronously, just use
2116	C<sigaction> as you would do without libev and forget about sharing	2269	C<sigaction> as you would do without libev and forget about sharing
2117	the signal. You can even use C<ev_async> from a signal handler to	2270	the signal. You can even use C<ev_async> from a signal handler to
…		…
2131	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should	2284	C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2132	not be unduly interrupted. If you have a problem with system calls getting	2285	not be unduly interrupted. If you have a problem with system calls getting
2133	interrupted by signals you can block all signals in an C<ev_check> watcher	2286	interrupted by signals you can block all signals in an C<ev_check> watcher
2134	and unblock them in an C<ev_prepare> watcher.	2287	and unblock them in an C<ev_prepare> watcher.
2135		2288
2136	=head3 The special problem of inheritance over execve	2289	=head3 The special problem of inheritance over fork/execve/pthread_create
2137		2290
2138	Both the signal mask (C<sigprocmask>) and the signal disposition	2291	Both the signal mask (C<sigprocmask>) and the signal disposition
2139	(C<sigaction>) are unspecified after starting a signal watcher (and after	2292	(C<sigaction>) are unspecified after starting a signal watcher (and after
2140	stopping it again), that is, libev might or might not block the signal,	2293	stopping it again), that is, libev might or might not block the signal,
2141	and might or might not set or restore the installed signal handler.	2294	and might or might not set or restore the installed signal handler.
…		…
2151		2304
2152	The simplest way to ensure that the signal mask is reset in the child is	2305	The simplest way to ensure that the signal mask is reset in the child is
2153	to install a fork handler with C<pthread_atfork> that resets it. That will	2306	to install a fork handler with C<pthread_atfork> that resets it. That will
2154	catch fork calls done by libraries (such as the libc) as well.	2307	catch fork calls done by libraries (such as the libc) as well.
2155		2308
2156	In current versions of libev, you can also ensure that the signal mask is	2309	In current versions of libev, the signal will not be blocked indefinitely
2157	not blocking any signals (except temporarily, so thread users watch out)	2310	unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces
2158	by specifying the C<EVFLAG_NOSIGFD> when creating the event loop. This	2311	the window of opportunity for problems, it will not go away, as libev
2159	is not guaranteed for future versions, however.	2312	I<has> to modify the signal mask, at least temporarily.
		2313
		2314	So I can't stress this enough: I<If you do not reset your signal mask when
		2315	you expect it to be empty, you have a race condition in your code>. This
		2316	is not a libev-specific thing, this is true for most event libraries.
2160		2317
2161	=head3 Watcher-Specific Functions and Data Members	2318	=head3 Watcher-Specific Functions and Data Members
2162		2319
2163	=over 4	2320	=over 4
2164		2321
…		…
2180	Example: Try to exit cleanly on SIGINT.	2337	Example: Try to exit cleanly on SIGINT.
2181		2338
2182	static void	2339	static void
2183	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)	2340	sigint_cb (struct ev_loop *loop, ev_signal *w, int revents)
2184	{	2341	{
2185	ev_unloop (loop, EVUNLOOP_ALL);	2342	ev_break (loop, EVBREAK_ALL);
2186	}	2343	}
2187		2344
2188	ev_signal signal_watcher;	2345	ev_signal signal_watcher;
2189	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);	2346	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
2190	ev_signal_start (loop, &signal_watcher);	2347	ev_signal_start (loop, &signal_watcher);
…		…
2576		2733
2577	Prepare and check watchers are usually (but not always) used in pairs:	2734	Prepare and check watchers are usually (but not always) used in pairs:
2578	prepare watchers get invoked before the process blocks and check watchers	2735	prepare watchers get invoked before the process blocks and check watchers
2579	afterwards.	2736	afterwards.
2580		2737
2581	You I<must not> call C<ev_loop> or similar functions that enter	2738	You I<must not> call C<ev_run> or similar functions that enter
2582	the current event loop from either C<ev_prepare> or C<ev_check>	2739	the current event loop from either C<ev_prepare> or C<ev_check>
2583	watchers. Other loops than the current one are fine, however. The	2740	watchers. Other loops than the current one are fine, however. The
2584	rationale behind this is that you do not need to check for recursion in	2741	rationale behind this is that you do not need to check for recursion in
2585	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,	2742	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
2586	C<ev_check> so if you have one watcher of each kind they will always be	2743	C<ev_check> so if you have one watcher of each kind they will always be
…		…
2754		2911
2755	if (timeout >= 0)	2912	if (timeout >= 0)
2756	// create/start timer	2913	// create/start timer
2757		2914
2758	// poll	2915	// poll
2759	ev_loop (EV_A_ 0);	2916	ev_run (EV_A_ 0);
2760		2917
2761	// stop timer again	2918	// stop timer again
2762	if (timeout >= 0)	2919	if (timeout >= 0)
2763	ev_timer_stop (EV_A_ &to);	2920	ev_timer_stop (EV_A_ &to);
2764		2921
…		…
2842	if you do not want that, you need to temporarily stop the embed watcher).	2999	if you do not want that, you need to temporarily stop the embed watcher).
2843		3000
2844	=item ev_embed_sweep (loop, ev_embed *)	3001	=item ev_embed_sweep (loop, ev_embed *)
2845		3002
2846	Make a single, non-blocking sweep over the embedded loop. This works	3003	Make a single, non-blocking sweep over the embedded loop. This works
2847	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most	3004	similarly to C<ev_run (embedded_loop, EVRUN_NOWAIT)>, but in the most
2848	appropriate way for embedded loops.	3005	appropriate way for embedded loops.
2849		3006
2850	=item struct ev_loop *other [read-only]	3007	=item struct ev_loop *other [read-only]
2851		3008
2852	The embedded event loop.	3009	The embedded event loop.
…		…
2912	C<ev_default_fork> cheats and calls it in the wrong process, the fork	3069	C<ev_default_fork> cheats and calls it in the wrong process, the fork
2913	handlers will be invoked, too, of course.	3070	handlers will be invoked, too, of course.
2914		3071
2915	=head3 The special problem of life after fork - how is it possible?	3072	=head3 The special problem of life after fork - how is it possible?
2916		3073
2917	Most uses of C<fork()> consist of forking, then some simple calls to ste	3074	Most uses of C<fork()> consist of forking, then some simple calls to set
2918	up/change the process environment, followed by a call to C<exec()>. This	3075	up/change the process environment, followed by a call to C<exec()>. This
2919	sequence should be handled by libev without any problems.	3076	sequence should be handled by libev without any problems.
2920		3077
2921	This changes when the application actually wants to do event handling	3078	This changes when the application actually wants to do event handling
2922	in the child, or both parent in child, in effect "continuing" after the	3079	in the child, or both parent in child, in effect "continuing" after the
…		…
2938	disadvantage of having to use multiple event loops (which do not support	3095	disadvantage of having to use multiple event loops (which do not support
2939	signal watchers).	3096	signal watchers).
2940		3097
2941	When this is not possible, or you want to use the default loop for	3098	When this is not possible, or you want to use the default loop for
2942	other reasons, then in the process that wants to start "fresh", call	3099	other reasons, then in the process that wants to start "fresh", call
2943	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3100	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
2944	the default loop will "orphan" (not stop) all registered watchers, so you	3101	Destroying the default loop will "orphan" (not stop) all registered
2945	have to be careful not to execute code that modifies those watchers. Note	3102	watchers, so you have to be careful not to execute code that modifies
2946	also that in that case, you have to re-register any signal watchers.	3103	those watchers. Note also that in that case, you have to re-register any
		3104	signal watchers.
2947		3105
2948	=head3 Watcher-Specific Functions and Data Members	3106	=head3 Watcher-Specific Functions and Data Members
2949		3107
2950	=over 4	3108	=over 4
2951		3109
2952	=item ev_fork_init (ev_signal *, callback)	3110	=item ev_fork_init (ev_fork *, callback)
2953		3111
2954	Initialises and configures the fork watcher - it has no parameters of any	3112	Initialises and configures the fork watcher - it has no parameters of any
2955	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3113	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
2956	believe me.	3114	really.
2957		3115
2958	=back	3116	=back
2959		3117
2960		3118
		3119	=head2 C<ev_cleanup> - even the best things end
		3120
		3121	Cleanup watchers are called just before the event loop is being destroyed
		3122	by a call to C<ev_loop_destroy>.
		3123
		3124	While there is no guarantee that the event loop gets destroyed, cleanup
		3125	watchers provide a convenient method to install cleanup hooks for your
		3126	program, worker threads and so on - you just to make sure to destroy the
		3127	loop when you want them to be invoked.
		3128
		3129	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3130	all other watchers, they do not keep a reference to the event loop (which
		3131	makes a lot of sense if you think about it). Like all other watchers, you
		3132	can call libev functions in the callback, except C<ev_cleanup_start>.
		3133
		3134	=head3 Watcher-Specific Functions and Data Members
		3135
		3136	=over 4
		3137
		3138	=item ev_cleanup_init (ev_cleanup *, callback)
		3139
		3140	Initialises and configures the cleanup watcher - it has no parameters of
		3141	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3142	pointless, I assure you.
		3143
		3144	=back
		3145
		3146	Example: Register an atexit handler to destroy the default loop, so any
		3147	cleanup functions are called.
		3148
		3149	static void
		3150	program_exits (void)
		3151	{
		3152	ev_loop_destroy (EV_DEFAULT_UC);
		3153	}
		3154
		3155	...
		3156	atexit (program_exits);
		3157
		3158
2961	=head2 C<ev_async> - how to wake up another event loop	3159	=head2 C<ev_async> - how to wake up an event loop
2962		3160
2963	In general, you cannot use an C<ev_loop> from multiple threads or other	3161	In general, you cannot use an C<ev_run> from multiple threads or other
2964	asynchronous sources such as signal handlers (as opposed to multiple event	3162	asynchronous sources such as signal handlers (as opposed to multiple event
2965	loops - those are of course safe to use in different threads).	3163	loops - those are of course safe to use in different threads).
2966		3164
2967	Sometimes, however, you need to wake up another event loop you do not	3165	Sometimes, however, you need to wake up an event loop you do not control,
2968	control, for example because it belongs to another thread. This is what	3166	for example because it belongs to another thread. This is what C<ev_async>
2969	C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you	3167	watchers do: as long as the C<ev_async> watcher is active, you can signal
2970	can signal it by calling C<ev_async_send>, which is thread- and signal	3168	it by calling C<ev_async_send>, which is thread- and signal safe.
2971	safe.
2972		3169
2973	This functionality is very similar to C<ev_signal> watchers, as signals,	3170	This functionality is very similar to C<ev_signal> watchers, as signals,
2974	too, are asynchronous in nature, and signals, too, will be compressed	3171	too, are asynchronous in nature, and signals, too, will be compressed
2975	(i.e. the number of callback invocations may be less than the number of	3172	(i.e. the number of callback invocations may be less than the number of
2976	C<ev_async_sent> calls).	3173	C<ev_async_sent> calls).
…		…
2981	=head3 Queueing	3178	=head3 Queueing
2982		3179
2983	C<ev_async> does not support queueing of data in any way. The reason	3180	C<ev_async> does not support queueing of data in any way. The reason
2984	is that the author does not know of a simple (or any) algorithm for a	3181	is that the author does not know of a simple (or any) algorithm for a
2985	multiple-writer-single-reader queue that works in all cases and doesn't	3182	multiple-writer-single-reader queue that works in all cases and doesn't
2986	need elaborate support such as pthreads.	3183	need elaborate support such as pthreads or unportable memory access
		3184	semantics.
2987		3185
2988	That means that if you want to queue data, you have to provide your own	3186	That means that if you want to queue data, you have to provide your own
2989	queue. But at least I can tell you how to implement locking around your	3187	queue. But at least I can tell you how to implement locking around your
2990	queue:	3188	queue:
2991		3189
…		…
3130		3328
3131	If C<timeout> is less than 0, then no timeout watcher will be	3329	If C<timeout> is less than 0, then no timeout watcher will be
3132	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	3330	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
3133	repeat = 0) will be started. C<0> is a valid timeout.	3331	repeat = 0) will be started. C<0> is a valid timeout.
3134		3332
3135	The callback has the type C<void (*cb)(int revents, void *arg)> and gets	3333	The callback has the type C<void (*cb)(int revents, void *arg)> and is
3136	passed an C<revents> set like normal event callbacks (a combination of	3334	passed an C<revents> set like normal event callbacks (a combination of
3137	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	3335	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg>
3138	value passed to C<ev_once>. Note that it is possible to receive I<both>	3336	value passed to C<ev_once>. Note that it is possible to receive I<both>
3139	a timeout and an io event at the same time - you probably should give io	3337	a timeout and an io event at the same time - you probably should give io
3140	events precedence.	3338	events precedence.
3141		3339
3142	Example: wait up to ten seconds for data to appear on STDIN_FILENO.	3340	Example: wait up to ten seconds for data to appear on STDIN_FILENO.
3143		3341
3144	static void stdin_ready (int revents, void *arg)	3342	static void stdin_ready (int revents, void *arg)
3145	{	3343	{
3146	if (revents & EV_READ)	3344	if (revents & EV_READ)
3147	/* stdin might have data for us, joy! */;	3345	/* stdin might have data for us, joy! */;
3148	else if (revents & EV_TIMEOUT)	3346	else if (revents & EV_TIMER)
3149	/* doh, nothing entered */;	3347	/* doh, nothing entered */;
3150	}	3348	}
3151		3349
3152	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	3350	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
3153		3351
3154	=item ev_feed_fd_event (struct ev_loop *, int fd, int revents)	3352	=item ev_feed_fd_event (loop, int fd, int revents)
3155		3353
3156	Feed an event on the given fd, as if a file descriptor backend detected	3354	Feed an event on the given fd, as if a file descriptor backend detected
3157	the given events it.	3355	the given events it.
3158		3356
3159	=item ev_feed_signal_event (struct ev_loop *loop, int signum)	3357	=item ev_feed_signal_event (loop, int signum)
3160		3358
3161	Feed an event as if the given signal occurred (C<loop> must be the default	3359	Feed an event as if the given signal occurred (C<loop> must be the default
3162	loop!).	3360	loop!).
3163		3361
3164	=back	3362	=back
…		…
3183	=item * Priorities are not currently supported. Initialising priorities	3381	=item * Priorities are not currently supported. Initialising priorities
3184	will fail and all watchers will have the same priority, even though there	3382	will fail and all watchers will have the same priority, even though there
3185	is an ev_pri field.	3383	is an ev_pri field.
3186		3384
3187	=item * In libevent, the last base created gets the signals, in libev, the	3385	=item * In libevent, the last base created gets the signals, in libev, the
3188	first base created (== the default loop) gets the signals.	3386	base that registered the signal gets the signals.
3189		3387
3190	=item * Other members are not supported.	3388	=item * Other members are not supported.
3191		3389
3192	=item * The libev emulation is I<not> ABI compatible to libevent, you need	3390	=item * The libev emulation is I<not> ABI compatible to libevent, you need
3193	to use the libev header file and library.	3391	to use the libev header file and library.
…		…
3244		3442
3245	=over 4	3443	=over 4
3246		3444
3247	=item ev::TYPE::TYPE ()	3445	=item ev::TYPE::TYPE ()
3248		3446
3249	=item ev::TYPE::TYPE (struct ev_loop *)	3447	=item ev::TYPE::TYPE (loop)
3250		3448
3251	=item ev::TYPE::~TYPE	3449	=item ev::TYPE::~TYPE
3252		3450
3253	The constructor (optionally) takes an event loop to associate the watcher	3451	The constructor (optionally) takes an event loop to associate the watcher
3254	with. If it is omitted, it will use C<EV_DEFAULT>.	3452	with. If it is omitted, it will use C<EV_DEFAULT>.
…		…
3287	myclass obj;	3485	myclass obj;
3288	ev::io iow;	3486	ev::io iow;
3289	iow.set <myclass, &myclass::io_cb> (&obj);	3487	iow.set <myclass, &myclass::io_cb> (&obj);
3290		3488
3291	=item w->set (object *)	3489	=item w->set (object *)
3292
3293	This is an B<experimental> feature that might go away in a future version.
3294		3490
3295	This is a variation of a method callback - leaving out the method to call	3491	This is a variation of a method callback - leaving out the method to call
3296	will default the method to C<operator ()>, which makes it possible to use	3492	will default the method to C<operator ()>, which makes it possible to use
3297	functor objects without having to manually specify the C<operator ()> all	3493	functor objects without having to manually specify the C<operator ()> all
3298	the time. Incidentally, you can then also leave out the template argument	3494	the time. Incidentally, you can then also leave out the template argument
…		…
3331	Example: Use a plain function as callback.	3527	Example: Use a plain function as callback.
3332		3528
3333	static void io_cb (ev::io &w, int revents) { }	3529	static void io_cb (ev::io &w, int revents) { }
3334	iow.set <io_cb> ();	3530	iow.set <io_cb> ();
3335		3531
3336	=item w->set (struct ev_loop *)	3532	=item w->set (loop)
3337		3533
3338	Associates a different C<struct ev_loop> with this watcher. You can only	3534	Associates a different C<struct ev_loop> with this watcher. You can only
3339	do this when the watcher is inactive (and not pending either).	3535	do this when the watcher is inactive (and not pending either).
3340		3536
3341	=item w->set ([arguments])	3537	=item w->set ([arguments])
3342		3538
3343	Basically the same as C<ev_TYPE_set>, with the same arguments. Must be	3539	Basically the same as C<ev_TYPE_set>, with the same arguments. Either this
3344	called at least once. Unlike the C counterpart, an active watcher gets	3540	method or a suitable start method must be called at least once. Unlike the
3345	automatically stopped and restarted when reconfiguring it with this	3541	C counterpart, an active watcher gets automatically stopped and restarted
3346	method.	3542	when reconfiguring it with this method.
3347		3543
3348	=item w->start ()	3544	=item w->start ()
3349		3545
3350	Starts the watcher. Note that there is no C<loop> argument, as the	3546	Starts the watcher. Note that there is no C<loop> argument, as the
3351	constructor already stores the event loop.	3547	constructor already stores the event loop.
3352		3548
		3549	=item w->start ([arguments])
		3550
		3551	Instead of calling C<set> and C<start> methods separately, it is often
		3552	convenient to wrap them in one call. Uses the same type of arguments as
		3553	the configure C<set> method of the watcher.
		3554
3353	=item w->stop ()	3555	=item w->stop ()
3354		3556
3355	Stops the watcher if it is active. Again, no C<loop> argument.	3557	Stops the watcher if it is active. Again, no C<loop> argument.
3356		3558
3357	=item w->again () (C<ev::timer>, C<ev::periodic> only)	3559	=item w->again () (C<ev::timer>, C<ev::periodic> only)
…		…
3369		3571
3370	=back	3572	=back
3371		3573
3372	=back	3574	=back
3373		3575
3374	Example: Define a class with an IO and idle watcher, start one of them in	3576	Example: Define a class with two I/O and idle watchers, start the I/O
3375	the constructor.	3577	watchers in the constructor.
3376		3578
3377	class myclass	3579	class myclass
3378	{	3580	{
3379	ev::io io ; void io_cb (ev::io &w, int revents);	3581	ev::io io ; void io_cb (ev::io &w, int revents);
		3582	ev::io2 io2 ; void io2_cb (ev::io &w, int revents);
3380	ev::idle idle; void idle_cb (ev::idle &w, int revents);	3583	ev::idle idle; void idle_cb (ev::idle &w, int revents);
3381		3584
3382	myclass (int fd)	3585	myclass (int fd)
3383	{	3586	{
3384	io .set <myclass, &myclass::io_cb > (this);	3587	io .set <myclass, &myclass::io_cb > (this);
		3588	io2 .set <myclass, &myclass::io2_cb > (this);
3385	idle.set <myclass, &myclass::idle_cb> (this);	3589	idle.set <myclass, &myclass::idle_cb> (this);
3386		3590
3387	io.start (fd, ev::READ);	3591	io.set (fd, ev::WRITE); // configure the watcher
		3592	io.start (); // start it whenever convenient
		3593
		3594	io2.start (fd, ev::READ); // set + start in one call
3388	}	3595	}
3389	};	3596	};
3390		3597
3391		3598
3392	=head1 OTHER LANGUAGE BINDINGS	3599	=head1 OTHER LANGUAGE BINDINGS
…		…
3440	Erkki Seppala has written Ocaml bindings for libev, to be found at	3647	Erkki Seppala has written Ocaml bindings for libev, to be found at
3441	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.	3648	L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3442		3649
3443	=item Lua	3650	=item Lua
3444		3651
3445	Brian Maher has written a partial interface to libev	3652	Brian Maher has written a partial interface to libev for lua (at the
3446	for lua (only C<ev_io> and C<ev_timer>), to be found at	3653	time of this writing, only C<ev_io> and C<ev_timer>), to be found at
3447	L<http://github.com/brimworks/lua-ev>.	3654	L<http://github.com/brimworks/lua-ev>.
3448		3655
3449	=back	3656	=back
3450		3657
3451		3658
…		…
3466	loop argument"). The C<EV_A> form is used when this is the sole argument,	3673	loop argument"). The C<EV_A> form is used when this is the sole argument,
3467	C<EV_A_> is used when other arguments are following. Example:	3674	C<EV_A_> is used when other arguments are following. Example:
3468		3675
3469	ev_unref (EV_A);	3676	ev_unref (EV_A);
3470	ev_timer_add (EV_A_ watcher);	3677	ev_timer_add (EV_A_ watcher);
3471	ev_loop (EV_A_ 0);	3678	ev_run (EV_A_ 0);
3472		3679
3473	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,	3680	It assumes the variable C<loop> of type C<struct ev_loop *> is in scope,
3474	which is often provided by the following macro.	3681	which is often provided by the following macro.
3475		3682
3476	=item C<EV_P>, C<EV_P_>	3683	=item C<EV_P>, C<EV_P_>
…		…
3516	}	3723	}
3517		3724
3518	ev_check check;	3725	ev_check check;
3519	ev_check_init (&check, check_cb);	3726	ev_check_init (&check, check_cb);
3520	ev_check_start (EV_DEFAULT_ &check);	3727	ev_check_start (EV_DEFAULT_ &check);
3521	ev_loop (EV_DEFAULT_ 0);	3728	ev_run (EV_DEFAULT_ 0);
3522		3729
3523	=head1 EMBEDDING	3730	=head1 EMBEDDING
3524		3731
3525	Libev can (and often is) directly embedded into host	3732	Libev can (and often is) directly embedded into host
3526	applications. Examples of applications that embed it include the Deliantra	3733	applications. Examples of applications that embed it include the Deliantra
…		…
3606	libev.m4	3813	libev.m4
3607		3814
3608	=head2 PREPROCESSOR SYMBOLS/MACROS	3815	=head2 PREPROCESSOR SYMBOLS/MACROS
3609		3816
3610	Libev can be configured via a variety of preprocessor symbols you have to	3817	Libev can be configured via a variety of preprocessor symbols you have to
3611	define before including any of its files. The default in the absence of	3818	define before including (or compiling) any of its files. The default in
3612	autoconf is documented for every option.	3819	the absence of autoconf is documented for every option.
		3820
		3821	Symbols marked with "(h)" do not change the ABI, and can have different
		3822	values when compiling libev vs. including F<ev.h>, so it is permissible
		3823	to redefine them before including F<ev.h> without breaking compatibility
		3824	to a compiled library. All other symbols change the ABI, which means all
		3825	users of libev and the libev code itself must be compiled with compatible
		3826	settings.
3613		3827
3614	=over 4	3828	=over 4
3615		3829
		3830	=item EV_COMPAT3 (h)
		3831
		3832	Backwards compatibility is a major concern for libev. This is why this
		3833	release of libev comes with wrappers for the functions and symbols that
		3834	have been renamed between libev version 3 and 4.
		3835
		3836	You can disable these wrappers (to test compatibility with future
		3837	versions) by defining C<EV_COMPAT3> to C<0> when compiling your
		3838	sources. This has the additional advantage that you can drop the C<struct>
		3839	from C<struct ev_loop> declarations, as libev will provide an C<ev_loop>
		3840	typedef in that case.
		3841
		3842	In some future version, the default for C<EV_COMPAT3> will become C<0>,
		3843	and in some even more future version the compatibility code will be
		3844	removed completely.
		3845
3616	=item EV_STANDALONE	3846	=item EV_STANDALONE (h)
3617		3847
3618	Must always be C<1> if you do not use autoconf configuration, which	3848	Must always be C<1> if you do not use autoconf configuration, which
3619	keeps libev from including F<config.h>, and it also defines dummy	3849	keeps libev from including F<config.h>, and it also defines dummy
3620	implementations for some libevent functions (such as logging, which is not	3850	implementations for some libevent functions (such as logging, which is not
3621	supported). It will also not define any of the structs usually found in	3851	supported). It will also not define any of the structs usually found in
…		…
3771	as well as for signal and thread safety in C<ev_async> watchers.	4001	as well as for signal and thread safety in C<ev_async> watchers.
3772		4002
3773	In the absence of this define, libev will use C<sig_atomic_t volatile>	4003	In the absence of this define, libev will use C<sig_atomic_t volatile>
3774	(from F<signal.h>), which is usually good enough on most platforms.	4004	(from F<signal.h>), which is usually good enough on most platforms.
3775		4005
3776	=item EV_H	4006	=item EV_H (h)
3777		4007
3778	The name of the F<ev.h> header file used to include it. The default if	4008	The name of the F<ev.h> header file used to include it. The default if
3779	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be	4009	undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
3780	used to virtually rename the F<ev.h> header file in case of conflicts.	4010	used to virtually rename the F<ev.h> header file in case of conflicts.
3781		4011
3782	=item EV_CONFIG_H	4012	=item EV_CONFIG_H (h)
3783		4013
3784	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override	4014	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
3785	F<ev.c>'s idea of where to find the F<config.h> file, similarly to	4015	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
3786	C<EV_H>, above.	4016	C<EV_H>, above.
3787		4017
3788	=item EV_EVENT_H	4018	=item EV_EVENT_H (h)
3789		4019
3790	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea	4020	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
3791	of how the F<event.h> header can be found, the default is C<"event.h">.	4021	of how the F<event.h> header can be found, the default is C<"event.h">.
3792		4022
3793	=item EV_PROTOTYPES	4023	=item EV_PROTOTYPES (h)
3794		4024
3795	If defined to be C<0>, then F<ev.h> will not define any function	4025	If defined to be C<0>, then F<ev.h> will not define any function
3796	prototypes, but still define all the structs and other symbols. This is	4026	prototypes, but still define all the structs and other symbols. This is
3797	occasionally useful if you want to provide your own wrapper functions	4027	occasionally useful if you want to provide your own wrapper functions
3798	around libev functions.	4028	around libev functions.
…		…
3820	fine.	4050	fine.
3821		4051
3822	If your embedding application does not need any priorities, defining these	4052	If your embedding application does not need any priorities, defining these
3823	both to C<0> will save some memory and CPU.	4053	both to C<0> will save some memory and CPU.
3824		4054
3825	=item EV_PERIODIC_ENABLE	4055	=item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE,
		4056	EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
		4057	EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3826		4058
3827	If undefined or defined to be C<1>, then periodic timers are supported. If	4059	If undefined or defined to be C<1> (and the platform supports it), then
3828	defined to be C<0>, then they are not. Disabling them saves a few kB of	4060	the respective watcher type is supported. If defined to be C<0>, then it
3829	code.	4061	is not. Disabling watcher types mainly saves code size.
3830		4062
3831	=item EV_IDLE_ENABLE	4063	=item EV_FEATURES
3832
3833	If undefined or defined to be C<1>, then idle watchers are supported. If
3834	defined to be C<0>, then they are not. Disabling them saves a few kB of
3835	code.
3836
3837	=item EV_EMBED_ENABLE
3838
3839	If undefined or defined to be C<1>, then embed watchers are supported. If
3840	defined to be C<0>, then they are not. Embed watchers rely on most other
3841	watcher types, which therefore must not be disabled.
3842
3843	=item EV_STAT_ENABLE
3844
3845	If undefined or defined to be C<1>, then stat watchers are supported. If
3846	defined to be C<0>, then they are not.
3847
3848	=item EV_FORK_ENABLE
3849
3850	If undefined or defined to be C<1>, then fork watchers are supported. If
3851	defined to be C<0>, then they are not.
3852
3853	=item EV_ASYNC_ENABLE
3854
3855	If undefined or defined to be C<1>, then async watchers are supported. If
3856	defined to be C<0>, then they are not.
3857
3858	=item EV_MINIMAL
3859		4064
3860	If you need to shave off some kilobytes of code at the expense of some	4065	If you need to shave off some kilobytes of code at the expense of some
3861	speed (but with the full API), define this symbol to C<1>. Currently this	4066	speed (but with the full API), you can define this symbol to request
3862	is used to override some inlining decisions, saves roughly 30% code size	4067	certain subsets of functionality. The default is to enable all features
3863	on amd64. It also selects a much smaller 2-heap for timer management over	4068	that can be enabled on the platform.
3864	the default 4-heap.
3865		4069
3866	You can save even more by disabling watcher types you do not need	4070	A typical way to use this symbol is to define it to C<0> (or to a bitset
3867	and setting C<EV_MAXPRI> == C<EV_MINPRI>. Also, disabling C<assert>	4071	with some broad features you want) and then selectively re-enable
3868	(C<-DNDEBUG>) will usually reduce code size a lot.	4072	additional parts you want, for example if you want everything minimal,
		4073	but multiple event loop support, async and child watchers and the poll
		4074	backend, use this:
3869		4075
3870	Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to	4076	#define EV_FEATURES 0
3871	provide a bare-bones event library. See C<ev.h> for details on what parts	4077	#define EV_MULTIPLICITY 1
3872	of the API are still available, and do not complain if this subset changes	4078	#define EV_USE_POLL 1
3873	over time.	4079	#define EV_CHILD_ENABLE 1
		4080	#define EV_ASYNC_ENABLE 1
		4081
		4082	The actual value is a bitset, it can be a combination of the following
		4083	values:
		4084
		4085	=over 4
		4086
		4087	=item C<1> - faster/larger code
		4088
		4089	Use larger code to speed up some operations.
		4090
		4091	Currently this is used to override some inlining decisions (enlarging the
		4092	code size by roughly 30% on amd64).
		4093
		4094	When optimising for size, use of compiler flags such as C<-Os> with
		4095	gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
		4096	assertions.
		4097
		4098	=item C<2> - faster/larger data structures
		4099
		4100	Replaces the small 2-heap for timer management by a faster 4-heap, larger
		4101	hash table sizes and so on. This will usually further increase code size
		4102	and can additionally have an effect on the size of data structures at
		4103	runtime.
		4104
		4105	=item C<4> - full API configuration
		4106
		4107	This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
		4108	enables multiplicity (C<EV_MULTIPLICITY>=1).
		4109
		4110	=item C<8> - full API
		4111
		4112	This enables a lot of the "lesser used" API functions. See C<ev.h> for
		4113	details on which parts of the API are still available without this
		4114	feature, and do not complain if this subset changes over time.
		4115
		4116	=item C<16> - enable all optional watcher types
		4117
		4118	Enables all optional watcher types. If you want to selectively enable
		4119	only some watcher types other than I/O and timers (e.g. prepare,
		4120	embed, async, child...) you can enable them manually by defining
		4121	C<EV_watchertype_ENABLE> to C<1> instead.
		4122
		4123	=item C<32> - enable all backends
		4124
		4125	This enables all backends - without this feature, you need to enable at
		4126	least one backend manually (C<EV_USE_SELECT> is a good choice).
		4127
		4128	=item C<64> - enable OS-specific "helper" APIs
		4129
		4130	Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
		4131	default.
		4132
		4133	=back
		4134
		4135	Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
		4136	reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
		4137	code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
		4138	watchers, timers and monotonic clock support.
		4139
		4140	With an intelligent-enough linker (gcc+binutils are intelligent enough
		4141	when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
		4142	your program might be left out as well - a binary starting a timer and an
		4143	I/O watcher then might come out at only 5Kb.
		4144
		4145	=item EV_AVOID_STDIO
		4146
		4147	If this is set to C<1> at compiletime, then libev will avoid using stdio
		4148	functions (printf, scanf, perror etc.). This will increase the code size
		4149	somewhat, but if your program doesn't otherwise depend on stdio and your
		4150	libc allows it, this avoids linking in the stdio library which is quite
		4151	big.
		4152
		4153	Note that error messages might become less precise when this option is
		4154	enabled.
3874		4155
3875	=item EV_NSIG	4156	=item EV_NSIG
3876		4157
3877	The highest supported signal number, +1 (or, the number of	4158	The highest supported signal number, +1 (or, the number of
3878	signals): Normally, libev tries to deduce the maximum number of signals	4159	signals): Normally, libev tries to deduce the maximum number of signals
3879	automatically, but sometimes this fails, in which case it can be	4160	automatically, but sometimes this fails, in which case it can be
3880	specified. Also, using a lower number than detected (C<32> should be	4161	specified. Also, using a lower number than detected (C<32> should be
3881	good for about any system in existance) can save some memory, as libev	4162	good for about any system in existence) can save some memory, as libev
3882	statically allocates some 12-24 bytes per signal number.	4163	statically allocates some 12-24 bytes per signal number.
3883		4164
3884	=item EV_PID_HASHSIZE	4165	=item EV_PID_HASHSIZE
3885		4166
3886	C<ev_child> watchers use a small hash table to distribute workload by	4167	C<ev_child> watchers use a small hash table to distribute workload by
3887	pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more	4168	pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled),
3888	than enough. If you need to manage thousands of children you might want to	4169	usually more than enough. If you need to manage thousands of children you
3889	increase this value (I<must> be a power of two).	4170	might want to increase this value (I<must> be a power of two).
3890		4171
3891	=item EV_INOTIFY_HASHSIZE	4172	=item EV_INOTIFY_HASHSIZE
3892		4173
3893	C<ev_stat> watchers use a small hash table to distribute workload by	4174	C<ev_stat> watchers use a small hash table to distribute workload by
3894	inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),	4175	inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES>
3895	usually more than enough. If you need to manage thousands of C<ev_stat>	4176	disabled), usually more than enough. If you need to manage thousands of
3896	watchers you might want to increase this value (I<must> be a power of	4177	C<ev_stat> watchers you might want to increase this value (I<must> be a
3897	two).	4178	power of two).
3898		4179
3899	=item EV_USE_4HEAP	4180	=item EV_USE_4HEAP
3900		4181
3901	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4182	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3902	timer and periodics heaps, libev uses a 4-heap when this symbol is defined	4183	timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3903	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably	4184	to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3904	faster performance with many (thousands) of watchers.	4185	faster performance with many (thousands) of watchers.
3905		4186
3906	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4187	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3907	(disabled).	4188	will be C<0>.
3908		4189
3909	=item EV_HEAP_CACHE_AT	4190	=item EV_HEAP_CACHE_AT
3910		4191
3911	Heaps are not very cache-efficient. To improve the cache-efficiency of the	4192	Heaps are not very cache-efficient. To improve the cache-efficiency of the
3912	timer and periodics heaps, libev can cache the timestamp (I<at>) within	4193	timer and periodics heaps, libev can cache the timestamp (I<at>) within
3913	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),	4194	the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3914	which uses 8-12 bytes more per watcher and a few hundred bytes more code,	4195	which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3915	but avoids random read accesses on heap changes. This improves performance	4196	but avoids random read accesses on heap changes. This improves performance
3916	noticeably with many (hundreds) of watchers.	4197	noticeably with many (hundreds) of watchers.
3917		4198
3918	The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0>	4199	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3919	(disabled).	4200	will be C<0>.
3920		4201
3921	=item EV_VERIFY	4202	=item EV_VERIFY
3922		4203
3923	Controls how much internal verification (see C<ev_loop_verify ()>) will	4204	Controls how much internal verification (see C<ev_verify ()>) will
3924	be done: If set to C<0>, no internal verification code will be compiled	4205	be done: If set to C<0>, no internal verification code will be compiled
3925	in. If set to C<1>, then verification code will be compiled in, but not	4206	in. If set to C<1>, then verification code will be compiled in, but not
3926	called. If set to C<2>, then the internal verification code will be	4207	called. If set to C<2>, then the internal verification code will be
3927	called once per loop, which can slow down libev. If set to C<3>, then the	4208	called once per loop, which can slow down libev. If set to C<3>, then the
3928	verification code will be called very frequently, which will slow down	4209	verification code will be called very frequently, which will slow down
3929	libev considerably.	4210	libev considerably.
3930		4211
3931	The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be	4212	The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3932	C<0>.	4213	will be C<0>.
3933		4214
3934	=item EV_COMMON	4215	=item EV_COMMON
3935		4216
3936	By default, all watchers have a C<void *data> member. By redefining	4217	By default, all watchers have a C<void *data> member. By redefining
3937	this macro to a something else you can include more and other types of	4218	this macro to something else you can include more and other types of
3938	members. You have to define it each time you include one of the files,	4219	members. You have to define it each time you include one of the files,
3939	though, and it must be identical each time.	4220	though, and it must be identical each time.
3940		4221
3941	For example, the perl EV module uses something like this:	4222	For example, the perl EV module uses something like this:
3942		4223
…		…
3995	file.	4276	file.
3996		4277
3997	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file	4278	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3998	that everybody includes and which overrides some configure choices:	4279	that everybody includes and which overrides some configure choices:
3999		4280
4000	#define EV_MINIMAL 1	4281	#define EV_FEATURES 8
4001	#define EV_USE_POLL 0	4282	#define EV_USE_SELECT 1
4002	#define EV_MULTIPLICITY 0
4003	#define EV_PERIODIC_ENABLE 0	4283	#define EV_PREPARE_ENABLE 1
		4284	#define EV_IDLE_ENABLE 1
4004	#define EV_STAT_ENABLE 0	4285	#define EV_SIGNAL_ENABLE 1
4005	#define EV_FORK_ENABLE 0	4286	#define EV_CHILD_ENABLE 1
		4287	#define EV_USE_STDEXCEPT 0
4006	#define EV_CONFIG_H <config.h>	4288	#define EV_CONFIG_H <config.h>
4007	#define EV_MINPRI 0
4008	#define EV_MAXPRI 0
4009		4289
4010	#include "ev++.h"	4290	#include "ev++.h"
4011		4291
4012	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:	4292	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
4013		4293
…		…
4144	userdata *u = ev_userdata (EV_A);	4424	userdata *u = ev_userdata (EV_A);
4145	pthread_mutex_lock (&u->lock);	4425	pthread_mutex_lock (&u->lock);
4146	}	4426	}
4147		4427
4148	The event loop thread first acquires the mutex, and then jumps straight	4428	The event loop thread first acquires the mutex, and then jumps straight
4149	into C<ev_loop>:	4429	into C<ev_run>:
4150		4430
4151	void *	4431	void *
4152	l_run (void *thr_arg)	4432	l_run (void *thr_arg)
4153	{	4433	{
4154	struct ev_loop *loop = (struct ev_loop *)thr_arg;	4434	struct ev_loop *loop = (struct ev_loop *)thr_arg;
4155		4435
4156	l_acquire (EV_A);	4436	l_acquire (EV_A);
4157	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);	4437	pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4158	ev_loop (EV_A_ 0);	4438	ev_run (EV_A_ 0);
4159	l_release (EV_A);	4439	l_release (EV_A);
4160		4440
4161	return 0;	4441	return 0;
4162	}	4442	}
4163		4443
…		…
4215		4495
4216	=head3 COROUTINES	4496	=head3 COROUTINES
4217		4497
4218	Libev is very accommodating to coroutines ("cooperative threads"):	4498	Libev is very accommodating to coroutines ("cooperative threads"):
4219	libev fully supports nesting calls to its functions from different	4499	libev fully supports nesting calls to its functions from different
4220	coroutines (e.g. you can call C<ev_loop> on the same loop from two	4500	coroutines (e.g. you can call C<ev_run> on the same loop from two
4221	different coroutines, and switch freely between both coroutines running	4501	different coroutines, and switch freely between both coroutines running
4222	the loop, as long as you don't confuse yourself). The only exception is	4502	the loop, as long as you don't confuse yourself). The only exception is
4223	that you must not do this from C<ev_periodic> reschedule callbacks.	4503	that you must not do this from C<ev_periodic> reschedule callbacks.
4224		4504
4225	Care has been taken to ensure that libev does not keep local state inside	4505	Care has been taken to ensure that libev does not keep local state inside
4226	C<ev_loop>, and other calls do not usually allow for coroutine switches as	4506	C<ev_run>, and other calls do not usually allow for coroutine switches as
4227	they do not call any callbacks.	4507	they do not call any callbacks.
4228		4508
4229	=head2 COMPILER WARNINGS	4509	=head2 COMPILER WARNINGS
4230		4510
4231	Depending on your compiler and compiler settings, you might get no or a	4511	Depending on your compiler and compiler settings, you might get no or a
…		…
4242	maintainable.	4522	maintainable.
4243		4523
4244	And of course, some compiler warnings are just plain stupid, or simply	4524	And of course, some compiler warnings are just plain stupid, or simply
4245	wrong (because they don't actually warn about the condition their message	4525	wrong (because they don't actually warn about the condition their message
4246	seems to warn about). For example, certain older gcc versions had some	4526	seems to warn about). For example, certain older gcc versions had some
4247	warnings that resulted an extreme number of false positives. These have	4527	warnings that resulted in an extreme number of false positives. These have
4248	been fixed, but some people still insist on making code warn-free with	4528	been fixed, but some people still insist on making code warn-free with
4249	such buggy versions.	4529	such buggy versions.
4250		4530
4251	While libev is written to generate as few warnings as possible,	4531	While libev is written to generate as few warnings as possible,
4252	"warn-free" code is not a goal, and it is recommended not to build libev	4532	"warn-free" code is not a goal, and it is recommended not to build libev
…		…
4288	I suggest using suppression lists.	4568	I suggest using suppression lists.
4289		4569
4290		4570
4291	=head1 PORTABILITY NOTES	4571	=head1 PORTABILITY NOTES
4292		4572
		4573	=head2 GNU/LINUX 32 BIT LIMITATIONS
		4574
		4575	GNU/Linux is the only common platform that supports 64 bit file/large file
		4576	interfaces but I<disables> them by default.
		4577
		4578	That means that libev compiled in the default environment doesn't support
		4579	files larger than 2GiB or so, which mainly affects C<ev_stat> watchers.
		4580
		4581	Unfortunately, many programs try to work around this GNU/Linux issue
		4582	by enabling the large file API, which makes them incompatible with the
		4583	standard libev compiled for their system.
		4584
		4585	Likewise, libev cannot enable the large file API itself as this would
		4586	suddenly make it incompatible to the default compile time environment,
		4587	i.e. all programs not using special compile switches.
		4588
		4589	=head2 OS/X AND DARWIN BUGS
		4590
		4591	The whole thing is a bug if you ask me - basically any system interface
		4592	you touch is broken, whether it is locales, poll, kqueue or even the
		4593	OpenGL drivers.
		4594
		4595	=head3 C<kqueue> is buggy
		4596
		4597	The kqueue syscall is broken in all known versions - most versions support
		4598	only sockets, many support pipes.
		4599
		4600	Libev tries to work around this by not using C<kqueue> by default on this
		4601	rotten platform, but of course you can still ask for it when creating a
		4602	loop - embedding a socket-only kqueue loop into a select-based one is
		4603	probably going to work well.
		4604
		4605	=head3 C<poll> is buggy
		4606
		4607	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
		4608	implementation by something calling C<kqueue> internally around the 10.5.6
		4609	release, so now C<kqueue> I<and> C<poll> are broken.
		4610
		4611	Libev tries to work around this by not using C<poll> by default on
		4612	this rotten platform, but of course you can still ask for it when creating
		4613	a loop.
		4614
		4615	=head3 C<select> is buggy
		4616
		4617	All that's left is C<select>, and of course Apple found a way to fuck this
		4618	one up as well: On OS/X, C<select> actively limits the number of file
		4619	descriptors you can pass in to 1024 - your program suddenly crashes when
		4620	you use more.
		4621
		4622	There is an undocumented "workaround" for this - defining
		4623	C<_DARWIN_UNLIMITED_SELECT>, which libev tries to use, so select I<should>
		4624	work on OS/X.
		4625
		4626	=head2 SOLARIS PROBLEMS AND WORKAROUNDS
		4627
		4628	=head3 C<errno> reentrancy
		4629
		4630	The default compile environment on Solaris is unfortunately so
		4631	thread-unsafe that you can't even use components/libraries compiled
		4632	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
		4633	defined by default. A valid, if stupid, implementation choice.
		4634
		4635	If you want to use libev in threaded environments you have to make sure
		4636	it's compiled with C<_REENTRANT> defined.
		4637
		4638	=head3 Event port backend
		4639
		4640	The scalable event interface for Solaris is called "event
		4641	ports". Unfortunately, this mechanism is very buggy in all major
		4642	releases. If you run into high CPU usage, your program freezes or you get
		4643	a large number of spurious wakeups, make sure you have all the relevant
		4644	and latest kernel patches applied. No, I don't know which ones, but there
		4645	are multiple ones to apply, and afterwards, event ports actually work
		4646	great.
		4647
		4648	If you can't get it to work, you can try running the program by setting
		4649	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
		4650	C<select> backends.
		4651
		4652	=head2 AIX POLL BUG
		4653
		4654	AIX unfortunately has a broken C<poll.h> header. Libev works around
		4655	this by trying to avoid the poll backend altogether (i.e. it's not even
		4656	compiled in), which normally isn't a big problem as C<select> works fine
		4657	with large bitsets on AIX, and AIX is dead anyway.
		4658
4293	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	4659	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
		4660
		4661	=head3 General issues
4294		4662
4295	Win32 doesn't support any of the standards (e.g. POSIX) that libev	4663	Win32 doesn't support any of the standards (e.g. POSIX) that libev
4296	requires, and its I/O model is fundamentally incompatible with the POSIX	4664	requires, and its I/O model is fundamentally incompatible with the POSIX
4297	model. Libev still offers limited functionality on this platform in	4665	model. Libev still offers limited functionality on this platform in
4298	the form of the C<EVBACKEND_SELECT> backend, and only supports socket	4666	the form of the C<EVBACKEND_SELECT> backend, and only supports socket
4299	descriptors. This only applies when using Win32 natively, not when using	4667	descriptors. This only applies when using Win32 natively, not when using
4300	e.g. cygwin.	4668	e.g. cygwin. Actually, it only applies to the microsofts own compilers,
		4669	as every compielr comes with a slightly differently broken/incompatible
		4670	environment.
4301		4671
4302	Lifting these limitations would basically require the full	4672	Lifting these limitations would basically require the full
4303	re-implementation of the I/O system. If you are into these kinds of	4673	re-implementation of the I/O system. If you are into this kind of thing,
4304	things, then note that glib does exactly that for you in a very portable	4674	then note that glib does exactly that for you in a very portable way (note
4305	way (note also that glib is the slowest event library known to man).	4675	also that glib is the slowest event library known to man).
4306		4676
4307	There is no supported compilation method available on windows except	4677	There is no supported compilation method available on windows except
4308	embedding it into other applications.	4678	embedding it into other applications.
4309		4679
4310	Sensible signal handling is officially unsupported by Microsoft - libev	4680	Sensible signal handling is officially unsupported by Microsoft - libev
…		…
4338	you do I<not> compile the F<ev.c> or any other embedded source files!):	4708	you do I<not> compile the F<ev.c> or any other embedded source files!):
4339		4709
4340	#include "evwrap.h"	4710	#include "evwrap.h"
4341	#include "ev.c"	4711	#include "ev.c"
4342		4712
4343	=over 4
4344
4345	=item The winsocket select function	4713	=head3 The winsocket C<select> function
4346		4714
4347	The winsocket C<select> function doesn't follow POSIX in that it	4715	The winsocket C<select> function doesn't follow POSIX in that it
4348	requires socket I<handles> and not socket I<file descriptors> (it is	4716	requires socket I<handles> and not socket I<file descriptors> (it is
4349	also extremely buggy). This makes select very inefficient, and also	4717	also extremely buggy). This makes select very inefficient, and also
4350	requires a mapping from file descriptors to socket handles (the Microsoft	4718	requires a mapping from file descriptors to socket handles (the Microsoft
…		…
4359	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */	4727	#define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
4360		4728
4361	Note that winsockets handling of fd sets is O(n), so you can easily get a	4729	Note that winsockets handling of fd sets is O(n), so you can easily get a
4362	complexity in the O(n²) range when using win32.	4730	complexity in the O(n²) range when using win32.
4363		4731
4364	=item Limited number of file descriptors	4732	=head3 Limited number of file descriptors
4365		4733
4366	Windows has numerous arbitrary (and low) limits on things.	4734	Windows has numerous arbitrary (and low) limits on things.
4367		4735
4368	Early versions of winsocket's select only supported waiting for a maximum	4736	Early versions of winsocket's select only supported waiting for a maximum
4369	of C<64> handles (probably owning to the fact that all windows kernels	4737	of C<64> handles (probably owning to the fact that all windows kernels
…		…
4384	runtime libraries. This might get you to about C<512> or C<2048> sockets	4752	runtime libraries. This might get you to about C<512> or C<2048> sockets
4385	(depending on windows version and/or the phase of the moon). To get more,	4753	(depending on windows version and/or the phase of the moon). To get more,
4386	you need to wrap all I/O functions and provide your own fd management, but	4754	you need to wrap all I/O functions and provide your own fd management, but
4387	the cost of calling select (O(n²)) will likely make this unworkable.	4755	the cost of calling select (O(n²)) will likely make this unworkable.
4388		4756
4389	=back
4390
4391	=head2 PORTABILITY REQUIREMENTS	4757	=head2 PORTABILITY REQUIREMENTS
4392		4758
4393	In addition to a working ISO-C implementation and of course the	4759	In addition to a working ISO-C implementation and of course the
4394	backend-specific APIs, libev relies on a few additional extensions:	4760	backend-specific APIs, libev relies on a few additional extensions:
4395		4761
…		…
4401	Libev assumes not only that all watcher pointers have the same internal	4767	Libev assumes not only that all watcher pointers have the same internal
4402	structure (guaranteed by POSIX but not by ISO C for example), but it also	4768	structure (guaranteed by POSIX but not by ISO C for example), but it also
4403	assumes that the same (machine) code can be used to call any watcher	4769	assumes that the same (machine) code can be used to call any watcher
4404	callback: The watcher callbacks have different type signatures, but libev	4770	callback: The watcher callbacks have different type signatures, but libev
4405	calls them using an C<ev_watcher *> internally.	4771	calls them using an C<ev_watcher *> internally.
		4772
		4773	=item pointer accesses must be thread-atomic
		4774
		4775	Accessing a pointer value must be atomic, it must both be readable and
		4776	writable in one piece - this is the case on all current architectures.
4406		4777
4407	=item C<sig_atomic_t volatile> must be thread-atomic as well	4778	=item C<sig_atomic_t volatile> must be thread-atomic as well
4408		4779
4409	The type C<sig_atomic_t volatile> (or whatever is defined as	4780	The type C<sig_atomic_t volatile> (or whatever is defined as
4410	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different	4781	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
…		…
4433	watchers.	4804	watchers.
4434		4805
4435	=item C<double> must hold a time value in seconds with enough accuracy	4806	=item C<double> must hold a time value in seconds with enough accuracy
4436		4807
4437	The type C<double> is used to represent timestamps. It is required to	4808	The type C<double> is used to represent timestamps. It is required to
4438	have at least 51 bits of mantissa (and 9 bits of exponent), which is good	4809	have at least 51 bits of mantissa (and 9 bits of exponent), which is
4439	enough for at least into the year 4000. This requirement is fulfilled by	4810	good enough for at least into the year 4000 with millisecond accuracy
		4811	(the design goal for libev). This requirement is overfulfilled by
4440	implementations implementing IEEE 754, which is basically all existing	4812	implementations using IEEE 754, which is basically all existing ones. With
4441	ones. With IEEE 754 doubles, you get microsecond accuracy until at least	4813	IEEE 754 doubles, you get microsecond accuracy until at least 2200.
4442	2200.
4443		4814
4444	=back	4815	=back
4445		4816
4446	If you know of other additional requirements drop me a note.	4817	If you know of other additional requirements drop me a note.
4447		4818
…		…
4515	involves iterating over all running async watchers or all signal numbers.	4886	involves iterating over all running async watchers or all signal numbers.
4516		4887
4517	=back	4888	=back
4518		4889
4519		4890
		4891	=head1 PORTING FROM LIBEV 3.X TO 4.X
		4892
		4893	The major version 4 introduced some incompatible changes to the API.
		4894
		4895	At the moment, the C<ev.h> header file provides compatibility definitions
		4896	for all changes, so most programs should still compile. The compatibility
		4897	layer might be removed in later versions of libev, so better update to the
		4898	new API early than late.
		4899
		4900	=over 4
		4901
		4902	=item C<EV_COMPAT3> backwards compatibility mechanism
		4903
		4904	The backward compatibility mechanism can be controlled by
		4905	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		4906	section.
		4907
		4908	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		4909
		4910	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		4911
		4912	ev_loop_destroy (EV_DEFAULT_UC);
		4913	ev_loop_fork (EV_DEFAULT);
		4914
		4915	=item function/symbol renames
		4916
		4917	A number of functions and symbols have been renamed:
		4918
		4919	ev_loop => ev_run
		4920	EVLOOP_NONBLOCK => EVRUN_NOWAIT
		4921	EVLOOP_ONESHOT => EVRUN_ONCE
		4922
		4923	ev_unloop => ev_break
		4924	EVUNLOOP_CANCEL => EVBREAK_CANCEL
		4925	EVUNLOOP_ONE => EVBREAK_ONE
		4926	EVUNLOOP_ALL => EVBREAK_ALL
		4927
		4928	EV_TIMEOUT => EV_TIMER
		4929
		4930	ev_loop_count => ev_iteration
		4931	ev_loop_depth => ev_depth
		4932	ev_loop_verify => ev_verify
		4933
		4934	Most functions working on C<struct ev_loop> objects don't have an
		4935	C<ev_loop_> prefix, so it was removed; C<ev_loop>, C<ev_unloop> and
		4936	associated constants have been renamed to not collide with the C<struct
		4937	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
		4938	as all other watcher types. Note that C<ev_loop_fork> is still called
		4939	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
		4940	typedef.
		4941
		4942	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
		4943
		4944	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
		4945	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
		4946	and work, but the library code will of course be larger.
		4947
		4948	=back
		4949
		4950
4520	=head1 GLOSSARY	4951	=head1 GLOSSARY
4521		4952
4522	=over 4	4953	=over 4
4523		4954
4524	=item active	4955	=item active
4525		4956
4526	A watcher is active as long as it has been started (has been attached to	4957	A watcher is active as long as it has been started and not yet stopped.
4527	an event loop) but not yet stopped (disassociated from the event loop).	4958	See L<WATCHER STATES> for details.
4528		4959
4529	=item application	4960	=item application
4530		4961
4531	In this document, an application is whatever is using libev.	4962	In this document, an application is whatever is using libev.
		4963
		4964	=item backend
		4965
		4966	The part of the code dealing with the operating system interfaces.
4532		4967
4533	=item callback	4968	=item callback
4534		4969
4535	The address of a function that is called when some event has been	4970	The address of a function that is called when some event has been
4536	detected. Callbacks are being passed the event loop, the watcher that	4971	detected. Callbacks are being passed the event loop, the watcher that
4537	received the event, and the actual event bitset.	4972	received the event, and the actual event bitset.
4538		4973
4539	=item callback invocation	4974	=item callback/watcher invocation
4540		4975
4541	The act of calling the callback associated with a watcher.	4976	The act of calling the callback associated with a watcher.
4542		4977
4543	=item event	4978	=item event
4544		4979
4545	A change of state of some external event, such as data now being available	4980	A change of state of some external event, such as data now being available
4546	for reading on a file descriptor, time having passed or simply not having	4981	for reading on a file descriptor, time having passed or simply not having
4547	any other events happening anymore.	4982	any other events happening anymore.
4548		4983
4549	In libev, events are represented as single bits (such as C<EV_READ> or	4984	In libev, events are represented as single bits (such as C<EV_READ> or
4550	C<EV_TIMEOUT>).	4985	C<EV_TIMER>).
4551		4986
4552	=item event library	4987	=item event library
4553		4988
4554	A software package implementing an event model and loop.	4989	A software package implementing an event model and loop.
4555		4990
…		…
4563	The model used to describe how an event loop handles and processes	4998	The model used to describe how an event loop handles and processes
4564	watchers and events.	4999	watchers and events.
4565		5000
4566	=item pending	5001	=item pending
4567		5002
4568	A watcher is pending as soon as the corresponding event has been detected,	5003	A watcher is pending as soon as the corresponding event has been
4569	and stops being pending as soon as the watcher will be invoked or its	5004	detected. See L<WATCHER STATES> for details.
4570	pending status is explicitly cleared by the application.
4571
4572	A watcher can be pending, but not active. Stopping a watcher also clears
4573	its pending status.
4574		5005
4575	=item real time	5006	=item real time
4576		5007
4577	The physical time that is observed. It is apparently strictly monotonic :)	5008	The physical time that is observed. It is apparently strictly monotonic :)
4578		5009
…		…
4585	=item watcher	5016	=item watcher
4586		5017
4587	A data structure that describes interest in certain events. Watchers need	5018	A data structure that describes interest in certain events. Watchers need
4588	to be started (attached to an event loop) before they can receive events.	5019	to be started (attached to an event loop) before they can receive events.
4589		5020
4590	=item watcher invocation
4591
4592	The act of calling the callback associated with a watcher.
4593
4594	=back	5021	=back
4595		5022
4596	=head1 AUTHOR	5023	=head1 AUTHOR
4597		5024
4598	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5025	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5026	Magnusson and Emanuele Giaquinta.
4599		5027

Diff Legend

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