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

Comparing libev/ev.pod (file contents):
Revision 1.31 by root, Fri Nov 23 05:00:45 2007 UTC vs.
Revision 1.35 by root, Fri Nov 23 19:35: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
…		…
189	result in some caching, there is still a syscall per such incident	246	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	247	(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	248	best to avoid that. Also, dup()ed file descriptors might not work very
192	well if you register events for both fds.	249	well if you register events for both fds.
193		250
		251	Please note that epoll sometimes generates spurious notifications, so you
		252	need to use non-blocking I/O or other means to avoid blocking when no data
		253	(or space) is available.
		254
194	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)	255	=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
195		256
196	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
197	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
198	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
199	completely useless). For this reason its not being "autodetected" unless	260	completely useless). For this reason its not being "autodetected"
200	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>).
201		263
202	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
203	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
204	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
205	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
…		…
212	=item C<EVBACKEND_PORT> (value 32, Solaris 10)	274	=item C<EVBACKEND_PORT> (value 32, Solaris 10)
213		275
214	This uses the Solaris 10 port mechanism. As with everything on Solaris,	276	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)).	277	it's really slow, but it still scales very well (O(active_fds)).
216		278
		279	Please note that solaris ports can result in a lot of spurious
		280	notifications, so you need to use non-blocking I/O or other means to avoid
		281	blocking when no data (or space) is available.
		282
217	=item C<EVBACKEND_ALL>	283	=item C<EVBACKEND_ALL>
218		284
219	Try all backends (even potentially broken ones that wouldn't be tried	285	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	286	with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
221	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.	287	C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
…		…
225	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
226	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
227	specified, most compiled-in backend will be tried, usually in reverse	293	specified, most compiled-in backend will be tried, usually in reverse
228	order of their flag values :)	294	order of their flag values :)
229		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
230	=item struct ev_loop *ev_loop_new (unsigned int flags)	312	=item struct ev_loop *ev_loop_new (unsigned int flags)
231		313
232	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
233	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
234	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
235	undefined behaviour (or a failed assertion if assertions are enabled).	317	undefined behaviour (or a failed assertion if assertions are enabled).
236		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
237	=item ev_default_destroy ()	325	=item ev_default_destroy ()
238		326
239	Destroys the default loop again (frees all memory and kernel state	327	Destroys the default loop again (frees all memory and kernel state
240	etc.). This stops all registered event watchers (by not touching them in	328	etc.). This stops all registered event watchers (by not touching them in
241	any way whatsoever, although you cannot rely on this :).	329	any way whatsoever, although you cannot rely on this :).
…		…
278	use.	366	use.
279		367
280	=item ev_tstamp ev_now (loop)	368	=item ev_tstamp ev_now (loop)
281		369
282	Returns the current "event loop time", which is the time the event loop	370	Returns the current "event loop time", which is the time the event loop
283	got events and started processing them. This timestamp does not change	371	received events and started processing them. This timestamp does not
284	as long as callbacks are being processed, and this is also the base time	372	change as long as callbacks are being processed, and this is also the base
285	used for relative timers. You can treat it as the timestamp of the event	373	time used for relative timers. You can treat it as the timestamp of the
286	occuring (or more correctly, the mainloop finding out about it).	374	event occuring (or more correctly, libev finding out about it).
287		375
288	=item ev_loop (loop, int flags)	376	=item ev_loop (loop, int flags)
289		377
290	Finally, this is it, the event handler. This function usually is called	378	Finally, this is it, the event handler. This function usually is called
291	after you initialised all your watchers and you want to start handling	379	after you initialised all your watchers and you want to start handling
292	events.	380	events.
293		381
294	If the flags argument is specified as 0, it will not return until either	382	If the flags argument is specified as C<0>, it will not return until
295	no event watchers are active anymore or C<ev_unloop> was called.	383	either no event watchers are active anymore or C<ev_unloop> was called.
		384
		385	Please note that an explicit C<ev_unloop> is usually better than
		386	relying on all watchers to be stopped when deciding when a program has
		387	finished (especially in interactive programs), but having a program that
		388	automatically loops as long as it has to and no longer by virtue of
		389	relying on its watchers stopping correctly is a thing of beauty.
296		390
297	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle	391	A flags value of C<EVLOOP_NONBLOCK> will look for new events, will handle
298	those events and any outstanding ones, but will not block your process in	392	those events and any outstanding ones, but will not block your process in
299	case there are no events and will return after one iteration of the loop.	393	case there are no events and will return after one iteration of the loop.
300		394
301	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if	395	A flags value of C<EVLOOP_ONESHOT> will look for new events (waiting if
302	neccessary) and will handle those and any outstanding ones. It will block	396	neccessary) and will handle those and any outstanding ones. It will block
303	your process until at least one new event arrives, and will return after	397	your process until at least one new event arrives, and will return after
304	one iteration of the loop.	398	one iteration of the loop. This is useful if you are waiting for some
		399	external event in conjunction with something not expressible using other
		400	libev watchers. However, a pair of C<ev_prepare>/C<ev_check> watchers is
		401	usually a better approach for this kind of thing.
305		402
306	This flags value could be used to implement alternative looping
307	constructs, but the C<prepare> and C<check> watchers provide a better and
308	more generic mechanism.
309
310	Here are the gory details of what ev_loop does:	403	Here are the gory details of what C<ev_loop> does:
311		404
312	1. If there are no active watchers (reference count is zero), return.	405	* If there are no active watchers (reference count is zero), return.
313	2. Queue and immediately call all prepare watchers.	406	- Queue prepare watchers and then call all outstanding watchers.
314	3. If we have been forked, recreate the kernel state.	407	- If we have been forked, recreate the kernel state.
315	4. Update the kernel state with all outstanding changes.	408	- Update the kernel state with all outstanding changes.
316	5. Update the "event loop time".	409	- Update the "event loop time".
317	6. Calculate for how long to block.	410	- Calculate for how long to block.
318	7. Block the process, waiting for events.	411	- Block the process, waiting for any events.
		412	- Queue all outstanding I/O (fd) events.
319	8. Update the "event loop time" and do time jump handling.	413	- Update the "event loop time" and do time jump handling.
320	9. Queue all outstanding timers.	414	- Queue all outstanding timers.
321	10. Queue all outstanding periodics.	415	- Queue all outstanding periodics.
322	11. If no events are pending now, queue all idle watchers.	416	- If no events are pending now, queue all idle watchers.
323	12. Queue all check watchers.	417	- Queue all check watchers.
324	13. Call all queued watchers in reverse order (i.e. check watchers first).	418	- Call all queued watchers in reverse order (i.e. check watchers first).
		419	Signals and child watchers are implemented as I/O watchers, and will
		420	be handled here by queueing them when their watcher gets executed.
325	14. If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK	421	- If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
326	was used, return, otherwise continue with step #1.	422	were used, return, otherwise continue with step *.
		423
		424	Example: queue some jobs and then loop until no events are outsanding
		425	anymore.
		426
		427	... queue jobs here, make sure they register event watchers as long
		428	... as they still have work to do (even an idle watcher will do..)
		429	ev_loop (my_loop, 0);
		430	... jobs done. yeah!
327		431
328	=item ev_unloop (loop, how)	432	=item ev_unloop (loop, how)
329		433
330	Can be used to make a call to C<ev_loop> return early (but only after it	434	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	435	has processed all outstanding events). The C<how> argument must be either
…		…
345	visible to the libev user and should not keep C<ev_loop> from exiting if	449	visible to the libev user and should not keep C<ev_loop> from exiting if
346	no event watchers registered by it are active. It is also an excellent	450	no event watchers registered by it are active. It is also an excellent
347	way to do this for generic recurring timers or from within third-party	451	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>.	452	libraries. Just remember to I<unref after start> and I<ref before stop>.
349		453
		454	Example: create a signal watcher, but keep it from keeping C<ev_loop>
		455	running when nothing else is active.
		456
		457	struct dv_signal exitsig;
		458	ev_signal_init (&exitsig, sig_cb, SIGINT);
		459	ev_signal_start (myloop, &exitsig);
		460	evf_unref (myloop);
		461
		462	Example: for some weird reason, unregister the above signal handler again.
		463
		464	ev_ref (myloop);
		465	ev_signal_stop (myloop, &exitsig);
		466
350	=back	467	=back
351		468
352	=head1 ANATOMY OF A WATCHER	469	=head1 ANATOMY OF A WATCHER
353		470
354	A watcher is a structure that you create and register to record your	471	A watcher is a structure that you create and register to record your
…		…
495	=head1 WATCHER TYPES	612	=head1 WATCHER TYPES
496		613
497	This section describes each watcher in detail, but will not repeat	614	This section describes each watcher in detail, but will not repeat
498	information given in the last section.	615	information given in the last section.
499		616
		617
500	=head2 C<ev_io> - is this file descriptor readable or writable	618	=head2 C<ev_io> - is this file descriptor readable or writable
501		619
502	I/O watchers check whether a file descriptor is readable or writable	620	I/O watchers check whether a file descriptor is readable or writable
503	in each iteration of the event loop (This behaviour is called	621	in each iteration of the event loop (This behaviour is called
504	level-triggering because you keep receiving events as long as the	622	level-triggering because you keep receiving events as long as the
…		…
528		646
529	Configures an C<ev_io> watcher. The fd is the file descriptor to rceeive	647	Configures an C<ev_io> watcher. The fd is the file descriptor to rceeive
530	events for and events is either C<EV_READ>, C<EV_WRITE> or C<EV_READ \|	648	events for and events is either C<EV_READ>, C<EV_WRITE> or C<EV_READ \|
531	EV_WRITE> to receive the given events.	649	EV_WRITE> to receive the given events.
532		650
		651	Please note that most of the more scalable backend mechanisms (for example
		652	epoll and solaris ports) can result in spurious readyness notifications
		653	for file descriptors, so you practically need to use non-blocking I/O (and
		654	treat callback invocation as hint only), or retest separately with a safe
		655	interface before doing I/O (XLib can do this), or force the use of either
		656	C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>, which don't suffer from this
		657	problem. Also note that it is quite easy to have your callback invoked
		658	when the readyness condition is no longer valid even when employing
		659	typical ways of handling events, so its a good idea to use non-blocking
		660	I/O unconditionally.
		661
533	=back	662	=back
		663
		664	Example: call C<stdin_readable_cb> when STDIN_FILENO has become, well
		665	readable, but only once. Since it is likely line-buffered, you could
		666	attempt to read a whole line in the callback:
		667
		668	static void
		669	stdin_readable_cb (struct ev_loop loop, struct ev_io w, int revents)
		670	{
		671	ev_io_stop (loop, w);
		672	.. read from stdin here (or from w->fd) and haqndle any I/O errors
		673	}
		674
		675	...
		676	struct ev_loop *loop = ev_default_init (0);
		677	struct ev_io stdin_readable;
		678	ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
		679	ev_io_start (loop, &stdin_readable);
		680	ev_loop (loop, 0);
		681
534		682
535	=head2 C<ev_timer> - relative and optionally recurring timeouts	683	=head2 C<ev_timer> - relative and optionally recurring timeouts
536		684
537	Timer watchers are simple relative timers that generate an event after a	685	Timer watchers are simple relative timers that generate an event after a
538	given time, and optionally repeating in regular intervals after that.	686	given time, and optionally repeating in regular intervals after that.
…		…
591	state where you do not expect data to travel on the socket, you can stop	739	state where you do not expect data to travel on the socket, you can stop
592	the timer, and again will automatically restart it if need be.	740	the timer, and again will automatically restart it if need be.
593		741
594	=back	742	=back
595		743
		744	Example: create a timer that fires after 60 seconds.
		745
		746	static void
		747	one_minute_cb (struct ev_loop loop, struct ev_timer w, int revents)
		748	{
		749	.. one minute over, w is actually stopped right here
		750	}
		751
		752	struct ev_timer mytimer;
		753	ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
		754	ev_timer_start (loop, &mytimer);
		755
		756	Example: create a timeout timer that times out after 10 seconds of
		757	inactivity.
		758
		759	static void
		760	timeout_cb (struct ev_loop loop, struct ev_timer w, int revents)
		761	{
		762	.. ten seconds without any activity
		763	}
		764
		765	struct ev_timer mytimer;
		766	ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
		767	ev_timer_again (&mytimer); /* start timer */
		768	ev_loop (loop, 0);
		769
		770	// and in some piece of code that gets executed on any "activity":
		771	// reset the timeout to start ticking again at 10 seconds
		772	ev_timer_again (&mytimer);
		773
		774
596	=head2 C<ev_periodic> - to cron or not to cron	775	=head2 C<ev_periodic> - to cron or not to cron
597		776
598	Periodic watchers are also timers of a kind, but they are very versatile	777	Periodic watchers are also timers of a kind, but they are very versatile
599	(and unfortunately a bit complex).	778	(and unfortunately a bit complex).
600		779
…		…
695	a different time than the last time it was called (e.g. in a crond like	874	a different time than the last time it was called (e.g. in a crond like
696	program when the crontabs have changed).	875	program when the crontabs have changed).
697		876
698	=back	877	=back
699		878
		879	Example: call a callback every hour, or, more precisely, whenever the
		880	system clock is divisible by 3600. The callback invocation times have
		881	potentially a lot of jittering, but good long-term stability.
		882
		883	static void
		884	clock_cb (struct ev_loop loop, struct ev_io w, int revents)
		885	{
		886	... its now a full hour (UTC, or TAI or whatever your clock follows)
		887	}
		888
		889	struct ev_periodic hourly_tick;
		890	ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
		891	ev_periodic_start (loop, &hourly_tick);
		892
		893	Example: the same as above, but use a reschedule callback to do it:
		894
		895	#include <math.h>
		896
		897	static ev_tstamp
		898	my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
		899	{
		900	return fmod (now, 3600.) + 3600.;
		901	}
		902
		903	ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
		904
		905	Example: call a callback every hour, starting now:
		906
		907	struct ev_periodic hourly_tick;
		908	ev_periodic_init (&hourly_tick, clock_cb,
		909	fmod (ev_now (loop), 3600.), 3600., 0);
		910	ev_periodic_start (loop, &hourly_tick);
		911
		912
700	=head2 C<ev_signal> - signal me when a signal gets signalled	913	=head2 C<ev_signal> - signal me when a signal gets signalled
701		914
702	Signal watchers will trigger an event when the process receives a specific	915	Signal watchers will trigger an event when the process receives a specific
703	signal one or more times. Even though signals are very asynchronous, libev	916	signal one or more times. Even though signals are very asynchronous, libev
704	will try it's best to deliver signals synchronously, i.e. as part of the	917	will try it's best to deliver signals synchronously, i.e. as part of the
…		…
720	Configures the watcher to trigger on the given signal number (usually one	933	Configures the watcher to trigger on the given signal number (usually one
721	of the C<SIGxxx> constants).	934	of the C<SIGxxx> constants).
722		935
723	=back	936	=back
724		937
		938
725	=head2 C<ev_child> - wait for pid status changes	939	=head2 C<ev_child> - wait for pid status changes
726		940
727	Child watchers trigger when your process receives a SIGCHLD in response to	941	Child watchers trigger when your process receives a SIGCHLD in response to
728	some child status changes (most typically when a child of yours dies).	942	some child status changes (most typically when a child of yours dies).
729		943
…		…
739	the status word (use the macros from C<sys/wait.h> and see your systems	953	the status word (use the macros from C<sys/wait.h> and see your systems
740	C<waitpid> documentation). The C<rpid> member contains the pid of the	954	C<waitpid> documentation). The C<rpid> member contains the pid of the
741	process causing the status change.	955	process causing the status change.
742		956
743	=back	957	=back
		958
		959	Example: try to exit cleanly on SIGINT and SIGTERM.
		960
		961	static void
		962	sigint_cb (struct ev_loop loop, struct ev_signal w, int revents)
		963	{
		964	ev_unloop (loop, EVUNLOOP_ALL);
		965	}
		966
		967	struct ev_signal signal_watcher;
		968	ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
		969	ev_signal_start (loop, &sigint_cb);
		970
744		971
745	=head2 C<ev_idle> - when you've got nothing better to do	972	=head2 C<ev_idle> - when you've got nothing better to do
746		973
747	Idle watchers trigger events when there are no other events are pending	974	Idle watchers trigger events when there are no other events are pending
748	(prepare, check and other idle watchers do not count). That is, as long	975	(prepare, check and other idle watchers do not count). That is, as long
…		…
768	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,	995	kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
769	believe me.	996	believe me.
770		997
771	=back	998	=back
772		999
		1000	Example: dynamically allocate an C<ev_idle>, start it, and in the
		1001	callback, free it. Alos, use no error checking, as usual.
		1002
		1003	static void
		1004	idle_cb (struct ev_loop loop, struct ev_idle w, int revents)
		1005	{
		1006	free (w);
		1007	// now do something you wanted to do when the program has
		1008	// no longer asnything immediate to do.
		1009	}
		1010
		1011	struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
		1012	ev_idle_init (idle_watcher, idle_cb);
		1013	ev_idle_start (loop, idle_cb);
		1014
		1015
773	=head2 C<ev_prepare> and C<ev_check> - customise your event loop	1016	=head2 C<ev_prepare> and C<ev_check> - customise your event loop
774		1017
775	Prepare and check watchers are usually (but not always) used in tandem:	1018	Prepare and check watchers are usually (but not always) used in tandem:
776	prepare watchers get invoked before the process blocks and check watchers	1019	prepare watchers get invoked before the process blocks and check watchers
777	afterwards.	1020	afterwards.
778		1021
779	Their main purpose is to integrate other event mechanisms into libev. This	1022	Their main purpose is to integrate other event mechanisms into libev and
780	could be used, for example, to track variable changes, implement your own	1023	their use is somewhat advanced. This could be used, for example, to track
781	watchers, integrate net-snmp or a coroutine library and lots more.	1024	variable changes, implement your own watchers, integrate net-snmp or a
		1025	coroutine library and lots more.
782		1026
783	This is done by examining in each prepare call which file descriptors need	1027	This is done by examining in each prepare call which file descriptors need
784	to be watched by the other library, registering C<ev_io> watchers for	1028	to be watched by the other library, registering C<ev_io> watchers for
785	them and starting an C<ev_timer> watcher for any timeouts (many libraries	1029	them and starting an C<ev_timer> watcher for any timeouts (many libraries
786	provide just this functionality). Then, in the check watcher you check for	1030	provide just this functionality). Then, in the check watcher you check for
…		…
808	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>	1052	parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
809	macros, but using them is utterly, utterly and completely pointless.	1053	macros, but using them is utterly, utterly and completely pointless.
810		1054
811	=back	1055	=back
812		1056
		1057	Example: TODO.
		1058
		1059
		1060	=head2 C<ev_embed> - when one backend isn't enough
		1061
		1062	This is a rather advanced watcher type that lets you embed one event loop
		1063	into another.
		1064
		1065	There are primarily two reasons you would want that: work around bugs and
		1066	prioritise I/O.
		1067
		1068	As an example for a bug workaround, the kqueue backend might only support
		1069	sockets on some platform, so it is unusable as generic backend, but you
		1070	still want to make use of it because you have many sockets and it scales
		1071	so nicely. In this case, you would create a kqueue-based loop and embed it
		1072	into your default loop (which might use e.g. poll). Overall operation will
		1073	be a bit slower because first libev has to poll and then call kevent, but
		1074	at least you can use both at what they are best.
		1075
		1076	As for prioritising I/O: rarely you have the case where some fds have
		1077	to be watched and handled very quickly (with low latency), and even
		1078	priorities and idle watchers might have too much overhead. In this case
		1079	you would put all the high priority stuff in one loop and all the rest in
		1080	a second one, and embed the second one in the first.
		1081
		1082	As long as the watcher is started it will automatically handle events. The
		1083	callback will be invoked whenever some events have been handled. You can
		1084	set the callback to C<0> to avoid having to specify one if you are not
		1085	interested in that.
		1086
		1087	Also, there have not currently been made special provisions for forking:
		1088	when you fork, you not only have to call C<ev_loop_fork> on both loops,
		1089	but you will also have to stop and restart any C<ev_embed> watchers
		1090	yourself.
		1091
		1092	Unfortunately, not all backends are embeddable, only the ones returned by
		1093	C<ev_embeddable_backends> are, which, unfortunately, does not include any
		1094	portable one.
		1095
		1096	So when you want to use this feature you will always have to be prepared
		1097	that you cannot get an embeddable loop. The recommended way to get around
		1098	this is to have a separate variables for your embeddable loop, try to
		1099	create it, and if that fails, use the normal loop for everything:
		1100
		1101	struct ev_loop *loop_hi = ev_default_init (0);
		1102	struct ev_loop *loop_lo = 0;
		1103	struct ev_embed embed;
		1104
		1105	// see if there is a chance of getting one that works
		1106	// (remember that a flags value of 0 means autodetection)
		1107	loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
		1108	? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
		1109	: 0;
		1110
		1111	// if we got one, then embed it, otherwise default to loop_hi
		1112	if (loop_lo)
		1113	{
		1114	ev_embed_init (&embed, 0, loop_lo);
		1115	ev_embed_start (loop_hi, &embed);
		1116	}
		1117	else
		1118	loop_lo = loop_hi;
		1119
		1120	=over 4
		1121
		1122	=item ev_embed_init (ev_embed , callback, struct ev_loop loop)
		1123
		1124	=item ev_embed_set (ev_embed , callback, struct ev_loop loop)
		1125
		1126	Configures the watcher to embed the given loop, which must be embeddable.
		1127
		1128	=back
		1129
		1130
813	=head1 OTHER FUNCTIONS	1131	=head1 OTHER FUNCTIONS
814		1132
815	There are some other functions of possible interest. Described. Here. Now.	1133	There are some other functions of possible interest. Described. Here. Now.
816		1134
817	=over 4	1135	=over 4
…		…
863		1181
864	Feed an event as if the given signal occured (loop must be the default loop!).	1182	Feed an event as if the given signal occured (loop must be the default loop!).
865		1183
866	=back	1184	=back
867		1185
		1186
868	=head1 LIBEVENT EMULATION	1187	=head1 LIBEVENT EMULATION
869		1188
870	Libev offers a compatibility emulation layer for libevent. It cannot	1189	Libev offers a compatibility emulation layer for libevent. It cannot
871	emulate the internals of libevent, so here are some usage hints:	1190	emulate the internals of libevent, so here are some usage hints:
872		1191

Diff Legend

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

Comparing libev/ev.pod (file contents): Revision 1.31 by root, Fri Nov 23 05:00:45 2007 UTC vs. Revision 1.35 by root, Fri Nov 23 19:35:09 2007 UTC

Diff Legend

Comparing libev/ev.pod (file contents):
Revision 1.31 by root, Fri Nov 23 05:00:45 2007 UTC vs.
Revision 1.35 by root, Fri Nov 23 19:35:09 2007 UTC