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

Comparing libev/ev.pod (file contents):
Revision 1.310 by root, Thu Oct 21 12:32:47 2010 UTC vs.
Revision 1.337 by root, Sun Oct 31 20:20:20 2010 UTC

…		…
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);
…		…
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	Familiarity with event based programming techniques in general is assumed	80	Familiarity with event based programming techniques in general is assumed
81	throughout this document.	81	throughout this document.
		82
		83	=head1 WHAT TO READ WHEN IN A HURRY
		84
		85	This manual tries to be very detailed, but unfortunately, this also makes
		86	it very long. If you just want to know the basics of libev, I suggest
		87	reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and
		88	look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and
		89	C<ev_timer> sections in L<WATCHER TYPES>.
82		90
83	=head1 ABOUT LIBEV	91	=head1 ABOUT LIBEV
84		92
85	Libev is an event loop: you register interest in certain events (such as a	93	Libev is an event loop: you register interest in certain events (such as a
86	file descriptor being readable or a timeout occurring), and it will manage	94	file descriptor being readable or a timeout occurring), and it will manage
…		…
124	this argument.	132	this argument.
125		133
126	=head2 TIME REPRESENTATION	134	=head2 TIME REPRESENTATION
127		135
128	Libev represents time as a single floating point number, representing	136	Libev represents time as a single floating point number, representing
129	the (fractional) number of seconds since the (POSIX) epoch (in practise	137	the (fractional) number of seconds since the (POSIX) epoch (in practice
130	somewhere near the beginning of 1970, details are complicated, don't	138	somewhere near the beginning of 1970, details are complicated, don't
131	ask). This type is called C<ev_tstamp>, which is what you should use	139	ask). This type is called C<ev_tstamp>, which is what you should use
132	too. It usually aliases to the C<double> type in C. When you need to do	140	too. It usually aliases to the C<double> type in C. When you need to do
133	any calculations on it, you should treat it as some floating point value.	141	any calculations on it, you should treat it as some floating point value.
134		142
…		…
165		173
166	=item ev_tstamp ev_time ()	174	=item ev_tstamp ev_time ()
167		175
168	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
169	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
170	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>.
171		180
172	=item ev_sleep (ev_tstamp interval)	181	=item ev_sleep (ev_tstamp interval)
173		182
174	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
175	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
…		…
192	as this indicates an incompatible change. Minor versions are usually	201	as this indicates an incompatible change. Minor versions are usually
193	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
194	not a problem.	203	not a problem.
195		204
196	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
197	version (note, however, that this will not detect ABI mismatches :).	206	version (note, however, that this will not detect other ABI mismatches,
		207	such as LFS or reentrancy).
198		208
199	assert (("libev version mismatch",	209	assert (("libev version mismatch",
200	ev_version_major () == EV_VERSION_MAJOR	210	ev_version_major () == EV_VERSION_MAJOR
201	&& ev_version_minor () >= EV_VERSION_MINOR));	211	&& ev_version_minor () >= EV_VERSION_MINOR));
202		212
…		…
213	assert (("sorry, no epoll, no sex",	223	assert (("sorry, no epoll, no sex",
214	ev_supported_backends () & EVBACKEND_EPOLL));	224	ev_supported_backends () & EVBACKEND_EPOLL));
215		225
216	=item unsigned int ev_recommended_backends ()	226	=item unsigned int ev_recommended_backends ()
217		227
218	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
219	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
220	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
221	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
222	(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
223	libev will probe for if you specify no backends explicitly.	234	probe for if you specify no backends explicitly.
224		235
225	=item unsigned int ev_embeddable_backends ()	236	=item unsigned int ev_embeddable_backends ()
226		237
227	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
228	is the theoretical, all-platform, value. To find which backends	239	value is platform-specific but can include backends not available on the
229	might be supported on the current system, you would need to look at	240	current system. To find which embeddable backends might be supported on
230	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	241	the current system, you would need to look at C<ev_embeddable_backends ()
231	recommended ones.	242	& ev_supported_backends ()>, likewise for recommended ones.
232		243
233	See the description of C<ev_embed> watchers for more info.	244	See the description of C<ev_embed> watchers for more info.
234		245
235	=item ev_set_allocator (void (cb)(void *ptr, long size)) [NOT REENTRANT]	246	=item ev_set_allocator (void (cb)(void *ptr, long size)) [NOT REENTRANT]
236		247
…		…
290	...	301	...
291	ev_set_syserr_cb (fatal_error);	302	ev_set_syserr_cb (fatal_error);
292		303
293	=back	304	=back
294		305
295	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	306	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
296		307
297	An event loop is described by a C<struct ev_loop *> (the C<struct> is	308	An event loop is described by a C<struct ev_loop *> (the C<struct> is
298	I<not> optional in case unless libev 3 compatibility is disabled, as libev	309	I<not> optional in this case unless libev 3 compatibility is disabled, as
299	3 had an C<ev_loop> function colliding with the struct name).	310	libev 3 had an C<ev_loop> function colliding with the struct name).
300		311
301	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
302	supports signals and child events, and dynamically created event loops	313	supports child process events, and dynamically created event loops which
303	which do not.	314	do not.
304		315
305	=over 4	316	=over 4
306		317
307	=item struct ev_loop *ev_default_loop (unsigned int flags)	318	=item struct ev_loop *ev_default_loop (unsigned int flags)
308		319
309	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
310	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
311	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
312	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".
313		330
314	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
315	function.	332	function (or via the C<EV_DEFAULT> macro).
316		333
317	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
318	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
319	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).
320		338
321	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,
322	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
323	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
324	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
325	can simply overwrite the C<SIGCHLD> signal handler I<after> calling	343	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
326	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.
327		363
328	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
329	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>).
330		366
331	The following flags are supported:	367	The following flags are supported:
…		…
427	epoll scales either O(1) or O(active_fds).	463	epoll scales either O(1) or O(active_fds).
428		464
429	The epoll mechanism deserves honorable mention as the most misdesigned	465	The epoll mechanism deserves honorable mention as the most misdesigned
430	of the more advanced event mechanisms: mere annoyances include silently	466	of the more advanced event mechanisms: mere annoyances include silently
431	dropping file descriptors, requiring a system call per change per file	467	dropping file descriptors, requiring a system call per change per file
432	descriptor (and unnecessary guessing of parameters), problems with dup and	468	descriptor (and unnecessary guessing of parameters), problems with dup,
		469	returning before the timeout value requiring additional iterations and so
433	so on. The biggest issue is fork races, however - if a program forks then	470	on. The biggest issue is fork races, however - if a program forks then
434	I<both> parent and child process have to recreate the epoll set, which can	471	I<both> parent and child process have to recreate the epoll set, which can
435	take considerable time (one syscall per file descriptor) and is of course	472	take considerable time (one syscall per file descriptor) and is of course
436	hard to detect.	473	hard to detect.
437		474
438	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but	475	Epoll is also notoriously buggy - embedding epoll fds I<should> work, but
…		…
549	If one or more of the backend flags are or'ed into the flags value,	586	If one or more of the backend flags are or'ed into the flags value,
550	then only these backends will be tried (in the reverse order as listed	587	then only these backends will be tried (in the reverse order as listed
551	here). If none are specified, all backends in C<ev_recommended_backends	588	here). If none are specified, all backends in C<ev_recommended_backends
552	()> will be tried.	589	()> will be tried.
553		590
554	Example: This is the most typical usage.
555
556	if (!ev_default_loop (0))
557	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
558
559	Example: Restrict libev to the select and poll backends, and do not allow
560	environment settings to be taken into account:
561
562	ev_default_loop (EVBACKEND_POLL \| EVBACKEND_SELECT \| EVFLAG_NOENV);
563
564	Example: Use whatever libev has to offer, but make sure that kqueue is
565	used if available (warning, breaks stuff, best use only with your own
566	private event loop and only if you know the OS supports your types of
567	fds):
568
569	ev_default_loop (ev_recommended_backends () \| EVBACKEND_KQUEUE);
570
571	=item struct ev_loop *ev_loop_new (unsigned int flags)
572
573	Similar to C<ev_default_loop>, but always creates a new event loop that is
574	always distinct from the default loop.
575
576	Note that this function I<is> thread-safe, and one common way to use
577	libev with threads is indeed to create one loop per thread, and using the
578	default loop in the "main" or "initial" thread.
579
580	Example: Try to create a event loop that uses epoll and nothing else.	591	Example: Try to create a event loop that uses epoll and nothing else.
581		592
582	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);	593	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);
583	if (!epoller)	594	if (!epoller)
584	fatal ("no epoll found here, maybe it hides under your chair");	595	fatal ("no epoll found here, maybe it hides under your chair");
585		596
		597	Example: Use whatever libev has to offer, but make sure that kqueue is
		598	used if available.
		599
		600	struct ev_loop *loop = ev_loop_new (ev_recommended_backends () \| EVBACKEND_KQUEUE);
		601
586	=item ev_default_destroy ()	602	=item ev_loop_destroy (loop)
587		603
588	Destroys the default loop (frees all memory and kernel state etc.). None	604	Destroys an event loop object (frees all memory and kernel state
589	of the active event watchers will be stopped in the normal sense, so	605	etc.). None of the active event watchers will be stopped in the normal
590	e.g. C<ev_is_active> might still return true. It is your responsibility to	606	sense, so e.g. C<ev_is_active> might still return true. It is your
591	either stop all watchers cleanly yourself I<before> calling this function,	607	responsibility to either stop all watchers cleanly yourself I<before>
592	or cope with the fact afterwards (which is usually the easiest thing, you	608	calling this function, or cope with the fact afterwards (which is usually
593	can just ignore the watchers and/or C<free ()> them for example).	609	the easiest thing, you can just ignore the watchers and/or C<free ()> them
		610	for example).
594		611
595	Note that certain global state, such as signal state (and installed signal	612	Note that certain global state, such as signal state (and installed signal
596	handlers), will not be freed by this function, and related watchers (such	613	handlers), will not be freed by this function, and related watchers (such
597	as signal and child watchers) would need to be stopped manually.	614	as signal and child watchers) would need to be stopped manually.
598		615
599	In general it is not advisable to call this function except in the	616	This function is normally used on loop objects allocated by
600	rare occasion where you really need to free e.g. the signal handling	617	C<ev_loop_new>, but it can also be used on the default loop returned by
		618	C<ev_default_loop>, in which case it is not thread-safe.
		619
		620	Note that it is not advisable to call this function on the default loop
		621	except in the rare occasion where you really need to free it's resources.
601	pipe fds. If you need dynamically allocated loops it is better to use	622	If you need dynamically allocated loops it is better to use C<ev_loop_new>
602	C<ev_loop_new> and C<ev_loop_destroy>.	623	and C<ev_loop_destroy>.
603		624
604	=item ev_loop_destroy (loop)	625	=item ev_loop_fork (loop)
605		626
606	Like C<ev_default_destroy>, but destroys an event loop created by an
607	earlier call to C<ev_loop_new>.
608
609	=item ev_default_fork ()
610
611	This function sets a flag that causes subsequent C<ev_run> iterations	627	This function sets a flag that causes subsequent C<ev_run> iterations to
612	to reinitialise the kernel state for backends that have one. Despite the	628	reinitialise the kernel state for backends that have one. Despite the
613	name, you can call it anytime, but it makes most sense after forking, in	629	name, you can call it anytime, but it makes most sense after forking, in
614	the child process (or both child and parent, but that again makes little	630	the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the
615	sense). You I<must> call it in the child before using any of the libev	631	child before resuming or calling C<ev_run>.
616	functions, and it will only take effect at the next C<ev_run> iteration.
617		632
618	Again, you I<have> to call it on I<any> loop that you want to re-use after	633	Again, you I<have> to call it on I<any> loop that you want to re-use after
619	a fork, I<even if you do not plan to use the loop in the parent>. This is	634	a fork, I<even if you do not plan to use the loop in the parent>. This is
620	because some kernel interfaces cough I<kqueue> cough do funny things	635	because some kernel interfaces cough I<kqueue> cough do funny things
621	during fork.	636	during fork.
…		…
626	call it at all (in fact, C<epoll> is so badly broken that it makes a	641	call it at all (in fact, C<epoll> is so badly broken that it makes a
627	difference, but libev will usually detect this case on its own and do a	642	difference, but libev will usually detect this case on its own and do a
628	costly reset of the backend).	643	costly reset of the backend).
629		644
630	The function itself is quite fast and it's usually not a problem to call	645	The function itself is quite fast and it's usually not a problem to call
631	it just in case after a fork. To make this easy, the function will fit in	646	it just in case after a fork.
632	quite nicely into a call to C<pthread_atfork>:
633		647
		648	Example: Automate calling C<ev_loop_fork> on the default loop when
		649	using pthreads.
		650
		651	static void
		652	post_fork_child (void)
		653	{
		654	ev_loop_fork (EV_DEFAULT);
		655	}
		656
		657	...
634	pthread_atfork (0, 0, ev_default_fork);	658	pthread_atfork (0, 0, post_fork_child);
635
636	=item ev_loop_fork (loop)
637
638	Like C<ev_default_fork>, but acts on an event loop created by
639	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
640	after fork that you want to re-use in the child, and how you keep track of
641	them is entirely your own problem.
642		659
643	=item int ev_is_default_loop (loop)	660	=item int ev_is_default_loop (loop)
644		661
645	Returns true when the given loop is, in fact, the default loop, and false	662	Returns true when the given loop is, in fact, the default loop, and false
646	otherwise.	663	otherwise.
…		…
807	Can be used to make a call to C<ev_run> return early (but only after it	824	Can be used to make a call to C<ev_run> return early (but only after it
808	has processed all outstanding events). The C<how> argument must be either	825	has processed all outstanding events). The C<how> argument must be either
809	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or	826	C<EVBREAK_ONE>, which will make the innermost C<ev_run> call return, or
810	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.	827	C<EVBREAK_ALL>, which will make all nested C<ev_run> calls return.
811		828
812	This "unloop state" will be cleared when entering C<ev_run> again.	829	This "break state" will be cleared when entering C<ev_run> again.
813		830
814	It is safe to call C<ev_break> from outside any C<ev_run> calls. ##TODO##	831	It is safe to call C<ev_break> from outside any C<ev_run> calls, too.
815		832
816	=item ev_ref (loop)	833	=item ev_ref (loop)
817		834
818	=item ev_unref (loop)	835	=item ev_unref (loop)
819		836
…		…
908		925
909	=item ev_invoke_pending (loop)	926	=item ev_invoke_pending (loop)
910		927
911	This call will simply invoke all pending watchers while resetting their	928	This call will simply invoke all pending watchers while resetting their
912	pending state. Normally, C<ev_run> does this automatically when required,	929	pending state. Normally, C<ev_run> does this automatically when required,
913	but when overriding the invoke callback this call comes handy.	930	but when overriding the invoke callback this call comes handy. This
		931	function can be invoked from a watcher - this can be useful for example
		932	when you want to do some lengthy calculation and want to pass further
		933	event handling to another thread (you still have to make sure only one
		934	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
914		935
915	=item int ev_pending_count (loop)	936	=item int ev_pending_count (loop)
916		937
917	Returns the number of pending watchers - zero indicates that no watchers	938	Returns the number of pending watchers - zero indicates that no watchers
918	are pending.	939	are pending.
…		…
990		1011
991	In the following description, uppercase C<TYPE> in names stands for the	1012	In the following description, uppercase C<TYPE> in names stands for the
992	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer	1013	watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
993	watchers and C<ev_io_start> for I/O watchers.	1014	watchers and C<ev_io_start> for I/O watchers.
994		1015
995	A watcher is a structure that you create and register to record your	1016	A watcher is an opaque structure that you allocate and register to record
996	interest in some event. For instance, if you want to wait for STDIN to	1017	your interest in some event. To make a concrete example, imagine you want
997	become readable, you would create an C<ev_io> watcher for that:	1018	to wait for STDIN to become readable, you would create an C<ev_io> watcher
		1019	for that:
998		1020
999	static void my_cb (struct ev_loop loop, ev_io w, int revents)	1021	static void my_cb (struct ev_loop loop, ev_io w, int revents)
1000	{	1022	{
1001	ev_io_stop (w);	1023	ev_io_stop (w);
1002	ev_break (loop, EVBREAK_ALL);	1024	ev_break (loop, EVBREAK_ALL);
…		…
1017	stack).	1039	stack).
1018		1040
1019	Each watcher has an associated watcher structure (called C<struct ev_TYPE>	1041	Each watcher has an associated watcher structure (called C<struct ev_TYPE>
1020	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).	1042	or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
1021		1043
1022	Each watcher structure must be initialised by a call to C<ev_init	1044	Each watcher structure must be initialised by a call to C<ev_init (watcher
1023	(watcher *, callback)>, which expects a callback to be provided. This	1045	*, callback)>, which expects a callback to be provided. This callback is
1024	callback gets invoked each time the event occurs (or, in the case of I/O	1046	invoked each time the event occurs (or, in the case of I/O watchers, each
1025	watchers, each time the event loop detects that the file descriptor given	1047	time the event loop detects that the file descriptor given is readable
1026	is readable and/or writable).	1048	and/or writable).
1027		1049
1028	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>	1050	Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
1029	macro to configure it, with arguments specific to the watcher type. There	1051	macro to configure it, with arguments specific to the watcher type. There
1030	is also a macro to combine initialisation and setting in one call: C<<	1052	is also a macro to combine initialisation and setting in one call: C<<
1031	ev_TYPE_init (watcher *, callback, ...) >>.	1053	ev_TYPE_init (watcher *, callback, ...) >>.
…		…
1099	=item C<EV_FORK>	1121	=item C<EV_FORK>
1100		1122
1101	The event loop has been resumed in the child process after fork (see	1123	The event loop has been resumed in the child process after fork (see
1102	C<ev_fork>).	1124	C<ev_fork>).
1103		1125
		1126	=item C<EV_CLEANUP>
		1127
		1128	The event loop is about to be destroyed (see C<ev_cleanup>).
		1129
1104	=item C<EV_ASYNC>	1130	=item C<EV_ASYNC>
1105		1131
1106	The given async watcher has been asynchronously notified (see C<ev_async>).	1132	The given async watcher has been asynchronously notified (see C<ev_async>).
1107		1133
1108	=item C<EV_CUSTOM>	1134	=item C<EV_CUSTOM>
…		…
1279		1305
1280	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related	1306	See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1281	functions that do not need a watcher.	1307	functions that do not need a watcher.
1282		1308
1283	=back	1309	=back
1284
1285		1310
1286	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	1311	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
1287		1312
1288	Each watcher has, by default, a member C<void *data> that you can change	1313	Each watcher has, by default, a member C<void *data> that you can change
1289	and read at any time: libev will completely ignore it. This can be used	1314	and read at any time: libev will completely ignore it. This can be used
…		…
1345	t2_cb (EV_P_ ev_timer *w, int revents)	1370	t2_cb (EV_P_ ev_timer *w, int revents)
1346	{	1371	{
1347	struct my_biggy big = (struct my_biggy *)	1372	struct my_biggy big = (struct my_biggy *)
1348	(((char *)w) - offsetof (struct my_biggy, t2));	1373	(((char *)w) - offsetof (struct my_biggy, t2));
1349	}	1374	}
		1375
		1376	=head2 WATCHER STATES
		1377
		1378	There are various watcher states mentioned throughout this manual -
		1379	active, pending and so on. In this section these states and the rules to
		1380	transition between them will be described in more detail - and while these
		1381	rules might look complicated, they usually do "the right thing".
		1382
		1383	=over 4
		1384
		1385	=item initialiased
		1386
		1387	Before a watcher can be registered with the event looop it has to be
		1388	initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
		1389	C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
		1390
		1391	In this state it is simply some block of memory that is suitable for use
		1392	in an event loop. It can be moved around, freed, reused etc. at will.
		1393
		1394	=item started/running/active
		1395
		1396	Once a watcher has been started with a call to C<ev_TYPE_start> it becomes
		1397	property of the event loop, and is actively waiting for events. While in
		1398	this state it cannot be accessed (except in a few documented ways), moved,
		1399	freed or anything else - the only legal thing is to keep a pointer to it,
		1400	and call libev functions on it that are documented to work on active watchers.
		1401
		1402	=item pending
		1403
		1404	If a watcher is active and libev determines that an event it is interested
		1405	in has occurred (such as a timer expiring), it will become pending. It will
		1406	stay in this pending state until either it is stopped or its callback is
		1407	about to be invoked, so it is not normally pending inside the watcher
		1408	callback.
		1409
		1410	The watcher might or might not be active while it is pending (for example,
		1411	an expired non-repeating timer can be pending but no longer active). If it
		1412	is stopped, it can be freely accessed (e.g. by calling C<ev_TYPE_set>),
		1413	but it is still property of the event loop at this time, so cannot be
		1414	moved, freed or reused. And if it is active the rules described in the
		1415	previous item still apply.
		1416
		1417	It is also possible to feed an event on a watcher that is not active (e.g.
		1418	via C<ev_feed_event>), in which case it becomes pending without being
		1419	active.
		1420
		1421	=item stopped
		1422
		1423	A watcher can be stopped implicitly by libev (in which case it might still
		1424	be pending), or explicitly by calling its C<ev_TYPE_stop> function. The
		1425	latter will clear any pending state the watcher might be in, regardless
		1426	of whether it was active or not, so stopping a watcher explicitly before
		1427	freeing it is often a good idea.
		1428
		1429	While stopped (and not pending) the watcher is essentially in the
		1430	initialised state, that is it can be reused, moved, modified in any way
		1431	you wish.
		1432
		1433	=back
1350		1434
1351	=head2 WATCHER PRIORITY MODELS	1435	=head2 WATCHER PRIORITY MODELS
1352		1436
1353	Many event loops support I<watcher priorities>, which are usually small	1437	Many event loops support I<watcher priorities>, which are usually small
1354	integers that influence the ordering of event callback invocation	1438	integers that influence the ordering of event callback invocation
…		…
3008	disadvantage of having to use multiple event loops (which do not support	3092	disadvantage of having to use multiple event loops (which do not support
3009	signal watchers).	3093	signal watchers).
3010		3094
3011	When this is not possible, or you want to use the default loop for	3095	When this is not possible, or you want to use the default loop for
3012	other reasons, then in the process that wants to start "fresh", call	3096	other reasons, then in the process that wants to start "fresh", call
3013	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3097	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
3014	the default loop will "orphan" (not stop) all registered watchers, so you	3098	Destroying the default loop will "orphan" (not stop) all registered
3015	have to be careful not to execute code that modifies those watchers. Note	3099	watchers, so you have to be careful not to execute code that modifies
3016	also that in that case, you have to re-register any signal watchers.	3100	those watchers. Note also that in that case, you have to re-register any
		3101	signal watchers.
3017		3102
3018	=head3 Watcher-Specific Functions and Data Members	3103	=head3 Watcher-Specific Functions and Data Members
3019		3104
3020	=over 4	3105	=over 4
3021		3106
3022	=item ev_fork_init (ev_signal *, callback)	3107	=item ev_fork_init (ev_fork *, callback)
3023		3108
3024	Initialises and configures the fork watcher - it has no parameters of any	3109	Initialises and configures the fork watcher - it has no parameters of any
3025	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,	3110	kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
3026	believe me.	3111	really.
3027		3112
3028	=back	3113	=back
		3114
		3115
		3116	=head2 C<ev_cleanup> - even the best things end
		3117
		3118	Cleanup watchers are called just before the event loop is being destroyed
		3119	by a call to C<ev_loop_destroy>.
		3120
		3121	While there is no guarantee that the event loop gets destroyed, cleanup
		3122	watchers provide a convenient method to install cleanup hooks for your
		3123	program, worker threads and so on - you just to make sure to destroy the
		3124	loop when you want them to be invoked.
		3125
		3126	Cleanup watchers are invoked in the same way as any other watcher. Unlike
		3127	all other watchers, they do not keep a reference to the event loop (which
		3128	makes a lot of sense if you think about it). Like all other watchers, you
		3129	can call libev functions in the callback, except C<ev_cleanup_start>.
		3130
		3131	=head3 Watcher-Specific Functions and Data Members
		3132
		3133	=over 4
		3134
		3135	=item ev_cleanup_init (ev_cleanup *, callback)
		3136
		3137	Initialises and configures the cleanup watcher - it has no parameters of
		3138	any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
		3139	pointless, I assure you.
		3140
		3141	=back
		3142
		3143	Example: Register an atexit handler to destroy the default loop, so any
		3144	cleanup functions are called.
		3145
		3146	static void
		3147	program_exits (void)
		3148	{
		3149	ev_loop_destroy (EV_DEFAULT_UC);
		3150	}
		3151
		3152	...
		3153	atexit (program_exits);
3029		3154
3030		3155
3031	=head2 C<ev_async> - how to wake up an event loop	3156	=head2 C<ev_async> - how to wake up an event loop
3032		3157
3033	In general, you cannot use an C<ev_run> from multiple threads or other	3158	In general, you cannot use an C<ev_run> from multiple threads or other
…		…
4467	=head3 C<kqueue> is buggy	4592	=head3 C<kqueue> is buggy
4468		4593
4469	The kqueue syscall is broken in all known versions - most versions support	4594	The kqueue syscall is broken in all known versions - most versions support
4470	only sockets, many support pipes.	4595	only sockets, many support pipes.
4471		4596
4472	Libev tries to work around this by not using C<kqueue> by default on	4597	Libev tries to work around this by not using C<kqueue> by default on this
4473	this rotten platform, but of course you can still ask for it when creating	4598	rotten platform, but of course you can still ask for it when creating a
4474	a loop.	4599	loop - embedding a socket-only kqueue loop into a select-based one is
		4600	probably going to work well.
4475		4601
4476	=head3 C<poll> is buggy	4602	=head3 C<poll> is buggy
4477		4603
4478	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>	4604	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
4479	implementation by something calling C<kqueue> internally around the 10.5.6	4605	implementation by something calling C<kqueue> internally around the 10.5.6
…		…
4498		4624
4499	=head3 C<errno> reentrancy	4625	=head3 C<errno> reentrancy
4500		4626
4501	The default compile environment on Solaris is unfortunately so	4627	The default compile environment on Solaris is unfortunately so
4502	thread-unsafe that you can't even use components/libraries compiled	4628	thread-unsafe that you can't even use components/libraries compiled
4503	without C<-D_REENTRANT> (as long as they use C<errno>), which, of course,	4629	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
4504	isn't defined by default.	4630	defined by default. A valid, if stupid, implementation choice.
4505		4631
4506	If you want to use libev in threaded environments you have to make sure	4632	If you want to use libev in threaded environments you have to make sure
4507	it's compiled with C<_REENTRANT> defined.	4633	it's compiled with C<_REENTRANT> defined.
4508		4634
4509	=head3 Event port backend	4635	=head3 Event port backend
4510		4636
4511	The scalable event interface for Solaris is called "event ports". Unfortunately,	4637	The scalable event interface for Solaris is called "event
4512	this mechanism is very buggy. If you run into high CPU usage, your program	4638	ports". Unfortunately, this mechanism is very buggy in all major
		4639	releases. If you run into high CPU usage, your program freezes or you get
4513	freezes or you get a large number of spurious wakeups, make sure you have	4640	a large number of spurious wakeups, make sure you have all the relevant
4514	all the relevant and latest kernel patches applied. No, I don't know which	4641	and latest kernel patches applied. No, I don't know which ones, but there
4515	ones, but there are multiple ones.	4642	are multiple ones to apply, and afterwards, event ports actually work
		4643	great.
4516		4644
4517	If you can't get it to work, you can try running the program by setting	4645	If you can't get it to work, you can try running the program by setting
4518	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and	4646	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
4519	C<select> backends.	4647	C<select> backends.
4520		4648
4521	=head2 AIX POLL BUG	4649	=head2 AIX POLL BUG
4522		4650
4523	AIX unfortunately has a broken C<poll.h> header. Libev works around	4651	AIX unfortunately has a broken C<poll.h> header. Libev works around
4524	this by trying to avoid the poll backend altogether (i.e. it's not even	4652	this by trying to avoid the poll backend altogether (i.e. it's not even
4525	compiled in), which normally isn't a big problem as C<select> works fine	4653	compiled in), which normally isn't a big problem as C<select> works fine
4526	with large bitsets, and AIX is dead anyway.	4654	with large bitsets on AIX, and AIX is dead anyway.
4527		4655
4528	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	4656	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
4529		4657
4530	=head3 General issues	4658	=head3 General issues
4531		4659
…		…
4637	structure (guaranteed by POSIX but not by ISO C for example), but it also	4765	structure (guaranteed by POSIX but not by ISO C for example), but it also
4638	assumes that the same (machine) code can be used to call any watcher	4766	assumes that the same (machine) code can be used to call any watcher
4639	callback: The watcher callbacks have different type signatures, but libev	4767	callback: The watcher callbacks have different type signatures, but libev
4640	calls them using an C<ev_watcher *> internally.	4768	calls them using an C<ev_watcher *> internally.
4641		4769
		4770	=item pointer accesses must be thread-atomic
		4771
		4772	Accessing a pointer value must be atomic, it must both be readable and
		4773	writable in one piece - this is the case on all current architectures.
		4774
4642	=item C<sig_atomic_t volatile> must be thread-atomic as well	4775	=item C<sig_atomic_t volatile> must be thread-atomic as well
4643		4776
4644	The type C<sig_atomic_t volatile> (or whatever is defined as	4777	The type C<sig_atomic_t volatile> (or whatever is defined as
4645	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different	4778	C<EV_ATOMIC_T>) must be atomic with respect to accesses from different
4646	threads. This is not part of the specification for C<sig_atomic_t>, but is	4779	threads. This is not part of the specification for C<sig_atomic_t>, but is
…		…
4752	=back	4885	=back
4753		4886
4754		4887
4755	=head1 PORTING FROM LIBEV 3.X TO 4.X	4888	=head1 PORTING FROM LIBEV 3.X TO 4.X
4756		4889
4757	The major version 4 introduced some minor incompatible changes to the API.	4890	The major version 4 introduced some incompatible changes to the API.
4758		4891
4759	At the moment, the C<ev.h> header file tries to implement superficial	4892	At the moment, the C<ev.h> header file provides compatibility definitions
4760	compatibility, so most programs should still compile. Those might be	4893	for all changes, so most programs should still compile. The compatibility
4761	removed in later versions of libev, so better update early than late.	4894	layer might be removed in later versions of libev, so better update to the
		4895	new API early than late.
4762		4896
4763	=over 4	4897	=over 4
		4898
		4899	=item C<EV_COMPAT3> backwards compatibility mechanism
		4900
		4901	The backward compatibility mechanism can be controlled by
		4902	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
		4903	section.
		4904
		4905	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		4906
		4907	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		4908
		4909	ev_loop_destroy (EV_DEFAULT_UC);
		4910	ev_loop_fork (EV_DEFAULT);
4764		4911
4765	=item function/symbol renames	4912	=item function/symbol renames
4766		4913
4767	A number of functions and symbols have been renamed:	4914	A number of functions and symbols have been renamed:
4768		4915
…		…
4787	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme	4934	ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
4788	as all other watcher types. Note that C<ev_loop_fork> is still called	4935	as all other watcher types. Note that C<ev_loop_fork> is still called
4789	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>	4936	C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
4790	typedef.	4937	typedef.
4791		4938
4792	=item C<EV_COMPAT3> backwards compatibility mechanism
4793
4794	The backward compatibility mechanism can be controlled by
4795	C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
4796	section.
4797
4798	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>	4939	=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
4799		4940
4800	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different	4941	The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
4801	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile	4942	mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
4802	and work, but the library code will of course be larger.	4943	and work, but the library code will of course be larger.
…		…
4808		4949
4809	=over 4	4950	=over 4
4810		4951
4811	=item active	4952	=item active
4812		4953
4813	A watcher is active as long as it has been started (has been attached to	4954	A watcher is active as long as it has been started and not yet stopped.
4814	an event loop) but not yet stopped (disassociated from the event loop).	4955	See L<WATCHER STATES> for details.
4815		4956
4816	=item application	4957	=item application
4817		4958
4818	In this document, an application is whatever is using libev.	4959	In this document, an application is whatever is using libev.
		4960
		4961	=item backend
		4962
		4963	The part of the code dealing with the operating system interfaces.
4819		4964
4820	=item callback	4965	=item callback
4821		4966
4822	The address of a function that is called when some event has been	4967	The address of a function that is called when some event has been
4823	detected. Callbacks are being passed the event loop, the watcher that	4968	detected. Callbacks are being passed the event loop, the watcher that
4824	received the event, and the actual event bitset.	4969	received the event, and the actual event bitset.
4825		4970
4826	=item callback invocation	4971	=item callback/watcher invocation
4827		4972
4828	The act of calling the callback associated with a watcher.	4973	The act of calling the callback associated with a watcher.
4829		4974
4830	=item event	4975	=item event
4831		4976
…		…
4850	The model used to describe how an event loop handles and processes	4995	The model used to describe how an event loop handles and processes
4851	watchers and events.	4996	watchers and events.
4852		4997
4853	=item pending	4998	=item pending
4854		4999
4855	A watcher is pending as soon as the corresponding event has been detected,	5000	A watcher is pending as soon as the corresponding event has been
4856	and stops being pending as soon as the watcher will be invoked or its	5001	detected. See L<WATCHER STATES> for details.
4857	pending status is explicitly cleared by the application.
4858
4859	A watcher can be pending, but not active. Stopping a watcher also clears
4860	its pending status.
4861		5002
4862	=item real time	5003	=item real time
4863		5004
4864	The physical time that is observed. It is apparently strictly monotonic :)	5005	The physical time that is observed. It is apparently strictly monotonic :)
4865		5006
…		…
4872	=item watcher	5013	=item watcher
4873		5014
4874	A data structure that describes interest in certain events. Watchers need	5015	A data structure that describes interest in certain events. Watchers need
4875	to be started (attached to an event loop) before they can receive events.	5016	to be started (attached to an event loop) before they can receive events.
4876		5017
4877	=item watcher invocation
4878
4879	The act of calling the callback associated with a watcher.
4880
4881	=back	5018	=back
4882		5019
4883	=head1 AUTHOR	5020	=head1 AUTHOR
4884		5021
4885	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	5022	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael
		5023	Magnusson and Emanuele Giaquinta.
4886		5024

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.310 by root, Thu Oct 21 12:32:47 2010 UTC vs. Revision 1.337 by root, Sun Oct 31 20:20:20 2010 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.310 by root, Thu Oct 21 12:32:47 2010 UTC vs.
Revision 1.337 by root, Sun Oct 31 20:20:20 2010 UTC