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

Comparing libev/ev.pod (file contents):
Revision 1.18 by root, Mon Nov 12 09:01:12 2007 UTC vs.
Revision 1.31 by root, Fri Nov 23 05:00:45 2007 UTC

…		…
56		56
57	=over 4	57	=over 4
58		58
59	=item ev_tstamp ev_time ()	59	=item ev_tstamp ev_time ()
60		60
61	Returns the current time as libev would use it.	61	Returns the current time as libev would use it. Please note that the
		62	C<ev_now> function is usually faster and also often returns the timestamp
		63	you actually want to know.
62		64
63	=item int ev_version_major ()	65	=item int ev_version_major ()
64		66
65	=item int ev_version_minor ()	67	=item int ev_version_minor ()
66		68
…		…
72		74
73	Usually, it's a good idea to terminate if the major versions mismatch,	75	Usually, it's a good idea to terminate if the major versions mismatch,
74	as this indicates an incompatible change. Minor versions are usually	76	as this indicates an incompatible change. Minor versions are usually
75	compatible to older versions, so a larger minor version alone is usually	77	compatible to older versions, so a larger minor version alone is usually
76	not a problem.	78	not a problem.
		79
		80	=item unsigned int ev_supported_backends ()
		81
		82	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>
		83	value) compiled into this binary of libev (independent of their
		84	availability on the system you are running on). See C<ev_default_loop> for
		85	a description of the set values.
		86
		87	=item unsigned int ev_recommended_backends ()
		88
		89	Return the set of all backends compiled into this binary of libev and also
		90	recommended for this platform. This set is often smaller than the one
		91	returned by C<ev_supported_backends>, as for example kqueue is broken on
		92	most BSDs and will not be autodetected unless you explicitly request it
		93	(assuming you know what you are doing). This is the set of backends that
		94	C<EVFLAG_AUTO> will probe for.
77		95
78	=item ev_set_allocator (void (cb)(void *ptr, long size))	96	=item ev_set_allocator (void (cb)(void *ptr, long size))
79		97
80	Sets the allocation function to use (the prototype is similar to the	98	Sets the allocation function to use (the prototype is similar to the
81	realloc C function, the semantics are identical). It is used to allocate	99	realloc C function, the semantics are identical). It is used to allocate
…		…
117	=item struct ev_loop *ev_default_loop (unsigned int flags)	135	=item struct ev_loop *ev_default_loop (unsigned int flags)
118		136
119	This will initialise the default event loop if it hasn't been initialised	137	This will initialise the default event loop if it hasn't been initialised
120	yet and return it. If the default loop could not be initialised, returns	138	yet and return it. If the default loop could not be initialised, returns
121	false. If it already was initialised it simply returns it (and ignores the	139	false. If it already was initialised it simply returns it (and ignores the
122	flags).	140	flags. If that is troubling you, check C<ev_backend ()> afterwards).
123		141
124	If you don't know what event loop to use, use the one returned from this	142	If you don't know what event loop to use, use the one returned from this
125	function.	143	function.
126		144
127	The flags argument can be used to specify special behaviour or specific	145	The flags argument can be used to specify special behaviour or specific
128	backends to use, and is usually specified as 0 (or EVFLAG_AUTO).	146	backends to use, and is usually specified as C<0> (or EVFLAG_AUTO).
129		147
130	It supports the following flags:	148	It supports the following flags:
131		149
132	=over 4	150	=over 4
133		151
…		…
143	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	161	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
144	override the flags completely if it is found in the environment. This is	162	override the flags completely if it is found in the environment. This is
145	useful to try out specific backends to test their performance, or to work	163	useful to try out specific backends to test their performance, or to work
146	around bugs.	164	around bugs.
147		165
148	=item C<EVMETHOD_SELECT> (portable select backend)	166	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
149		167
		168	This is your standard select(2) backend. Not I<completely> standard, as
		169	libev tries to roll its own fd_set with no limits on the number of fds,
		170	but if that fails, expect a fairly low limit on the number of fds when
		171	using this backend. It doesn't scale too well (O(highest_fd)), but its usually
		172	the fastest backend for a low number of fds.
		173
150	=item C<EVMETHOD_POLL> (poll backend, available everywhere except on windows)	174	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
151		175
152	=item C<EVMETHOD_EPOLL> (linux only)	176	And this is your standard poll(2) backend. It's more complicated than
		177	select, but handles sparse fds better and has no artificial limit on the
		178	number of fds you can use (except it will slow down considerably with a
		179	lot of inactive fds). It scales similarly to select, i.e. O(total_fds).
153		180
154	=item C<EVMETHOD_KQUEUE> (some bsds only)	181	=item C<EVBACKEND_EPOLL> (value 4, Linux)
155		182
156	=item C<EVMETHOD_DEVPOLL> (solaris 8 only)	183	For few fds, this backend is a bit little slower than poll and select,
		184	but it scales phenomenally better. While poll and select usually scale like
		185	O(total_fds) where n is the total number of fds (or the highest fd), epoll scales
		186	either O(1) or O(active_fds).
157		187
158	=item C<EVMETHOD_PORT> (solaris 10 only)	188	While stopping and starting an I/O watcher in the same iteration will
		189	result in some caching, there is still a syscall per such incident
		190	(because the fd could point to a different file description now), so its
		191	best to avoid that. Also, dup()ed file descriptors might not work very
		192	well if you register events for both fds.
		193
		194	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
		195
		196	Kqueue deserves special mention, as at the time of this writing, it
		197	was broken on all BSDs except NetBSD (usually it doesn't work with
		198	anything but sockets and pipes, except on Darwin, where of course its
		199	completely useless). For this reason its not being "autodetected" unless
		200	you explicitly specify the flags (i.e. you don't use EVFLAG_AUTO).
		201
		202	It scales in the same way as the epoll backend, but the interface to the
		203	kernel is more efficient (which says nothing about its actual speed, of
		204	course). While starting and stopping an I/O watcher does not cause an
		205	extra syscall as with epoll, it still adds up to four event changes per
		206	incident, so its best to avoid that.
		207
		208	=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
		209
		210	This is not implemented yet (and might never be).
		211
		212	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
		213
		214	This uses the Solaris 10 port mechanism. As with everything on Solaris,
		215	it's really slow, but it still scales very well (O(active_fds)).
		216
		217	=item C<EVBACKEND_ALL>
		218
		219	Try all backends (even potentially broken ones that wouldn't be tried
		220	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
		221	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
		222
		223	=back
159		224
160	If one or more of these are ored into the flags value, then only these	225	If one or more of these are ored into the flags value, then only these
161	backends will be tried (in the reverse order as given here). If one are	226	backends will be tried (in the reverse order as given here). If none are
162	specified, any backend will do.	227	specified, most compiled-in backend will be tried, usually in reverse
163		228	order of their flag values :)
164	=back
165		229
166	=item struct ev_loop *ev_loop_new (unsigned int flags)	230	=item struct ev_loop *ev_loop_new (unsigned int flags)
167		231
168	Similar to C<ev_default_loop>, but always creates a new event loop that is	232	Similar to C<ev_default_loop>, but always creates a new event loop that is
169	always distinct from the default loop. Unlike the default loop, it cannot	233	always distinct from the default loop. Unlike the default loop, it cannot
…		…
186	This function reinitialises the kernel state for backends that have	250	This function reinitialises the kernel state for backends that have
187	one. Despite the name, you can call it anytime, but it makes most sense	251	one. Despite the name, you can call it anytime, but it makes most sense
188	after forking, in either the parent or child process (or both, but that	252	after forking, in either the parent or child process (or both, but that
189	again makes little sense).	253	again makes little sense).
190		254
191	You I<must> call this function after forking if and only if you want to	255	You I<must> call this function in the child process after forking if and
192	use the event library in both processes. If you just fork+exec, you don't	256	only if you want to use the event library in both processes. If you just
193	have to call it.	257	fork+exec, you don't have to call it.
194		258
195	The function itself is quite fast and it's usually not a problem to call	259	The function itself is quite fast and it's usually not a problem to call
196	it just in case after a fork. To make this easy, the function will fit in	260	it just in case after a fork. To make this easy, the function will fit in
197	quite nicely into a call to C<pthread_atfork>:	261	quite nicely into a call to C<pthread_atfork>:
198		262
199	pthread_atfork (0, 0, ev_default_fork);	263	pthread_atfork (0, 0, ev_default_fork);
200		264
		265	At the moment, C<EVBACKEND_SELECT> and C<EVBACKEND_POLL> are safe to use
		266	without calling this function, so if you force one of those backends you
		267	do not need to care.
		268
201	=item ev_loop_fork (loop)	269	=item ev_loop_fork (loop)
202		270
203	Like C<ev_default_fork>, but acts on an event loop created by	271	Like C<ev_default_fork>, but acts on an event loop created by
204	C<ev_loop_new>. Yes, you have to call this on every allocated event loop	272	C<ev_loop_new>. Yes, you have to call this on every allocated event loop
205	after fork, and how you do this is entirely your own problem.	273	after fork, and how you do this is entirely your own problem.
206		274
207	=item unsigned int ev_method (loop)	275	=item unsigned int ev_backend (loop)
208		276
209	Returns one of the C<EVMETHOD_*> flags indicating the event backend in	277	Returns one of the C<EVBACKEND_*> flags indicating the event backend in
210	use.	278	use.
211		279
212	=item ev_tstamp ev_now (loop)	280	=item ev_tstamp ev_now (loop)
213		281
214	Returns the current "event loop time", which is the time the event loop	282	Returns the current "event loop time", which is the time the event loop
…		…
237		305
238	This flags value could be used to implement alternative looping	306	This flags value could be used to implement alternative looping
239	constructs, but the C<prepare> and C<check> watchers provide a better and	307	constructs, but the C<prepare> and C<check> watchers provide a better and
240	more generic mechanism.	308	more generic mechanism.
241		309
		310	Here are the gory details of what ev_loop does:
		311
		312	1. If there are no active watchers (reference count is zero), return.
		313	2. Queue and immediately call all prepare watchers.
		314	3. If we have been forked, recreate the kernel state.
		315	4. Update the kernel state with all outstanding changes.
		316	5. Update the "event loop time".
		317	6. Calculate for how long to block.
		318	7. Block the process, waiting for events.
		319	8. Update the "event loop time" and do time jump handling.
		320	9. Queue all outstanding timers.
		321	10. Queue all outstanding periodics.
		322	11. If no events are pending now, queue all idle watchers.
		323	12. Queue all check watchers.
		324	13. Call all queued watchers in reverse order (i.e. check watchers first).
		325	14. If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
		326	was used, return, otherwise continue with step #1.
		327
242	=item ev_unloop (loop, how)	328	=item ev_unloop (loop, how)
243		329
244	Can be used to make a call to C<ev_loop> return early (but only after it	330	Can be used to make a call to C<ev_loop> return early (but only after it
245	has processed all outstanding events). The C<how> argument must be either	331	has processed all outstanding events). The C<how> argument must be either
246	C<EVUNLOOP_ONCE>, which will make the innermost C<ev_loop> call return, or	332	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
247	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.	333	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
248		334
249	=item ev_ref (loop)	335	=item ev_ref (loop)
250		336
251	=item ev_unref (loop)	337	=item ev_unref (loop)
…		…
302	*) >>), and you can stop watching for events at any time by calling the	388	*) >>), and you can stop watching for events at any time by calling the
303	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	389	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.
304		390
305	As long as your watcher is active (has been started but not stopped) you	391	As long as your watcher is active (has been started but not stopped) you
306	must not touch the values stored in it. Most specifically you must never	392	must not touch the values stored in it. Most specifically you must never
307	reinitialise it or call its set method.	393	reinitialise it or call its set macro.
308		394
309	You can check whether an event is active by calling the C<ev_is_active	395	You can check whether an event is active by calling the C<ev_is_active
310	(watcher *)> macro. To see whether an event is outstanding (but the	396	(watcher *)> macro. To see whether an event is outstanding (but the
311	callback for it has not been called yet) you can use the C<ev_is_pending	397	callback for it has not been called yet) you can use the C<ev_is_pending
312	(watcher *)> macro.	398	(watcher *)> macro.
…		…
417	in each iteration of the event loop (This behaviour is called	503	in each iteration of the event loop (This behaviour is called
418	level-triggering because you keep receiving events as long as the	504	level-triggering because you keep receiving events as long as the
419	condition persists. Remember you can stop the watcher if you don't want to	505	condition persists. Remember you can stop the watcher if you don't want to
420	act on the event and neither want to receive future events).	506	act on the event and neither want to receive future events).
421		507
422	In general you can register as many read and/or write event watchers oer	508	In general you can register as many read and/or write event watchers per
423	fd as you want (as long as you don't confuse yourself). Setting all file	509	fd as you want (as long as you don't confuse yourself). Setting all file
424	descriptors to non-blocking mode is also usually a good idea (but not	510	descriptors to non-blocking mode is also usually a good idea (but not
425	required if you know what you are doing).	511	required if you know what you are doing).
426		512
427	You have to be careful with dup'ed file descriptors, though. Some backends	513	You have to be careful with dup'ed file descriptors, though. Some backends
428	(the linux epoll backend is a notable example) cannot handle dup'ed file	514	(the linux epoll backend is a notable example) cannot handle dup'ed file
429	descriptors correctly if you register interest in two or more fds pointing	515	descriptors correctly if you register interest in two or more fds pointing
430	to the same file/socket etc. description.	516	to the same underlying file/socket etc. description (that is, they share
		517	the same underlying "file open").
431		518
432	If you must do this, then force the use of a known-to-be-good backend	519	If you must do this, then force the use of a known-to-be-good backend
433	(at the time of this writing, this includes only EVMETHOD_SELECT and	520	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
434	EVMETHOD_POLL).	521	C<EVBACKEND_POLL>).
435		522
436	=over 4	523	=over 4
437		524
438	=item ev_io_init (ev_io *, callback, int fd, int events)	525	=item ev_io_init (ev_io *, callback, int fd, int events)
439		526
…		…
449		536
450	Timer watchers are simple relative timers that generate an event after a	537	Timer watchers are simple relative timers that generate an event after a
451	given time, and optionally repeating in regular intervals after that.	538	given time, and optionally repeating in regular intervals after that.
452		539
453	The timers are based on real time, that is, if you register an event that	540	The timers are based on real time, that is, if you register an event that
454	times out after an hour and youreset your system clock to last years	541	times out after an hour and you reset your system clock to last years
455	time, it will still time out after (roughly) and hour. "Roughly" because	542	time, it will still time out after (roughly) and hour. "Roughly" because
456	detecting time jumps is hard, and soem inaccuracies are unavoidable (the	543	detecting time jumps is hard, and some inaccuracies are unavoidable (the
457	monotonic clock option helps a lot here).	544	monotonic clock option helps a lot here).
458		545
459	The relative timeouts are calculated relative to the C<ev_now ()>	546	The relative timeouts are calculated relative to the C<ev_now ()>
460	time. This is usually the right thing as this timestamp refers to the time	547	time. This is usually the right thing as this timestamp refers to the time
461	of the event triggering whatever timeout you are modifying/starting. If	548	of the event triggering whatever timeout you are modifying/starting. If
462	you suspect event processing to be delayed and you need to base the timeout	549	you suspect event processing to be delayed and you I<need> to base the timeout
463	ion the current time, use something like this to adjust for this:	550	on the current time, use something like this to adjust for this:
464		551
465	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);	552	ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
		553
		554	The callback is guarenteed to be invoked only when its timeout has passed,
		555	but if multiple timers become ready during the same loop iteration then
		556	order of execution is undefined.
466		557
467	=over 4	558	=over 4
468		559
469	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)	560	=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
470		561
…		…
476	later, again, and again, until stopped manually.	567	later, again, and again, until stopped manually.
477		568
478	The timer itself will do a best-effort at avoiding drift, that is, if you	569	The timer itself will do a best-effort at avoiding drift, that is, if you
479	configure a timer to trigger every 10 seconds, then it will trigger at	570	configure a timer to trigger every 10 seconds, then it will trigger at
480	exactly 10 second intervals. If, however, your program cannot keep up with	571	exactly 10 second intervals. If, however, your program cannot keep up with
481	the timer (ecause it takes longer than those 10 seconds to do stuff) the	572	the timer (because it takes longer than those 10 seconds to do stuff) the
482	timer will not fire more than once per event loop iteration.	573	timer will not fire more than once per event loop iteration.
483		574
484	=item ev_timer_again (loop)	575	=item ev_timer_again (loop)
485		576
486	This will act as if the timer timed out and restart it again if it is	577	This will act as if the timer timed out and restart it again if it is
…		…
517	again).	608	again).
518		609
519	They can also be used to implement vastly more complex timers, such as	610	They can also be used to implement vastly more complex timers, such as
520	triggering an event on eahc midnight, local time.	611	triggering an event on eahc midnight, local time.
521		612
		613	As with timers, the callback is guarenteed to be invoked only when the
		614	time (C<at>) has been passed, but if multiple periodic timers become ready
		615	during the same loop iteration then order of execution is undefined.
		616
522	=over 4	617	=over 4
523		618
524	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)	619	=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
525		620
526	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)	621	=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)
527		622
528	Lots of arguments, lets sort it out... There are basically three modes of	623	Lots of arguments, lets sort it out... There are basically three modes of
529	operation, and we will explain them from simplest to complex:	624	operation, and we will explain them from simplest to complex:
530
531		625
532	=over 4	626	=over 4
533		627
534	=item * absolute timer (interval = reschedule_cb = 0)	628	=item * absolute timer (interval = reschedule_cb = 0)
535		629
…		…
582	(that is, the lowest time value larger than to the second argument). It	676	(that is, the lowest time value larger than to the second argument). It
583	will usually be called just before the callback will be triggered, but	677	will usually be called just before the callback will be triggered, but
584	might be called at other times, too.	678	might be called at other times, too.
585		679
586	NOTE: I<< This callback must always return a time that is later than the	680	NOTE: I<< This callback must always return a time that is later than the
587	passed C<now> value >>. Not even C<now> itself will do, it must be larger.	681	passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger.
588		682
589	This can be used to create very complex timers, such as a timer that	683	This can be used to create very complex timers, such as a timer that
590	triggers on each midnight, local time. To do this, you would calculate the	684	triggers on each midnight, local time. To do this, you would calculate the
591	next midnight after C<now> and return the timestamp value for this. How you do this	685	next midnight after C<now> and return the timestamp value for this. How
592	is, again, up to you (but it is not trivial).	686	you do this is, again, up to you (but it is not trivial, which is the main
		687	reason I omitted it as an example).
593		688
594	=back	689	=back
595		690
596	=item ev_periodic_again (loop, ev_periodic *)	691	=item ev_periodic_again (loop, ev_periodic *)
597		692
…		…
676	=back	771	=back
677		772
678	=head2 C<ev_prepare> and C<ev_check> - customise your event loop	773	=head2 C<ev_prepare> and C<ev_check> - customise your event loop
679		774
680	Prepare and check watchers are usually (but not always) used in tandem:	775	Prepare and check watchers are usually (but not always) used in tandem:
681	Prepare watchers get invoked before the process blocks and check watchers	776	prepare watchers get invoked before the process blocks and check watchers
682	afterwards.	777	afterwards.
683		778
684	Their main purpose is to integrate other event mechanisms into libev. This	779	Their main purpose is to integrate other event mechanisms into libev. This
685	could be used, for example, to track variable changes, implement your own	780	could be used, for example, to track variable changes, implement your own
686	watchers, integrate net-snmp or a coroutine library and lots more.	781	watchers, integrate net-snmp or a coroutine library and lots more.
…		…
689	to be watched by the other library, registering C<ev_io> watchers for	784	to be watched by the other library, registering C<ev_io> watchers for
690	them and starting an C<ev_timer> watcher for any timeouts (many libraries	785	them and starting an C<ev_timer> watcher for any timeouts (many libraries
691	provide just this functionality). Then, in the check watcher you check for	786	provide just this functionality). Then, in the check watcher you check for
692	any events that occured (by checking the pending status of all watchers	787	any events that occured (by checking the pending status of all watchers
693	and stopping them) and call back into the library. The I/O and timer	788	and stopping them) and call back into the library. The I/O and timer
694	callbacks will never actually be called (but must be valid neverthelles,	789	callbacks will never actually be called (but must be valid nevertheless,
695	because you never know, you know?).	790	because you never know, you know?).
696		791
697	As another example, the Perl Coro module uses these hooks to integrate	792	As another example, the Perl Coro module uses these hooks to integrate
698	coroutines into libev programs, by yielding to other active coroutines	793	coroutines into libev programs, by yielding to other active coroutines
699	during each prepare and only letting the process block if no coroutines	794	during each prepare and only letting the process block if no coroutines
700	are ready to run (its actually more complicated, it only runs coroutines	795	are ready to run (it's actually more complicated: it only runs coroutines
701	with priority higher than the event loop and one lower priority once,	796	with priority higher than or equal to the event loop and one coroutine
702	using idle watchers to keep the event loop from blocking if lower-priority	797	of lower priority, but only once, using idle watchers to keep the event
703	coroutines exist, thus mapping low-priority coroutines to idle/background	798	loop from blocking if lower-priority coroutines are active, thus mapping
704	tasks).	799	low-priority coroutines to idle/background tasks).
705		800
706	=over 4	801	=over 4
707		802
708	=item ev_prepare_init (ev_prepare *, callback)	803	=item ev_prepare_init (ev_prepare *, callback)
709		804
…		…
724	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)	819	=item ev_once (loop, int fd, int events, ev_tstamp timeout, callback)
725		820
726	This function combines a simple timer and an I/O watcher, calls your	821	This function combines a simple timer and an I/O watcher, calls your
727	callback on whichever event happens first and automatically stop both	822	callback on whichever event happens first and automatically stop both
728	watchers. This is useful if you want to wait for a single event on an fd	823	watchers. This is useful if you want to wait for a single event on an fd
729	or timeout without havign to allocate/configure/start/stop/free one or	824	or timeout without having to allocate/configure/start/stop/free one or
730	more watchers yourself.	825	more watchers yourself.
731		826
732	If C<fd> is less than 0, then no I/O watcher will be started and events	827	If C<fd> is less than 0, then no I/O watcher will be started and events
733	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and	828	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and
734	C<events> set will be craeted and started.	829	C<events> set will be craeted and started.
…		…
737	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and	832	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
738	repeat = 0) will be started. While C<0> is a valid timeout, it is of	833	repeat = 0) will be started. While C<0> is a valid timeout, it is of
739	dubious value.	834	dubious value.
740		835
741	The callback has the type C<void (cb)(int revents, void arg)> and gets	836	The callback has the type C<void (cb)(int revents, void arg)> and gets
742	passed an events set like normal event callbacks (with a combination of	837	passed an C<revents> set like normal event callbacks (a combination of
743	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>	838	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
744	value passed to C<ev_once>:	839	value passed to C<ev_once>:
745		840
746	static void stdin_ready (int revents, void *arg)	841	static void stdin_ready (int revents, void *arg)
747	{	842	{
…		…
768		863
769	Feed an event as if the given signal occured (loop must be the default loop!).	864	Feed an event as if the given signal occured (loop must be the default loop!).
770		865
771	=back	866	=back
772		867
		868	=head1 LIBEVENT EMULATION
		869
		870	Libev offers a compatibility emulation layer for libevent. It cannot
		871	emulate the internals of libevent, so here are some usage hints:
		872
		873	=over 4
		874
		875	=item * Use it by including <event.h>, as usual.
		876
		877	=item * The following members are fully supported: ev_base, ev_callback,
		878	ev_arg, ev_fd, ev_res, ev_events.
		879
		880	=item * Avoid using ev_flags and the EVLIST_*-macros, while it is
		881	maintained by libev, it does not work exactly the same way as in libevent (consider
		882	it a private API).
		883
		884	=item * Priorities are not currently supported. Initialising priorities
		885	will fail and all watchers will have the same priority, even though there
		886	is an ev_pri field.
		887
		888	=item * Other members are not supported.
		889
		890	=item * The libev emulation is I<not> ABI compatible to libevent, you need
		891	to use the libev header file and library.
		892
		893	=back
		894
		895	=head1 C++ SUPPORT
		896
		897	TBD.
		898
773	=head1 AUTHOR	899	=head1 AUTHOR
774		900
775	Marc Lehmann <libev@schmorp.de>.	901	Marc Lehmann <libev@schmorp.de>.
776		902

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.18 by root, Mon Nov 12 09:01:12 2007 UTC vs. Revision 1.31 by root, Fri Nov 23 05:00:45 2007 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.18 by root, Mon Nov 12 09:01:12 2007 UTC vs.
Revision 1.31 by root, Fri Nov 23 05:00:45 2007 UTC