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

Comparing libev/ev.pod (file contents):
Revision 1.311 by root, Thu Oct 21 14:40:07 2010 UTC vs.
Revision 1.322 by root, Sun Oct 24 17:58:41 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);
…		…
124	this argument.	124	this argument.
125		125
126	=head2 TIME REPRESENTATION	126	=head2 TIME REPRESENTATION
127		127
128	Libev represents time as a single floating point number, representing	128	Libev represents time as a single floating point number, representing
129	the (fractional) number of seconds since the (POSIX) epoch (in practise	129	the (fractional) number of seconds since the (POSIX) epoch (in practice
130	somewhere near the beginning of 1970, details are complicated, don't	130	somewhere near the beginning of 1970, details are complicated, don't
131	ask). This type is called C<ev_tstamp>, which is what you should use	131	ask). This type is called C<ev_tstamp>, which is what you should use
132	too. It usually aliases to the C<double> type in C. When you need to do	132	too. It usually aliases to the C<double> type in C. When you need to do
133	any calculations on it, you should treat it as some floating point value.	133	any calculations on it, you should treat it as some floating point value.
134		134
…		…
165		165
166	=item ev_tstamp ev_time ()	166	=item ev_tstamp ev_time ()
167		167
168	Returns the current time as libev would use it. Please note that the	168	Returns the current time as libev would use it. Please note that the
169	C<ev_now> function is usually faster and also often returns the timestamp	169	C<ev_now> function is usually faster and also often returns the timestamp
170	you actually want to know.	170	you actually want to know. Also interesting is the combination of
		171	C<ev_update_now> and C<ev_now>.
171		172
172	=item ev_sleep (ev_tstamp interval)	173	=item ev_sleep (ev_tstamp interval)
173		174
174	Sleep for the given interval: The current thread will be blocked until	175	Sleep for the given interval: The current thread will be blocked until
175	either it is interrupted or the given time interval has passed. Basically	176	either it is interrupted or the given time interval has passed. Basically
…		…
192	as this indicates an incompatible change. Minor versions are usually	193	as this indicates an incompatible change. Minor versions are usually
193	compatible to older versions, so a larger minor version alone is usually	194	compatible to older versions, so a larger minor version alone is usually
194	not a problem.	195	not a problem.
195		196
196	Example: Make sure we haven't accidentally been linked against the wrong	197	Example: Make sure we haven't accidentally been linked against the wrong
197	version (note, however, that this will not detect ABI mismatches :).	198	version (note, however, that this will not detect other ABI mismatches,
		199	such as LFS or reentrancy).
198		200
199	assert (("libev version mismatch",	201	assert (("libev version mismatch",
200	ev_version_major () == EV_VERSION_MAJOR	202	ev_version_major () == EV_VERSION_MAJOR
201	&& ev_version_minor () >= EV_VERSION_MINOR));	203	&& ev_version_minor () >= EV_VERSION_MINOR));
202		204
…		…
213	assert (("sorry, no epoll, no sex",	215	assert (("sorry, no epoll, no sex",
214	ev_supported_backends () & EVBACKEND_EPOLL));	216	ev_supported_backends () & EVBACKEND_EPOLL));
215		217
216	=item unsigned int ev_recommended_backends ()	218	=item unsigned int ev_recommended_backends ()
217		219
218	Return the set of all backends compiled into this binary of libev and also	220	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	221	also recommended for this platform, meaning it will work for most file
		222	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	223	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	224	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	225	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.	226	probe for if you specify no backends explicitly.
224		227
225	=item unsigned int ev_embeddable_backends ()	228	=item unsigned int ev_embeddable_backends ()
226		229
227	Returns the set of backends that are embeddable in other event loops. This	230	Returns the set of backends that are embeddable in other event loops. This
228	is the theoretical, all-platform, value. To find which backends	231	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	232	current system. To find which embeddable backends might be supported on
230	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for	233	the current system, you would need to look at C<ev_embeddable_backends ()
231	recommended ones.	234	& ev_supported_backends ()>, likewise for recommended ones.
232		235
233	See the description of C<ev_embed> watchers for more info.	236	See the description of C<ev_embed> watchers for more info.
234		237
235	=item ev_set_allocator (void (cb)(void *ptr, long size)) [NOT REENTRANT]	238	=item ev_set_allocator (void (cb)(void *ptr, long size)) [NOT REENTRANT]
236		239
…		…
290	...	293	...
291	ev_set_syserr_cb (fatal_error);	294	ev_set_syserr_cb (fatal_error);
292		295
293	=back	296	=back
294		297
295	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	298	=head1 FUNCTIONS CONTROLLING EVENT LOOPS
296		299
297	An event loop is described by a C<struct ev_loop *> (the C<struct> is	300	An event loop is described by a C<struct ev_loop *> (the C<struct> is
298	I<not> optional in this case unless libev 3 compatibility is disabled, as	301	I<not> optional in this case unless libev 3 compatibility is disabled, as
299	libev 3 had an C<ev_loop> function colliding with the struct name).	302	libev 3 had an C<ev_loop> function colliding with the struct name).
300		303
…		…
304		307
305	=over 4	308	=over 4
306		309
307	=item struct ev_loop *ev_default_loop (unsigned int flags)	310	=item struct ev_loop *ev_default_loop (unsigned int flags)
308		311
309	This will initialise the default event loop if it hasn't been initialised	312	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	313	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	314	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).	315	C<ev_loop_new>.
		316
		317	If the default loop is already initialised then this function simply
		318	returns it (and ignores the flags. If that is troubling you, check
		319	C<ev_backend ()> afterwards). Otherwise it will create it with the given
		320	flags, which should almost always be C<0>, unless the caller is also the
		321	one calling C<ev_run> or otherwise qualifies as "the main program".
313		322
314	If you don't know what event loop to use, use the one returned from this	323	If you don't know what event loop to use, use the one returned from this
315	function.	324	function (or via the C<EV_DEFAULT> macro).
316		325
317	Note that this function is I<not> thread-safe, so if you want to use it	326	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,	327	from multiple threads, you have to employ some kind of mutex (note also
319	as loops cannot be shared easily between threads anyway).	328	that this case is unlikely, as loops cannot be shared easily between
		329	threads anyway).
320		330
321	The default loop is the only loop that can handle C<ev_signal> and	331	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	332	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	333	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	334	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	335	C<SIGCHLD> signal handler I<after> calling C<ev_default_init>.
326	C<ev_default_init>.	336
		337	Example: This is the most typical usage.
		338
		339	if (!ev_default_loop (0))
		340	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
		341
		342	Example: Restrict libev to the select and poll backends, and do not allow
		343	environment settings to be taken into account:
		344
		345	ev_default_loop (EVBACKEND_POLL \| EVBACKEND_SELECT \| EVFLAG_NOENV);
		346
		347	Example: Use whatever libev has to offer, but make sure that kqueue is
		348	used if available (warning, breaks stuff, best use only with your own
		349	private event loop and only if you know the OS supports your types of
		350	fds):
		351
		352	ev_default_loop (ev_recommended_backends () \| EVBACKEND_KQUEUE);
		353
		354	=item struct ev_loop *ev_loop_new (unsigned int flags)
		355
		356	This will create and initialise a new event loop object. If the loop
		357	could not be initialised, returns false.
		358
		359	Note that this function I<is> thread-safe, and one common way to use
		360	libev with threads is indeed to create one loop per thread, and using the
		361	default loop in the "main" or "initial" thread.
327		362
328	The flags argument can be used to specify special behaviour or specific	363	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>).	364	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
330		365
331	The following flags are supported:	366	The following flags are supported:
…		…
549	If one or more of the backend flags are or'ed into the flags value,	584	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	585	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	586	here). If none are specified, all backends in C<ev_recommended_backends
552	()> will be tried.	587	()> will be tried.
553		588
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.	589	Example: Try to create a event loop that uses epoll and nothing else.
581		590
582	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);	591	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);
583	if (!epoller)	592	if (!epoller)
584	fatal ("no epoll found here, maybe it hides under your chair");	593	fatal ("no epoll found here, maybe it hides under your chair");
585		594
586	=item ev_default_destroy ()	595	=item ev_loop_destroy (loop)
587		596
588	Destroys the default loop (frees all memory and kernel state etc.). None	597	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	598	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	599	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,	600	responsibility to either stop all watchers cleanly yourself I<before>
592	or cope with the fact afterwards (which is usually the easiest thing, you	601	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).	602	the easiest thing, you can just ignore the watchers and/or C<free ()> them
		603	for example).
594		604
595	Note that certain global state, such as signal state (and installed signal	605	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	606	handlers), will not be freed by this function, and related watchers (such
597	as signal and child watchers) would need to be stopped manually.	607	as signal and child watchers) would need to be stopped manually.
598		608
599	In general it is not advisable to call this function except in the	609	This function is normally used on loop objects allocated by
600	rare occasion where you really need to free e.g. the signal handling	610	C<ev_loop_new>, but it can also be used on the default loop returned by
		611	C<ev_default_loop>, in which case it is not thread-safe.
		612
		613	Note that it is not advisable to call this function on the default loop
		614	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	615	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>.	616	and C<ev_loop_destroy>.
603		617
604	=item ev_loop_destroy (loop)	618	=item ev_loop_fork (loop)
605		619
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	620	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	621	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	622	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	623	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	624	child before resuming or calling C<ev_run>.
616	functions, and it will only take effect at the next C<ev_run> iteration.
617		625
618	Again, you I<have> to call it on I<any> loop that you want to re-use after	626	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	627	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	628	because some kernel interfaces cough I<kqueue> cough do funny things
621	during fork.	629	during fork.
…		…
626	call it at all (in fact, C<epoll> is so badly broken that it makes a	634	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	635	difference, but libev will usually detect this case on its own and do a
628	costly reset of the backend).	636	costly reset of the backend).
629		637
630	The function itself is quite fast and it's usually not a problem to call	638	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	639	it just in case after a fork.
632	quite nicely into a call to C<pthread_atfork>:
633		640
		641	Example: Automate calling C<ev_loop_fork> on the default loop when
		642	using pthreads.
		643
		644	static void
		645	post_fork_child (void)
		646	{
		647	ev_loop_fork (EV_DEFAULT);
		648	}
		649
		650	...
634	pthread_atfork (0, 0, ev_default_fork);	651	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		652
643	=item int ev_is_default_loop (loop)	653	=item int ev_is_default_loop (loop)
644		654
645	Returns true when the given loop is, in fact, the default loop, and false	655	Returns true when the given loop is, in fact, the default loop, and false
646	otherwise.	656	otherwise.
…		…
908		918
909	=item ev_invoke_pending (loop)	919	=item ev_invoke_pending (loop)
910		920
911	This call will simply invoke all pending watchers while resetting their	921	This call will simply invoke all pending watchers while resetting their
912	pending state. Normally, C<ev_run> does this automatically when required,	922	pending state. Normally, C<ev_run> does this automatically when required,
913	but when overriding the invoke callback this call comes handy.	923	but when overriding the invoke callback this call comes handy. This
		924	function can be invoked from a watcher - this can be useful for example
		925	when you want to do some lengthy calculation and want to pass further
		926	event handling to another thread (you still have to make sure only one
		927	thread executes within C<ev_invoke_pending> or C<ev_run> of course).
914		928
915	=item int ev_pending_count (loop)	929	=item int ev_pending_count (loop)
916		930
917	Returns the number of pending watchers - zero indicates that no watchers	931	Returns the number of pending watchers - zero indicates that no watchers
918	are pending.	932	are pending.
…		…
1159	and call libev functions on it that are documented to work on active watchers.	1173	and call libev functions on it that are documented to work on active watchers.
1160		1174
1161	=item pending	1175	=item pending
1162		1176
1163	If a watcher is active and libev determines that an event it is interested	1177	If a watcher is active and libev determines that an event it is interested
1164	in has occured (such as a timer expiring), it will become pending. It will	1178	in has occurred (such as a timer expiring), it will become pending. It will
1165	stay in this pending state until either it is stopped or its callback is	1179	stay in this pending state until either it is stopped or its callback is
1166	about to be invoked, so it is not normally pending inside the watcher	1180	about to be invoked, so it is not normally pending inside the watcher
1167	callback.	1181	callback.
1168		1182
1169	The watcher might or might not be active while it is pending (for example,	1183	The watcher might or might not be active while it is pending (for example,
…		…
3068	disadvantage of having to use multiple event loops (which do not support	3082	disadvantage of having to use multiple event loops (which do not support
3069	signal watchers).	3083	signal watchers).
3070		3084
3071	When this is not possible, or you want to use the default loop for	3085	When this is not possible, or you want to use the default loop for
3072	other reasons, then in the process that wants to start "fresh", call	3086	other reasons, then in the process that wants to start "fresh", call
3073	C<ev_default_destroy ()> followed by C<ev_default_loop (...)>. Destroying	3087	C<ev_loop_destroy (EV_DEFAULT)> followed by C<ev_default_loop (...)>.
3074	the default loop will "orphan" (not stop) all registered watchers, so you	3088	Destroying the default loop will "orphan" (not stop) all registered
3075	have to be careful not to execute code that modifies those watchers. Note	3089	watchers, so you have to be careful not to execute code that modifies
3076	also that in that case, you have to re-register any signal watchers.	3090	those watchers. Note also that in that case, you have to re-register any
		3091	signal watchers.
3077		3092
3078	=head3 Watcher-Specific Functions and Data Members	3093	=head3 Watcher-Specific Functions and Data Members
3079		3094
3080	=over 4	3095	=over 4
3081		3096
…		…
4527	=head3 C<kqueue> is buggy	4542	=head3 C<kqueue> is buggy
4528		4543
4529	The kqueue syscall is broken in all known versions - most versions support	4544	The kqueue syscall is broken in all known versions - most versions support
4530	only sockets, many support pipes.	4545	only sockets, many support pipes.
4531		4546
4532	Libev tries to work around this by not using C<kqueue> by default on	4547	Libev tries to work around this by not using C<kqueue> by default on this
4533	this rotten platform, but of course you can still ask for it when creating	4548	rotten platform, but of course you can still ask for it when creating a
4534	a loop.	4549	loop - embedding a socket-only kqueue loop into a select-based one is
		4550	probably going to work well.
4535		4551
4536	=head3 C<poll> is buggy	4552	=head3 C<poll> is buggy
4537		4553
4538	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>	4554	Instead of fixing C<kqueue>, Apple replaced their (working) C<poll>
4539	implementation by something calling C<kqueue> internally around the 10.5.6	4555	implementation by something calling C<kqueue> internally around the 10.5.6
…		…
4558		4574
4559	=head3 C<errno> reentrancy	4575	=head3 C<errno> reentrancy
4560		4576
4561	The default compile environment on Solaris is unfortunately so	4577	The default compile environment on Solaris is unfortunately so
4562	thread-unsafe that you can't even use components/libraries compiled	4578	thread-unsafe that you can't even use components/libraries compiled
4563	without C<-D_REENTRANT> (as long as they use C<errno>), which, of course,	4579	without C<-D_REENTRANT> in a threaded program, which, of course, isn't
4564	isn't defined by default.	4580	defined by default. A valid, if stupid, implementation choice.
4565		4581
4566	If you want to use libev in threaded environments you have to make sure	4582	If you want to use libev in threaded environments you have to make sure
4567	it's compiled with C<_REENTRANT> defined.	4583	it's compiled with C<_REENTRANT> defined.
4568		4584
4569	=head3 Event port backend	4585	=head3 Event port backend
4570		4586
4571	The scalable event interface for Solaris is called "event ports". Unfortunately,	4587	The scalable event interface for Solaris is called "event
4572	this mechanism is very buggy. If you run into high CPU usage, your program	4588	ports". Unfortunately, this mechanism is very buggy in all major
		4589	releases. If you run into high CPU usage, your program freezes or you get
4573	freezes or you get a large number of spurious wakeups, make sure you have	4590	a large number of spurious wakeups, make sure you have all the relevant
4574	all the relevant and latest kernel patches applied. No, I don't know which	4591	and latest kernel patches applied. No, I don't know which ones, but there
4575	ones, but there are multiple ones.	4592	are multiple ones to apply, and afterwards, event ports actually work
		4593	great.
4576		4594
4577	If you can't get it to work, you can try running the program by setting	4595	If you can't get it to work, you can try running the program by setting
4578	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and	4596	the environment variable C<LIBEV_FLAGS=3> to only allow C<poll> and
4579	C<select> backends.	4597	C<select> backends.
4580		4598
4581	=head2 AIX POLL BUG	4599	=head2 AIX POLL BUG
4582		4600
4583	AIX unfortunately has a broken C<poll.h> header. Libev works around	4601	AIX unfortunately has a broken C<poll.h> header. Libev works around
4584	this by trying to avoid the poll backend altogether (i.e. it's not even	4602	this by trying to avoid the poll backend altogether (i.e. it's not even
4585	compiled in), which normally isn't a big problem as C<select> works fine	4603	compiled in), which normally isn't a big problem as C<select> works fine
4586	with large bitsets, and AIX is dead anyway.	4604	with large bitsets on AIX, and AIX is dead anyway.
4587		4605
4588	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS	4606	=head2 WIN32 PLATFORM LIMITATIONS AND WORKAROUNDS
4589		4607
4590	=head3 General issues	4608	=head3 General issues
4591		4609
…		…
4820	compatibility, so most programs should still compile. Those might be	4838	compatibility, so most programs should still compile. Those might be
4821	removed in later versions of libev, so better update early than late.	4839	removed in later versions of libev, so better update early than late.
4822		4840
4823	=over 4	4841	=over 4
4824		4842
		4843	=item C<ev_default_destroy> and C<ev_default_fork> have been removed
		4844
		4845	These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
		4846
		4847	ev_loop_destroy (EV_DEFAULT);
		4848	ev_loop_fork (EV_DEFAULT);
		4849
4825	=item function/symbol renames	4850	=item function/symbol renames
4826		4851
4827	A number of functions and symbols have been renamed:	4852	A number of functions and symbols have been renamed:
4828		4853
4829	ev_loop => ev_run	4854	ev_loop => ev_run
…		…
4868		4893
4869	=over 4	4894	=over 4
4870		4895
4871	=item active	4896	=item active
4872		4897
4873	A watcher is active as long as it has been started (has been attached to	4898	A watcher is active as long as it has been started and not yet stopped.
4874	an event loop) but not yet stopped (disassociated from the event loop).	4899	See L<WATCHER STATES> for details.
4875		4900
4876	=item application	4901	=item application
4877		4902
4878	In this document, an application is whatever is using libev.	4903	In this document, an application is whatever is using libev.
		4904
		4905	=item backend
		4906
		4907	The part of the code dealing with the operating system interfaces.
4879		4908
4880	=item callback	4909	=item callback
4881		4910
4882	The address of a function that is called when some event has been	4911	The address of a function that is called when some event has been
4883	detected. Callbacks are being passed the event loop, the watcher that	4912	detected. Callbacks are being passed the event loop, the watcher that
4884	received the event, and the actual event bitset.	4913	received the event, and the actual event bitset.
4885		4914
4886	=item callback invocation	4915	=item callback/watcher invocation
4887		4916
4888	The act of calling the callback associated with a watcher.	4917	The act of calling the callback associated with a watcher.
4889		4918
4890	=item event	4919	=item event
4891		4920
…		…
4910	The model used to describe how an event loop handles and processes	4939	The model used to describe how an event loop handles and processes
4911	watchers and events.	4940	watchers and events.
4912		4941
4913	=item pending	4942	=item pending
4914		4943
4915	A watcher is pending as soon as the corresponding event has been detected,	4944	A watcher is pending as soon as the corresponding event has been
4916	and stops being pending as soon as the watcher will be invoked or its	4945	detected. See L<WATCHER STATES> for details.
4917	pending status is explicitly cleared by the application.
4918
4919	A watcher can be pending, but not active. Stopping a watcher also clears
4920	its pending status.
4921		4946
4922	=item real time	4947	=item real time
4923		4948
4924	The physical time that is observed. It is apparently strictly monotonic :)	4949	The physical time that is observed. It is apparently strictly monotonic :)
4925		4950
…		…
4932	=item watcher	4957	=item watcher
4933		4958
4934	A data structure that describes interest in certain events. Watchers need	4959	A data structure that describes interest in certain events. Watchers need
4935	to be started (attached to an event loop) before they can receive events.	4960	to be started (attached to an event loop) before they can receive events.
4936		4961
4937	=item watcher invocation
4938
4939	The act of calling the callback associated with a watcher.
4940
4941	=back	4962	=back
4942		4963
4943	=head1 AUTHOR	4964	=head1 AUTHOR
4944		4965
4945	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.	4966	Marc Lehmann <libev@schmorp.de>, with repeated corrections by Mikael Magnusson.

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.311 by root, Thu Oct 21 14:40:07 2010 UTC vs. Revision 1.322 by root, Sun Oct 24 17:58:41 2010 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.311 by root, Thu Oct 21 14:40:07 2010 UTC vs.
Revision 1.322 by root, Sun Oct 24 17:58:41 2010 UTC