ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.pod
(Generate patch)

Comparing libev/ev.pod (file contents):
Revision 1.80 by root, Sun Dec 9 19:47:30 2007 UTC vs.
Revision 1.118 by root, Thu Jan 10 06:00:55 2008 UTC

… …
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 #include <ev.h> 7 #include <ev.h>
8 8
9=head1 EXAMPLE PROGRAM 9=head2 EXAMPLE PROGRAM
10 10
11 #include <ev.h> 11 #include <ev.h>
12 12
13 ev_io stdin_watcher; 13 ev_io stdin_watcher;
14 ev_timer timeout_watcher; 14 ev_timer timeout_watcher;
… …
53The newest version of this document is also available as a html-formatted 53The newest version of this document is also available as a html-formatted
54web page you might find easier to navigate when reading it for the first 54web page you might find easier to navigate when reading it for the first
55time: L<http://cvs.schmorp.de/libev/ev.html>. 55time: L<http://cvs.schmorp.de/libev/ev.html>.
56 56
57Libev is an event loop: you register interest in certain events (such as a 57Libev is an event loop: you register interest in certain events (such as a
58file descriptor being readable or a timeout occuring), and it will manage 58file descriptor being readable or a timeout occurring), and it will manage
59these event sources and provide your program with events. 59these event sources and provide your program with events.
60 60
61To do this, it must take more or less complete control over your process 61To do this, it must take more or less complete control over your process
62(or thread) by executing the I<event loop> handler, and will then 62(or thread) by executing the I<event loop> handler, and will then
63communicate events via a callback mechanism. 63communicate events via a callback mechanism.
… …
65You register interest in certain events by registering so-called I<event 65You register interest in certain events by registering so-called I<event
66watchers>, which are relatively small C structures you initialise with the 66watchers>, which are relatively small C structures you initialise with the
67details of the event, and then hand it over to libev by I<starting> the 67details of the event, and then hand it over to libev by I<starting> the
68watcher. 68watcher.
69 69
70=head1 FEATURES 70=head2 FEATURES
71 71
72Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the 72Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
73BSD-specific C<kqueue> and the Solaris-specific event port mechanisms 73BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
74for file descriptor events (C<ev_io>), the Linux C<inotify> interface 74for file descriptor events (C<ev_io>), the Linux C<inotify> interface
75(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers 75(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers
… …
82 82
83It also is quite fast (see this 83It also is quite fast (see this
84L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent 84L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
85for example). 85for example).
86 86
87=head1 CONVENTIONS 87=head2 CONVENTIONS
88 88
89Libev is very configurable. In this manual the default configuration will 89Libev is very configurable. In this manual the default configuration will
90be described, which supports multiple event loops. For more info about 90be described, which supports multiple event loops. For more info about
91various configuration options please have a look at B<EMBED> section in 91various configuration options please have a look at B<EMBED> section in
92this manual. If libev was configured without support for multiple event 92this manual. If libev was configured without support for multiple event
93loops, then all functions taking an initial argument of name C<loop> 93loops, then all functions taking an initial argument of name C<loop>
94(which is always of type C<struct ev_loop *>) will not have this argument. 94(which is always of type C<struct ev_loop *>) will not have this argument.
95 95
96=head1 TIME REPRESENTATION 96=head2 TIME REPRESENTATION
97 97
98Libev represents time as a single floating point number, representing the 98Libev represents time as a single floating point number, representing the
99(fractional) number of seconds since the (POSIX) epoch (somewhere near 99(fractional) number of seconds since the (POSIX) epoch (somewhere near
100the beginning of 1970, details are complicated, don't ask). This type is 100the beginning of 1970, details are complicated, don't ask). This type is
101called C<ev_tstamp>, which is what you should use too. It usually aliases 101called C<ev_tstamp>, which is what you should use too. It usually aliases
102to the C<double> type in C, and when you need to do any calculations on 102to the C<double> type in C, and when you need to do any calculations on
103it, you should treat it as such. 103it, you should treat it as some floatingpoint value. Unlike the name
104component C<stamp> might indicate, it is also used for time differences
105throughout libev.
104 106
105=head1 GLOBAL FUNCTIONS 107=head1 GLOBAL FUNCTIONS
106 108
107These functions can be called anytime, even before initialising the 109These functions can be called anytime, even before initialising the
108library in any way. 110library in any way.
… …
112=item ev_tstamp ev_time () 114=item ev_tstamp ev_time ()
113 115
114Returns the current time as libev would use it. Please note that the 116Returns the current time as libev would use it. Please note that the
115C<ev_now> function is usually faster and also often returns the timestamp 117C<ev_now> function is usually faster and also often returns the timestamp
116you actually want to know. 118you actually want to know.
119
120=item ev_sleep (ev_tstamp interval)
121
122Sleep for the given interval: The current thread will be blocked until
123either it is interrupted or the given time interval has passed. Basically
124this is a subsecond-resolution C<sleep ()>.
117 125
118=item int ev_version_major () 126=item int ev_version_major ()
119 127
120=item int ev_version_minor () 128=item int ev_version_minor ()
121 129
… …
252flags. If that is troubling you, check C<ev_backend ()> afterwards). 260flags. If that is troubling you, check C<ev_backend ()> afterwards).
253 261
254If you don't know what event loop to use, use the one returned from this 262If you don't know what event loop to use, use the one returned from this
255function. 263function.
256 264
265The default loop is the only loop that can handle C<ev_signal> and
266C<ev_child> watchers, and to do this, it always registers a handler
267for C<SIGCHLD>. If this is a problem for your app you can either
268create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
269can simply overwrite the C<SIGCHLD> signal handler I<after> calling
270C<ev_default_init>.
271
257The flags argument can be used to specify special behaviour or specific 272The flags argument can be used to specify special behaviour or specific
258backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). 273backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
259 274
260The following flags are supported: 275The following flags are supported:
261 276
… …
298=item C<EVBACKEND_SELECT> (value 1, portable select backend) 313=item C<EVBACKEND_SELECT> (value 1, portable select backend)
299 314
300This is your standard select(2) backend. Not I<completely> standard, as 315This is your standard select(2) backend. Not I<completely> standard, as
301libev tries to roll its own fd_set with no limits on the number of fds, 316libev tries to roll its own fd_set with no limits on the number of fds,
302but if that fails, expect a fairly low limit on the number of fds when 317but if that fails, expect a fairly low limit on the number of fds when
303using this backend. It doesn't scale too well (O(highest_fd)), but its usually 318using this backend. It doesn't scale too well (O(highest_fd)), but its
304the fastest backend for a low number of fds. 319usually the fastest backend for a low number of (low-numbered :) fds.
320
321To get good performance out of this backend you need a high amount of
322parallelity (most of the file descriptors should be busy). If you are
323writing a server, you should C<accept ()> in a loop to accept as many
324connections as possible during one iteration. You might also want to have
325a look at C<ev_set_io_collect_interval ()> to increase the amount of
326readyness notifications you get per iteration.
305 327
306=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) 328=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
307 329
308And this is your standard poll(2) backend. It's more complicated than 330And this is your standard poll(2) backend. It's more complicated
309select, but handles sparse fds better and has no artificial limit on the 331than select, but handles sparse fds better and has no artificial
310number of fds you can use (except it will slow down considerably with a 332limit on the number of fds you can use (except it will slow down
311lot of inactive fds). It scales similarly to select, i.e. O(total_fds). 333considerably with a lot of inactive fds). It scales similarly to select,
334i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
335performance tips.
312 336
313=item C<EVBACKEND_EPOLL> (value 4, Linux) 337=item C<EVBACKEND_EPOLL> (value 4, Linux)
314 338
315For few fds, this backend is a bit little slower than poll and select, 339For few fds, this backend is a bit little slower than poll and select,
316but it scales phenomenally better. While poll and select usually scale like 340but it scales phenomenally better. While poll and select usually scale
317O(total_fds) where n is the total number of fds (or the highest fd), epoll scales 341like O(total_fds) where n is the total number of fds (or the highest fd),
318either O(1) or O(active_fds). 342epoll scales either O(1) or O(active_fds). The epoll design has a number
343of shortcomings, such as silently dropping events in some hard-to-detect
344cases and rewiring a syscall per fd change, no fork support and bad
345support for dup.
319 346
320While stopping and starting an I/O watcher in the same iteration will 347While stopping, setting and starting an I/O watcher in the same iteration
321result in some caching, there is still a syscall per such incident 348will result in some caching, there is still a syscall per such incident
322(because the fd could point to a different file description now), so its 349(because the fd could point to a different file description now), so its
323best to avoid that. Also, dup()ed file descriptors might not work very 350best to avoid that. Also, C<dup ()>'ed file descriptors might not work
324well if you register events for both fds. 351very well if you register events for both fds.
325 352
326Please note that epoll sometimes generates spurious notifications, so you 353Please note that epoll sometimes generates spurious notifications, so you
327need to use non-blocking I/O or other means to avoid blocking when no data 354need to use non-blocking I/O or other means to avoid blocking when no data
328(or space) is available. 355(or space) is available.
329 356
357Best performance from this backend is achieved by not unregistering all
358watchers for a file descriptor until it has been closed, if possible, i.e.
359keep at least one watcher active per fd at all times.
360
361While nominally embeddeble in other event loops, this feature is broken in
362all kernel versions tested so far.
363
330=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 364=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
331 365
332Kqueue deserves special mention, as at the time of this writing, it 366Kqueue deserves special mention, as at the time of this writing, it
333was broken on all BSDs except NetBSD (usually it doesn't work with 367was broken on all BSDs except NetBSD (usually it doesn't work reliably
334anything but sockets and pipes, except on Darwin, where of course its 368with anything but sockets and pipes, except on Darwin, where of course
335completely useless). For this reason its not being "autodetected" 369it's completely useless). For this reason it's not being "autodetected"
336unless you explicitly specify it explicitly in the flags (i.e. using 370unless you explicitly specify it explicitly in the flags (i.e. using
337C<EVBACKEND_KQUEUE>). 371C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
372system like NetBSD.
373
374You still can embed kqueue into a normal poll or select backend and use it
375only for sockets (after having made sure that sockets work with kqueue on
376the target platform). See C<ev_embed> watchers for more info.
338 377
339It scales in the same way as the epoll backend, but the interface to the 378It scales in the same way as the epoll backend, but the interface to the
340kernel is more efficient (which says nothing about its actual speed, of 379kernel is more efficient (which says nothing about its actual speed, of
341course). While starting and stopping an I/O watcher does not cause an 380course). While stopping, setting and starting an I/O watcher does never
342extra syscall as with epoll, it still adds up to four event changes per 381cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to
343incident, so its best to avoid that. 382two event changes per incident, support for C<fork ()> is very bad and it
383drops fds silently in similarly hard-to-detect cases.
384
385This backend usually performs well under most conditions.
386
387While nominally embeddable in other event loops, this doesn't work
388everywhere, so you might need to test for this. And since it is broken
389almost everywhere, you should only use it when you have a lot of sockets
390(for which it usually works), by embedding it into another event loop
391(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for
392sockets.
344 393
345=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) 394=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
346 395
347This is not implemented yet (and might never be). 396This is not implemented yet (and might never be, unless you send me an
397implementation). According to reports, C</dev/poll> only supports sockets
398and is not embeddable, which would limit the usefulness of this backend
399immensely.
348 400
349=item C<EVBACKEND_PORT> (value 32, Solaris 10) 401=item C<EVBACKEND_PORT> (value 32, Solaris 10)
350 402
351This uses the Solaris 10 port mechanism. As with everything on Solaris, 403This uses the Solaris 10 event port mechanism. As with everything on Solaris,
352it's really slow, but it still scales very well (O(active_fds)). 404it's really slow, but it still scales very well (O(active_fds)).
353 405
354Please note that solaris ports can result in a lot of spurious 406Please note that solaris event ports can deliver a lot of spurious
355notifications, so you need to use non-blocking I/O or other means to avoid 407notifications, so you need to use non-blocking I/O or other means to avoid
356blocking when no data (or space) is available. 408blocking when no data (or space) is available.
409
410While this backend scales well, it requires one system call per active
411file descriptor per loop iteration. For small and medium numbers of file
412descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
413might perform better.
414
415On the positive side, ignoring the spurious readyness notifications, this
416backend actually performed to specification in all tests and is fully
417embeddable, which is a rare feat among the OS-specific backends.
357 418
358=item C<EVBACKEND_ALL> 419=item C<EVBACKEND_ALL>
359 420
360Try all backends (even potentially broken ones that wouldn't be tried 421Try all backends (even potentially broken ones that wouldn't be tried
361with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as 422with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
362C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. 423C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
363 424
425It is definitely not recommended to use this flag.
426
364=back 427=back
365 428
366If one or more of these are ored into the flags value, then only these 429If one or more of these are ored into the flags value, then only these
367backends will be tried (in the reverse order as given here). If none are 430backends will be tried (in the reverse order as listed here). If none are
368specified, most compiled-in backend will be tried, usually in reverse 431specified, all backends in C<ev_recommended_backends ()> will be tried.
369order of their flag values :)
370 432
371The most typical usage is like this: 433The most typical usage is like this:
372 434
373 if (!ev_default_loop (0)) 435 if (!ev_default_loop (0))
374 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 436 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
… …
402Destroys the default loop again (frees all memory and kernel state 464Destroys the default loop again (frees all memory and kernel state
403etc.). None of the active event watchers will be stopped in the normal 465etc.). None of the active event watchers will be stopped in the normal
404sense, so e.g. C<ev_is_active> might still return true. It is your 466sense, so e.g. C<ev_is_active> might still return true. It is your
405responsibility to either stop all watchers cleanly yoursef I<before> 467responsibility to either stop all watchers cleanly yoursef I<before>
406calling this function, or cope with the fact afterwards (which is usually 468calling this function, or cope with the fact afterwards (which is usually
407the easiest thing, youc na just ignore the watchers and/or C<free ()> them 469the easiest thing, you can just ignore the watchers and/or C<free ()> them
408for example). 470for example).
471
472Note that certain global state, such as signal state, will not be freed by
473this function, and related watchers (such as signal and child watchers)
474would need to be stopped manually.
475
476In general it is not advisable to call this function except in the
477rare occasion where you really need to free e.g. the signal handling
478pipe fds. If you need dynamically allocated loops it is better to use
479C<ev_loop_new> and C<ev_loop_destroy>).
409 480
410=item ev_loop_destroy (loop) 481=item ev_loop_destroy (loop)
411 482
412Like C<ev_default_destroy>, but destroys an event loop created by an 483Like C<ev_default_destroy>, but destroys an event loop created by an
413earlier call to C<ev_loop_new>. 484earlier call to C<ev_loop_new>.
… …
458 529
459Returns the current "event loop time", which is the time the event loop 530Returns the current "event loop time", which is the time the event loop
460received events and started processing them. This timestamp does not 531received events and started processing them. This timestamp does not
461change as long as callbacks are being processed, and this is also the base 532change as long as callbacks are being processed, and this is also the base
462time used for relative timers. You can treat it as the timestamp of the 533time used for relative timers. You can treat it as the timestamp of the
463event occuring (or more correctly, libev finding out about it). 534event occurring (or more correctly, libev finding out about it).
464 535
465=item ev_loop (loop, int flags) 536=item ev_loop (loop, int flags)
466 537
467Finally, this is it, the event handler. This function usually is called 538Finally, this is it, the event handler. This function usually is called
468after you initialised all your watchers and you want to start handling 539after you initialised all your watchers and you want to start handling
… …
490usually a better approach for this kind of thing. 561usually a better approach for this kind of thing.
491 562
492Here are the gory details of what C<ev_loop> does: 563Here are the gory details of what C<ev_loop> does:
493 564
494 - Before the first iteration, call any pending watchers. 565 - Before the first iteration, call any pending watchers.
495 * If there are no active watchers (reference count is zero), return. 566 * If EVFLAG_FORKCHECK was used, check for a fork.
496 - Queue all prepare watchers and then call all outstanding watchers. 567 - If a fork was detected, queue and call all fork watchers.
568 - Queue and call all prepare watchers.
497 - If we have been forked, recreate the kernel state. 569 - If we have been forked, recreate the kernel state.
498 - Update the kernel state with all outstanding changes. 570 - Update the kernel state with all outstanding changes.
499 - Update the "event loop time". 571 - Update the "event loop time".
500 - Calculate for how long to block. 572 - Calculate for how long to sleep or block, if at all
573 (active idle watchers, EVLOOP_NONBLOCK or not having
574 any active watchers at all will result in not sleeping).
575 - Sleep if the I/O and timer collect interval say so.
501 - Block the process, waiting for any events. 576 - Block the process, waiting for any events.
502 - Queue all outstanding I/O (fd) events. 577 - Queue all outstanding I/O (fd) events.
503 - Update the "event loop time" and do time jump handling. 578 - Update the "event loop time" and do time jump handling.
504 - Queue all outstanding timers. 579 - Queue all outstanding timers.
505 - Queue all outstanding periodics. 580 - Queue all outstanding periodics.
506 - If no events are pending now, queue all idle watchers. 581 - If no events are pending now, queue all idle watchers.
507 - Queue all check watchers. 582 - Queue all check watchers.
508 - Call all queued watchers in reverse order (i.e. check watchers first). 583 - Call all queued watchers in reverse order (i.e. check watchers first).
509 Signals and child watchers are implemented as I/O watchers, and will 584 Signals and child watchers are implemented as I/O watchers, and will
510 be handled here by queueing them when their watcher gets executed. 585 be handled here by queueing them when their watcher gets executed.
511 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 586 - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
512 were used, return, otherwise continue with step *. 587 were used, or there are no active watchers, return, otherwise
588 continue with step *.
513 589
514Example: Queue some jobs and then loop until no events are outsanding 590Example: Queue some jobs and then loop until no events are outstanding
515anymore. 591anymore.
516 592
517 ... queue jobs here, make sure they register event watchers as long 593 ... queue jobs here, make sure they register event watchers as long
518 ... as they still have work to do (even an idle watcher will do..) 594 ... as they still have work to do (even an idle watcher will do..)
519 ev_loop (my_loop, 0); 595 ev_loop (my_loop, 0);
… …
523 599
524Can be used to make a call to C<ev_loop> return early (but only after it 600Can be used to make a call to C<ev_loop> return early (but only after it
525has processed all outstanding events). The C<how> argument must be either 601has processed all outstanding events). The C<how> argument must be either
526C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or 602C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
527C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. 603C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
604
605This "unloop state" will be cleared when entering C<ev_loop> again.
528 606
529=item ev_ref (loop) 607=item ev_ref (loop)
530 608
531=item ev_unref (loop) 609=item ev_unref (loop)
532 610
… …
537returning, ev_unref() after starting, and ev_ref() before stopping it. For 615returning, ev_unref() after starting, and ev_ref() before stopping it. For
538example, libev itself uses this for its internal signal pipe: It is not 616example, libev itself uses this for its internal signal pipe: It is not
539visible to the libev user and should not keep C<ev_loop> from exiting if 617visible to the libev user and should not keep C<ev_loop> from exiting if
540no event watchers registered by it are active. It is also an excellent 618no event watchers registered by it are active. It is also an excellent
541way to do this for generic recurring timers or from within third-party 619way to do this for generic recurring timers or from within third-party
542libraries. Just remember to I<unref after start> and I<ref before stop>. 620libraries. Just remember to I<unref after start> and I<ref before stop>
621(but only if the watcher wasn't active before, or was active before,
622respectively).
543 623
544Example: Create a signal watcher, but keep it from keeping C<ev_loop> 624Example: Create a signal watcher, but keep it from keeping C<ev_loop>
545running when nothing else is active. 625running when nothing else is active.
546 626
547 struct ev_signal exitsig; 627 struct ev_signal exitsig;
… …
551 631
552Example: For some weird reason, unregister the above signal handler again. 632Example: For some weird reason, unregister the above signal handler again.
553 633
554 ev_ref (loop); 634 ev_ref (loop);
555 ev_signal_stop (loop, &exitsig); 635 ev_signal_stop (loop, &exitsig);
636
637=item ev_set_io_collect_interval (loop, ev_tstamp interval)
638
639=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
640
641These advanced functions influence the time that libev will spend waiting
642for events. Both are by default C<0>, meaning that libev will try to
643invoke timer/periodic callbacks and I/O callbacks with minimum latency.
644
645Setting these to a higher value (the C<interval> I<must> be >= C<0>)
646allows libev to delay invocation of I/O and timer/periodic callbacks to
647increase efficiency of loop iterations.
648
649The background is that sometimes your program runs just fast enough to
650handle one (or very few) event(s) per loop iteration. While this makes
651the program responsive, it also wastes a lot of CPU time to poll for new
652events, especially with backends like C<select ()> which have a high
653overhead for the actual polling but can deliver many events at once.
654
655By setting a higher I<io collect interval> you allow libev to spend more
656time collecting I/O events, so you can handle more events per iteration,
657at the cost of increasing latency. Timeouts (both C<ev_periodic> and
658C<ev_timer>) will be not affected. Setting this to a non-null value will
659introduce an additional C<ev_sleep ()> call into most loop iterations.
660
661Likewise, by setting a higher I<timeout collect interval> you allow libev
662to spend more time collecting timeouts, at the expense of increased
663latency (the watcher callback will be called later). C<ev_io> watchers
664will not be affected. Setting this to a non-null value will not introduce
665any overhead in libev.
666
667Many (busy) programs can usually benefit by setting the io collect
668interval to a value near C<0.1> or so, which is often enough for
669interactive servers (of course not for games), likewise for timeouts. It
670usually doesn't make much sense to set it to a lower value than C<0.01>,
671as this approsaches the timing granularity of most systems.
556 672
557=back 673=back
558 674
559 675
560=head1 ANATOMY OF A WATCHER 676=head1 ANATOMY OF A WATCHER
… …
886In general you can register as many read and/or write event watchers per 1002In general you can register as many read and/or write event watchers per
887fd as you want (as long as you don't confuse yourself). Setting all file 1003fd as you want (as long as you don't confuse yourself). Setting all file
888descriptors to non-blocking mode is also usually a good idea (but not 1004descriptors to non-blocking mode is also usually a good idea (but not
889required if you know what you are doing). 1005required if you know what you are doing).
890 1006
891You have to be careful with dup'ed file descriptors, though. Some backends
892(the linux epoll backend is a notable example) cannot handle dup'ed file
893descriptors correctly if you register interest in two or more fds pointing
894to the same underlying file/socket/etc. description (that is, they share
895the same underlying "file open").
896
897If you must do this, then force the use of a known-to-be-good backend 1007If you must do this, then force the use of a known-to-be-good backend
898(at the time of this writing, this includes only C<EVBACKEND_SELECT> and 1008(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
899C<EVBACKEND_POLL>). 1009C<EVBACKEND_POLL>).
900 1010
901Another thing you have to watch out for is that it is quite easy to 1011Another thing you have to watch out for is that it is quite easy to
… …
911play around with an Xlib connection), then you have to seperately re-test 1021play around with an Xlib connection), then you have to seperately re-test
912whether a file descriptor is really ready with a known-to-be good interface 1022whether a file descriptor is really ready with a known-to-be good interface
913such as poll (fortunately in our Xlib example, Xlib already does this on 1023such as poll (fortunately in our Xlib example, Xlib already does this on
914its own, so its quite safe to use). 1024its own, so its quite safe to use).
915 1025
1026=head3 The special problem of disappearing file descriptors
1027
1028Some backends (e.g. kqueue, epoll) need to be told about closing a file
1029descriptor (either by calling C<close> explicitly or by any other means,
1030such as C<dup>). The reason is that you register interest in some file
1031descriptor, but when it goes away, the operating system will silently drop
1032this interest. If another file descriptor with the same number then is
1033registered with libev, there is no efficient way to see that this is, in
1034fact, a different file descriptor.
1035
1036To avoid having to explicitly tell libev about such cases, libev follows
1037the following policy: Each time C<ev_io_set> is being called, libev
1038will assume that this is potentially a new file descriptor, otherwise
1039it is assumed that the file descriptor stays the same. That means that
1040you I<have> to call C<ev_io_set> (or C<ev_io_init>) when you change the
1041descriptor even if the file descriptor number itself did not change.
1042
1043This is how one would do it normally anyway, the important point is that
1044the libev application should not optimise around libev but should leave
1045optimisations to libev.
1046
1047=head3 The special problem of dup'ed file descriptors
1048
1049Some backends (e.g. epoll), cannot register events for file descriptors,
1050but only events for the underlying file descriptions. That means when you
1051have C<dup ()>'ed file descriptors or weirder constellations, and register
1052events for them, only one file descriptor might actually receive events.
1053
1054There is no workaround possible except not registering events
1055for potentially C<dup ()>'ed file descriptors, or to resort to
1056C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1057
1058=head3 The special problem of fork
1059
1060Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1061useless behaviour. Libev fully supports fork, but needs to be told about
1062it in the child.
1063
1064To support fork in your programs, you either have to call
1065C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
1066enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1067C<EVBACKEND_POLL>.
1068
1069
1070=head3 Watcher-Specific Functions
1071
916=over 4 1072=over 4
917 1073
918=item ev_io_init (ev_io *, callback, int fd, int events) 1074=item ev_io_init (ev_io *, callback, int fd, int events)
919 1075
920=item ev_io_set (ev_io *, int fd, int events) 1076=item ev_io_set (ev_io *, int fd, int events)
… …
930=item int events [read-only] 1086=item int events [read-only]
931 1087
932The events being watched. 1088The events being watched.
933 1089
934=back 1090=back
1091
1092=head3 Examples
935 1093
936Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well 1094Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
937readable, but only once. Since it is likely line-buffered, you could 1095readable, but only once. Since it is likely line-buffered, you could
938attempt to read a whole line in the callback. 1096attempt to read a whole line in the callback.
939 1097
… …
972 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 1130 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
973 1131
974The callback is guarenteed to be invoked only when its timeout has passed, 1132The callback is guarenteed to be invoked only when its timeout has passed,
975but if multiple timers become ready during the same loop iteration then 1133but if multiple timers become ready during the same loop iteration then
976order of execution is undefined. 1134order of execution is undefined.
1135
1136=head3 Watcher-Specific Functions and Data Members
977 1137
978=over 4 1138=over 4
979 1139
980=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 1140=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
981 1141
… …
1035or C<ev_timer_again> is called and determines the next timeout (if any), 1195or C<ev_timer_again> is called and determines the next timeout (if any),
1036which is also when any modifications are taken into account. 1196which is also when any modifications are taken into account.
1037 1197
1038=back 1198=back
1039 1199
1200=head3 Examples
1201
1040Example: Create a timer that fires after 60 seconds. 1202Example: Create a timer that fires after 60 seconds.
1041 1203
1042 static void 1204 static void
1043 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1205 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1044 { 1206 {
… …
1087 1249
1088As with timers, the callback is guarenteed to be invoked only when the 1250As with timers, the callback is guarenteed to be invoked only when the
1089time (C<at>) has been passed, but if multiple periodic timers become ready 1251time (C<at>) has been passed, but if multiple periodic timers become ready
1090during the same loop iteration then order of execution is undefined. 1252during the same loop iteration then order of execution is undefined.
1091 1253
1254=head3 Watcher-Specific Functions and Data Members
1255
1092=over 4 1256=over 4
1093 1257
1094=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) 1258=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
1095 1259
1096=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) 1260=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)
… …
1192 1356
1193The current reschedule callback, or C<0>, if this functionality is 1357The current reschedule callback, or C<0>, if this functionality is
1194switched off. Can be changed any time, but changes only take effect when 1358switched off. Can be changed any time, but changes only take effect when
1195the periodic timer fires or C<ev_periodic_again> is being called. 1359the periodic timer fires or C<ev_periodic_again> is being called.
1196 1360
1361=item ev_tstamp at [read-only]
1362
1363When active, contains the absolute time that the watcher is supposed to
1364trigger next.
1365
1197=back 1366=back
1367
1368=head3 Examples
1198 1369
1199Example: Call a callback every hour, or, more precisely, whenever the 1370Example: Call a callback every hour, or, more precisely, whenever the
1200system clock is divisible by 3600. The callback invocation times have 1371system clock is divisible by 3600. The callback invocation times have
1201potentially a lot of jittering, but good long-term stability. 1372potentially a lot of jittering, but good long-term stability.
1202 1373
… …
1242with the kernel (thus it coexists with your own signal handlers as long 1413with the kernel (thus it coexists with your own signal handlers as long
1243as you don't register any with libev). Similarly, when the last signal 1414as you don't register any with libev). Similarly, when the last signal
1244watcher for a signal is stopped libev will reset the signal handler to 1415watcher for a signal is stopped libev will reset the signal handler to
1245SIG_DFL (regardless of what it was set to before). 1416SIG_DFL (regardless of what it was set to before).
1246 1417
1418=head3 Watcher-Specific Functions and Data Members
1419
1247=over 4 1420=over 4
1248 1421
1249=item ev_signal_init (ev_signal *, callback, int signum) 1422=item ev_signal_init (ev_signal *, callback, int signum)
1250 1423
1251=item ev_signal_set (ev_signal *, int signum) 1424=item ev_signal_set (ev_signal *, int signum)
… …
1262 1435
1263=head2 C<ev_child> - watch out for process status changes 1436=head2 C<ev_child> - watch out for process status changes
1264 1437
1265Child watchers trigger when your process receives a SIGCHLD in response to 1438Child watchers trigger when your process receives a SIGCHLD in response to
1266some child status changes (most typically when a child of yours dies). 1439some child status changes (most typically when a child of yours dies).
1440
1441=head3 Watcher-Specific Functions and Data Members
1267 1442
1268=over 4 1443=over 4
1269 1444
1270=item ev_child_init (ev_child *, callback, int pid) 1445=item ev_child_init (ev_child *, callback, int pid)
1271 1446
… …
1290 1465
1291The process exit/trace status caused by C<rpid> (see your systems 1466The process exit/trace status caused by C<rpid> (see your systems
1292C<waitpid> and C<sys/wait.h> documentation for details). 1467C<waitpid> and C<sys/wait.h> documentation for details).
1293 1468
1294=back 1469=back
1470
1471=head3 Examples
1295 1472
1296Example: Try to exit cleanly on SIGINT and SIGTERM. 1473Example: Try to exit cleanly on SIGINT and SIGTERM.
1297 1474
1298 static void 1475 static void
1299 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1476 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
… …
1340semantics of C<ev_stat> watchers, which means that libev sometimes needs 1517semantics of C<ev_stat> watchers, which means that libev sometimes needs
1341to fall back to regular polling again even with inotify, but changes are 1518to fall back to regular polling again even with inotify, but changes are
1342usually detected immediately, and if the file exists there will be no 1519usually detected immediately, and if the file exists there will be no
1343polling. 1520polling.
1344 1521
1522=head3 Inotify
1523
1524When C<inotify (7)> support has been compiled into libev (generally only
1525available on Linux) and present at runtime, it will be used to speed up
1526change detection where possible. The inotify descriptor will be created lazily
1527when the first C<ev_stat> watcher is being started.
1528
1529Inotify presense does not change the semantics of C<ev_stat> watchers
1530except that changes might be detected earlier, and in some cases, to avoid
1531making regular C<stat> calls. Even in the presense of inotify support
1532there are many cases where libev has to resort to regular C<stat> polling.
1533
1534(There is no support for kqueue, as apparently it cannot be used to
1535implement this functionality, due to the requirement of having a file
1536descriptor open on the object at all times).
1537
1538=head3 The special problem of stat time resolution
1539
1540The C<stat ()> syscall only supports full-second resolution portably, and
1541even on systems where the resolution is higher, many filesystems still
1542only support whole seconds.
1543
1544That means that, if the time is the only thing that changes, you might
1545miss updates: on the first update, C<ev_stat> detects a change and calls
1546your callback, which does something. When there is another update within
1547the same second, C<ev_stat> will be unable to detect it.
1548
1549The solution to this is to delay acting on a change for a second (or till
1550the next second boundary), using a roughly one-second delay C<ev_timer>
1551(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>
1552is added to work around small timing inconsistencies of some operating
1553systems.
1554
1555=head3 Watcher-Specific Functions and Data Members
1556
1345=over 4 1557=over 4
1346 1558
1347=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) 1559=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
1348 1560
1349=item ev_stat_set (ev_stat *, const char *path, ev_tstamp interval) 1561=item ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)
… …
1384=item const char *path [read-only] 1596=item const char *path [read-only]
1385 1597
1386The filesystem path that is being watched. 1598The filesystem path that is being watched.
1387 1599
1388=back 1600=back
1601
1602=head3 Examples
1389 1603
1390Example: Watch C</etc/passwd> for attribute changes. 1604Example: Watch C</etc/passwd> for attribute changes.
1391 1605
1392 static void 1606 static void
1393 passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) 1607 passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
… …
1406 } 1620 }
1407 1621
1408 ... 1622 ...
1409 ev_stat passwd; 1623 ev_stat passwd;
1410 1624
1411 ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); 1625 ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1412 ev_stat_start (loop, &passwd); 1626 ev_stat_start (loop, &passwd);
1627
1628Example: Like above, but additionally use a one-second delay so we do not
1629miss updates (however, frequent updates will delay processing, too, so
1630one might do the work both on C<ev_stat> callback invocation I<and> on
1631C<ev_timer> callback invocation).
1632
1633 static ev_stat passwd;
1634 static ev_timer timer;
1635
1636 static void
1637 timer_cb (EV_P_ ev_timer *w, int revents)
1638 {
1639 ev_timer_stop (EV_A_ w);
1640
1641 /* now it's one second after the most recent passwd change */
1642 }
1643
1644 static void
1645 stat_cb (EV_P_ ev_stat *w, int revents)
1646 {
1647 /* reset the one-second timer */
1648 ev_timer_again (EV_A_ &timer);
1649 }
1650
1651 ...
1652 ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1653 ev_stat_start (loop, &passwd);
1654 ev_timer_init (&timer, timer_cb, 0., 1.01);
1413 1655
1414 1656
1415=head2 C<ev_idle> - when you've got nothing better to do... 1657=head2 C<ev_idle> - when you've got nothing better to do...
1416 1658
1417Idle watchers trigger events when no other events of the same or higher 1659Idle watchers trigger events when no other events of the same or higher
… …
1431Apart from keeping your process non-blocking (which is a useful 1673Apart from keeping your process non-blocking (which is a useful
1432effect on its own sometimes), idle watchers are a good place to do 1674effect on its own sometimes), idle watchers are a good place to do
1433"pseudo-background processing", or delay processing stuff to after the 1675"pseudo-background processing", or delay processing stuff to after the
1434event loop has handled all outstanding events. 1676event loop has handled all outstanding events.
1435 1677
1678=head3 Watcher-Specific Functions and Data Members
1679
1436=over 4 1680=over 4
1437 1681
1438=item ev_idle_init (ev_signal *, callback) 1682=item ev_idle_init (ev_signal *, callback)
1439 1683
1440Initialises and configures the idle watcher - it has no parameters of any 1684Initialises and configures the idle watcher - it has no parameters of any
1441kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 1685kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1442believe me. 1686believe me.
1443 1687
1444=back 1688=back
1689
1690=head3 Examples
1445 1691
1446Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the 1692Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1447callback, free it. Also, use no error checking, as usual. 1693callback, free it. Also, use no error checking, as usual.
1448 1694
1449 static void 1695 static void
… …
1501 1747
1502It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 1748It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1503priority, to ensure that they are being run before any other watchers 1749priority, to ensure that they are being run before any other watchers
1504after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, 1750after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1505too) should not activate ("feed") events into libev. While libev fully 1751too) should not activate ("feed") events into libev. While libev fully
1506supports this, they will be called before other C<ev_check> watchers did 1752supports this, they will be called before other C<ev_check> watchers
1507their job. As C<ev_check> watchers are often used to embed other event 1753did their job. As C<ev_check> watchers are often used to embed other
1508loops those other event loops might be in an unusable state until their 1754(non-libev) event loops those other event loops might be in an unusable
1509C<ev_check> watcher ran (always remind yourself to coexist peacefully with 1755state until their C<ev_check> watcher ran (always remind yourself to
1510others). 1756coexist peacefully with others).
1757
1758=head3 Watcher-Specific Functions and Data Members
1511 1759
1512=over 4 1760=over 4
1513 1761
1514=item ev_prepare_init (ev_prepare *, callback) 1762=item ev_prepare_init (ev_prepare *, callback)
1515 1763
… …
1518Initialises and configures the prepare or check watcher - they have no 1766Initialises and configures the prepare or check watcher - they have no
1519parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 1767parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1520macros, but using them is utterly, utterly and completely pointless. 1768macros, but using them is utterly, utterly and completely pointless.
1521 1769
1522=back 1770=back
1771
1772=head3 Examples
1523 1773
1524There are a number of principal ways to embed other event loops or modules 1774There are a number of principal ways to embed other event loops or modules
1525into libev. Here are some ideas on how to include libadns into libev 1775into libev. Here are some ideas on how to include libadns into libev
1526(there is a Perl module named C<EV::ADNS> that does this, which you could 1776(there is a Perl module named C<EV::ADNS> that does this, which you could
1527use for an actually working example. Another Perl module named C<EV::Glib> 1777use for an actually working example. Another Perl module named C<EV::Glib>
… …
1696portable one. 1946portable one.
1697 1947
1698So when you want to use this feature you will always have to be prepared 1948So when you want to use this feature you will always have to be prepared
1699that you cannot get an embeddable loop. The recommended way to get around 1949that you cannot get an embeddable loop. The recommended way to get around
1700this is to have a separate variables for your embeddable loop, try to 1950this is to have a separate variables for your embeddable loop, try to
1701create it, and if that fails, use the normal loop for everything: 1951create it, and if that fails, use the normal loop for everything.
1952
1953=head3 Watcher-Specific Functions and Data Members
1954
1955=over 4
1956
1957=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
1958
1959=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
1960
1961Configures the watcher to embed the given loop, which must be
1962embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1963invoked automatically, otherwise it is the responsibility of the callback
1964to invoke it (it will continue to be called until the sweep has been done,
1965if you do not want thta, you need to temporarily stop the embed watcher).
1966
1967=item ev_embed_sweep (loop, ev_embed *)
1968
1969Make a single, non-blocking sweep over the embedded loop. This works
1970similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1971apropriate way for embedded loops.
1972
1973=item struct ev_loop *other [read-only]
1974
1975The embedded event loop.
1976
1977=back
1978
1979=head3 Examples
1980
1981Example: Try to get an embeddable event loop and embed it into the default
1982event loop. If that is not possible, use the default loop. The default
1983loop is stored in C<loop_hi>, while the mebeddable loop is stored in
1984C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be
1985used).
1702 1986
1703 struct ev_loop *loop_hi = ev_default_init (0); 1987 struct ev_loop *loop_hi = ev_default_init (0);
1704 struct ev_loop *loop_lo = 0; 1988 struct ev_loop *loop_lo = 0;
1705 struct ev_embed embed; 1989 struct ev_embed embed;
1706 1990
… …
1717 ev_embed_start (loop_hi, &embed); 2001 ev_embed_start (loop_hi, &embed);
1718 } 2002 }
1719 else 2003 else
1720 loop_lo = loop_hi; 2004 loop_lo = loop_hi;
1721 2005
1722=over 4 2006Example: Check if kqueue is available but not recommended and create
2007a kqueue backend for use with sockets (which usually work with any
2008kqueue implementation). Store the kqueue/socket-only event loop in
2009C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
1723 2010
1724=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 2011 struct ev_loop *loop = ev_default_init (0);
2012 struct ev_loop *loop_socket = 0;
2013 struct ev_embed embed;
2014
2015 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2016 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2017 {
2018 ev_embed_init (&embed, 0, loop_socket);
2019 ev_embed_start (loop, &embed);
2020 }
1725 2021
1726=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 2022 if (!loop_socket)
2023 loop_socket = loop;
1727 2024
1728Configures the watcher to embed the given loop, which must be 2025 // now use loop_socket for all sockets, and loop for everything else
1729embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1730invoked automatically, otherwise it is the responsibility of the callback
1731to invoke it (it will continue to be called until the sweep has been done,
1732if you do not want thta, you need to temporarily stop the embed watcher).
1733
1734=item ev_embed_sweep (loop, ev_embed *)
1735
1736Make a single, non-blocking sweep over the embedded loop. This works
1737similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1738apropriate way for embedded loops.
1739
1740=item struct ev_loop *loop [read-only]
1741
1742The embedded event loop.
1743
1744=back
1745 2026
1746 2027
1747=head2 C<ev_fork> - the audacity to resume the event loop after a fork 2028=head2 C<ev_fork> - the audacity to resume the event loop after a fork
1748 2029
1749Fork watchers are called when a C<fork ()> was detected (usually because 2030Fork watchers are called when a C<fork ()> was detected (usually because
… …
1752event loop blocks next and before C<ev_check> watchers are being called, 2033event loop blocks next and before C<ev_check> watchers are being called,
1753and only in the child after the fork. If whoever good citizen calling 2034and only in the child after the fork. If whoever good citizen calling
1754C<ev_default_fork> cheats and calls it in the wrong process, the fork 2035C<ev_default_fork> cheats and calls it in the wrong process, the fork
1755handlers will be invoked, too, of course. 2036handlers will be invoked, too, of course.
1756 2037
2038=head3 Watcher-Specific Functions and Data Members
2039
1757=over 4 2040=over 4
1758 2041
1759=item ev_fork_init (ev_signal *, callback) 2042=item ev_fork_init (ev_signal *, callback)
1760 2043
1761Initialises and configures the fork watcher - it has no parameters of any 2044Initialises and configures the fork watcher - it has no parameters of any
… …
1977 2260
1978=item w->stop () 2261=item w->stop ()
1979 2262
1980Stops the watcher if it is active. Again, no C<loop> argument. 2263Stops the watcher if it is active. Again, no C<loop> argument.
1981 2264
1982=item w->again () C<ev::timer>, C<ev::periodic> only 2265=item w->again () (C<ev::timer>, C<ev::periodic> only)
1983 2266
1984For C<ev::timer> and C<ev::periodic>, this invokes the corresponding 2267For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
1985C<ev_TYPE_again> function. 2268C<ev_TYPE_again> function.
1986 2269
1987=item w->sweep () C<ev::embed> only 2270=item w->sweep () (C<ev::embed> only)
1988 2271
1989Invokes C<ev_embed_sweep>. 2272Invokes C<ev_embed_sweep>.
1990 2273
1991=item w->update () C<ev::stat> only 2274=item w->update () (C<ev::stat> only)
1992 2275
1993Invokes C<ev_stat_stat>. 2276Invokes C<ev_stat_stat>.
1994 2277
1995=back 2278=back
1996 2279
… …
2016 } 2299 }
2017 2300
2018 2301
2019=head1 MACRO MAGIC 2302=head1 MACRO MAGIC
2020 2303
2021Libev can be compiled with a variety of options, the most fundemantal is 2304Libev can be compiled with a variety of options, the most fundamantal
2022C<EV_MULTIPLICITY>. This option determines whether (most) functions and 2305of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2023callbacks have an initial C<struct ev_loop *> argument. 2306functions and callbacks have an initial C<struct ev_loop *> argument.
2024 2307
2025To make it easier to write programs that cope with either variant, the 2308To make it easier to write programs that cope with either variant, the
2026following macros are defined: 2309following macros are defined:
2027 2310
2028=over 4 2311=over 4
… …
2082Libev can (and often is) directly embedded into host 2365Libev can (and often is) directly embedded into host
2083applications. Examples of applications that embed it include the Deliantra 2366applications. Examples of applications that embed it include the Deliantra
2084Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe) 2367Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
2085and rxvt-unicode. 2368and rxvt-unicode.
2086 2369
2087The goal is to enable you to just copy the neecssary files into your 2370The goal is to enable you to just copy the necessary files into your
2088source directory without having to change even a single line in them, so 2371source directory without having to change even a single line in them, so
2089you can easily upgrade by simply copying (or having a checked-out copy of 2372you can easily upgrade by simply copying (or having a checked-out copy of
2090libev somewhere in your source tree). 2373libev somewhere in your source tree).
2091 2374
2092=head2 FILESETS 2375=head2 FILESETS
… …
2182 2465
2183If defined to be C<1>, libev will try to detect the availability of the 2466If defined to be C<1>, libev will try to detect the availability of the
2184monotonic clock option at both compiletime and runtime. Otherwise no use 2467monotonic clock option at both compiletime and runtime. Otherwise no use
2185of the monotonic clock option will be attempted. If you enable this, you 2468of the monotonic clock option will be attempted. If you enable this, you
2186usually have to link against librt or something similar. Enabling it when 2469usually have to link against librt or something similar. Enabling it when
2187the functionality isn't available is safe, though, althoguh you have 2470the functionality isn't available is safe, though, although you have
2188to make sure you link against any libraries where the C<clock_gettime> 2471to make sure you link against any libraries where the C<clock_gettime>
2189function is hiding in (often F<-lrt>). 2472function is hiding in (often F<-lrt>).
2190 2473
2191=item EV_USE_REALTIME 2474=item EV_USE_REALTIME
2192 2475
2193If defined to be C<1>, libev will try to detect the availability of the 2476If defined to be C<1>, libev will try to detect the availability of the
2194realtime clock option at compiletime (and assume its availability at 2477realtime clock option at compiletime (and assume its availability at
2195runtime if successful). Otherwise no use of the realtime clock option will 2478runtime if successful). Otherwise no use of the realtime clock option will
2196be attempted. This effectively replaces C<gettimeofday> by C<clock_get 2479be attempted. This effectively replaces C<gettimeofday> by C<clock_get
2197(CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries 2480(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
2198in the description of C<EV_USE_MONOTONIC>, though. 2481note about libraries in the description of C<EV_USE_MONOTONIC>, though.
2482
2483=item EV_USE_NANOSLEEP
2484
2485If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2486and will use it for delays. Otherwise it will use C<select ()>.
2199 2487
2200=item EV_USE_SELECT 2488=item EV_USE_SELECT
2201 2489
2202If undefined or defined to be C<1>, libev will compile in support for the 2490If undefined or defined to be C<1>, libev will compile in support for the
2203C<select>(2) backend. No attempt at autodetection will be done: if no 2491C<select>(2) backend. No attempt at autodetection will be done: if no
… …
2221wants osf handles on win32 (this is the case when the select to 2509wants osf handles on win32 (this is the case when the select to
2222be used is the winsock select). This means that it will call 2510be used is the winsock select). This means that it will call
2223C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, 2511C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
2224it is assumed that all these functions actually work on fds, even 2512it is assumed that all these functions actually work on fds, even
2225on win32. Should not be defined on non-win32 platforms. 2513on win32. Should not be defined on non-win32 platforms.
2514
2515=item EV_FD_TO_WIN32_HANDLE
2516
2517If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
2518file descriptors to socket handles. When not defining this symbol (the
2519default), then libev will call C<_get_osfhandle>, which is usually
2520correct. In some cases, programs use their own file descriptor management,
2521in which case they can provide this function to map fds to socket handles.
2226 2522
2227=item EV_USE_POLL 2523=item EV_USE_POLL
2228 2524
2229If defined to be C<1>, libev will compile in support for the C<poll>(2) 2525If defined to be C<1>, libev will compile in support for the C<poll>(2)
2230backend. Otherwise it will be enabled on non-win32 platforms. It 2526backend. Otherwise it will be enabled on non-win32 platforms. It
… …
2267be detected at runtime. 2563be detected at runtime.
2268 2564
2269=item EV_H 2565=item EV_H
2270 2566
2271The name of the F<ev.h> header file used to include it. The default if 2567The name of the F<ev.h> header file used to include it. The default if
2272undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This 2568undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
2273can be used to virtually rename the F<ev.h> header file in case of conflicts. 2569used to virtually rename the F<ev.h> header file in case of conflicts.
2274 2570
2275=item EV_CONFIG_H 2571=item EV_CONFIG_H
2276 2572
2277If C<EV_STANDALONE> isn't C<1>, this variable can be used to override 2573If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
2278F<ev.c>'s idea of where to find the F<config.h> file, similarly to 2574F<ev.c>'s idea of where to find the F<config.h> file, similarly to
2279C<EV_H>, above. 2575C<EV_H>, above.
2280 2576
2281=item EV_EVENT_H 2577=item EV_EVENT_H
2282 2578
2283Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea 2579Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
2284of how the F<event.h> header can be found. 2580of how the F<event.h> header can be found, the default is C<"event.h">.
2285 2581
2286=item EV_PROTOTYPES 2582=item EV_PROTOTYPES
2287 2583
2288If defined to be C<0>, then F<ev.h> will not define any function 2584If defined to be C<0>, then F<ev.h> will not define any function
2289prototypes, but still define all the structs and other symbols. This is 2585prototypes, but still define all the structs and other symbols. This is
… …
2355than enough. If you need to manage thousands of children you might want to 2651than enough. If you need to manage thousands of children you might want to
2356increase this value (I<must> be a power of two). 2652increase this value (I<must> be a power of two).
2357 2653
2358=item EV_INOTIFY_HASHSIZE 2654=item EV_INOTIFY_HASHSIZE
2359 2655
2360C<ev_staz> watchers use a small hash table to distribute workload by 2656C<ev_stat> watchers use a small hash table to distribute workload by
2361inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), 2657inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2362usually more than enough. If you need to manage thousands of C<ev_stat> 2658usually more than enough. If you need to manage thousands of C<ev_stat>
2363watchers you might want to increase this value (I<must> be a power of 2659watchers you might want to increase this value (I<must> be a power of
2364two). 2660two).
2365 2661
… …
2382 2678
2383=item ev_set_cb (ev, cb) 2679=item ev_set_cb (ev, cb)
2384 2680
2385Can be used to change the callback member declaration in each watcher, 2681Can be used to change the callback member declaration in each watcher,
2386and the way callbacks are invoked and set. Must expand to a struct member 2682and the way callbacks are invoked and set. Must expand to a struct member
2387definition and a statement, respectively. See the F<ev.v> header file for 2683definition and a statement, respectively. See the F<ev.h> header file for
2388their default definitions. One possible use for overriding these is to 2684their default definitions. One possible use for overriding these is to
2389avoid the C<struct ev_loop *> as first argument in all cases, or to use 2685avoid the C<struct ev_loop *> as first argument in all cases, or to use
2390method calls instead of plain function calls in C++. 2686method calls instead of plain function calls in C++.
2687
2688=head2 EXPORTED API SYMBOLS
2689
2690If you need to re-export the API (e.g. via a dll) and you need a list of
2691exported symbols, you can use the provided F<Symbol.*> files which list
2692all public symbols, one per line:
2693
2694 Symbols.ev for libev proper
2695 Symbols.event for the libevent emulation
2696
2697This can also be used to rename all public symbols to avoid clashes with
2698multiple versions of libev linked together (which is obviously bad in
2699itself, but sometimes it is inconvinient to avoid this).
2700
2701A sed command like this will create wrapper C<#define>'s that you need to
2702include before including F<ev.h>:
2703
2704 <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
2705
2706This would create a file F<wrap.h> which essentially looks like this:
2707
2708 #define ev_backend myprefix_ev_backend
2709 #define ev_check_start myprefix_ev_check_start
2710 #define ev_check_stop myprefix_ev_check_stop
2711 ...
2391 2712
2392=head2 EXAMPLES 2713=head2 EXAMPLES
2393 2714
2394For a real-world example of a program the includes libev 2715For a real-world example of a program the includes libev
2395verbatim, you can have a look at the EV perl module 2716verbatim, you can have a look at the EV perl module
… …
2436 2757
2437=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) 2758=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2438 2759
2439This means that, when you have a watcher that triggers in one hour and 2760This means that, when you have a watcher that triggers in one hour and
2440there are 100 watchers that would trigger before that then inserting will 2761there are 100 watchers that would trigger before that then inserting will
2441have to skip those 100 watchers. 2762have to skip roughly seven (C<ld 100>) of these watchers.
2442 2763
2443=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) 2764=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
2444 2765
2445That means that for changing a timer costs less than removing/adding them 2766That means that changing a timer costs less than removing/adding them
2446as only the relative motion in the event queue has to be paid for. 2767as only the relative motion in the event queue has to be paid for.
2447 2768
2448=item Starting io/check/prepare/idle/signal/child watchers: O(1) 2769=item Starting io/check/prepare/idle/signal/child watchers: O(1)
2449 2770
2450These just add the watcher into an array or at the head of a list. 2771These just add the watcher into an array or at the head of a list.
2772
2451=item Stopping check/prepare/idle watchers: O(1) 2773=item Stopping check/prepare/idle watchers: O(1)
2452 2774
2453=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) 2775=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2454 2776
2455These watchers are stored in lists then need to be walked to find the 2777These watchers are stored in lists then need to be walked to find the
2456correct watcher to remove. The lists are usually short (you don't usually 2778correct watcher to remove. The lists are usually short (you don't usually
2457have many watchers waiting for the same fd or signal). 2779have many watchers waiting for the same fd or signal).
2458 2780
2459=item Finding the next timer per loop iteration: O(1) 2781=item Finding the next timer in each loop iteration: O(1)
2782
2783By virtue of using a binary heap, the next timer is always found at the
2784beginning of the storage array.
2460 2785
2461=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) 2786=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2462 2787
2463A change means an I/O watcher gets started or stopped, which requires 2788A change means an I/O watcher gets started or stopped, which requires
2464libev to recalculate its status (and possibly tell the kernel). 2789libev to recalculate its status (and possibly tell the kernel, depending
2790on backend and wether C<ev_io_set> was used).
2465 2791
2466=item Activating one watcher: O(1) 2792=item Activating one watcher (putting it into the pending state): O(1)
2467 2793
2468=item Priority handling: O(number_of_priorities) 2794=item Priority handling: O(number_of_priorities)
2469 2795
2470Priorities are implemented by allocating some space for each 2796Priorities are implemented by allocating some space for each
2471priority. When doing priority-based operations, libev usually has to 2797priority. When doing priority-based operations, libev usually has to
2472linearly search all the priorities. 2798linearly search all the priorities, but starting/stopping and activating
2799watchers becomes O(1) w.r.t. prioritiy handling.
2473 2800
2474=back 2801=back
2475 2802
2476 2803
2804=head1 Win32 platform limitations and workarounds
2805
2806Win32 doesn't support any of the standards (e.g. POSIX) that libev
2807requires, and its I/O model is fundamentally incompatible with the POSIX
2808model. Libev still offers limited functionality on this platform in
2809the form of the C<EVBACKEND_SELECT> backend, and only supports socket
2810descriptors. This only applies when using Win32 natively, not when using
2811e.g. cygwin.
2812
2813There is no supported compilation method available on windows except
2814embedding it into other applications.
2815
2816Due to the many, low, and arbitrary limits on the win32 platform and the
2817abysmal performance of winsockets, using a large number of sockets is not
2818recommended (and not reasonable). If your program needs to use more than
2819a hundred or so sockets, then likely it needs to use a totally different
2820implementation for windows, as libev offers the POSIX model, which cannot
2821be implemented efficiently on windows (microsoft monopoly games).
2822
2823=over 4
2824
2825=item The winsocket select function
2826
2827The winsocket C<select> function doesn't follow POSIX in that it requires
2828socket I<handles> and not socket I<file descriptors>. This makes select
2829very inefficient, and also requires a mapping from file descriptors
2830to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,
2831C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor
2832symbols for more info.
2833
2834The configuration for a "naked" win32 using the microsoft runtime
2835libraries and raw winsocket select is:
2836
2837 #define EV_USE_SELECT 1
2838 #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
2839
2840Note that winsockets handling of fd sets is O(n), so you can easily get a
2841complexity in the O(n²) range when using win32.
2842
2843=item Limited number of file descriptors
2844
2845Windows has numerous arbitrary (and low) limits on things. Early versions
2846of winsocket's select only supported waiting for a max. of C<64> handles
2847(probably owning to the fact that all windows kernels can only wait for
2848C<64> things at the same time internally; microsoft recommends spawning a
2849chain of threads and wait for 63 handles and the previous thread in each).
2850
2851Newer versions support more handles, but you need to define C<FD_SETSIZE>
2852to some high number (e.g. C<2048>) before compiling the winsocket select
2853call (which might be in libev or elsewhere, for example, perl does its own
2854select emulation on windows).
2855
2856Another limit is the number of file descriptors in the microsoft runtime
2857libraries, which by default is C<64> (there must be a hidden I<64> fetish
2858or something like this inside microsoft). You can increase this by calling
2859C<_setmaxstdio>, which can increase this limit to C<2048> (another
2860arbitrary limit), but is broken in many versions of the microsoft runtime
2861libraries.
2862
2863This might get you to about C<512> or C<2048> sockets (depending on
2864windows version and/or the phase of the moon). To get more, you need to
2865wrap all I/O functions and provide your own fd management, but the cost of
2866calling select (O(n²)) will likely make this unworkable.
2867
2868=back
2869
2870
2477=head1 AUTHOR 2871=head1 AUTHOR
2478 2872
2479Marc Lehmann <libev@schmorp.de>. 2873Marc Lehmann <libev@schmorp.de>.
2480 2874

Diff Legend

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