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

Comparing libev/ev.pod (file contents):
Revision 1.8 by root, Mon Nov 12 08:20:02 2007 UTC vs.
Revision 1.31 by root, Fri Nov 23 05:00:45 2007 UTC

…		…
39	F<README.embed> in the libev distribution. If libev was configured without	39	F<README.embed> in the libev distribution. If libev was configured without
40	support for multiple event loops, then all functions taking an initial	40	support for multiple event loops, then all functions taking an initial
41	argument of name C<loop> (which is always of type C<struct ev_loop *>)	41	argument of name C<loop> (which is always of type C<struct ev_loop *>)
42	will not have this argument.	42	will not have this argument.
43		43
44	=head1 TIME AND OTHER GLOBAL FUNCTIONS	44	=head1 TIME REPRESENTATION
45		45
46	Libev represents time as a single floating point number, representing the	46	Libev represents time as a single floating point number, representing the
47	(fractional) number of seconds since the (POSIX) epoch (somewhere near	47	(fractional) number of seconds since the (POSIX) epoch (somewhere near
48	the beginning of 1970, details are complicated, don't ask). This type is	48	the beginning of 1970, details are complicated, don't ask). This type is
49	called C<ev_tstamp>, which is what you should use too. It usually aliases	49	called C<ev_tstamp>, which is what you should use too. It usually aliases
50	to the double type in C.	50	to the double type in C.
51		51
		52	=head1 GLOBAL FUNCTIONS
		53
		54	These functions can be called anytime, even before initialising the
		55	library in any way.
		56
52	=over 4	57	=over 4
53		58
54	=item ev_tstamp ev_time ()	59	=item ev_tstamp ev_time ()
55		60
56	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.
57		64
58	=item int ev_version_major ()	65	=item int ev_version_major ()
59		66
60	=item int ev_version_minor ()	67	=item int ev_version_minor ()
61		68
…		…
63	you linked against by calling the functions C<ev_version_major> and	70	you linked against by calling the functions C<ev_version_major> and
64	C<ev_version_minor>. If you want, you can compare against the global	71	C<ev_version_minor>. If you want, you can compare against the global
65	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the	72	symbols C<EV_VERSION_MAJOR> and C<EV_VERSION_MINOR>, which specify the
66	version of the library your program was compiled against.	73	version of the library your program was compiled against.
67		74
68	Usually, its a good idea to terminate if the major versions mismatch,	75	Usually, it's a good idea to terminate if the major versions mismatch,
69	as this indicates an incompatible change. Minor versions are usually	76	as this indicates an incompatible change. Minor versions are usually
70	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
71	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.
72		95
73	=item ev_set_allocator (void (cb)(void *ptr, long size))	96	=item ev_set_allocator (void (cb)(void *ptr, long size))
74		97
75	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
76	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
…		…
99	An event loop is described by a C<struct ev_loop *>. The library knows two	122	An event loop is described by a C<struct ev_loop *>. The library knows two
100	types of such loops, the I<default> loop, which supports signals and child	123	types of such loops, the I<default> loop, which supports signals and child
101	events, and dynamically created loops which do not.	124	events, and dynamically created loops which do not.
102		125
103	If you use threads, a common model is to run the default event loop	126	If you use threads, a common model is to run the default event loop
104	in your main thread (or in a separate thrad) and for each thread you	127	in your main thread (or in a separate thread) and for each thread you
105	create, you also create another event loop. Libev itself does no locking	128	create, you also create another event loop. Libev itself does no locking
106	whatsoever, so if you mix calls to the same event loop in different	129	whatsoever, so if you mix calls to the same event loop in different
107	threads, make sure you lock (this is usually a bad idea, though, even if	130	threads, make sure you lock (this is usually a bad idea, though, even if
108	done correctly, because its hideous and inefficient).	131	done correctly, because it's hideous and inefficient).
109		132
110	=over 4	133	=over 4
111		134
112	=item struct ev_loop *ev_default_loop (unsigned int flags)	135	=item struct ev_loop *ev_default_loop (unsigned int flags)
113		136
114	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
115	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
116	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
117	flags).	140	flags. If that is troubling you, check C<ev_backend ()> afterwards).
118		141
119	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
120	function.	143	function.
121		144
122	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
123	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).
124		147
125	It supports the following flags:	148	It supports the following flags:
126		149
127	=over 4	150	=over 4
128		151
129	=item EVFLAG_AUTO	152	=item C<EVFLAG_AUTO>
130		153
131	The default flags value. Use this if you have no clue (its the right	154	The default flags value. Use this if you have no clue (it's the right
132	thing, believe me).	155	thing, believe me).
133		156
134	=item EVFLAG_NOENV	157	=item C<EVFLAG_NOENV>
135		158
136	If this flag bit is ored into the flag value (or the program runs setuid	159	If this flag bit is ored into the flag value (or the program runs setuid
137	or setgid) then libev will I<not> look at the environment variable	160	or setgid) then libev will I<not> look at the environment variable
138	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will	161	C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
139	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
140	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
141	around bugs.	164	around bugs.
142		165
143	=item EVMETHOD_SELECT portable select backend	166	=item C<EVBACKEND_SELECT> (value 1, portable select backend)
144		167
145	=item EVMETHOD_POLL poll backend (everywhere except windows)	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.
146		173
147	=item EVMETHOD_EPOLL linux only	174	=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
148		175
149	=item EVMETHOD_KQUEUE some bsds 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).
150		180
151	=item EVMETHOD_DEVPOLL solaris 8 only	181	=item C<EVBACKEND_EPOLL> (value 4, Linux)
152		182
153	=item EVMETHOD_PORT solaris 10 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).
		187
		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
154		224
155	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
156	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
157	specified, any backend will do.	227	specified, most compiled-in backend will be tried, usually in reverse
158		228	order of their flag values :)
159	=back
160		229
161	=item struct ev_loop *ev_loop_new (unsigned int flags)	230	=item struct ev_loop *ev_loop_new (unsigned int flags)
162		231
163	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
164	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
…		…
167		236
168	=item ev_default_destroy ()	237	=item ev_default_destroy ()
169		238
170	Destroys the default loop again (frees all memory and kernel state	239	Destroys the default loop again (frees all memory and kernel state
171	etc.). This stops all registered event watchers (by not touching them in	240	etc.). This stops all registered event watchers (by not touching them in
172	any way whatsoever, although you cnanot rely on this :).	241	any way whatsoever, although you cannot rely on this :).
173		242
174	=item ev_loop_destroy (loop)	243	=item ev_loop_destroy (loop)
175		244
176	Like C<ev_default_destroy>, but destroys an event loop created by an	245	Like C<ev_default_destroy>, but destroys an event loop created by an
177	earlier call to C<ev_loop_new>.	246	earlier call to C<ev_loop_new>.
…		…
181	This function reinitialises the kernel state for backends that have	250	This function reinitialises the kernel state for backends that have
182	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
183	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
184	again makes little sense).	253	again makes little sense).
185		254
186	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
187	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
188	have to call it.	257	fork+exec, you don't have to call it.
189		258
190	The function itself is quite fast and its usually not a problem to call	259	The function itself is quite fast and it's usually not a problem to call
191	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
192	quite nicely into a call to C<pthread_atfork>:	261	quite nicely into a call to C<pthread_atfork>:
193		262
194	pthread_atfork (0, 0, ev_default_fork);	263	pthread_atfork (0, 0, ev_default_fork);
		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.
195		268
196	=item ev_loop_fork (loop)	269	=item ev_loop_fork (loop)
197		270
198	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
199	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
200	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.
201		274
202	=item unsigned int ev_method (loop)	275	=item unsigned int ev_backend (loop)
203		276
204	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
205	use.	278	use.
206		279
207	=item ev_tstamp = ev_now (loop)	280	=item ev_tstamp ev_now (loop)
208		281
209	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
210	got events and started processing them. This timestamp does not change	283	got events and started processing them. This timestamp does not change
211	as long as callbacks are being processed, and this is also the base time	284	as long as callbacks are being processed, and this is also the base time
212	used for relative timers. You can treat it as the timestamp of the event	285	used for relative timers. You can treat it as the timestamp of the event
…		…
221	If the flags argument is specified as 0, it will not return until either	294	If the flags argument is specified as 0, it will not return until either
222	no event watchers are active anymore or C<ev_unloop> was called.	295	no event watchers are active anymore or C<ev_unloop> was called.
223		296
224	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	297	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
225	those events and any outstanding ones, but will not block your process in	298	those events and any outstanding ones, but will not block your process in
226	case there are no events.	299	case there are no events and will return after one iteration of the loop.
227		300
228	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	301	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
229	neccessary) and will handle those and any outstanding ones. It will block	302	neccessary) and will handle those and any outstanding ones. It will block
230	your process until at least one new event arrives.	303	your process until at least one new event arrives, and will return after
		304	one iteration of the loop.
231		305
232	This flags value could be used to implement alternative looping	306	This flags value could be used to implement alternative looping
233	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
234	more generic mechanism.	308	more generic mechanism.
235		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
236	=item ev_unloop (loop, how)	328	=item ev_unloop (loop, how)
237		329
238	Can be used to make a call to C<ev_loop> return early. The C<how> argument	330	Can be used to make a call to C<ev_loop> return early (but only after it
		331	has processed all outstanding events). The C<how> argument must be either
239	must be either C<EVUNLOOP_ONCE>, which will make the innermost C<ev_loop>	332	C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
240	call return, or C<EVUNLOOP_ALL>, which will make all nested C<ev_loop>	333	C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
241	calls return.
242		334
243	=item ev_ref (loop)	335	=item ev_ref (loop)
244		336
245	=item ev_unref (loop)	337	=item ev_unref (loop)
246		338
247	Ref/unref can be used to add or remove a refcount on the event loop: Every	339	Ref/unref can be used to add or remove a reference count on the event
248	watcher keeps one reference. If you have a long-runing watcher you never	340	loop: Every watcher keeps one reference, and as long as the reference
249	unregister that should not keep ev_loop from running, ev_unref() after	341	count is nonzero, C<ev_loop> will not return on its own. If you have
250	starting, and ev_ref() before stopping it. Libev itself uses this for	342	a watcher you never unregister that should not keep C<ev_loop> from
251	example for its internal signal pipe: It is not visible to you as a user	343	returning, ev_unref() after starting, and ev_ref() before stopping it. For
252	and should not keep C<ev_loop> from exiting if the work is done. It is	344	example, libev itself uses this for its internal signal pipe: It is not
253	also an excellent way to do this for generic recurring timers or from	345	visible to the libev user and should not keep C<ev_loop> from exiting if
254	within third-party libraries. Just remember to unref after start and ref	346	no event watchers registered by it are active. It is also an excellent
255	before stop.	347	way to do this for generic recurring timers or from within third-party
		348	libraries. Just remember to I<unref after start> and I<ref before stop>.
256		349
257	=back	350	=back
258		351
259	=head1 ANATOMY OF A WATCHER	352	=head1 ANATOMY OF A WATCHER
260		353
261	A watcher is a structure that you create and register to record your	354	A watcher is a structure that you create and register to record your
262	interest in some event. For instance, if you want to wait for STDIN to	355	interest in some event. For instance, if you want to wait for STDIN to
263	become readable, you would create an ev_io watcher for that:	356	become readable, you would create an C<ev_io> watcher for that:
264		357
265	static void my_cb (struct ev_loop loop, struct ev_io w, int revents)	358	static void my_cb (struct ev_loop loop, struct ev_io w, int revents)
266	{	359	{
267	ev_io_stop (w);	360	ev_io_stop (w);
268	ev_unloop (loop, EVUNLOOP_ALL);	361	ev_unloop (loop, EVUNLOOP_ALL);
…		…
295	*) >>), 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
296	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	389	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.
297		390
298	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
299	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
300	reinitialise it or call its set method.	393	reinitialise it or call its set macro.
301		394
302	You cna 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
303	(watcher *)> macro. To see whether an event is outstanding (but the	396	(watcher *)> macro. To see whether an event is outstanding (but the
304	callback for it has not been called yet) you cna use the C<ev_is_pending	397	callback for it has not been called yet) you can use the C<ev_is_pending
305	(watcher *)> macro.	398	(watcher *)> macro.
306		399
307	Each and every callback receives the event loop pointer as first, the	400	Each and every callback receives the event loop pointer as first, the
308	registered watcher structure as second, and a bitset of received events as	401	registered watcher structure as second, and a bitset of received events as
309	third argument.	402	third argument.
310		403
311	The rceeived events usually include a single bit per event type received	404	The received events usually include a single bit per event type received
312	(you can receive multiple events at the same time). The possible bit masks	405	(you can receive multiple events at the same time). The possible bit masks
313	are:	406	are:
314		407
315	=over 4	408	=over 4
316		409
317	=item EV_READ	410	=item C<EV_READ>
318		411
319	=item EV_WRITE	412	=item C<EV_WRITE>
320		413
321	The file descriptor in the ev_io watcher has become readable and/or	414	The file descriptor in the C<ev_io> watcher has become readable and/or
322	writable.	415	writable.
323		416
324	=item EV_TIMEOUT	417	=item C<EV_TIMEOUT>
325		418
326	The ev_timer watcher has timed out.	419	The C<ev_timer> watcher has timed out.
327		420
328	=item EV_PERIODIC	421	=item C<EV_PERIODIC>
329		422
330	The ev_periodic watcher has timed out.	423	The C<ev_periodic> watcher has timed out.
331		424
332	=item EV_SIGNAL	425	=item C<EV_SIGNAL>
333		426
334	The signal specified in the ev_signal watcher has been received by a thread.	427	The signal specified in the C<ev_signal> watcher has been received by a thread.
335		428
336	=item EV_CHILD	429	=item C<EV_CHILD>
337		430
338	The pid specified in the ev_child watcher has received a status change.	431	The pid specified in the C<ev_child> watcher has received a status change.
339		432
340	=item EV_IDLE	433	=item C<EV_IDLE>
341		434
342	The ev_idle watcher has determined that you have nothing better to do.	435	The C<ev_idle> watcher has determined that you have nothing better to do.
343		436
344	=item EV_PREPARE	437	=item C<EV_PREPARE>
345		438
346	=item EV_CHECK	439	=item C<EV_CHECK>
347		440
348	All ev_prepare watchers are invoked just I<before> C<ev_loop> starts	441	All C<ev_prepare> watchers are invoked just I<before> C<ev_loop> starts
349	to gather new events, and all ev_check watchers are invoked just after	442	to gather new events, and all C<ev_check> watchers are invoked just after
350	C<ev_loop> has gathered them, but before it invokes any callbacks for any	443	C<ev_loop> has gathered them, but before it invokes any callbacks for any
351	received events. Callbacks of both watcher types can start and stop as	444	received events. Callbacks of both watcher types can start and stop as
352	many watchers as they want, and all of them will be taken into account	445	many watchers as they want, and all of them will be taken into account
353	(for example, a ev_prepare watcher might start an idle watcher to keep	446	(for example, a C<ev_prepare> watcher might start an idle watcher to keep
354	C<ev_loop> from blocking).	447	C<ev_loop> from blocking).
355		448
356	=item EV_ERROR	449	=item C<EV_ERROR>
357		450
358	An unspecified error has occured, the watcher has been stopped. This might	451	An unspecified error has occured, the watcher has been stopped. This might
359	happen because the watcher could not be properly started because libev	452	happen because the watcher could not be properly started because libev
360	ran out of memory, a file descriptor was found to be closed or any other	453	ran out of memory, a file descriptor was found to be closed or any other
361	problem. You best act on it by reporting the problem and somehow coping	454	problem. You best act on it by reporting the problem and somehow coping
…		…
370	=back	463	=back
371		464
372	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	465	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
373		466
374	Each watcher has, by default, a member C<void *data> that you can change	467	Each watcher has, by default, a member C<void *data> that you can change
375	and read at any time, libev will completely ignore it. This cna be used	468	and read at any time, libev will completely ignore it. This can be used
376	to associate arbitrary data with your watcher. If you need more data and	469	to associate arbitrary data with your watcher. If you need more data and
377	don't want to allocate memory and store a pointer to it in that data	470	don't want to allocate memory and store a pointer to it in that data
378	member, you can also "subclass" the watcher type and provide your own	471	member, you can also "subclass" the watcher type and provide your own
379	data:	472	data:
380		473
…		…
402	=head1 WATCHER TYPES	495	=head1 WATCHER TYPES
403		496
404	This section describes each watcher in detail, but will not repeat	497	This section describes each watcher in detail, but will not repeat
405	information given in the last section.	498	information given in the last section.
406		499
407	=head2 struct ev_io - is my file descriptor readable or writable	500	=head2 C<ev_io> - is this file descriptor readable or writable
408		501
409	I/O watchers check whether a file descriptor is readable or writable	502	I/O watchers check whether a file descriptor is readable or writable
410	in each iteration of the event loop (This behaviour is called	503	in each iteration of the event loop (This behaviour is called
411	level-triggering because you keep receiving events as long as the	504	level-triggering because you keep receiving events as long as the
412	condition persists. Remember you cna stop the watcher if you don't want to	505	condition persists. Remember you can stop the watcher if you don't want to
413	act on the event and neither want to receive future events).	506	act on the event and neither want to receive future events).
414		507
415	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
416	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
417	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
418	required if you know what you are doing).	511	required if you know what you are doing).
419		512
420	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
421	(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
422	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
423	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").
424		518
425	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
426	(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
427	EVMETHOD_POLL).	521	C<EVBACKEND_POLL>).
428		522
429	=over 4	523	=over 4
430		524
431	=item ev_io_init (ev_io *, callback, int fd, int events)	525	=item ev_io_init (ev_io *, callback, int fd, int events)
432		526
433	=item ev_io_set (ev_io *, int fd, int events)	527	=item ev_io_set (ev_io *, int fd, int events)
434		528
435	Configures an ev_io watcher. The fd is the file descriptor to rceeive	529	Configures an C<ev_io> watcher. The fd is the file descriptor to rceeive
436	events for and events is either C<EV_READ>, C<EV_WRITE> or C<EV_READ \|	530	events for and events is either C<EV_READ>, C<EV_WRITE> or C<EV_READ \|
437	EV_WRITE> to receive the given events.	531	EV_WRITE> to receive the given events.
438		532
439	=back	533	=back
440		534
441	=head2 struct ev_timer - relative and optionally recurring timeouts	535	=head2 C<ev_timer> - relative and optionally recurring timeouts
442		536
443	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
444	given time, and optionally repeating in regular intervals after that.	538	given time, and optionally repeating in regular intervals after that.
445		539
446	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
447	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
448	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
449	detecting time jumps is hard, and soem inaccuracies are unavoidable (the	543	detecting time jumps is hard, and some inaccuracies are unavoidable (the
450	monotonic clock option helps a lot here).	544	monotonic clock option helps a lot here).
		545
		546	The relative timeouts are calculated relative to the C<ev_now ()>
		547	time. This is usually the right thing as this timestamp refers to the time
		548	of the event triggering whatever timeout you are modifying/starting. If
		549	you suspect event processing to be delayed and you I<need> to base the timeout
		550	on the current time, use something like this to adjust for this:
		551
		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.
451		557
452	=over 4	558	=over 4
453		559
454	=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)
455		561
…		…
461	later, again, and again, until stopped manually.	567	later, again, and again, until stopped manually.
462		568
463	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
464	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
465	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
466	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
467	timer will not fire more than once per event loop iteration.	573	timer will not fire more than once per event loop iteration.
468		574
469	=item ev_timer_again (loop)	575	=item ev_timer_again (loop)
470		576
471	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
…		…
478		584
479	This sounds a bit complicated, but here is a useful and typical	585	This sounds a bit complicated, but here is a useful and typical
480	example: Imagine you have a tcp connection and you want a so-called idle	586	example: Imagine you have a tcp connection and you want a so-called idle
481	timeout, that is, you want to be called when there have been, say, 60	587	timeout, that is, you want to be called when there have been, say, 60
482	seconds of inactivity on the socket. The easiest way to do this is to	588	seconds of inactivity on the socket. The easiest way to do this is to
483	configure an ev_timer with after=repeat=60 and calling ev_timer_again each	589	configure an C<ev_timer> with after=repeat=60 and calling ev_timer_again each
484	time you successfully read or write some data. If you go into an idle	590	time you successfully read or write some data. If you go into an idle
485	state where you do not expect data to travel on the socket, you can stop	591	state where you do not expect data to travel on the socket, you can stop
486	the timer, and again will automatically restart it if need be.	592	the timer, and again will automatically restart it if need be.
487		593
488	=back	594	=back
489		595
490	=head2 ev_periodic - to cron or not to cron it	596	=head2 C<ev_periodic> - to cron or not to cron
491		597
492	Periodic watchers are also timers of a kind, but they are very versatile	598	Periodic watchers are also timers of a kind, but they are very versatile
493	(and unfortunately a bit complex).	599	(and unfortunately a bit complex).
494		600
495	Unlike ev_timer's, they are not based on real time (or relative time)	601	Unlike C<ev_timer>'s, they are not based on real time (or relative time)
496	but on wallclock time (absolute time). You can tell a periodic watcher	602	but on wallclock time (absolute time). You can tell a periodic watcher
497	to trigger "at" some specific point in time. For example, if you tell a	603	to trigger "at" some specific point in time. For example, if you tell a
498	periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now ()	604	periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now ()
499	+ 10.>) and then reset your system clock to the last year, then it will	605	+ 10.>) and then reset your system clock to the last year, then it will
500	take a year to trigger the event (unlike an ev_timer, which would trigger	606	take a year to trigger the event (unlike an C<ev_timer>, which would trigger
501	roughly 10 seconds later and of course not if you reset your system time	607	roughly 10 seconds later and of course not if you reset your system time
502	again).	608	again).
503		609
504	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
505	triggering an event on eahc midnight, local time.	611	triggering an event on eahc midnight, local time.
506		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
507	=over 4	617	=over 4
508		618
509	=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)
510		620
511	=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)
512		622
513	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
514	operation, and we will explain them from simplest to complex:	624	operation, and we will explain them from simplest to complex:
515
516		625
517	=over 4	626	=over 4
518		627
519	=item * absolute timer (interval = reschedule_cb = 0)	628	=item * absolute timer (interval = reschedule_cb = 0)
520		629
…		…
534		643
535	ev_periodic_set (&periodic, 0., 3600., 0);	644	ev_periodic_set (&periodic, 0., 3600., 0);
536		645
537	This doesn't mean there will always be 3600 seconds in between triggers,	646	This doesn't mean there will always be 3600 seconds in between triggers,
538	but only that the the callback will be called when the system time shows a	647	but only that the the callback will be called when the system time shows a
539	full hour (UTC), or more correct, when the system time is evenly divisible	648	full hour (UTC), or more correctly, when the system time is evenly divisible
540	by 3600.	649	by 3600.
541		650
542	Another way to think about it (for the mathematically inclined) is that	651	Another way to think about it (for the mathematically inclined) is that
543	ev_periodic will try to run the callback in this mode at the next possible	652	C<ev_periodic> will try to run the callback in this mode at the next possible
544	time where C<time = at (mod interval)>, regardless of any time jumps.	653	time where C<time = at (mod interval)>, regardless of any time jumps.
545		654
546	=item * manual reschedule mode (reschedule_cb = callback)	655	=item * manual reschedule mode (reschedule_cb = callback)
547		656
548	In this mode the values for C<interval> and C<at> are both being	657	In this mode the values for C<interval> and C<at> are both being
549	ignored. Instead, each time the periodic watcher gets scheduled, the	658	ignored. Instead, each time the periodic watcher gets scheduled, the
550	reschedule callback will be called with the watcher as first, and the	659	reschedule callback will be called with the watcher as first, and the
551	current time as second argument.	660	current time as second argument.
552		661
553	NOTE: I<This callback MUST NOT stop or destroy the periodic or any other	662	NOTE: I<This callback MUST NOT stop or destroy any periodic watcher,
554	periodic watcher, ever, or make any event loop modificstions>. If you need	663	ever, or make any event loop modifications>. If you need to stop it,
555	to stop it, return 1e30 (or so, fudge fudge) and stop it afterwards.	664	return C<now + 1e30> (or so, fudge fudge) and stop it afterwards (e.g. by
		665	starting a prepare watcher).
556		666
557	Its prototype is c<ev_tstamp (reschedule_cb)(struct ev_periodic w,	667	Its prototype is C<ev_tstamp (reschedule_cb)(struct ev_periodic w,
558	ev_tstamp now)>, e.g.:	668	ev_tstamp now)>, e.g.:
559		669
560	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)	670	static ev_tstamp my_rescheduler (struct ev_periodic *w, ev_tstamp now)
561	{	671	{
562	return now + 60.;	672	return now + 60.;
…		…
565	It must return the next time to trigger, based on the passed time value	675	It must return the next time to trigger, based on the passed time value
566	(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
567	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
568	might be called at other times, too.	678	might be called at other times, too.
569		679
		680	NOTE: I<< This callback must always return a time that is later than the
		681	passed C<now> value >>. Not even C<now> itself will do, it I<must> be larger.
		682
570	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
571	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
572	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
573	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).
574		688
575	=back	689	=back
576		690
577	=item ev_periodic_again (loop, ev_periodic *)	691	=item ev_periodic_again (loop, ev_periodic *)
578		692
…		…
581	a different time than the last time it was called (e.g. in a crond like	695	a different time than the last time it was called (e.g. in a crond like
582	program when the crontabs have changed).	696	program when the crontabs have changed).
583		697
584	=back	698	=back
585		699
586	=head2 ev_signal - signal me when a signal gets signalled	700	=head2 C<ev_signal> - signal me when a signal gets signalled
587		701
588	Signal watchers will trigger an event when the process receives a specific	702	Signal watchers will trigger an event when the process receives a specific
589	signal one or more times. Even though signals are very asynchronous, libev	703	signal one or more times. Even though signals are very asynchronous, libev
590	will try its best to deliver signals synchronously, i.e. as part of the	704	will try it's best to deliver signals synchronously, i.e. as part of the
591	normal event processing, like any other event.	705	normal event processing, like any other event.
592		706
593	You cna configure as many watchers as you like per signal. Only when the	707	You can configure as many watchers as you like per signal. Only when the
594	first watcher gets started will libev actually register a signal watcher	708	first watcher gets started will libev actually register a signal watcher
595	with the kernel (thus it coexists with your own signal handlers as long	709	with the kernel (thus it coexists with your own signal handlers as long
596	as you don't register any with libev). Similarly, when the last signal	710	as you don't register any with libev). Similarly, when the last signal
597	watcher for a signal is stopped libev will reset the signal handler to	711	watcher for a signal is stopped libev will reset the signal handler to
598	SIG_DFL (regardless of what it was set to before).	712	SIG_DFL (regardless of what it was set to before).
…		…
606	Configures the watcher to trigger on the given signal number (usually one	720	Configures the watcher to trigger on the given signal number (usually one
607	of the C<SIGxxx> constants).	721	of the C<SIGxxx> constants).
608		722
609	=back	723	=back
610		724
611	=head2 ev_child - wait for pid status changes	725	=head2 C<ev_child> - wait for pid status changes
612		726
613	Child watchers trigger when your process receives a SIGCHLD in response to	727	Child watchers trigger when your process receives a SIGCHLD in response to
614	some child status changes (most typically when a child of yours dies).	728	some child status changes (most typically when a child of yours dies).
615		729
616	=over 4	730	=over 4
…		…
620	=item ev_child_set (ev_child *, int pid)	734	=item ev_child_set (ev_child *, int pid)
621		735
622	Configures the watcher to wait for status changes of process C<pid> (or	736	Configures the watcher to wait for status changes of process C<pid> (or
623	I<any> process if C<pid> is specified as C<0>). The callback can look	737	I<any> process if C<pid> is specified as C<0>). The callback can look
624	at the C<rstatus> member of the C<ev_child> watcher structure to see	738	at the C<rstatus> member of the C<ev_child> watcher structure to see
625	the status word (use the macros from C<sys/wait.h>). The C<rpid> member	739	the status word (use the macros from C<sys/wait.h> and see your systems
626	contains the pid of the process causing the status change.	740	C<waitpid> documentation). The C<rpid> member contains the pid of the
		741	process causing the status change.
627		742
628	=back	743	=back
629		744
630	=head2 ev_idle - when you've got nothing better to do	745	=head2 C<ev_idle> - when you've got nothing better to do
631		746
632	Idle watchers trigger events when there are no other I/O or timer (or	747	Idle watchers trigger events when there are no other events are pending
633	periodic) events pending. That is, as long as your process is busy	748	(prepare, check and other idle watchers do not count). That is, as long
634	handling sockets or timeouts it will not be called. But when your process	749	as your process is busy handling sockets or timeouts (or even signals,
635	is idle all idle watchers are being called again and again - until	750	imagine) it will not be triggered. But when your process is idle all idle
		751	watchers are being called again and again, once per event loop iteration -
636	stopped, that is, or your process receives more events.	752	until stopped, that is, or your process receives more events and becomes
		753	busy.
637		754
638	The most noteworthy effect is that as long as any idle watchers are	755	The most noteworthy effect is that as long as any idle watchers are
639	active, the process will not block when waiting for new events.	756	active, the process will not block when waiting for new events.
640		757
641	Apart from keeping your process non-blocking (which is a useful	758	Apart from keeping your process non-blocking (which is a useful
…		…
651	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	768	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
652	believe me.	769	believe me.
653		770
654	=back	771	=back
655		772
656	=head2 prepare and check - your hooks into the event loop	773	=head2 C<ev_prepare> and C<ev_check> - customise your event loop
657		774
658	Prepare and check watchers usually (but not always) are used in	775	Prepare and check watchers are usually (but not always) used in tandem:
659	tandom. Prepare watchers get invoked before the process blocks and check	776	prepare watchers get invoked before the process blocks and check watchers
660	watchers afterwards.	777	afterwards.
661		778
662	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
663	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
664	watchers, integrate net-snmp or a coroutine library and lots more.	781	watchers, integrate net-snmp or a coroutine library and lots more.
665		782
666	This is done by examining in each prepare call which file descriptors need	783	This is done by examining in each prepare call which file descriptors need
667	to be watched by the other library, registering ev_io watchers for them	784	to be watched by the other library, registering C<ev_io> watchers for
668	and starting an ev_timer watcher for any timeouts (many libraries provide	785	them and starting an C<ev_timer> watcher for any timeouts (many libraries
669	just this functionality). Then, in the check watcher you check for any	786	provide just this functionality). Then, in the check watcher you check for
670	events that occured (by making your callbacks set soem flags for example)	787	any events that occured (by checking the pending status of all watchers
671	and call back into the library.	788	and stopping them) and call back into the library. The I/O and timer
		789	callbacks will never actually be called (but must be valid nevertheless,
		790	because you never know, you know?).
672		791
673	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
674	coroutines into libev programs, by yielding to other active coroutines	793	coroutines into libev programs, by yielding to other active coroutines
675	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
676	are ready to run.	795	are ready to run (it's actually more complicated: it only runs coroutines
		796	with priority higher than or equal to the event loop and one coroutine
		797	of lower priority, but only once, using idle watchers to keep the event
		798	loop from blocking if lower-priority coroutines are active, thus mapping
		799	low-priority coroutines to idle/background tasks).
677		800
678	=over 4	801	=over 4
679		802
680	=item ev_prepare_init (ev_prepare *, callback)	803	=item ev_prepare_init (ev_prepare *, callback)
681		804
682	=item ev_check_init (ev_check *, callback)	805	=item ev_check_init (ev_check *, callback)
683		806
684	Initialises and configures the prepare or check watcher - they have no	807	Initialises and configures the prepare or check watcher - they have no
685	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	808	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
686	macros, but using them is utterly, utterly pointless.	809	macros, but using them is utterly, utterly and completely pointless.
687		810
688	=back	811	=back
689		812
690	=head1 OTHER FUNCTIONS	813	=head1 OTHER FUNCTIONS
691		814
692	There are some other fucntions of possible interest. Described. Here. Now.	815	There are some other functions of possible interest. Described. Here. Now.
693		816
694	=over 4	817	=over 4
695		818
696	=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)
697		820
698	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
699	callback on whichever event happens first and automatically stop both	822	callback on whichever event happens first and automatically stop both
700	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
701	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
702	more watchers yourself.	825	more watchers yourself.
703		826
704	If C<fd> is less than 0, then no I/O watcher will be started and events is	827	If C<fd> is less than 0, then no I/O watcher will be started and events
705	ignored. Otherwise, an ev_io watcher for the given C<fd> and C<events> set	828	is being ignored. Otherwise, an C<ev_io> watcher for the given C<fd> and
706	will be craeted and started.	829	C<events> set will be craeted and started.
707		830
708	If C<timeout> is less than 0, then no timeout watcher will be	831	If C<timeout> is less than 0, then no timeout watcher will be
709	started. Otherwise an ev_timer watcher with after = C<timeout> (and repeat	832	started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
710	= 0) will be started.	833	repeat = 0) will be started. While C<0> is a valid timeout, it is of
		834	dubious value.
711		835
712	The callback has the type C<void (cb)(int revents, void arg)> and	836	The callback has the type C<void (cb)(int revents, void arg)> and gets
713	gets passed an events set (normally a combination of EV_ERROR, EV_READ,	837	passed an C<revents> set like normal event callbacks (a combination of
714	EV_WRITE or EV_TIMEOUT) and the C<arg> value passed to C<ev_once>:	838	C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg>
		839	value passed to C<ev_once>:
715		840
716	static void stdin_ready (int revents, void *arg)	841	static void stdin_ready (int revents, void *arg)
717	{	842	{
718	if (revents & EV_TIMEOUT)	843	if (revents & EV_TIMEOUT)
719	/* doh, nothing entered */	844	/* doh, nothing entered */;
720	else if (revents & EV_READ)	845	else if (revents & EV_READ)
721	/* stdin might have data for us, joy! */	846	/* stdin might have data for us, joy! */;
722	}	847	}
723		848
724	ev_once (STDIN_FILENO, EV_READm 10., stdin_ready, 0);	849	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
725		850
726	=item ev_feed_event (loop, watcher, int events)	851	=item ev_feed_event (loop, watcher, int events)
727		852
728	Feeds the given event set into the event loop, as if the specified event	853	Feeds the given event set into the event loop, as if the specified event
729	has happened for the specified watcher (which must be a pointer to an	854	had happened for the specified watcher (which must be a pointer to an
730	initialised but not necessarily active event watcher).	855	initialised but not necessarily started event watcher).
731		856
732	=item ev_feed_fd_event (loop, int fd, int revents)	857	=item ev_feed_fd_event (loop, int fd, int revents)
733		858
734	Feed an event on the given fd, as if a file descriptor backend detected it.	859	Feed an event on the given fd, as if a file descriptor backend detected
		860	the given events it.
735		861
736	=item ev_feed_signal_event (loop, int signum)	862	=item ev_feed_signal_event (loop, int signum)
737		863
738	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!).
739		865
740	=back	866	=back
741		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
742	=head1 AUTHOR	899	=head1 AUTHOR
743		900
744	Marc Lehmann <libev@schmorp.de>.	901	Marc Lehmann <libev@schmorp.de>.
745		902

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.8 by root, Mon Nov 12 08:20:02 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.8 by root, Mon Nov 12 08:20:02 2007 UTC vs.
Revision 1.31 by root, Fri Nov 23 05:00:45 2007 UTC