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

Comparing libev/ev.pod (file contents):
Revision 1.81 by root, Wed Dec 12 04:53:58 2007 UTC vs.
Revision 1.114 by root, Mon Dec 31 01:31:30 2007 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
… …
298=item C<EVBACKEND_SELECT> (value 1, portable select backend) 306=item C<EVBACKEND_SELECT> (value 1, portable select backend)
299 307
300This is your standard select(2) backend. Not I<completely> standard, as 308This 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, 309libev 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 310but 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 311using this backend. It doesn't scale too well (O(highest_fd)), but its
304the fastest backend for a low number of fds. 312usually the fastest backend for a low number of (low-numbered :) fds.
313
314To get good performance out of this backend you need a high amount of
315parallelity (most of the file descriptors should be busy). If you are
316writing a server, you should C<accept ()> in a loop to accept as many
317connections as possible during one iteration. You might also want to have
318a look at C<ev_set_io_collect_interval ()> to increase the amount of
319readyness notifications you get per iteration.
305 320
306=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) 321=item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows)
307 322
308And this is your standard poll(2) backend. It's more complicated than 323And this is your standard poll(2) backend. It's more complicated
309select, but handles sparse fds better and has no artificial limit on the 324than select, but handles sparse fds better and has no artificial
310number of fds you can use (except it will slow down considerably with a 325limit 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). 326considerably with a lot of inactive fds). It scales similarly to select,
327i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for
328performance tips.
312 329
313=item C<EVBACKEND_EPOLL> (value 4, Linux) 330=item C<EVBACKEND_EPOLL> (value 4, Linux)
314 331
315For few fds, this backend is a bit little slower than poll and select, 332For 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 333but 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 334like O(total_fds) where n is the total number of fds (or the highest fd),
318either O(1) or O(active_fds). 335epoll scales either O(1) or O(active_fds). The epoll design has a number
336of shortcomings, such as silently dropping events in some hard-to-detect
337cases and rewiring a syscall per fd change, no fork support and bad
338support for dup.
319 339
320While stopping and starting an I/O watcher in the same iteration will 340While stopping, setting and starting an I/O watcher in the same iteration
321result in some caching, there is still a syscall per such incident 341will 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 342(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 343best to avoid that. Also, C<dup ()>'ed file descriptors might not work
324well if you register events for both fds. 344very well if you register events for both fds.
325 345
326Please note that epoll sometimes generates spurious notifications, so you 346Please 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 347need to use non-blocking I/O or other means to avoid blocking when no data
328(or space) is available. 348(or space) is available.
329 349
350Best performance from this backend is achieved by not unregistering all
351watchers for a file descriptor until it has been closed, if possible, i.e.
352keep at least one watcher active per fd at all times.
353
354While nominally embeddeble in other event loops, this feature is broken in
355all kernel versions tested so far.
356
330=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 357=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
331 358
332Kqueue deserves special mention, as at the time of this writing, it 359Kqueue deserves special mention, as at the time of this writing, it
333was broken on all BSDs except NetBSD (usually it doesn't work with 360was broken on all BSDs except NetBSD (usually it doesn't work reliably
334anything but sockets and pipes, except on Darwin, where of course its 361with anything but sockets and pipes, except on Darwin, where of course
335completely useless). For this reason its not being "autodetected" 362it's completely useless). For this reason it's not being "autodetected"
336unless you explicitly specify it explicitly in the flags (i.e. using 363unless you explicitly specify it explicitly in the flags (i.e. using
337C<EVBACKEND_KQUEUE>). 364C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough)
365system like NetBSD.
366
367You still can embed kqueue into a normal poll or select backend and use it
368only for sockets (after having made sure that sockets work with kqueue on
369the target platform). See C<ev_embed> watchers for more info.
338 370
339It scales in the same way as the epoll backend, but the interface to the 371It 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 372kernel is more efficient (which says nothing about its actual speed, of
341course). While starting and stopping an I/O watcher does not cause an 373course). 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 374cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to
343incident, so its best to avoid that. 375two event changes per incident, support for C<fork ()> is very bad and it
376drops fds silently in similarly hard-to-detect cases.
377
378This backend usually performs well under most conditions.
379
380While nominally embeddable in other event loops, this doesn't work
381everywhere, so you might need to test for this. And since it is broken
382almost everywhere, you should only use it when you have a lot of sockets
383(for which it usually works), by embedding it into another event loop
384(e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for
385sockets.
344 386
345=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) 387=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
346 388
347This is not implemented yet (and might never be). 389This is not implemented yet (and might never be, unless you send me an
390implementation). According to reports, C</dev/poll> only supports sockets
391and is not embeddable, which would limit the usefulness of this backend
392immensely.
348 393
349=item C<EVBACKEND_PORT> (value 32, Solaris 10) 394=item C<EVBACKEND_PORT> (value 32, Solaris 10)
350 395
351This uses the Solaris 10 port mechanism. As with everything on Solaris, 396This 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)). 397it's really slow, but it still scales very well (O(active_fds)).
353 398
354Please note that solaris ports can result in a lot of spurious 399Please 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 400notifications, so you need to use non-blocking I/O or other means to avoid
356blocking when no data (or space) is available. 401blocking when no data (or space) is available.
402
403While this backend scales well, it requires one system call per active
404file descriptor per loop iteration. For small and medium numbers of file
405descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend
406might perform better.
357 407
358=item C<EVBACKEND_ALL> 408=item C<EVBACKEND_ALL>
359 409
360Try all backends (even potentially broken ones that wouldn't be tried 410Try 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 411with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as
362C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. 412C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
413
414It is definitely not recommended to use this flag.
363 415
364=back 416=back
365 417
366If one or more of these are ored into the flags value, then only these 418If 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 419backends will be tried (in the reverse order as given here). If none are
… …
402Destroys the default loop again (frees all memory and kernel state 454Destroys the default loop again (frees all memory and kernel state
403etc.). None of the active event watchers will be stopped in the normal 455etc.). 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 456sense, so e.g. C<ev_is_active> might still return true. It is your
405responsibility to either stop all watchers cleanly yoursef I<before> 457responsibility to either stop all watchers cleanly yoursef I<before>
406calling this function, or cope with the fact afterwards (which is usually 458calling 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 459the easiest thing, you can just ignore the watchers and/or C<free ()> them
408for example). 460for example).
461
462Note that certain global state, such as signal state, will not be freed by
463this function, and related watchers (such as signal and child watchers)
464would need to be stopped manually.
465
466In general it is not advisable to call this function except in the
467rare occasion where you really need to free e.g. the signal handling
468pipe fds. If you need dynamically allocated loops it is better to use
469C<ev_loop_new> and C<ev_loop_destroy>).
409 470
410=item ev_loop_destroy (loop) 471=item ev_loop_destroy (loop)
411 472
412Like C<ev_default_destroy>, but destroys an event loop created by an 473Like C<ev_default_destroy>, but destroys an event loop created by an
413earlier call to C<ev_loop_new>. 474earlier call to C<ev_loop_new>.
… …
458 519
459Returns the current "event loop time", which is the time the event loop 520Returns the current "event loop time", which is the time the event loop
460received events and started processing them. This timestamp does not 521received events and started processing them. This timestamp does not
461change as long as callbacks are being processed, and this is also the base 522change 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 523time used for relative timers. You can treat it as the timestamp of the
463event occuring (or more correctly, libev finding out about it). 524event occurring (or more correctly, libev finding out about it).
464 525
465=item ev_loop (loop, int flags) 526=item ev_loop (loop, int flags)
466 527
467Finally, this is it, the event handler. This function usually is called 528Finally, this is it, the event handler. This function usually is called
468after you initialised all your watchers and you want to start handling 529after you initialised all your watchers and you want to start handling
… …
490usually a better approach for this kind of thing. 551usually a better approach for this kind of thing.
491 552
492Here are the gory details of what C<ev_loop> does: 553Here are the gory details of what C<ev_loop> does:
493 554
494 - Before the first iteration, call any pending watchers. 555 - Before the first iteration, call any pending watchers.
495 * If there are no active watchers (reference count is zero), return. 556 * If EVFLAG_FORKCHECK was used, check for a fork.
496 - Queue all prepare watchers and then call all outstanding watchers. 557 - If a fork was detected, queue and call all fork watchers.
558 - Queue and call all prepare watchers.
497 - If we have been forked, recreate the kernel state. 559 - If we have been forked, recreate the kernel state.
498 - Update the kernel state with all outstanding changes. 560 - Update the kernel state with all outstanding changes.
499 - Update the "event loop time". 561 - Update the "event loop time".
500 - Calculate for how long to block. 562 - Calculate for how long to sleep or block, if at all
563 (active idle watchers, EVLOOP_NONBLOCK or not having
564 any active watchers at all will result in not sleeping).
565 - Sleep if the I/O and timer collect interval say so.
501 - Block the process, waiting for any events. 566 - Block the process, waiting for any events.
502 - Queue all outstanding I/O (fd) events. 567 - Queue all outstanding I/O (fd) events.
503 - Update the "event loop time" and do time jump handling. 568 - Update the "event loop time" and do time jump handling.
504 - Queue all outstanding timers. 569 - Queue all outstanding timers.
505 - Queue all outstanding periodics. 570 - Queue all outstanding periodics.
506 - If no events are pending now, queue all idle watchers. 571 - If no events are pending now, queue all idle watchers.
507 - Queue all check watchers. 572 - Queue all check watchers.
508 - Call all queued watchers in reverse order (i.e. check watchers first). 573 - 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 574 Signals and child watchers are implemented as I/O watchers, and will
510 be handled here by queueing them when their watcher gets executed. 575 be handled here by queueing them when their watcher gets executed.
511 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 576 - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
512 were used, return, otherwise continue with step *. 577 were used, or there are no active watchers, return, otherwise
578 continue with step *.
513 579
514Example: Queue some jobs and then loop until no events are outsanding 580Example: Queue some jobs and then loop until no events are outstanding
515anymore. 581anymore.
516 582
517 ... queue jobs here, make sure they register event watchers as long 583 ... 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..) 584 ... as they still have work to do (even an idle watcher will do..)
519 ev_loop (my_loop, 0); 585 ev_loop (my_loop, 0);
… …
552Example: For some weird reason, unregister the above signal handler again. 618Example: For some weird reason, unregister the above signal handler again.
553 619
554 ev_ref (loop); 620 ev_ref (loop);
555 ev_signal_stop (loop, &exitsig); 621 ev_signal_stop (loop, &exitsig);
556 622
623=item ev_set_io_collect_interval (loop, ev_tstamp interval)
624
625=item ev_set_timeout_collect_interval (loop, ev_tstamp interval)
626
627These advanced functions influence the time that libev will spend waiting
628for events. Both are by default C<0>, meaning that libev will try to
629invoke timer/periodic callbacks and I/O callbacks with minimum latency.
630
631Setting these to a higher value (the C<interval> I<must> be >= C<0>)
632allows libev to delay invocation of I/O and timer/periodic callbacks to
633increase efficiency of loop iterations.
634
635The background is that sometimes your program runs just fast enough to
636handle one (or very few) event(s) per loop iteration. While this makes
637the program responsive, it also wastes a lot of CPU time to poll for new
638events, especially with backends like C<select ()> which have a high
639overhead for the actual polling but can deliver many events at once.
640
641By setting a higher I<io collect interval> you allow libev to spend more
642time collecting I/O events, so you can handle more events per iteration,
643at the cost of increasing latency. Timeouts (both C<ev_periodic> and
644C<ev_timer>) will be not affected. Setting this to a non-null value will
645introduce an additional C<ev_sleep ()> call into most loop iterations.
646
647Likewise, by setting a higher I<timeout collect interval> you allow libev
648to spend more time collecting timeouts, at the expense of increased
649latency (the watcher callback will be called later). C<ev_io> watchers
650will not be affected. Setting this to a non-null value will not introduce
651any overhead in libev.
652
653Many (busy) programs can usually benefit by setting the io collect
654interval to a value near C<0.1> or so, which is often enough for
655interactive servers (of course not for games), likewise for timeouts. It
656usually doesn't make much sense to set it to a lower value than C<0.01>,
657as this approsaches the timing granularity of most systems.
658
557=back 659=back
558 660
559 661
560=head1 ANATOMY OF A WATCHER 662=head1 ANATOMY OF A WATCHER
561 663
… …
886In general you can register as many read and/or write event watchers per 988In 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 989fd 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 990descriptors to non-blocking mode is also usually a good idea (but not
889required if you know what you are doing). 991required if you know what you are doing).
890 992
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 993If 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 994(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
899C<EVBACKEND_POLL>). 995C<EVBACKEND_POLL>).
900 996
901Another thing you have to watch out for is that it is quite easy to 997Another thing you have to watch out for is that it is quite easy to
… …
913such as poll (fortunately in our Xlib example, Xlib already does this on 1009such as poll (fortunately in our Xlib example, Xlib already does this on
914its own, so its quite safe to use). 1010its own, so its quite safe to use).
915 1011
916=head3 The special problem of disappearing file descriptors 1012=head3 The special problem of disappearing file descriptors
917 1013
918Some backends (e.g kqueue, epoll) need to be told about closing a file 1014Some backends (e.g. kqueue, epoll) need to be told about closing a file
919descriptor (either by calling C<close> explicitly or by any other means, 1015descriptor (either by calling C<close> explicitly or by any other means,
920such as C<dup>). The reason is that you register interest in some file 1016such as C<dup>). The reason is that you register interest in some file
921descriptor, but when it goes away, the operating system will silently drop 1017descriptor, but when it goes away, the operating system will silently drop
922this interest. If another file descriptor with the same number then is 1018this interest. If another file descriptor with the same number then is
923registered with libev, there is no efficient way to see that this is, in 1019registered with libev, there is no efficient way to see that this is, in
… …
932 1028
933This is how one would do it normally anyway, the important point is that 1029This is how one would do it normally anyway, the important point is that
934the libev application should not optimise around libev but should leave 1030the libev application should not optimise around libev but should leave
935optimisations to libev. 1031optimisations to libev.
936 1032
1033=head3 The special problem of dup'ed file descriptors
1034
1035Some backends (e.g. epoll), cannot register events for file descriptors,
1036but only events for the underlying file descriptions. That means when you
1037have C<dup ()>'ed file descriptors or weirder constellations, and register
1038events for them, only one file descriptor might actually receive events.
1039
1040There is no workaround possible except not registering events
1041for potentially C<dup ()>'ed file descriptors, or to resort to
1042C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1043
1044=head3 The special problem of fork
1045
1046Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
1047useless behaviour. Libev fully supports fork, but needs to be told about
1048it in the child.
1049
1050To support fork in your programs, you either have to call
1051C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
1052enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1053C<EVBACKEND_POLL>.
1054
1055
1056=head3 Watcher-Specific Functions
937 1057
938=over 4 1058=over 4
939 1059
940=item ev_io_init (ev_io *, callback, int fd, int events) 1060=item ev_io_init (ev_io *, callback, int fd, int events)
941 1061
… …
952=item int events [read-only] 1072=item int events [read-only]
953 1073
954The events being watched. 1074The events being watched.
955 1075
956=back 1076=back
1077
1078=head3 Examples
957 1079
958Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well 1080Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
959readable, but only once. Since it is likely line-buffered, you could 1081readable, but only once. Since it is likely line-buffered, you could
960attempt to read a whole line in the callback. 1082attempt to read a whole line in the callback.
961 1083
… …
994 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 1116 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.);
995 1117
996The callback is guarenteed to be invoked only when its timeout has passed, 1118The callback is guarenteed to be invoked only when its timeout has passed,
997but if multiple timers become ready during the same loop iteration then 1119but if multiple timers become ready during the same loop iteration then
998order of execution is undefined. 1120order of execution is undefined.
1121
1122=head3 Watcher-Specific Functions and Data Members
999 1123
1000=over 4 1124=over 4
1001 1125
1002=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 1126=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1003 1127
… …
1057or C<ev_timer_again> is called and determines the next timeout (if any), 1181or C<ev_timer_again> is called and determines the next timeout (if any),
1058which is also when any modifications are taken into account. 1182which is also when any modifications are taken into account.
1059 1183
1060=back 1184=back
1061 1185
1186=head3 Examples
1187
1062Example: Create a timer that fires after 60 seconds. 1188Example: Create a timer that fires after 60 seconds.
1063 1189
1064 static void 1190 static void
1065 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1191 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1066 { 1192 {
… …
1109 1235
1110As with timers, the callback is guarenteed to be invoked only when the 1236As with timers, the callback is guarenteed to be invoked only when the
1111time (C<at>) has been passed, but if multiple periodic timers become ready 1237time (C<at>) has been passed, but if multiple periodic timers become ready
1112during the same loop iteration then order of execution is undefined. 1238during the same loop iteration then order of execution is undefined.
1113 1239
1240=head3 Watcher-Specific Functions and Data Members
1241
1114=over 4 1242=over 4
1115 1243
1116=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb) 1244=item ev_periodic_init (ev_periodic *, callback, ev_tstamp at, ev_tstamp interval, reschedule_cb)
1117 1245
1118=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb) 1246=item ev_periodic_set (ev_periodic *, ev_tstamp after, ev_tstamp repeat, reschedule_cb)
… …
1214 1342
1215The current reschedule callback, or C<0>, if this functionality is 1343The current reschedule callback, or C<0>, if this functionality is
1216switched off. Can be changed any time, but changes only take effect when 1344switched off. Can be changed any time, but changes only take effect when
1217the periodic timer fires or C<ev_periodic_again> is being called. 1345the periodic timer fires or C<ev_periodic_again> is being called.
1218 1346
1347=item ev_tstamp at [read-only]
1348
1349When active, contains the absolute time that the watcher is supposed to
1350trigger next.
1351
1219=back 1352=back
1353
1354=head3 Examples
1220 1355
1221Example: Call a callback every hour, or, more precisely, whenever the 1356Example: Call a callback every hour, or, more precisely, whenever the
1222system clock is divisible by 3600. The callback invocation times have 1357system clock is divisible by 3600. The callback invocation times have
1223potentially a lot of jittering, but good long-term stability. 1358potentially a lot of jittering, but good long-term stability.
1224 1359
… …
1264with the kernel (thus it coexists with your own signal handlers as long 1399with the kernel (thus it coexists with your own signal handlers as long
1265as you don't register any with libev). Similarly, when the last signal 1400as you don't register any with libev). Similarly, when the last signal
1266watcher for a signal is stopped libev will reset the signal handler to 1401watcher for a signal is stopped libev will reset the signal handler to
1267SIG_DFL (regardless of what it was set to before). 1402SIG_DFL (regardless of what it was set to before).
1268 1403
1404=head3 Watcher-Specific Functions and Data Members
1405
1269=over 4 1406=over 4
1270 1407
1271=item ev_signal_init (ev_signal *, callback, int signum) 1408=item ev_signal_init (ev_signal *, callback, int signum)
1272 1409
1273=item ev_signal_set (ev_signal *, int signum) 1410=item ev_signal_set (ev_signal *, int signum)
… …
1284 1421
1285=head2 C<ev_child> - watch out for process status changes 1422=head2 C<ev_child> - watch out for process status changes
1286 1423
1287Child watchers trigger when your process receives a SIGCHLD in response to 1424Child watchers trigger when your process receives a SIGCHLD in response to
1288some child status changes (most typically when a child of yours dies). 1425some child status changes (most typically when a child of yours dies).
1426
1427=head3 Watcher-Specific Functions and Data Members
1289 1428
1290=over 4 1429=over 4
1291 1430
1292=item ev_child_init (ev_child *, callback, int pid) 1431=item ev_child_init (ev_child *, callback, int pid)
1293 1432
… …
1312 1451
1313The process exit/trace status caused by C<rpid> (see your systems 1452The process exit/trace status caused by C<rpid> (see your systems
1314C<waitpid> and C<sys/wait.h> documentation for details). 1453C<waitpid> and C<sys/wait.h> documentation for details).
1315 1454
1316=back 1455=back
1456
1457=head3 Examples
1317 1458
1318Example: Try to exit cleanly on SIGINT and SIGTERM. 1459Example: Try to exit cleanly on SIGINT and SIGTERM.
1319 1460
1320 static void 1461 static void
1321 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1462 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
… …
1362semantics of C<ev_stat> watchers, which means that libev sometimes needs 1503semantics of C<ev_stat> watchers, which means that libev sometimes needs
1363to fall back to regular polling again even with inotify, but changes are 1504to fall back to regular polling again even with inotify, but changes are
1364usually detected immediately, and if the file exists there will be no 1505usually detected immediately, and if the file exists there will be no
1365polling. 1506polling.
1366 1507
1508=head3 Inotify
1509
1510When C<inotify (7)> support has been compiled into libev (generally only
1511available on Linux) and present at runtime, it will be used to speed up
1512change detection where possible. The inotify descriptor will be created lazily
1513when the first C<ev_stat> watcher is being started.
1514
1515Inotify presense does not change the semantics of C<ev_stat> watchers
1516except that changes might be detected earlier, and in some cases, to avoid
1517making regular C<stat> calls. Even in the presense of inotify support
1518there are many cases where libev has to resort to regular C<stat> polling.
1519
1520(There is no support for kqueue, as apparently it cannot be used to
1521implement this functionality, due to the requirement of having a file
1522descriptor open on the object at all times).
1523
1524=head3 The special problem of stat time resolution
1525
1526The C<stat ()> syscall only supports full-second resolution portably, and
1527even on systems where the resolution is higher, many filesystems still
1528only support whole seconds.
1529
1530That means that, if the time is the only thing that changes, you might
1531miss updates: on the first update, C<ev_stat> detects a change and calls
1532your callback, which does something. When there is another update within
1533the same second, C<ev_stat> will be unable to detect it.
1534
1535The solution to this is to delay acting on a change for a second (or till
1536the next second boundary), using a roughly one-second delay C<ev_timer>
1537(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>
1538is added to work around small timing inconsistencies of some operating
1539systems.
1540
1541=head3 Watcher-Specific Functions and Data Members
1542
1367=over 4 1543=over 4
1368 1544
1369=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) 1545=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
1370 1546
1371=item ev_stat_set (ev_stat *, const char *path, ev_tstamp interval) 1547=item ev_stat_set (ev_stat *, const char *path, ev_tstamp interval)
… …
1406=item const char *path [read-only] 1582=item const char *path [read-only]
1407 1583
1408The filesystem path that is being watched. 1584The filesystem path that is being watched.
1409 1585
1410=back 1586=back
1587
1588=head3 Examples
1411 1589
1412Example: Watch C</etc/passwd> for attribute changes. 1590Example: Watch C</etc/passwd> for attribute changes.
1413 1591
1414 static void 1592 static void
1415 passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) 1593 passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
… …
1428 } 1606 }
1429 1607
1430 ... 1608 ...
1431 ev_stat passwd; 1609 ev_stat passwd;
1432 1610
1433 ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); 1611 ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1434 ev_stat_start (loop, &passwd); 1612 ev_stat_start (loop, &passwd);
1613
1614Example: Like above, but additionally use a one-second delay so we do not
1615miss updates (however, frequent updates will delay processing, too, so
1616one might do the work both on C<ev_stat> callback invocation I<and> on
1617C<ev_timer> callback invocation).
1618
1619 static ev_stat passwd;
1620 static ev_timer timer;
1621
1622 static void
1623 timer_cb (EV_P_ ev_timer *w, int revents)
1624 {
1625 ev_timer_stop (EV_A_ w);
1626
1627 /* now it's one second after the most recent passwd change */
1628 }
1629
1630 static void
1631 stat_cb (EV_P_ ev_stat *w, int revents)
1632 {
1633 /* reset the one-second timer */
1634 ev_timer_again (EV_A_ &timer);
1635 }
1636
1637 ...
1638 ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1639 ev_stat_start (loop, &passwd);
1640 ev_timer_init (&timer, timer_cb, 0., 1.01);
1435 1641
1436 1642
1437=head2 C<ev_idle> - when you've got nothing better to do... 1643=head2 C<ev_idle> - when you've got nothing better to do...
1438 1644
1439Idle watchers trigger events when no other events of the same or higher 1645Idle watchers trigger events when no other events of the same or higher
… …
1453Apart from keeping your process non-blocking (which is a useful 1659Apart from keeping your process non-blocking (which is a useful
1454effect on its own sometimes), idle watchers are a good place to do 1660effect on its own sometimes), idle watchers are a good place to do
1455"pseudo-background processing", or delay processing stuff to after the 1661"pseudo-background processing", or delay processing stuff to after the
1456event loop has handled all outstanding events. 1662event loop has handled all outstanding events.
1457 1663
1664=head3 Watcher-Specific Functions and Data Members
1665
1458=over 4 1666=over 4
1459 1667
1460=item ev_idle_init (ev_signal *, callback) 1668=item ev_idle_init (ev_signal *, callback)
1461 1669
1462Initialises and configures the idle watcher - it has no parameters of any 1670Initialises and configures the idle watcher - it has no parameters of any
1463kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 1671kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1464believe me. 1672believe me.
1465 1673
1466=back 1674=back
1675
1676=head3 Examples
1467 1677
1468Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the 1678Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1469callback, free it. Also, use no error checking, as usual. 1679callback, free it. Also, use no error checking, as usual.
1470 1680
1471 static void 1681 static void
… …
1523 1733
1524It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 1734It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>)
1525priority, to ensure that they are being run before any other watchers 1735priority, to ensure that they are being run before any other watchers
1526after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, 1736after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers,
1527too) should not activate ("feed") events into libev. While libev fully 1737too) should not activate ("feed") events into libev. While libev fully
1528supports this, they will be called before other C<ev_check> watchers did 1738supports this, they will be called before other C<ev_check> watchers
1529their job. As C<ev_check> watchers are often used to embed other event 1739did their job. As C<ev_check> watchers are often used to embed other
1530loops those other event loops might be in an unusable state until their 1740(non-libev) event loops those other event loops might be in an unusable
1531C<ev_check> watcher ran (always remind yourself to coexist peacefully with 1741state until their C<ev_check> watcher ran (always remind yourself to
1532others). 1742coexist peacefully with others).
1743
1744=head3 Watcher-Specific Functions and Data Members
1533 1745
1534=over 4 1746=over 4
1535 1747
1536=item ev_prepare_init (ev_prepare *, callback) 1748=item ev_prepare_init (ev_prepare *, callback)
1537 1749
… …
1540Initialises and configures the prepare or check watcher - they have no 1752Initialises and configures the prepare or check watcher - they have no
1541parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 1753parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1542macros, but using them is utterly, utterly and completely pointless. 1754macros, but using them is utterly, utterly and completely pointless.
1543 1755
1544=back 1756=back
1757
1758=head3 Examples
1545 1759
1546There are a number of principal ways to embed other event loops or modules 1760There are a number of principal ways to embed other event loops or modules
1547into libev. Here are some ideas on how to include libadns into libev 1761into libev. Here are some ideas on how to include libadns into libev
1548(there is a Perl module named C<EV::ADNS> that does this, which you could 1762(there is a Perl module named C<EV::ADNS> that does this, which you could
1549use for an actually working example. Another Perl module named C<EV::Glib> 1763use for an actually working example. Another Perl module named C<EV::Glib>
… …
1718portable one. 1932portable one.
1719 1933
1720So when you want to use this feature you will always have to be prepared 1934So when you want to use this feature you will always have to be prepared
1721that you cannot get an embeddable loop. The recommended way to get around 1935that you cannot get an embeddable loop. The recommended way to get around
1722this is to have a separate variables for your embeddable loop, try to 1936this is to have a separate variables for your embeddable loop, try to
1723create it, and if that fails, use the normal loop for everything: 1937create it, and if that fails, use the normal loop for everything.
1938
1939=head3 Watcher-Specific Functions and Data Members
1940
1941=over 4
1942
1943=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
1944
1945=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
1946
1947Configures the watcher to embed the given loop, which must be
1948embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1949invoked automatically, otherwise it is the responsibility of the callback
1950to invoke it (it will continue to be called until the sweep has been done,
1951if you do not want thta, you need to temporarily stop the embed watcher).
1952
1953=item ev_embed_sweep (loop, ev_embed *)
1954
1955Make a single, non-blocking sweep over the embedded loop. This works
1956similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1957apropriate way for embedded loops.
1958
1959=item struct ev_loop *other [read-only]
1960
1961The embedded event loop.
1962
1963=back
1964
1965=head3 Examples
1966
1967Example: Try to get an embeddable event loop and embed it into the default
1968event loop. If that is not possible, use the default loop. The default
1969loop is stored in C<loop_hi>, while the mebeddable loop is stored in
1970C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be
1971used).
1724 1972
1725 struct ev_loop *loop_hi = ev_default_init (0); 1973 struct ev_loop *loop_hi = ev_default_init (0);
1726 struct ev_loop *loop_lo = 0; 1974 struct ev_loop *loop_lo = 0;
1727 struct ev_embed embed; 1975 struct ev_embed embed;
1728 1976
… …
1739 ev_embed_start (loop_hi, &embed); 1987 ev_embed_start (loop_hi, &embed);
1740 } 1988 }
1741 else 1989 else
1742 loop_lo = loop_hi; 1990 loop_lo = loop_hi;
1743 1991
1744=over 4 1992Example: Check if kqueue is available but not recommended and create
1993a kqueue backend for use with sockets (which usually work with any
1994kqueue implementation). Store the kqueue/socket-only event loop in
1995C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
1745 1996
1746=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 1997 struct ev_loop *loop = ev_default_init (0);
1998 struct ev_loop *loop_socket = 0;
1999 struct ev_embed embed;
2000
2001 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2002 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2003 {
2004 ev_embed_init (&embed, 0, loop_socket);
2005 ev_embed_start (loop, &embed);
2006 }
1747 2007
1748=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 2008 if (!loop_socket)
2009 loop_socket = loop;
1749 2010
1750Configures the watcher to embed the given loop, which must be 2011 // now use loop_socket for all sockets, and loop for everything else
1751embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1752invoked automatically, otherwise it is the responsibility of the callback
1753to invoke it (it will continue to be called until the sweep has been done,
1754if you do not want thta, you need to temporarily stop the embed watcher).
1755
1756=item ev_embed_sweep (loop, ev_embed *)
1757
1758Make a single, non-blocking sweep over the embedded loop. This works
1759similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1760apropriate way for embedded loops.
1761
1762=item struct ev_loop *loop [read-only]
1763
1764The embedded event loop.
1765
1766=back
1767 2012
1768 2013
1769=head2 C<ev_fork> - the audacity to resume the event loop after a fork 2014=head2 C<ev_fork> - the audacity to resume the event loop after a fork
1770 2015
1771Fork watchers are called when a C<fork ()> was detected (usually because 2016Fork watchers are called when a C<fork ()> was detected (usually because
… …
1774event loop blocks next and before C<ev_check> watchers are being called, 2019event loop blocks next and before C<ev_check> watchers are being called,
1775and only in the child after the fork. If whoever good citizen calling 2020and only in the child after the fork. If whoever good citizen calling
1776C<ev_default_fork> cheats and calls it in the wrong process, the fork 2021C<ev_default_fork> cheats and calls it in the wrong process, the fork
1777handlers will be invoked, too, of course. 2022handlers will be invoked, too, of course.
1778 2023
2024=head3 Watcher-Specific Functions and Data Members
2025
1779=over 4 2026=over 4
1780 2027
1781=item ev_fork_init (ev_signal *, callback) 2028=item ev_fork_init (ev_signal *, callback)
1782 2029
1783Initialises and configures the fork watcher - it has no parameters of any 2030Initialises and configures the fork watcher - it has no parameters of any
… …
1999 2246
2000=item w->stop () 2247=item w->stop ()
2001 2248
2002Stops the watcher if it is active. Again, no C<loop> argument. 2249Stops the watcher if it is active. Again, no C<loop> argument.
2003 2250
2004=item w->again () C<ev::timer>, C<ev::periodic> only 2251=item w->again () (C<ev::timer>, C<ev::periodic> only)
2005 2252
2006For C<ev::timer> and C<ev::periodic>, this invokes the corresponding 2253For C<ev::timer> and C<ev::periodic>, this invokes the corresponding
2007C<ev_TYPE_again> function. 2254C<ev_TYPE_again> function.
2008 2255
2009=item w->sweep () C<ev::embed> only 2256=item w->sweep () (C<ev::embed> only)
2010 2257
2011Invokes C<ev_embed_sweep>. 2258Invokes C<ev_embed_sweep>.
2012 2259
2013=item w->update () C<ev::stat> only 2260=item w->update () (C<ev::stat> only)
2014 2261
2015Invokes C<ev_stat_stat>. 2262Invokes C<ev_stat_stat>.
2016 2263
2017=back 2264=back
2018 2265
… …
2038 } 2285 }
2039 2286
2040 2287
2041=head1 MACRO MAGIC 2288=head1 MACRO MAGIC
2042 2289
2043Libev can be compiled with a variety of options, the most fundemantal is 2290Libev can be compiled with a variety of options, the most fundamantal
2044C<EV_MULTIPLICITY>. This option determines whether (most) functions and 2291of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2045callbacks have an initial C<struct ev_loop *> argument. 2292functions and callbacks have an initial C<struct ev_loop *> argument.
2046 2293
2047To make it easier to write programs that cope with either variant, the 2294To make it easier to write programs that cope with either variant, the
2048following macros are defined: 2295following macros are defined:
2049 2296
2050=over 4 2297=over 4
… …
2104Libev can (and often is) directly embedded into host 2351Libev can (and often is) directly embedded into host
2105applications. Examples of applications that embed it include the Deliantra 2352applications. Examples of applications that embed it include the Deliantra
2106Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe) 2353Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
2107and rxvt-unicode. 2354and rxvt-unicode.
2108 2355
2109The goal is to enable you to just copy the neecssary files into your 2356The goal is to enable you to just copy the necessary files into your
2110source directory without having to change even a single line in them, so 2357source directory without having to change even a single line in them, so
2111you can easily upgrade by simply copying (or having a checked-out copy of 2358you can easily upgrade by simply copying (or having a checked-out copy of
2112libev somewhere in your source tree). 2359libev somewhere in your source tree).
2113 2360
2114=head2 FILESETS 2361=head2 FILESETS
… …
2204 2451
2205If defined to be C<1>, libev will try to detect the availability of the 2452If defined to be C<1>, libev will try to detect the availability of the
2206monotonic clock option at both compiletime and runtime. Otherwise no use 2453monotonic clock option at both compiletime and runtime. Otherwise no use
2207of the monotonic clock option will be attempted. If you enable this, you 2454of the monotonic clock option will be attempted. If you enable this, you
2208usually have to link against librt or something similar. Enabling it when 2455usually have to link against librt or something similar. Enabling it when
2209the functionality isn't available is safe, though, althoguh you have 2456the functionality isn't available is safe, though, although you have
2210to make sure you link against any libraries where the C<clock_gettime> 2457to make sure you link against any libraries where the C<clock_gettime>
2211function is hiding in (often F<-lrt>). 2458function is hiding in (often F<-lrt>).
2212 2459
2213=item EV_USE_REALTIME 2460=item EV_USE_REALTIME
2214 2461
2215If defined to be C<1>, libev will try to detect the availability of the 2462If defined to be C<1>, libev will try to detect the availability of the
2216realtime clock option at compiletime (and assume its availability at 2463realtime clock option at compiletime (and assume its availability at
2217runtime if successful). Otherwise no use of the realtime clock option will 2464runtime if successful). Otherwise no use of the realtime clock option will
2218be attempted. This effectively replaces C<gettimeofday> by C<clock_get 2465be attempted. This effectively replaces C<gettimeofday> by C<clock_get
2219(CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries 2466(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
2220in the description of C<EV_USE_MONOTONIC>, though. 2467note about libraries in the description of C<EV_USE_MONOTONIC>, though.
2468
2469=item EV_USE_NANOSLEEP
2470
2471If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2472and will use it for delays. Otherwise it will use C<select ()>.
2221 2473
2222=item EV_USE_SELECT 2474=item EV_USE_SELECT
2223 2475
2224If undefined or defined to be C<1>, libev will compile in support for the 2476If undefined or defined to be C<1>, libev will compile in support for the
2225C<select>(2) backend. No attempt at autodetection will be done: if no 2477C<select>(2) backend. No attempt at autodetection will be done: if no
… …
2243wants osf handles on win32 (this is the case when the select to 2495wants osf handles on win32 (this is the case when the select to
2244be used is the winsock select). This means that it will call 2496be used is the winsock select). This means that it will call
2245C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, 2497C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
2246it is assumed that all these functions actually work on fds, even 2498it is assumed that all these functions actually work on fds, even
2247on win32. Should not be defined on non-win32 platforms. 2499on win32. Should not be defined on non-win32 platforms.
2500
2501=item EV_FD_TO_WIN32_HANDLE
2502
2503If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
2504file descriptors to socket handles. When not defining this symbol (the
2505default), then libev will call C<_get_osfhandle>, which is usually
2506correct. In some cases, programs use their own file descriptor management,
2507in which case they can provide this function to map fds to socket handles.
2248 2508
2249=item EV_USE_POLL 2509=item EV_USE_POLL
2250 2510
2251If defined to be C<1>, libev will compile in support for the C<poll>(2) 2511If defined to be C<1>, libev will compile in support for the C<poll>(2)
2252backend. Otherwise it will be enabled on non-win32 platforms. It 2512backend. Otherwise it will be enabled on non-win32 platforms. It
… …
2289be detected at runtime. 2549be detected at runtime.
2290 2550
2291=item EV_H 2551=item EV_H
2292 2552
2293The name of the F<ev.h> header file used to include it. The default if 2553The name of the F<ev.h> header file used to include it. The default if
2294undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This 2554undefined is C<"ev.h"> in F<event.h> and F<ev.c>. This can be used to
2295can be used to virtually rename the F<ev.h> header file in case of conflicts. 2555virtually rename the F<ev.h> header file in case of conflicts.
2296 2556
2297=item EV_CONFIG_H 2557=item EV_CONFIG_H
2298 2558
2299If C<EV_STANDALONE> isn't C<1>, this variable can be used to override 2559If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
2300F<ev.c>'s idea of where to find the F<config.h> file, similarly to 2560F<ev.c>'s idea of where to find the F<config.h> file, similarly to
2301C<EV_H>, above. 2561C<EV_H>, above.
2302 2562
2303=item EV_EVENT_H 2563=item EV_EVENT_H
2304 2564
2305Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea 2565Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
2306of how the F<event.h> header can be found. 2566of how the F<event.h> header can be found, the dfeault is C<"event.h">.
2307 2567
2308=item EV_PROTOTYPES 2568=item EV_PROTOTYPES
2309 2569
2310If defined to be C<0>, then F<ev.h> will not define any function 2570If defined to be C<0>, then F<ev.h> will not define any function
2311prototypes, but still define all the structs and other symbols. This is 2571prototypes, but still define all the structs and other symbols. This is
… …
2377than enough. If you need to manage thousands of children you might want to 2637than enough. If you need to manage thousands of children you might want to
2378increase this value (I<must> be a power of two). 2638increase this value (I<must> be a power of two).
2379 2639
2380=item EV_INOTIFY_HASHSIZE 2640=item EV_INOTIFY_HASHSIZE
2381 2641
2382C<ev_staz> watchers use a small hash table to distribute workload by 2642C<ev_stat> watchers use a small hash table to distribute workload by
2383inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), 2643inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2384usually more than enough. If you need to manage thousands of C<ev_stat> 2644usually more than enough. If you need to manage thousands of C<ev_stat>
2385watchers you might want to increase this value (I<must> be a power of 2645watchers you might want to increase this value (I<must> be a power of
2386two). 2646two).
2387 2647
… …
2404 2664
2405=item ev_set_cb (ev, cb) 2665=item ev_set_cb (ev, cb)
2406 2666
2407Can be used to change the callback member declaration in each watcher, 2667Can be used to change the callback member declaration in each watcher,
2408and the way callbacks are invoked and set. Must expand to a struct member 2668and the way callbacks are invoked and set. Must expand to a struct member
2409definition and a statement, respectively. See the F<ev.v> header file for 2669definition and a statement, respectively. See the F<ev.h> header file for
2410their default definitions. One possible use for overriding these is to 2670their default definitions. One possible use for overriding these is to
2411avoid the C<struct ev_loop *> as first argument in all cases, or to use 2671avoid the C<struct ev_loop *> as first argument in all cases, or to use
2412method calls instead of plain function calls in C++. 2672method calls instead of plain function calls in C++.
2673
2674=head2 EXPORTED API SYMBOLS
2675
2676If you need to re-export the API (e.g. via a dll) and you need a list of
2677exported symbols, you can use the provided F<Symbol.*> files which list
2678all public symbols, one per line:
2679
2680 Symbols.ev for libev proper
2681 Symbols.event for the libevent emulation
2682
2683This can also be used to rename all public symbols to avoid clashes with
2684multiple versions of libev linked together (which is obviously bad in
2685itself, but sometimes it is inconvinient to avoid this).
2686
2687A sed command like this will create wrapper C<#define>'s that you need to
2688include before including F<ev.h>:
2689
2690 <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
2691
2692This would create a file F<wrap.h> which essentially looks like this:
2693
2694 #define ev_backend myprefix_ev_backend
2695 #define ev_check_start myprefix_ev_check_start
2696 #define ev_check_stop myprefix_ev_check_stop
2697 ...
2413 2698
2414=head2 EXAMPLES 2699=head2 EXAMPLES
2415 2700
2416For a real-world example of a program the includes libev 2701For a real-world example of a program the includes libev
2417verbatim, you can have a look at the EV perl module 2702verbatim, you can have a look at the EV perl module
… …
2458 2743
2459=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) 2744=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2460 2745
2461This means that, when you have a watcher that triggers in one hour and 2746This means that, when you have a watcher that triggers in one hour and
2462there are 100 watchers that would trigger before that then inserting will 2747there are 100 watchers that would trigger before that then inserting will
2463have to skip those 100 watchers. 2748have to skip roughly seven (C<ld 100>) of these watchers.
2464 2749
2465=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) 2750=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
2466 2751
2467That means that for changing a timer costs less than removing/adding them 2752That means that changing a timer costs less than removing/adding them
2468as only the relative motion in the event queue has to be paid for. 2753as only the relative motion in the event queue has to be paid for.
2469 2754
2470=item Starting io/check/prepare/idle/signal/child watchers: O(1) 2755=item Starting io/check/prepare/idle/signal/child watchers: O(1)
2471 2756
2472These just add the watcher into an array or at the head of a list. 2757These just add the watcher into an array or at the head of a list.
2758
2473=item Stopping check/prepare/idle watchers: O(1) 2759=item Stopping check/prepare/idle watchers: O(1)
2474 2760
2475=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) 2761=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2476 2762
2477These watchers are stored in lists then need to be walked to find the 2763These watchers are stored in lists then need to be walked to find the
2478correct watcher to remove. The lists are usually short (you don't usually 2764correct watcher to remove. The lists are usually short (you don't usually
2479have many watchers waiting for the same fd or signal). 2765have many watchers waiting for the same fd or signal).
2480 2766
2481=item Finding the next timer per loop iteration: O(1) 2767=item Finding the next timer in each loop iteration: O(1)
2768
2769By virtue of using a binary heap, the next timer is always found at the
2770beginning of the storage array.
2482 2771
2483=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) 2772=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2484 2773
2485A change means an I/O watcher gets started or stopped, which requires 2774A change means an I/O watcher gets started or stopped, which requires
2486libev to recalculate its status (and possibly tell the kernel). 2775libev to recalculate its status (and possibly tell the kernel, depending
2776on backend and wether C<ev_io_set> was used).
2487 2777
2488=item Activating one watcher: O(1) 2778=item Activating one watcher (putting it into the pending state): O(1)
2489 2779
2490=item Priority handling: O(number_of_priorities) 2780=item Priority handling: O(number_of_priorities)
2491 2781
2492Priorities are implemented by allocating some space for each 2782Priorities are implemented by allocating some space for each
2493priority. When doing priority-based operations, libev usually has to 2783priority. When doing priority-based operations, libev usually has to
2494linearly search all the priorities. 2784linearly search all the priorities, but starting/stopping and activating
2785watchers becomes O(1) w.r.t. prioritiy handling.
2495 2786
2496=back 2787=back
2497 2788
2498 2789
2790=head1 Win32 platform limitations and workarounds
2791
2792Win32 doesn't support any of the standards (e.g. POSIX) that libev
2793requires, and its I/O model is fundamentally incompatible with the POSIX
2794model. Libev still offers limited functionality on this platform in
2795the form of the C<EVBACKEND_SELECT> backend, and only supports socket
2796descriptors. This only applies when using Win32 natively, not when using
2797e.g. cygwin.
2798
2799There is no supported compilation method available on windows except
2800embedding it into other applications.
2801
2802Due to the many, low, and arbitrary limits on the win32 platform and the
2803abysmal performance of winsockets, using a large number of sockets is not
2804recommended (and not reasonable). If your program needs to use more than
2805a hundred or so sockets, then likely it needs to use a totally different
2806implementation for windows, as libev offers the POSIX model, which cannot
2807be implemented efficiently on windows (microsoft monopoly games).
2808
2809=over 4
2810
2811=item The winsocket select function
2812
2813The winsocket C<select> function doesn't follow POSIX in that it requires
2814socket I<handles> and not socket I<file descriptors>. This makes select
2815very inefficient, and also requires a mapping from file descriptors
2816to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,
2817C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor
2818symbols for more info.
2819
2820The configuration for a "naked" win32 using the microsoft runtime
2821libraries and raw winsocket select is:
2822
2823 #define EV_USE_SELECT 1
2824 #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
2825
2826Note that winsockets handling of fd sets is O(n), so you can easily get a
2827complexity in the O(n²) range when using win32.
2828
2829=item Limited number of file descriptors
2830
2831Windows has numerous arbitrary (and low) limits on things. Early versions
2832of winsocket's select only supported waiting for a max. of C<64> handles
2833(probably owning to the fact that all windows kernels can only wait for
2834C<64> things at the same time internally; microsoft recommends spawning a
2835chain of threads and wait for 63 handles and the previous thread in each).
2836
2837Newer versions support more handles, but you need to define C<FD_SETSIZE>
2838to some high number (e.g. C<2048>) before compiling the winsocket select
2839call (which might be in libev or elsewhere, for example, perl does its own
2840select emulation on windows).
2841
2842Another limit is the number of file descriptors in the microsoft runtime
2843libraries, which by default is C<64> (there must be a hidden I<64> fetish
2844or something like this inside microsoft). You can increase this by calling
2845C<_setmaxstdio>, which can increase this limit to C<2048> (another
2846arbitrary limit), but is broken in many versions of the microsoft runtime
2847libraries.
2848
2849This might get you to about C<512> or C<2048> sockets (depending on
2850windows version and/or the phase of the moon). To get more, you need to
2851wrap all I/O functions and provide your own fd management, but the cost of
2852calling select (O(n²)) will likely make this unworkable.
2853
2854=back
2855
2856
2499=head1 AUTHOR 2857=head1 AUTHOR
2500 2858
2501Marc Lehmann <libev@schmorp.de>. 2859Marc Lehmann <libev@schmorp.de>.
2502 2860

Diff Legend

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