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

Comparing libev/ev.pod (file contents):
Revision 1.32 by root, Fri Nov 23 08:36:35 2007 UTC vs.
Revision 1.45 by root, Mon Nov 26 09:52:09 2007 UTC

…		…
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 C<double> type in C, and when you need to do any calculations on
		51	it, you should treat it as such.
		52
51		53
52	=head1 GLOBAL FUNCTIONS	54	=head1 GLOBAL FUNCTIONS
53		55
54	These functions can be called anytime, even before initialising the	56	These functions can be called anytime, even before initialising the
55	library in any way.	57	library in any way.
…		…
75	Usually, it's a good idea to terminate if the major versions mismatch,	77	Usually, it's a good idea to terminate if the major versions mismatch,
76	as this indicates an incompatible change. Minor versions are usually	78	as this indicates an incompatible change. Minor versions are usually
77	compatible to older versions, so a larger minor version alone is usually	79	compatible to older versions, so a larger minor version alone is usually
78	not a problem.	80	not a problem.
79		81
		82	Example: make sure we haven't accidentally been linked against the wrong
		83	version:
		84
		85	assert (("libev version mismatch",
		86	ev_version_major () == EV_VERSION_MAJOR
		87	&& ev_version_minor () >= EV_VERSION_MINOR));
		88
80	=item unsigned int ev_supported_backends ()	89	=item unsigned int ev_supported_backends ()
81		90
82	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>	91	Return the set of all backends (i.e. their corresponding C<EV_BACKEND_*>
83	value) compiled into this binary of libev (independent of their	92	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	93	availability on the system you are running on). See C<ev_default_loop> for
85	a description of the set values.	94	a description of the set values.
		95
		96	Example: make sure we have the epoll method, because yeah this is cool and
		97	a must have and can we have a torrent of it please!!!11
		98
		99	assert (("sorry, no epoll, no sex",
		100	ev_supported_backends () & EVBACKEND_EPOLL));
86		101
87	=item unsigned int ev_recommended_backends ()	102	=item unsigned int ev_recommended_backends ()
88		103
89	Return the set of all backends compiled into this binary of libev and also	104	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	105	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	106	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	107	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	108	(assuming you know what you are doing). This is the set of backends that
94	C<EVFLAG_AUTO> will probe for.	109	libev will probe for if you specify no backends explicitly.
		110
		111	=item unsigned int ev_embeddable_backends ()
		112
		113	Returns the set of backends that are embeddable in other event loops. This
		114	is the theoretical, all-platform, value. To find which backends
		115	might be supported on the current system, you would need to look at
		116	C<ev_embeddable_backends () & ev_supported_backends ()>, likewise for
		117	recommended ones.
		118
		119	See the description of C<ev_embed> watchers for more info.
95		120
96	=item ev_set_allocator (void (cb)(void *ptr, long size))	121	=item ev_set_allocator (void (cb)(void *ptr, long size))
97		122
98	Sets the allocation function to use (the prototype is similar to the	123	Sets the allocation function to use (the prototype is similar to the
99	realloc C function, the semantics are identical). It is used to allocate	124	realloc C function, the semantics are identical). It is used to allocate
…		…
102	destructive action. The default is your system realloc function.	127	destructive action. The default is your system realloc function.
103		128
104	You could override this function in high-availability programs to, say,	129	You could override this function in high-availability programs to, say,
105	free some memory if it cannot allocate memory, to use a special allocator,	130	free some memory if it cannot allocate memory, to use a special allocator,
106	or even to sleep a while and retry until some memory is available.	131	or even to sleep a while and retry until some memory is available.
		132
		133	Example: replace the libev allocator with one that waits a bit and then
		134	retries: better than mine).
		135
		136	static void *
		137	persistent_realloc (void *ptr, long size)
		138	{
		139	for (;;)
		140	{
		141	void *newptr = realloc (ptr, size);
		142
		143	if (newptr)
		144	return newptr;
		145
		146	sleep (60);
		147	}
		148	}
		149
		150	...
		151	ev_set_allocator (persistent_realloc);
107		152
108	=item ev_set_syserr_cb (void (cb)(const char msg));	153	=item ev_set_syserr_cb (void (cb)(const char msg));
109		154
110	Set the callback function to call on a retryable syscall error (such	155	Set the callback function to call on a retryable syscall error (such
111	as failed select, poll, epoll_wait). The message is a printable string	156	as failed select, poll, epoll_wait). The message is a printable string
…		…
113	callback is set, then libev will expect it to remedy the sitution, no	158	callback is set, then libev will expect it to remedy the sitution, no
114	matter what, when it returns. That is, libev will generally retry the	159	matter what, when it returns. That is, libev will generally retry the
115	requested operation, or, if the condition doesn't go away, do bad stuff	160	requested operation, or, if the condition doesn't go away, do bad stuff
116	(such as abort).	161	(such as abort).
117		162
		163	Example: do the same thing as libev does internally:
		164
		165	static void
		166	fatal_error (const char *msg)
		167	{
		168	perror (msg);
		169	abort ();
		170	}
		171
		172	...
		173	ev_set_syserr_cb (fatal_error);
		174
118	=back	175	=back
119		176
120	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP	177	=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
121		178
122	An event loop is described by a C<struct ev_loop *>. The library knows two	179	An event loop is described by a C<struct ev_loop *>. The library knows two
…		…
141		198
142	If you don't know what event loop to use, use the one returned from this	199	If you don't know what event loop to use, use the one returned from this
143	function.	200	function.
144		201
145	The flags argument can be used to specify special behaviour or specific	202	The flags argument can be used to specify special behaviour or specific
146	backends to use, and is usually specified as C<0> (or EVFLAG_AUTO).	203	backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
147		204
148	It supports the following flags:	205	The following flags are supported:
149		206
150	=over 4	207	=over 4
151		208
152	=item C<EVFLAG_AUTO>	209	=item C<EVFLAG_AUTO>
153		210
…		…
198	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	255	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
199		256
200	Kqueue deserves special mention, as at the time of this writing, it	257	Kqueue deserves special mention, as at the time of this writing, it
201	was broken on all BSDs except NetBSD (usually it doesn't work with	258	was broken on all BSDs except NetBSD (usually it doesn't work with
202	anything but sockets and pipes, except on Darwin, where of course its	259	anything but sockets and pipes, except on Darwin, where of course its
203	completely useless). For this reason its not being "autodetected" unless	260	completely useless). For this reason its not being "autodetected"
204	you explicitly specify the flags (i.e. you don't use EVFLAG_AUTO).	261	unless you explicitly specify it explicitly in the flags (i.e. using
		262	C<EVBACKEND_KQUEUE>).
205		263
206	It scales in the same way as the epoll backend, but the interface to the	264	It scales in the same way as the epoll backend, but the interface to the
207	kernel is more efficient (which says nothing about its actual speed, of	265	kernel is more efficient (which says nothing about its actual speed, of
208	course). While starting and stopping an I/O watcher does not cause an	266	course). While starting and stopping an I/O watcher does not cause an
209	extra syscall as with epoll, it still adds up to four event changes per	267	extra syscall as with epoll, it still adds up to four event changes per
…		…
233	If one or more of these are ored into the flags value, then only these	291	If one or more of these are ored into the flags value, then only these
234	backends will be tried (in the reverse order as given here). If none are	292	backends will be tried (in the reverse order as given here). If none are
235	specified, most compiled-in backend will be tried, usually in reverse	293	specified, most compiled-in backend will be tried, usually in reverse
236	order of their flag values :)	294	order of their flag values :)
237		295
		296	The most typical usage is like this:
		297
		298	if (!ev_default_loop (0))
		299	fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
		300
		301	Restrict libev to the select and poll backends, and do not allow
		302	environment settings to be taken into account:
		303
		304	ev_default_loop (EVBACKEND_POLL \| EVBACKEND_SELECT \| EVFLAG_NOENV);
		305
		306	Use whatever libev has to offer, but make sure that kqueue is used if
		307	available (warning, breaks stuff, best use only with your own private
		308	event loop and only if you know the OS supports your types of fds):
		309
		310	ev_default_loop (ev_recommended_backends () \| EVBACKEND_KQUEUE);
		311
238	=item struct ev_loop *ev_loop_new (unsigned int flags)	312	=item struct ev_loop *ev_loop_new (unsigned int flags)
239		313
240	Similar to C<ev_default_loop>, but always creates a new event loop that is	314	Similar to C<ev_default_loop>, but always creates a new event loop that is
241	always distinct from the default loop. Unlike the default loop, it cannot	315	always distinct from the default loop. Unlike the default loop, it cannot
242	handle signal and child watchers, and attempts to do so will be greeted by	316	handle signal and child watchers, and attempts to do so will be greeted by
243	undefined behaviour (or a failed assertion if assertions are enabled).	317	undefined behaviour (or a failed assertion if assertions are enabled).
244		318
		319	Example: try to create a event loop that uses epoll and nothing else.
		320
		321	struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL \| EVFLAG_NOENV);
		322	if (!epoller)
		323	fatal ("no epoll found here, maybe it hides under your chair");
		324
245	=item ev_default_destroy ()	325	=item ev_default_destroy ()
246		326
247	Destroys the default loop again (frees all memory and kernel state	327	Destroys the default loop again (frees all memory and kernel state
248	etc.). This stops all registered event watchers (by not touching them in	328	etc.). None of the active event watchers will be stopped in the normal
249	any way whatsoever, although you cannot rely on this :).	329	sense, so e.g. C<ev_is_active> might still return true. It is your
		330	responsibility to either stop all watchers cleanly yoursef I<before>
		331	calling this function, or cope with the fact afterwards (which is usually
		332	the easiest thing, youc na just ignore the watchers and/or C<free ()> them
		333	for example).
250		334
251	=item ev_loop_destroy (loop)	335	=item ev_loop_destroy (loop)
252		336
253	Like C<ev_default_destroy>, but destroys an event loop created by an	337	Like C<ev_default_destroy>, but destroys an event loop created by an
254	earlier call to C<ev_loop_new>.	338	earlier call to C<ev_loop_new>.
…		…
286	use.	370	use.
287		371
288	=item ev_tstamp ev_now (loop)	372	=item ev_tstamp ev_now (loop)
289		373
290	Returns the current "event loop time", which is the time the event loop	374	Returns the current "event loop time", which is the time the event loop
291	got events and started processing them. This timestamp does not change	375	received events and started processing them. This timestamp does not
292	as long as callbacks are being processed, and this is also the base time	376	change as long as callbacks are being processed, and this is also the base
293	used for relative timers. You can treat it as the timestamp of the event	377	time used for relative timers. You can treat it as the timestamp of the
294	occuring (or more correctly, the mainloop finding out about it).	378	event occuring (or more correctly, libev finding out about it).
295		379
296	=item ev_loop (loop, int flags)	380	=item ev_loop (loop, int flags)
297		381
298	Finally, this is it, the event handler. This function usually is called	382	Finally, this is it, the event handler. This function usually is called
299	after you initialised all your watchers and you want to start handling	383	after you initialised all your watchers and you want to start handling
300	events.	384	events.
301		385
302	If the flags argument is specified as 0, it will not return until either	386	If the flags argument is specified as C<0>, it will not return until
303	no event watchers are active anymore or C<ev_unloop> was called.	387	either no event watchers are active anymore or C<ev_unloop> was called.
		388
		389	Please note that an explicit C<ev_unloop> is usually better than
		390	relying on all watchers to be stopped when deciding when a program has
		391	finished (especially in interactive programs), but having a program that
		392	automatically loops as long as it has to and no longer by virtue of
		393	relying on its watchers stopping correctly is a thing of beauty.
304		394
305	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	395	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
306	those events and any outstanding ones, but will not block your process in	396	those events and any outstanding ones, but will not block your process in
307	case there are no events and will return after one iteration of the loop.	397	case there are no events and will return after one iteration of the loop.
308		398
309	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	399	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
310	neccessary) and will handle those and any outstanding ones. It will block	400	neccessary) and will handle those and any outstanding ones. It will block
311	your process until at least one new event arrives, and will return after	401	your process until at least one new event arrives, and will return after
312	one iteration of the loop.	402	one iteration of the loop. This is useful if you are waiting for some
		403	external event in conjunction with something not expressible using other
		404	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
		405	usually a better approach for this kind of thing.
313		406
314	This flags value could be used to implement alternative looping
315	constructs, but the C<prepare> and C<check> watchers provide a better and
316	more generic mechanism.
317
318	Here are the gory details of what ev_loop does:	407	Here are the gory details of what C<ev_loop> does:
319		408
320	1. If there are no active watchers (reference count is zero), return.	409	* If there are no active watchers (reference count is zero), return.
321	2. Queue and immediately call all prepare watchers.	410	- Queue prepare watchers and then call all outstanding watchers.
322	3. If we have been forked, recreate the kernel state.	411	- If we have been forked, recreate the kernel state.
323	4. Update the kernel state with all outstanding changes.	412	- Update the kernel state with all outstanding changes.
324	5. Update the "event loop time".	413	- Update the "event loop time".
325	6. Calculate for how long to block.	414	- Calculate for how long to block.
326	7. Block the process, waiting for events.	415	- Block the process, waiting for any events.
		416	- Queue all outstanding I/O (fd) events.
327	8. Update the "event loop time" and do time jump handling.	417	- Update the "event loop time" and do time jump handling.
328	9. Queue all outstanding timers.	418	- Queue all outstanding timers.
329	10. Queue all outstanding periodics.	419	- Queue all outstanding periodics.
330	11. If no events are pending now, queue all idle watchers.	420	- If no events are pending now, queue all idle watchers.
331	12. Queue all check watchers.	421	- Queue all check watchers.
332	13. Call all queued watchers in reverse order (i.e. check watchers first).	422	- Call all queued watchers in reverse order (i.e. check watchers first).
		423	Signals and child watchers are implemented as I/O watchers, and will
		424	be handled here by queueing them when their watcher gets executed.
333	14. If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	425	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
334	was used, return, otherwise continue with step #1.	426	were used, return, otherwise continue with step *.
		427
		428	Example: queue some jobs and then loop until no events are outsanding
		429	anymore.
		430
		431	... queue jobs here, make sure they register event watchers as long
		432	... as they still have work to do (even an idle watcher will do..)
		433	ev_loop (my_loop, 0);
		434	... jobs done. yeah!
335		435
336	=item ev_unloop (loop, how)	436	=item ev_unloop (loop, how)
337		437
338	Can be used to make a call to C<ev_loop> return early (but only after it	438	Can be used to make a call to C<ev_loop> return early (but only after it
339	has processed all outstanding events). The C<how> argument must be either	439	has processed all outstanding events). The C<how> argument must be either
…		…
353	visible to the libev user and should not keep C<ev_loop> from exiting if	453	visible to the libev user and should not keep C<ev_loop> from exiting if
354	no event watchers registered by it are active. It is also an excellent	454	no event watchers registered by it are active. It is also an excellent
355	way to do this for generic recurring timers or from within third-party	455	way to do this for generic recurring timers or from within third-party
356	libraries. Just remember to I<unref after start> and I<ref before stop>.	456	libraries. Just remember to I<unref after start> and I<ref before stop>.
357		457
		458	Example: create a signal watcher, but keep it from keeping C<ev_loop>
		459	running when nothing else is active.
		460
		461	struct dv_signal exitsig;
		462	ev_signal_init (&exitsig, sig_cb, SIGINT);
		463	ev_signal_start (myloop, &exitsig);
		464	evf_unref (myloop);
		465
		466	Example: for some weird reason, unregister the above signal handler again.
		467
		468	ev_ref (myloop);
		469	ev_signal_stop (myloop, &exitsig);
		470
358	=back	471	=back
		472
359		473
360	=head1 ANATOMY OF A WATCHER	474	=head1 ANATOMY OF A WATCHER
361		475
362	A watcher is a structure that you create and register to record your	476	A watcher is a structure that you create and register to record your
363	interest in some event. For instance, if you want to wait for STDIN to	477	interest in some event. For instance, if you want to wait for STDIN to
…		…
396	*) >>), and you can stop watching for events at any time by calling the	510	*) >>), and you can stop watching for events at any time by calling the
397	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.	511	corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>.
398		512
399	As long as your watcher is active (has been started but not stopped) you	513	As long as your watcher is active (has been started but not stopped) you
400	must not touch the values stored in it. Most specifically you must never	514	must not touch the values stored in it. Most specifically you must never
401	reinitialise it or call its set macro.	515	reinitialise it or call its C<set> macro.
402
403	You can check whether an event is active by calling the C<ev_is_active
404	(watcher *)> macro. To see whether an event is outstanding (but the
405	callback for it has not been called yet) you can use the C<ev_is_pending
406	(watcher *)> macro.
407		516
408	Each and every callback receives the event loop pointer as first, the	517	Each and every callback receives the event loop pointer as first, the
409	registered watcher structure as second, and a bitset of received events as	518	registered watcher structure as second, and a bitset of received events as
410	third argument.	519	third argument.
411		520
…		…
468	with the error from read() or write(). This will not work in multithreaded	577	with the error from read() or write(). This will not work in multithreaded
469	programs, though, so beware.	578	programs, though, so beware.
470		579
471	=back	580	=back
472		581
		582	=head2 GENERIC WATCHER FUNCTIONS
		583
		584	In the following description, C<TYPE> stands for the watcher type,
		585	e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.
		586
		587	=over 4
		588
		589	=item C<ev_init> (ev_TYPE *watcher, callback)
		590
		591	This macro initialises the generic portion of a watcher. The contents
		592	of the watcher object can be arbitrary (so C<malloc> will do). Only
		593	the generic parts of the watcher are initialised, you I<need> to call
		594	the type-specific C<ev_TYPE_set> macro afterwards to initialise the
		595	type-specific parts. For each type there is also a C<ev_TYPE_init> macro
		596	which rolls both calls into one.
		597
		598	You can reinitialise a watcher at any time as long as it has been stopped
		599	(or never started) and there are no pending events outstanding.
		600
		601	The callback is always of type C<void ()(ev_loop loop, ev_TYPE *watcher,
		602	int revents)>.
		603
		604	=item C<ev_TYPE_set> (ev_TYPE *, [args])
		605
		606	This macro initialises the type-specific parts of a watcher. You need to
		607	call C<ev_init> at least once before you call this macro, but you can
		608	call C<ev_TYPE_set> any number of times. You must not, however, call this
		609	macro on a watcher that is active (it can be pending, however, which is a
		610	difference to the C<ev_init> macro).
		611
		612	Although some watcher types do not have type-specific arguments
		613	(e.g. C<ev_prepare>) you still need to call its C<set> macro.
		614
		615	=item C<ev_TYPE_init> (ev_TYPE *watcher, callback, [args])
		616
		617	This convinience macro rolls both C<ev_init> and C<ev_TYPE_set> macro
		618	calls into a single call. This is the most convinient method to initialise
		619	a watcher. The same limitations apply, of course.
		620
		621	=item C<ev_TYPE_start> (loop , ev_TYPE watcher)
		622
		623	Starts (activates) the given watcher. Only active watchers will receive
		624	events. If the watcher is already active nothing will happen.
		625
		626	=item C<ev_TYPE_stop> (loop , ev_TYPE watcher)
		627
		628	Stops the given watcher again (if active) and clears the pending
		629	status. It is possible that stopped watchers are pending (for example,
		630	non-repeating timers are being stopped when they become pending), but
		631	C<ev_TYPE_stop> ensures that the watcher is neither active nor pending. If
		632	you want to free or reuse the memory used by the watcher it is therefore a
		633	good idea to always call its C<ev_TYPE_stop> function.
		634
		635	=item bool ev_is_active (ev_TYPE *watcher)
		636
		637	Returns a true value iff the watcher is active (i.e. it has been started
		638	and not yet been stopped). As long as a watcher is active you must not modify
		639	it.
		640
		641	=item bool ev_is_pending (ev_TYPE *watcher)
		642
		643	Returns a true value iff the watcher is pending, (i.e. it has outstanding
		644	events but its callback has not yet been invoked). As long as a watcher
		645	is pending (but not active) you must not call an init function on it (but
		646	C<ev_TYPE_set> is safe) and you must make sure the watcher is available to
		647	libev (e.g. you cnanot C<free ()> it).
		648
		649	=item callback = ev_cb (ev_TYPE *watcher)
		650
		651	Returns the callback currently set on the watcher.
		652
		653	=item ev_cb_set (ev_TYPE *watcher, callback)
		654
		655	Change the callback. You can change the callback at virtually any time
		656	(modulo threads).
		657
		658	=back
		659
		660
473	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER	661	=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
474		662
475	Each watcher has, by default, a member C<void *data> that you can change	663	Each watcher has, by default, a member C<void *data> that you can change
476	and read at any time, libev will completely ignore it. This can be used	664	and read at any time, libev will completely ignore it. This can be used
477	to associate arbitrary data with your watcher. If you need more data and	665	to associate arbitrary data with your watcher. If you need more data and
…		…
503	=head1 WATCHER TYPES	691	=head1 WATCHER TYPES
504		692
505	This section describes each watcher in detail, but will not repeat	693	This section describes each watcher in detail, but will not repeat
506	information given in the last section.	694	information given in the last section.
507		695
		696
508	=head2 C<ev_io> - is this file descriptor readable or writable	697	=head2 C<ev_io> - is this file descriptor readable or writable?
509		698
510	I/O watchers check whether a file descriptor is readable or writable	699	I/O watchers check whether a file descriptor is readable or writable
511	in each iteration of the event loop (This behaviour is called	700	in each iteration of the event loop, or, more precisely, when reading
512	level-triggering because you keep receiving events as long as the	701	would not block the process and writing would at least be able to write
513	condition persists. Remember you can stop the watcher if you don't want to	702	some data. This behaviour is called level-triggering because you keep
514	act on the event and neither want to receive future events).	703	receiving events as long as the condition persists. Remember you can stop
		704	the watcher if you don't want to act on the event and neither want to
		705	receive future events.
515		706
516	In general you can register as many read and/or write event watchers per	707	In general you can register as many read and/or write event watchers per
517	fd as you want (as long as you don't confuse yourself). Setting all file	708	fd as you want (as long as you don't confuse yourself). Setting all file
518	descriptors to non-blocking mode is also usually a good idea (but not	709	descriptors to non-blocking mode is also usually a good idea (but not
519	required if you know what you are doing).	710	required if you know what you are doing).
520		711
521	You have to be careful with dup'ed file descriptors, though. Some backends	712	You have to be careful with dup'ed file descriptors, though. Some backends
522	(the linux epoll backend is a notable example) cannot handle dup'ed file	713	(the linux epoll backend is a notable example) cannot handle dup'ed file
523	descriptors correctly if you register interest in two or more fds pointing	714	descriptors correctly if you register interest in two or more fds pointing
524	to the same underlying file/socket etc. description (that is, they share	715	to the same underlying file/socket/etc. description (that is, they share
525	the same underlying "file open").	716	the same underlying "file open").
526		717
527	If you must do this, then force the use of a known-to-be-good backend	718	If you must do this, then force the use of a known-to-be-good backend
528	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and	719	(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
529	C<EVBACKEND_POLL>).	720	C<EVBACKEND_POLL>).
530		721
		722	Another thing you have to watch out for is that it is quite easy to
		723	receive "spurious" readyness notifications, that is your callback might
		724	be called with C<EV_READ> but a subsequent C<read>(2) will actually block
		725	because there is no data. Not only are some backends known to create a
		726	lot of those (for example solaris ports), it is very easy to get into
		727	this situation even with a relatively standard program structure. Thus
		728	it is best to always use non-blocking I/O: An extra C<read>(2) returning
		729	C<EAGAIN> is far preferable to a program hanging until some data arrives.
		730
		731	If you cannot run the fd in non-blocking mode (for example you should not
		732	play around with an Xlib connection), then you have to seperately re-test
		733	wether a file descriptor is really ready with a known-to-be good interface
		734	such as poll (fortunately in our Xlib example, Xlib already does this on
		735	its own, so its quite safe to use).
		736
531	=over 4	737	=over 4
532		738
533	=item ev_io_init (ev_io *, callback, int fd, int events)	739	=item ev_io_init (ev_io *, callback, int fd, int events)
534		740
535	=item ev_io_set (ev_io *, int fd, int events)	741	=item ev_io_set (ev_io *, int fd, int events)
536		742
537	Configures an C<ev_io> watcher. The fd is the file descriptor to rceeive	743	Configures an C<ev_io> watcher. The C<fd> is the file descriptor to
538	events for and events is either C<EV_READ>, C<EV_WRITE> or C<EV_READ \|	744	rceeive events for and events is either C<EV_READ>, C<EV_WRITE> or
539	EV_WRITE> to receive the given events.	745	C<EV_READ \| EV_WRITE> to receive the given events.
540
541	Please note that most of the more scalable backend mechanisms (for example
542	epoll and solaris ports) can result in spurious readyness notifications
543	for file descriptors, so you practically need to use non-blocking I/O (and
544	treat callback invocation as hint only), or retest separately with a safe
545	interface before doing I/O (XLib can do this), or force the use of either
546	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>, which don't suffer from this
547	problem. Also note that it is quite easy to have your callback invoked
548	when the readyness condition is no longer valid even when employing
549	typical ways of handling events, so its a good idea to use non-blocking
550	I/O unconditionally.
551		746
552	=back	747	=back
553		748
		749	Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well
		750	readable, but only once. Since it is likely line-buffered, you could
		751	attempt to read a whole line in the callback:
		752
		753	static void
		754	stdin_readable_cb (struct ev_loop loop, struct ev_io w, int revents)
		755	{
		756	ev_io_stop (loop, w);
		757	.. read from stdin here (or from w->fd) and haqndle any I/O errors
		758	}
		759
		760	...
		761	struct ev_loop *loop = ev_default_init (0);
		762	struct ev_io stdin_readable;
		763	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
		764	ev_io_start (loop, &stdin_readable);
		765	ev_loop (loop, 0);
		766
		767
554	=head2 C<ev_timer> - relative and optionally recurring timeouts	768	=head2 C<ev_timer> - relative and optionally repeating timeouts
555		769
556	Timer watchers are simple relative timers that generate an event after a	770	Timer watchers are simple relative timers that generate an event after a
557	given time, and optionally repeating in regular intervals after that.	771	given time, and optionally repeating in regular intervals after that.
558		772
559	The timers are based on real time, that is, if you register an event that	773	The timers are based on real time, that is, if you register an event that
…		…
610	state where you do not expect data to travel on the socket, you can stop	824	state where you do not expect data to travel on the socket, you can stop
611	the timer, and again will automatically restart it if need be.	825	the timer, and again will automatically restart it if need be.
612		826
613	=back	827	=back
614		828
		829	Example: create a timer that fires after 60 seconds.
		830
		831	static void
		832	one_minute_cb (struct ev_loop loop, struct ev_timer w, int revents)
		833	{
		834	.. one minute over, w is actually stopped right here
		835	}
		836
		837	struct ev_timer mytimer;
		838	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
		839	ev_timer_start (loop, &mytimer);
		840
		841	Example: create a timeout timer that times out after 10 seconds of
		842	inactivity.
		843
		844	static void
		845	timeout_cb (struct ev_loop loop, struct ev_timer w, int revents)
		846	{
		847	.. ten seconds without any activity
		848	}
		849
		850	struct ev_timer mytimer;
		851	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
		852	ev_timer_again (&mytimer); /* start timer */
		853	ev_loop (loop, 0);
		854
		855	// and in some piece of code that gets executed on any "activity":
		856	// reset the timeout to start ticking again at 10 seconds
		857	ev_timer_again (&mytimer);
		858
		859
615	=head2 C<ev_periodic> - to cron or not to cron	860	=head2 C<ev_periodic> - to cron or not to cron?
616		861
617	Periodic watchers are also timers of a kind, but they are very versatile	862	Periodic watchers are also timers of a kind, but they are very versatile
618	(and unfortunately a bit complex).	863	(and unfortunately a bit complex).
619		864
620	Unlike C<ev_timer>'s, they are not based on real time (or relative time)	865	Unlike C<ev_timer>'s, they are not based on real time (or relative time)
621	but on wallclock time (absolute time). You can tell a periodic watcher	866	but on wallclock time (absolute time). You can tell a periodic watcher
622	to trigger "at" some specific point in time. For example, if you tell a	867	to trigger "at" some specific point in time. For example, if you tell a
623	periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now ()	868	periodic watcher to trigger in 10 seconds (by specifiying e.g. C<ev_now ()
624	+ 10.>) and then reset your system clock to the last year, then it will	869	+ 10.>) and then reset your system clock to the last year, then it will
625	take a year to trigger the event (unlike an C<ev_timer>, which would trigger	870	take a year to trigger the event (unlike an C<ev_timer>, which would trigger
626	roughly 10 seconds later and of course not if you reset your system time	871	roughly 10 seconds later and of course not if you reset your system time
627	again).	872	again).
628		873
…		…
714	a different time than the last time it was called (e.g. in a crond like	959	a different time than the last time it was called (e.g. in a crond like
715	program when the crontabs have changed).	960	program when the crontabs have changed).
716		961
717	=back	962	=back
718		963
		964	Example: call a callback every hour, or, more precisely, whenever the
		965	system clock is divisible by 3600. The callback invocation times have
		966	potentially a lot of jittering, but good long-term stability.
		967
		968	static void
		969	clock_cb (struct ev_loop loop, struct ev_io w, int revents)
		970	{
		971	... its now a full hour (UTC, or TAI or whatever your clock follows)
		972	}
		973
		974	struct ev_periodic hourly_tick;
		975	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
		976	ev_periodic_start (loop, &hourly_tick);
		977
		978	Example: the same as above, but use a reschedule callback to do it:
		979
		980	#include <math.h>
		981
		982	static ev_tstamp
		983	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
		984	{
		985	return fmod (now, 3600.) + 3600.;
		986	}
		987
		988	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
		989
		990	Example: call a callback every hour, starting now:
		991
		992	struct ev_periodic hourly_tick;
		993	ev_periodic_init (&hourly_tick, clock_cb,
		994	fmod (ev_now (loop), 3600.), 3600., 0);
		995	ev_periodic_start (loop, &hourly_tick);
		996
		997
719	=head2 C<ev_signal> - signal me when a signal gets signalled	998	=head2 C<ev_signal> - signal me when a signal gets signalled!
720		999
721	Signal watchers will trigger an event when the process receives a specific	1000	Signal watchers will trigger an event when the process receives a specific
722	signal one or more times. Even though signals are very asynchronous, libev	1001	signal one or more times. Even though signals are very asynchronous, libev
723	will try it's best to deliver signals synchronously, i.e. as part of the	1002	will try it's best to deliver signals synchronously, i.e. as part of the
724	normal event processing, like any other event.	1003	normal event processing, like any other event.
…		…
739	Configures the watcher to trigger on the given signal number (usually one	1018	Configures the watcher to trigger on the given signal number (usually one
740	of the C<SIGxxx> constants).	1019	of the C<SIGxxx> constants).
741		1020
742	=back	1021	=back
743		1022
		1023
744	=head2 C<ev_child> - wait for pid status changes	1024	=head2 C<ev_child> - watch out for process status changes
745		1025
746	Child watchers trigger when your process receives a SIGCHLD in response to	1026	Child watchers trigger when your process receives a SIGCHLD in response to
747	some child status changes (most typically when a child of yours dies).	1027	some child status changes (most typically when a child of yours dies).
748		1028
749	=over 4	1029	=over 4
…		…
759	C<waitpid> documentation). The C<rpid> member contains the pid of the	1039	C<waitpid> documentation). The C<rpid> member contains the pid of the
760	process causing the status change.	1040	process causing the status change.
761		1041
762	=back	1042	=back
763		1043
		1044	Example: try to exit cleanly on SIGINT and SIGTERM.
		1045
		1046	static void
		1047	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)
		1048	{
		1049	ev_unloop (loop, EVUNLOOP_ALL);
		1050	}
		1051
		1052	struct ev_signal signal_watcher;
		1053	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
		1054	ev_signal_start (loop, &sigint_cb);
		1055
		1056
764	=head2 C<ev_idle> - when you've got nothing better to do	1057	=head2 C<ev_idle> - when you've got nothing better to do...
765		1058
766	Idle watchers trigger events when there are no other events are pending	1059	Idle watchers trigger events when there are no other events are pending
767	(prepare, check and other idle watchers do not count). That is, as long	1060	(prepare, check and other idle watchers do not count). That is, as long
768	as your process is busy handling sockets or timeouts (or even signals,	1061	as your process is busy handling sockets or timeouts (or even signals,
769	imagine) it will not be triggered. But when your process is idle all idle	1062	imagine) it will not be triggered. But when your process is idle all idle
…		…
787	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	1080	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
788	believe me.	1081	believe me.
789		1082
790	=back	1083	=back
791		1084
		1085	Example: dynamically allocate an C<ev_idle>, start it, and in the
		1086	callback, free it. Alos, use no error checking, as usual.
		1087
		1088	static void
		1089	idle_cb (struct ev_loop loop, struct ev_idle w, int revents)
		1090	{
		1091	free (w);
		1092	// now do something you wanted to do when the program has
		1093	// no longer asnything immediate to do.
		1094	}
		1095
		1096	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
		1097	ev_idle_init (idle_watcher, idle_cb);
		1098	ev_idle_start (loop, idle_cb);
		1099
		1100
792	=head2 C<ev_prepare> and C<ev_check> - customise your event loop	1101	=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
793		1102
794	Prepare and check watchers are usually (but not always) used in tandem:	1103	Prepare and check watchers are usually (but not always) used in tandem:
795	prepare watchers get invoked before the process blocks and check watchers	1104	prepare watchers get invoked before the process blocks and check watchers
796	afterwards.	1105	afterwards.
797		1106
		1107	You I<must not> call C<ev_loop> or similar functions that enter
		1108	the current event loop from either C<ev_prepare> or C<ev_check>
		1109	watchers. Other loops than the current one are fine, however. The
		1110	rationale behind this is that you do not need to check for recursion in
		1111	those watchers, i.e. the sequence will always be C<ev_prepare>, blocking,
		1112	C<ev_check> so if you have one watcher of each kind they will always be
		1113	called in pairs bracketing the blocking call.
		1114
798	Their main purpose is to integrate other event mechanisms into libev. This	1115	Their main purpose is to integrate other event mechanisms into libev and
799	could be used, for example, to track variable changes, implement your own	1116	their use is somewhat advanced. This could be used, for example, to track
800	watchers, integrate net-snmp or a coroutine library and lots more.	1117	variable changes, implement your own watchers, integrate net-snmp or a
		1118	coroutine library and lots more. They are also occasionally useful if
		1119	you cache some data and want to flush it before blocking (for example,
		1120	in X programs you might want to do an C<XFlush ()> in an C<ev_prepare>
		1121	watcher).
801		1122
802	This is done by examining in each prepare call which file descriptors need	1123	This is done by examining in each prepare call which file descriptors need
803	to be watched by the other library, registering C<ev_io> watchers for	1124	to be watched by the other library, registering C<ev_io> watchers for
804	them and starting an C<ev_timer> watcher for any timeouts (many libraries	1125	them and starting an C<ev_timer> watcher for any timeouts (many libraries
805	provide just this functionality). Then, in the check watcher you check for	1126	provide just this functionality). Then, in the check watcher you check for
…		…
827	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	1148	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
828	macros, but using them is utterly, utterly and completely pointless.	1149	macros, but using them is utterly, utterly and completely pointless.
829		1150
830	=back	1151	=back
831		1152
		1153	Example: To include a library such as adns, you would add IO watchers
		1154	and a timeout watcher in a prepare handler, as required by libadns, and
		1155	in a check watcher, destroy them and call into libadns. What follows is
		1156	pseudo-code only of course:
		1157
		1158	static ev_io iow [nfd];
		1159	static ev_timer tw;
		1160
		1161	static void
		1162	io_cb (ev_loop loop, ev_io w, int revents)
		1163	{
		1164	// set the relevant poll flags
		1165	struct pollfd fd = (struct pollfd )w->data;
		1166	if (revents & EV_READ ) fd->revents \|= fd->events & POLLIN;
		1167	if (revents & EV_WRITE) fd->revents \|= fd->events & POLLOUT;
		1168	}
		1169
		1170	// create io watchers for each fd and a timer before blocking
		1171	static void
		1172	adns_prepare_cb (ev_loop loop, ev_prepare w, int revents)
		1173	{
		1174	int timeout = 3600000;truct pollfd fds [nfd];
		1175	// actual code will need to loop here and realloc etc.
		1176	adns_beforepoll (ads, fds, &nfd, &timeout, timeval_from (ev_time ()));
		1177
		1178	/* the callback is illegal, but won't be called as we stop during check */
		1179	ev_timer_init (&tw, 0, timeout * 1e-3);
		1180	ev_timer_start (loop, &tw);
		1181
		1182	// create on ev_io per pollfd
		1183	for (int i = 0; i < nfd; ++i)
		1184	{
		1185	ev_io_init (iow + i, io_cb, fds [i].fd,
		1186	((fds [i].events & POLLIN ? EV_READ : 0)
		1187	\| (fds [i].events & POLLOUT ? EV_WRITE : 0)));
		1188
		1189	fds [i].revents = 0;
		1190	iow [i].data = fds + i;
		1191	ev_io_start (loop, iow + i);
		1192	}
		1193	}
		1194
		1195	// stop all watchers after blocking
		1196	static void
		1197	adns_check_cb (ev_loop loop, ev_check w, int revents)
		1198	{
		1199	ev_timer_stop (loop, &tw);
		1200
		1201	for (int i = 0; i < nfd; ++i)
		1202	ev_io_stop (loop, iow + i);
		1203
		1204	adns_afterpoll (adns, fds, nfd, timeval_from (ev_now (loop));
		1205	}
		1206
		1207
		1208	=head2 C<ev_embed> - when one backend isn't enough...
		1209
		1210	This is a rather advanced watcher type that lets you embed one event loop
		1211	into another (currently only C<ev_io> events are supported in the embedded
		1212	loop, other types of watchers might be handled in a delayed or incorrect
		1213	fashion and must not be used).
		1214
		1215	There are primarily two reasons you would want that: work around bugs and
		1216	prioritise I/O.
		1217
		1218	As an example for a bug workaround, the kqueue backend might only support
		1219	sockets on some platform, so it is unusable as generic backend, but you
		1220	still want to make use of it because you have many sockets and it scales
		1221	so nicely. In this case, you would create a kqueue-based loop and embed it
		1222	into your default loop (which might use e.g. poll). Overall operation will
		1223	be a bit slower because first libev has to poll and then call kevent, but
		1224	at least you can use both at what they are best.
		1225
		1226	As for prioritising I/O: rarely you have the case where some fds have
		1227	to be watched and handled very quickly (with low latency), and even
		1228	priorities and idle watchers might have too much overhead. In this case
		1229	you would put all the high priority stuff in one loop and all the rest in
		1230	a second one, and embed the second one in the first.
		1231
		1232	As long as the watcher is active, the callback will be invoked every time
		1233	there might be events pending in the embedded loop. The callback must then
		1234	call C<ev_embed_sweep (mainloop, watcher)> to make a single sweep and invoke
		1235	their callbacks (you could also start an idle watcher to give the embedded
		1236	loop strictly lower priority for example). You can also set the callback
		1237	to C<0>, in which case the embed watcher will automatically execute the
		1238	embedded loop sweep.
		1239
		1240	As long as the watcher is started it will automatically handle events. The
		1241	callback will be invoked whenever some events have been handled. You can
		1242	set the callback to C<0> to avoid having to specify one if you are not
		1243	interested in that.
		1244
		1245	Also, there have not currently been made special provisions for forking:
		1246	when you fork, you not only have to call C<ev_loop_fork> on both loops,
		1247	but you will also have to stop and restart any C<ev_embed> watchers
		1248	yourself.
		1249
		1250	Unfortunately, not all backends are embeddable, only the ones returned by
		1251	C<ev_embeddable_backends> are, which, unfortunately, does not include any
		1252	portable one.
		1253
		1254	So when you want to use this feature you will always have to be prepared
		1255	that you cannot get an embeddable loop. The recommended way to get around
		1256	this is to have a separate variables for your embeddable loop, try to
		1257	create it, and if that fails, use the normal loop for everything:
		1258
		1259	struct ev_loop *loop_hi = ev_default_init (0);
		1260	struct ev_loop *loop_lo = 0;
		1261	struct ev_embed embed;
		1262
		1263	// see if there is a chance of getting one that works
		1264	// (remember that a flags value of 0 means autodetection)
		1265	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
		1266	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
		1267	: 0;
		1268
		1269	// if we got one, then embed it, otherwise default to loop_hi
		1270	if (loop_lo)
		1271	{
		1272	ev_embed_init (&embed, 0, loop_lo);
		1273	ev_embed_start (loop_hi, &embed);
		1274	}
		1275	else
		1276	loop_lo = loop_hi;
		1277
		1278	=over 4
		1279
		1280	=item ev_embed_init (ev_embed , callback, struct ev_loop embedded_loop)
		1281
		1282	=item ev_embed_set (ev_embed , callback, struct ev_loop embedded_loop)
		1283
		1284	Configures the watcher to embed the given loop, which must be
		1285	embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
		1286	invoked automatically, otherwise it is the responsibility of the callback
		1287	to invoke it (it will continue to be called until the sweep has been done,
		1288	if you do not want thta, you need to temporarily stop the embed watcher).
		1289
		1290	=item ev_embed_sweep (loop, ev_embed *)
		1291
		1292	Make a single, non-blocking sweep over the embedded loop. This works
		1293	similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
		1294	apropriate way for embedded loops.
		1295
		1296	=back
		1297
		1298
832	=head1 OTHER FUNCTIONS	1299	=head1 OTHER FUNCTIONS
833		1300
834	There are some other functions of possible interest. Described. Here. Now.	1301	There are some other functions of possible interest. Described. Here. Now.
835		1302
836	=over 4	1303	=over 4
…		…
865	/* stdin might have data for us, joy! */;	1332	/* stdin might have data for us, joy! */;
866	}	1333	}
867		1334
868	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);	1335	ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
869		1336
870	=item ev_feed_event (loop, watcher, int events)	1337	=item ev_feed_event (ev_loop , watcher , int revents)
871		1338
872	Feeds the given event set into the event loop, as if the specified event	1339	Feeds the given event set into the event loop, as if the specified event
873	had happened for the specified watcher (which must be a pointer to an	1340	had happened for the specified watcher (which must be a pointer to an
874	initialised but not necessarily started event watcher).	1341	initialised but not necessarily started event watcher).
875		1342
876	=item ev_feed_fd_event (loop, int fd, int revents)	1343	=item ev_feed_fd_event (ev_loop *, int fd, int revents)
877		1344
878	Feed an event on the given fd, as if a file descriptor backend detected	1345	Feed an event on the given fd, as if a file descriptor backend detected
879	the given events it.	1346	the given events it.
880		1347
881	=item ev_feed_signal_event (loop, int signum)	1348	=item ev_feed_signal_event (ev_loop *loop, int signum)
882		1349
883	Feed an event as if the given signal occured (loop must be the default loop!).	1350	Feed an event as if the given signal occured (C<loop> must be the default
		1351	loop!).
884		1352
885	=back	1353	=back
		1354
886		1355
887	=head1 LIBEVENT EMULATION	1356	=head1 LIBEVENT EMULATION
888		1357
889	Libev offers a compatibility emulation layer for libevent. It cannot	1358	Libev offers a compatibility emulation layer for libevent. It cannot
890	emulate the internals of libevent, so here are some usage hints:	1359	emulate the internals of libevent, so here are some usage hints:
…		…
911		1380
912	=back	1381	=back
913		1382
914	=head1 C++ SUPPORT	1383	=head1 C++ SUPPORT
915		1384
916	TBD.	1385	Libev comes with some simplistic wrapper classes for C++ that mainly allow
		1386	you to use some convinience methods to start/stop watchers and also change
		1387	the callback model to a model using method callbacks on objects.
		1388
		1389	To use it,
		1390
		1391	#include <ev++.h>
		1392
		1393	(it is not installed by default). This automatically includes F<ev.h>
		1394	and puts all of its definitions (many of them macros) into the global
		1395	namespace. All C++ specific things are put into the C<ev> namespace.
		1396
		1397	It should support all the same embedding options as F<ev.h>, most notably
		1398	C<EV_MULTIPLICITY>.
		1399
		1400	Here is a list of things available in the C<ev> namespace:
		1401
		1402	=over 4
		1403
		1404	=item C<ev::READ>, C<ev::WRITE> etc.
		1405
		1406	These are just enum values with the same values as the C<EV_READ> etc.
		1407	macros from F<ev.h>.
		1408
		1409	=item C<ev::tstamp>, C<ev::now>
		1410
		1411	Aliases to the same types/functions as with the C<ev_> prefix.
		1412
		1413	=item C<ev::io>, C<ev::timer>, C<ev::periodic>, C<ev::idle>, C<ev::sig> etc.
		1414
		1415	For each C<ev_TYPE> watcher in F<ev.h> there is a corresponding class of
		1416	the same name in the C<ev> namespace, with the exception of C<ev_signal>
		1417	which is called C<ev::sig> to avoid clashes with the C<signal> macro
		1418	defines by many implementations.
		1419
		1420	All of those classes have these methods:
		1421
		1422	=over 4
		1423
		1424	=item ev::TYPE::TYPE (object , object::method )
		1425
		1426	=item ev::TYPE::TYPE (object , object::method , struct ev_loop *)
		1427
		1428	=item ev::TYPE::~TYPE
		1429
		1430	The constructor takes a pointer to an object and a method pointer to
		1431	the event handler callback to call in this class. The constructor calls
		1432	C<ev_init> for you, which means you have to call the C<set> method
		1433	before starting it. If you do not specify a loop then the constructor
		1434	automatically associates the default loop with this watcher.
		1435
		1436	The destructor automatically stops the watcher if it is active.
		1437
		1438	=item w->set (struct ev_loop *)
		1439
		1440	Associates a different C<struct ev_loop> with this watcher. You can only
		1441	do this when the watcher is inactive (and not pending either).
		1442
		1443	=item w->set ([args])
		1444
		1445	Basically the same as C<ev_TYPE_set>, with the same args. Must be
		1446	called at least once. Unlike the C counterpart, an active watcher gets
		1447	automatically stopped and restarted.
		1448
		1449	=item w->start ()
		1450
		1451	Starts the watcher. Note that there is no C<loop> argument as the
		1452	constructor already takes the loop.
		1453
		1454	=item w->stop ()
		1455
		1456	Stops the watcher if it is active. Again, no C<loop> argument.
		1457
		1458	=item w->again () C<ev::timer>, C<ev::periodic> only
		1459
		1460	For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
		1461	C<ev_TYPE_again> function.
		1462
		1463	=item w->sweep () C<ev::embed> only
		1464
		1465	Invokes C<ev_embed_sweep>.
		1466
		1467	=back
		1468
		1469	=back
		1470
		1471	Example: Define a class with an IO and idle watcher, start one of them in
		1472	the constructor.
		1473
		1474	class myclass
		1475	{
		1476	ev_io io; void io_cb (ev::io &w, int revents);
		1477	ev_idle idle void idle_cb (ev::idle &w, int revents);
		1478
		1479	myclass ();
		1480	}
		1481
		1482	myclass::myclass (int fd)
		1483	: io (this, &myclass::io_cb),
		1484	idle (this, &myclass::idle_cb)
		1485	{
		1486	io.start (fd, ev::READ);
		1487	}
		1488
		1489	=head1 EMBEDDING
		1490
		1491	Libev can (and often is) directly embedded into host
		1492	applications. Examples of applications that embed it include the Deliantra
		1493	Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
		1494	and rxvt-unicode.
		1495
		1496	The goal is to enable you to just copy the neecssary files into your
		1497	source directory without having to change even a single line in them, so
		1498	you can easily upgrade by simply copying (or having a checked-out copy of
		1499	libev somewhere in your source tree).
		1500
		1501	=head2 FILESETS
		1502
		1503	Depending on what features you need you need to include one or more sets of files
		1504	in your app.
		1505
		1506	=head3 CORE EVENT LOOP
		1507
		1508	To include only the libev core (all the C<ev_*> functions), with manual
		1509	configuration (no autoconf):
		1510
		1511	#define EV_STANDALONE 1
		1512	#include "ev.c"
		1513
		1514	This will automatically include F<ev.h>, too, and should be done in a
		1515	single C source file only to provide the function implementations. To use
		1516	it, do the same for F<ev.h> in all files wishing to use this API (best
		1517	done by writing a wrapper around F<ev.h> that you can include instead and
		1518	where you can put other configuration options):
		1519
		1520	#define EV_STANDALONE 1
		1521	#include "ev.h"
		1522
		1523	Both header files and implementation files can be compiled with a C++
		1524	compiler (at least, thats a stated goal, and breakage will be treated
		1525	as a bug).
		1526
		1527	You need the following files in your source tree, or in a directory
		1528	in your include path (e.g. in libev/ when using -Ilibev):
		1529
		1530	ev.h
		1531	ev.c
		1532	ev_vars.h
		1533	ev_wrap.h
		1534
		1535	ev_win32.c required on win32 platforms only
		1536
		1537	ev_select.c only when select backend is enabled (which is by default)
		1538	ev_poll.c only when poll backend is enabled (disabled by default)
		1539	ev_epoll.c only when the epoll backend is enabled (disabled by default)
		1540	ev_kqueue.c only when the kqueue backend is enabled (disabled by default)
		1541	ev_port.c only when the solaris port backend is enabled (disabled by default)
		1542
		1543	F<ev.c> includes the backend files directly when enabled, so you only need
		1544	to compile this single file.
		1545
		1546	=head3 LIBEVENT COMPATIBILITY API
		1547
		1548	To include the libevent compatibility API, also include:
		1549
		1550	#include "event.c"
		1551
		1552	in the file including F<ev.c>, and:
		1553
		1554	#include "event.h"
		1555
		1556	in the files that want to use the libevent API. This also includes F<ev.h>.
		1557
		1558	You need the following additional files for this:
		1559
		1560	event.h
		1561	event.c
		1562
		1563	=head3 AUTOCONF SUPPORT
		1564
		1565	Instead of using C<EV_STANDALONE=1> and providing your config in
		1566	whatever way you want, you can also C<m4_include([libev.m4])> in your
		1567	F<configure.ac> and leave C<EV_STANDALONE> undefined. F<ev.c> will then
		1568	include F<config.h> and configure itself accordingly.
		1569
		1570	For this of course you need the m4 file:
		1571
		1572	libev.m4
		1573
		1574	=head2 PREPROCESSOR SYMBOLS/MACROS
		1575
		1576	Libev can be configured via a variety of preprocessor symbols you have to define
		1577	before including any of its files. The default is not to build for multiplicity
		1578	and only include the select backend.
		1579
		1580	=over 4
		1581
		1582	=item EV_STANDALONE
		1583
		1584	Must always be C<1> if you do not use autoconf configuration, which
		1585	keeps libev from including F<config.h>, and it also defines dummy
		1586	implementations for some libevent functions (such as logging, which is not
		1587	supported). It will also not define any of the structs usually found in
		1588	F<event.h> that are not directly supported by the libev core alone.
		1589
		1590	=item EV_USE_MONOTONIC
		1591
		1592	If defined to be C<1>, libev will try to detect the availability of the
		1593	monotonic clock option at both compiletime and runtime. Otherwise no use
		1594	of the monotonic clock option will be attempted. If you enable this, you
		1595	usually have to link against librt or something similar. Enabling it when
		1596	the functionality isn't available is safe, though, althoguh you have
		1597	to make sure you link against any libraries where the C<clock_gettime>
		1598	function is hiding in (often F<-lrt>).
		1599
		1600	=item EV_USE_REALTIME
		1601
		1602	If defined to be C<1>, libev will try to detect the availability of the
		1603	realtime clock option at compiletime (and assume its availability at
		1604	runtime if successful). Otherwise no use of the realtime clock option will
		1605	be attempted. This effectively replaces C<gettimeofday> by C<clock_get
		1606	(CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries
		1607	in the description of C<EV_USE_MONOTONIC>, though.
		1608
		1609	=item EV_USE_SELECT
		1610
		1611	If undefined or defined to be C<1>, libev will compile in support for the
		1612	C<select>(2) backend. No attempt at autodetection will be done: if no
		1613	other method takes over, select will be it. Otherwise the select backend
		1614	will not be compiled in.
		1615
		1616	=item EV_SELECT_USE_FD_SET
		1617
		1618	If defined to C<1>, then the select backend will use the system C<fd_set>
		1619	structure. This is useful if libev doesn't compile due to a missing
		1620	C<NFDBITS> or C<fd_mask> definition or it misguesses the bitset layout on
		1621	exotic systems. This usually limits the range of file descriptors to some
		1622	low limit such as 1024 or might have other limitations (winsocket only
		1623	allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might
		1624	influence the size of the C<fd_set> used.
		1625
		1626	=item EV_SELECT_IS_WINSOCKET
		1627
		1628	When defined to C<1>, the select backend will assume that
		1629	select/socket/connect etc. don't understand file descriptors but
		1630	wants osf handles on win32 (this is the case when the select to
		1631	be used is the winsock select). This means that it will call
		1632	C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
		1633	it is assumed that all these functions actually work on fds, even
		1634	on win32. Should not be defined on non-win32 platforms.
		1635
		1636	=item EV_USE_POLL
		1637
		1638	If defined to be C<1>, libev will compile in support for the C<poll>(2)
		1639	backend. Otherwise it will be enabled on non-win32 platforms. It
		1640	takes precedence over select.
		1641
		1642	=item EV_USE_EPOLL
		1643
		1644	If defined to be C<1>, libev will compile in support for the Linux
		1645	C<epoll>(7) backend. Its availability will be detected at runtime,
		1646	otherwise another method will be used as fallback. This is the
		1647	preferred backend for GNU/Linux systems.
		1648
		1649	=item EV_USE_KQUEUE
		1650
		1651	If defined to be C<1>, libev will compile in support for the BSD style
		1652	C<kqueue>(2) backend. Its actual availability will be detected at runtime,
		1653	otherwise another method will be used as fallback. This is the preferred
		1654	backend for BSD and BSD-like systems, although on most BSDs kqueue only
		1655	supports some types of fds correctly (the only platform we found that
		1656	supports ptys for example was NetBSD), so kqueue might be compiled in, but
		1657	not be used unless explicitly requested. The best way to use it is to find
		1658	out whether kqueue supports your type of fd properly and use an embedded
		1659	kqueue loop.
		1660
		1661	=item EV_USE_PORT
		1662
		1663	If defined to be C<1>, libev will compile in support for the Solaris
		1664	10 port style backend. Its availability will be detected at runtime,
		1665	otherwise another method will be used as fallback. This is the preferred
		1666	backend for Solaris 10 systems.
		1667
		1668	=item EV_USE_DEVPOLL
		1669
		1670	reserved for future expansion, works like the USE symbols above.
		1671
		1672	=item EV_H
		1673
		1674	The name of the F<ev.h> header file used to include it. The default if
		1675	undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This
		1676	can be used to virtually rename the F<ev.h> header file in case of conflicts.
		1677
		1678	=item EV_CONFIG_H
		1679
		1680	If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
		1681	F<ev.c>'s idea of where to find the F<config.h> file, similarly to
		1682	C<EV_H>, above.
		1683
		1684	=item EV_EVENT_H
		1685
		1686	Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
		1687	of how the F<event.h> header can be found.
		1688
		1689	=item EV_PROTOTYPES
		1690
		1691	If defined to be C<0>, then F<ev.h> will not define any function
		1692	prototypes, but still define all the structs and other symbols. This is
		1693	occasionally useful if you want to provide your own wrapper functions
		1694	around libev functions.
		1695
		1696	=item EV_MULTIPLICITY
		1697
		1698	If undefined or defined to C<1>, then all event-loop-specific functions
		1699	will have the C<struct ev_loop *> as first argument, and you can create
		1700	additional independent event loops. Otherwise there will be no support
		1701	for multiple event loops and there is no first event loop pointer
		1702	argument. Instead, all functions act on the single default loop.
		1703
		1704	=item EV_PERIODICS
		1705
		1706	If undefined or defined to be C<1>, then periodic timers are supported,
		1707	otherwise not. This saves a few kb of code.
		1708
		1709	=item EV_COMMON
		1710
		1711	By default, all watchers have a C<void *data> member. By redefining
		1712	this macro to a something else you can include more and other types of
		1713	members. You have to define it each time you include one of the files,
		1714	though, and it must be identical each time.
		1715
		1716	For example, the perl EV module uses something like this:
		1717
		1718	#define EV_COMMON \
		1719	SV self; / contains this struct */ \
		1720	SV cb_sv, fh /* note no trailing ";" */
		1721
		1722	=item EV_CB_DECLARE (type)
		1723
		1724	=item EV_CB_INVOKE (watcher, revents)
		1725
		1726	=item ev_set_cb (ev, cb)
		1727
		1728	Can be used to change the callback member declaration in each watcher,
		1729	and the way callbacks are invoked and set. Must expand to a struct member
		1730	definition and a statement, respectively. See the F<ev.v> header file for
		1731	their default definitions. One possible use for overriding these is to
		1732	avoid the C<struct ev_loop *> as first argument in all cases, or to use
		1733	method calls instead of plain function calls in C++.
		1734
		1735	=head2 EXAMPLES
		1736
		1737	For a real-world example of a program the includes libev
		1738	verbatim, you can have a look at the EV perl module
		1739	(L<http://software.schmorp.de/pkg/EV.html>). It has the libev files in
		1740	the F<libev/> subdirectory and includes them in the F<EV/EVAPI.h> (public
		1741	interface) and F<EV.xs> (implementation) files. Only the F<EV.xs> file
		1742	will be compiled. It is pretty complex because it provides its own header
		1743	file.
		1744
		1745	The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
		1746	that everybody includes and which overrides some autoconf choices:
		1747
		1748	#define EV_USE_POLL 0
		1749	#define EV_MULTIPLICITY 0
		1750	#define EV_PERIODICS 0
		1751	#define EV_CONFIG_H <config.h>
		1752
		1753	#include "ev++.h"
		1754
		1755	And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
		1756
		1757	#include "ev_cpp.h"
		1758	#include "ev.c"
917		1759
918	=head1 AUTHOR	1760	=head1 AUTHOR
919		1761
920	Marc Lehmann <libev@schmorp.de>.	1762	Marc Lehmann <libev@schmorp.de>.
921		1763

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.32 by root, Fri Nov 23 08:36:35 2007 UTC vs. Revision 1.45 by root, Mon Nov 26 09:52:09 2007 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.32 by root, Fri Nov 23 08:36:35 2007 UTC vs.
Revision 1.45 by root, Mon Nov 26 09:52:09 2007 UTC