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

Comparing libev/ev.pod (file contents):
Revision 1.100 by root, Sat Dec 22 11:49:17 2007 UTC vs.
Revision 1.132 by root, Wed Feb 20 17:45:29 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;
… …
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
… …
260flags. If that is troubling you, check C<ev_backend ()> afterwards). 260flags. If that is troubling you, check C<ev_backend ()> afterwards).
261 261
262If 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
263function. 263function.
264 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
265The flags argument can be used to specify special behaviour or specific 272The flags argument can be used to specify special behaviour or specific
266backends 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>).
267 274
268The following flags are supported: 275The following flags are supported:
269 276
… …
306=item C<EVBACKEND_SELECT> (value 1, portable select backend) 313=item C<EVBACKEND_SELECT> (value 1, portable select backend)
307 314
308This is your standard select(2) backend. Not I<completely> standard, as 315This is your standard select(2) backend. Not I<completely> standard, as
309libev 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,
310but 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
311using 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
312the 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.
313 327
314=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)
315 329
316And this is your standard poll(2) backend. It's more complicated than 330And this is your standard poll(2) backend. It's more complicated
317select, but handles sparse fds better and has no artificial limit on the 331than select, but handles sparse fds better and has no artificial
318number 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
319lot 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.
320 336
321=item C<EVBACKEND_EPOLL> (value 4, Linux) 337=item C<EVBACKEND_EPOLL> (value 4, Linux)
322 338
323For 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,
324but it scales phenomenally better. While poll and select usually scale 340but it scales phenomenally better. While poll and select usually scale
325like O(total_fds) where n is the total number of fds (or the highest fd), 341like O(total_fds) where n is the total number of fds (or the highest fd),
326epoll scales either O(1) or O(active_fds). The epoll design has a number 342epoll scales either O(1) or O(active_fds). The epoll design has a number
327of shortcomings, such as silently dropping events in some hard-to-detect 343of shortcomings, such as silently dropping events in some hard-to-detect
328cases and rewiring a syscall per fd change, no fork support and bad 344cases and rewiring a syscall per fd change, no fork support and bad
329support for dup: 345support for dup.
330 346
331While stopping, setting and starting an I/O watcher in the same iteration 347While stopping, setting and starting an I/O watcher in the same iteration
332will result in some caching, there is still a syscall per such incident 348will result in some caching, there is still a syscall per such incident
333(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
334best to avoid that. Also, C<dup ()>'ed file descriptors might not work 350best to avoid that. Also, C<dup ()>'ed file descriptors might not work
335very well if you register events for both fds. 351very well if you register events for both fds.
336 352
337Please note that epoll sometimes generates spurious notifications, so you 353Please note that epoll sometimes generates spurious notifications, so you
338need 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
339(or space) is available. 355(or space) is available.
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.
340 363
341=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 364=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
342 365
343Kqueue deserves special mention, as at the time of this writing, it 366Kqueue deserves special mention, as at the time of this writing, it
344was broken on all BSDs except NetBSD (usually it doesn't work reliably 367was broken on all BSDs except NetBSD (usually it doesn't work reliably
… …
357course). While stopping, setting and starting an I/O watcher does never 380course). While stopping, setting and starting an I/O watcher does never
358cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to 381cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to
359two event changes per incident, support for C<fork ()> is very bad and it 382two event changes per incident, support for C<fork ()> is very bad and it
360drops fds silently in similarly hard-to-detect cases. 383drops fds silently in similarly hard-to-detect cases.
361 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.
393
362=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) 394=item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8)
363 395
364This 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.
365 400
366=item C<EVBACKEND_PORT> (value 32, Solaris 10) 401=item C<EVBACKEND_PORT> (value 32, Solaris 10)
367 402
368This uses the Solaris 10 event port mechanism. As with everything on Solaris, 403This uses the Solaris 10 event port mechanism. As with everything on Solaris,
369it'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)).
370 405
371Please note that solaris event ports can deliver a lot of spurious 406Please note that solaris event ports can deliver a lot of spurious
372notifications, 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
373blocking when no data (or space) is available. 408blocking when no data (or space) is available.
374 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.
418
375=item C<EVBACKEND_ALL> 419=item C<EVBACKEND_ALL>
376 420
377Try all backends (even potentially broken ones that wouldn't be tried 421Try all backends (even potentially broken ones that wouldn't be tried
378with 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
379C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. 423C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>.
380 424
425It is definitely not recommended to use this flag.
426
381=back 427=back
382 428
383If 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
384backends 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
385specified, most compiled-in backend will be tried, usually in reverse 431specified, all backends in C<ev_recommended_backends ()> will be tried.
386order of their flag values :)
387 432
388The most typical usage is like this: 433The most typical usage is like this:
389 434
390 if (!ev_default_loop (0)) 435 if (!ev_default_loop (0))
391 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 436 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
… …
438Like 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
439earlier call to C<ev_loop_new>. 484earlier call to C<ev_loop_new>.
440 485
441=item ev_default_fork () 486=item ev_default_fork ()
442 487
488This function sets a flag that causes subsequent C<ev_loop> iterations
443This function reinitialises the kernel state for backends that have 489to reinitialise the kernel state for backends that have one. Despite the
444one. Despite the name, you can call it anytime, but it makes most sense 490name, you can call it anytime, but it makes most sense after forking, in
445after forking, in either the parent or child process (or both, but that 491the child process (or both child and parent, but that again makes little
446again makes little sense). 492sense). You I<must> call it in the child before using any of the libev
493functions, and it will only take effect at the next C<ev_loop> iteration.
447 494
448You I<must> call this function in the child process after forking if and 495On the other hand, you only need to call this function in the child
449only if you want to use the event library in both processes. If you just 496process if and only if you want to use the event library in the child. If
450fork+exec, you don't have to call it. 497you just fork+exec, you don't have to call it at all.
451 498
452The function itself is quite fast and it's usually not a problem to call 499The function itself is quite fast and it's usually not a problem to call
453it just in case after a fork. To make this easy, the function will fit in 500it just in case after a fork. To make this easy, the function will fit in
454quite nicely into a call to C<pthread_atfork>: 501quite nicely into a call to C<pthread_atfork>:
455 502
456 pthread_atfork (0, 0, ev_default_fork); 503 pthread_atfork (0, 0, ev_default_fork);
457 504
458At the moment, C<EVBACKEND_SELECT> and C<EVBACKEND_POLL> are safe to use
459without calling this function, so if you force one of those backends you
460do not need to care.
461
462=item ev_loop_fork (loop) 505=item ev_loop_fork (loop)
463 506
464Like C<ev_default_fork>, but acts on an event loop created by 507Like C<ev_default_fork>, but acts on an event loop created by
465C<ev_loop_new>. Yes, you have to call this on every allocated event loop 508C<ev_loop_new>. Yes, you have to call this on every allocated event loop
466after fork, and how you do this is entirely your own problem. 509after fork, and how you do this is entirely your own problem.
510
511=item int ev_is_default_loop (loop)
512
513Returns true when the given loop actually is the default loop, false otherwise.
467 514
468=item unsigned int ev_loop_count (loop) 515=item unsigned int ev_loop_count (loop)
469 516
470Returns the count of loop iterations for the loop, which is identical to 517Returns the count of loop iterations for the loop, which is identical to
471the number of times libev did poll for new events. It starts at C<0> and 518the number of times libev did poll for new events. It starts at C<0> and
… …
516usually a better approach for this kind of thing. 563usually a better approach for this kind of thing.
517 564
518Here are the gory details of what C<ev_loop> does: 565Here are the gory details of what C<ev_loop> does:
519 566
520 - Before the first iteration, call any pending watchers. 567 - Before the first iteration, call any pending watchers.
521 * If there are no active watchers (reference count is zero), return. 568 * If EVFLAG_FORKCHECK was used, check for a fork.
522 - Queue all prepare watchers and then call all outstanding watchers. 569 - If a fork was detected, queue and call all fork watchers.
570 - Queue and call all prepare watchers.
523 - If we have been forked, recreate the kernel state. 571 - If we have been forked, recreate the kernel state.
524 - Update the kernel state with all outstanding changes. 572 - Update the kernel state with all outstanding changes.
525 - Update the "event loop time". 573 - Update the "event loop time".
526 - Calculate for how long to block. 574 - Calculate for how long to sleep or block, if at all
575 (active idle watchers, EVLOOP_NONBLOCK or not having
576 any active watchers at all will result in not sleeping).
577 - Sleep if the I/O and timer collect interval say so.
527 - Block the process, waiting for any events. 578 - Block the process, waiting for any events.
528 - Queue all outstanding I/O (fd) events. 579 - Queue all outstanding I/O (fd) events.
529 - Update the "event loop time" and do time jump handling. 580 - Update the "event loop time" and do time jump handling.
530 - Queue all outstanding timers. 581 - Queue all outstanding timers.
531 - Queue all outstanding periodics. 582 - Queue all outstanding periodics.
532 - If no events are pending now, queue all idle watchers. 583 - If no events are pending now, queue all idle watchers.
533 - Queue all check watchers. 584 - Queue all check watchers.
534 - Call all queued watchers in reverse order (i.e. check watchers first). 585 - Call all queued watchers in reverse order (i.e. check watchers first).
535 Signals and child watchers are implemented as I/O watchers, and will 586 Signals and child watchers are implemented as I/O watchers, and will
536 be handled here by queueing them when their watcher gets executed. 587 be handled here by queueing them when their watcher gets executed.
537 - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK 588 - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
538 were used, return, otherwise continue with step *. 589 were used, or there are no active watchers, return, otherwise
590 continue with step *.
539 591
540Example: Queue some jobs and then loop until no events are outsanding 592Example: Queue some jobs and then loop until no events are outstanding
541anymore. 593anymore.
542 594
543 ... queue jobs here, make sure they register event watchers as long 595 ... queue jobs here, make sure they register event watchers as long
544 ... as they still have work to do (even an idle watcher will do..) 596 ... as they still have work to do (even an idle watcher will do..)
545 ev_loop (my_loop, 0); 597 ev_loop (my_loop, 0);
… …
549 601
550Can be used to make a call to C<ev_loop> return early (but only after it 602Can be used to make a call to C<ev_loop> return early (but only after it
551has processed all outstanding events). The C<how> argument must be either 603has processed all outstanding events). The C<how> argument must be either
552C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or 604C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or
553C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. 605C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return.
606
607This "unloop state" will be cleared when entering C<ev_loop> again.
554 608
555=item ev_ref (loop) 609=item ev_ref (loop)
556 610
557=item ev_unref (loop) 611=item ev_unref (loop)
558 612
… …
563returning, ev_unref() after starting, and ev_ref() before stopping it. For 617returning, ev_unref() after starting, and ev_ref() before stopping it. For
564example, libev itself uses this for its internal signal pipe: It is not 618example, libev itself uses this for its internal signal pipe: It is not
565visible to the libev user and should not keep C<ev_loop> from exiting if 619visible to the libev user and should not keep C<ev_loop> from exiting if
566no event watchers registered by it are active. It is also an excellent 620no event watchers registered by it are active. It is also an excellent
567way to do this for generic recurring timers or from within third-party 621way to do this for generic recurring timers or from within third-party
568libraries. Just remember to I<unref after start> and I<ref before stop>. 622libraries. Just remember to I<unref after start> and I<ref before stop>
623(but only if the watcher wasn't active before, or was active before,
624respectively).
569 625
570Example: Create a signal watcher, but keep it from keeping C<ev_loop> 626Example: Create a signal watcher, but keep it from keeping C<ev_loop>
571running when nothing else is active. 627running when nothing else is active.
572 628
573 struct ev_signal exitsig; 629 struct ev_signal exitsig;
… …
599overhead for the actual polling but can deliver many events at once. 655overhead for the actual polling but can deliver many events at once.
600 656
601By setting a higher I<io collect interval> you allow libev to spend more 657By setting a higher I<io collect interval> you allow libev to spend more
602time collecting I/O events, so you can handle more events per iteration, 658time collecting I/O events, so you can handle more events per iteration,
603at the cost of increasing latency. Timeouts (both C<ev_periodic> and 659at the cost of increasing latency. Timeouts (both C<ev_periodic> and
604C<ev_timer>) will be not affected. Setting this to a non-null bvalue will 660C<ev_timer>) will be not affected. Setting this to a non-null value will
605introduce an additional C<ev_sleep ()> call into most loop iterations. 661introduce an additional C<ev_sleep ()> call into most loop iterations.
606 662
607Likewise, by setting a higher I<timeout collect interval> you allow libev 663Likewise, by setting a higher I<timeout collect interval> you allow libev
608to spend more time collecting timeouts, at the expense of increased 664to spend more time collecting timeouts, at the expense of increased
609latency (the watcher callback will be called later). C<ev_io> watchers 665latency (the watcher callback will be called later). C<ev_io> watchers
… …
721 777
722=item C<EV_FORK> 778=item C<EV_FORK>
723 779
724The event loop has been resumed in the child process after fork (see 780The event loop has been resumed in the child process after fork (see
725C<ev_fork>). 781C<ev_fork>).
782
783=item C<EV_ASYNC>
784
785The given async watcher has been asynchronously notified (see C<ev_async>).
726 786
727=item C<EV_ERROR> 787=item C<EV_ERROR>
728 788
729An unspecified error has occured, the watcher has been stopped. This might 789An unspecified error has occured, the watcher has been stopped. This might
730happen because the watcher could not be properly started because libev 790happen because the watcher could not be properly started because libev
… …
948In general you can register as many read and/or write event watchers per 1008In general you can register as many read and/or write event watchers per
949fd as you want (as long as you don't confuse yourself). Setting all file 1009fd as you want (as long as you don't confuse yourself). Setting all file
950descriptors to non-blocking mode is also usually a good idea (but not 1010descriptors to non-blocking mode is also usually a good idea (but not
951required if you know what you are doing). 1011required if you know what you are doing).
952 1012
953You have to be careful with dup'ed file descriptors, though. Some backends
954(the linux epoll backend is a notable example) cannot handle dup'ed file
955descriptors correctly if you register interest in two or more fds pointing
956to the same underlying file/socket/etc. description (that is, they share
957the same underlying "file open").
958
959If you must do this, then force the use of a known-to-be-good backend 1013If you must do this, then force the use of a known-to-be-good backend
960(at the time of this writing, this includes only C<EVBACKEND_SELECT> and 1014(at the time of this writing, this includes only C<EVBACKEND_SELECT> and
961C<EVBACKEND_POLL>). 1015C<EVBACKEND_POLL>).
962 1016
963Another thing you have to watch out for is that it is quite easy to 1017Another thing you have to watch out for is that it is quite easy to
… …
997optimisations to libev. 1051optimisations to libev.
998 1052
999=head3 The special problem of dup'ed file descriptors 1053=head3 The special problem of dup'ed file descriptors
1000 1054
1001Some backends (e.g. epoll), cannot register events for file descriptors, 1055Some backends (e.g. epoll), cannot register events for file descriptors,
1002but only events for the underlying file descriptions. That menas when you 1056but only events for the underlying file descriptions. That means when you
1003have C<dup ()>'ed file descriptors and register events for them, only one 1057have C<dup ()>'ed file descriptors or weirder constellations, and register
1004file descriptor might actually receive events. 1058events for them, only one file descriptor might actually receive events.
1005 1059
1006There is no workaorund possible except not registering events 1060There is no workaround possible except not registering events
1007for potentially C<dup ()>'ed file descriptors or to resort to 1061for potentially C<dup ()>'ed file descriptors, or to resort to
1008C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. 1062C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>.
1009 1063
1010=head3 The special problem of fork 1064=head3 The special problem of fork
1011 1065
1012Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit 1066Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit
… …
1038=item int events [read-only] 1092=item int events [read-only]
1039 1093
1040The events being watched. 1094The events being watched.
1041 1095
1042=back 1096=back
1097
1098=head3 Examples
1043 1099
1044Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well 1100Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well
1045readable, but only once. Since it is likely line-buffered, you could 1101readable, but only once. Since it is likely line-buffered, you could
1046attempt to read a whole line in the callback. 1102attempt to read a whole line in the callback.
1047 1103
… …
1100configure a timer to trigger every 10 seconds, then it will trigger at 1156configure a timer to trigger every 10 seconds, then it will trigger at
1101exactly 10 second intervals. If, however, your program cannot keep up with 1157exactly 10 second intervals. If, however, your program cannot keep up with
1102the timer (because it takes longer than those 10 seconds to do stuff) the 1158the timer (because it takes longer than those 10 seconds to do stuff) the
1103timer will not fire more than once per event loop iteration. 1159timer will not fire more than once per event loop iteration.
1104 1160
1105=item ev_timer_again (loop) 1161=item ev_timer_again (loop, ev_timer *)
1106 1162
1107This will act as if the timer timed out and restart it again if it is 1163This will act as if the timer timed out and restart it again if it is
1108repeating. The exact semantics are: 1164repeating. The exact semantics are:
1109 1165
1110If the timer is pending, its pending status is cleared. 1166If the timer is pending, its pending status is cleared.
… …
1145or C<ev_timer_again> is called and determines the next timeout (if any), 1201or C<ev_timer_again> is called and determines the next timeout (if any),
1146which is also when any modifications are taken into account. 1202which is also when any modifications are taken into account.
1147 1203
1148=back 1204=back
1149 1205
1206=head3 Examples
1207
1150Example: Create a timer that fires after 60 seconds. 1208Example: Create a timer that fires after 60 seconds.
1151 1209
1152 static void 1210 static void
1153 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) 1211 one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
1154 { 1212 {
… …
1217In this configuration the watcher triggers an event at the wallclock time 1275In this configuration the watcher triggers an event at the wallclock time
1218C<at> and doesn't repeat. It will not adjust when a time jump occurs, 1276C<at> and doesn't repeat. It will not adjust when a time jump occurs,
1219that is, if it is to be run at January 1st 2011 then it will run when the 1277that is, if it is to be run at January 1st 2011 then it will run when the
1220system time reaches or surpasses this time. 1278system time reaches or surpasses this time.
1221 1279
1222=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 1280=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1223 1281
1224In this mode the watcher will always be scheduled to time out at the next 1282In this mode the watcher will always be scheduled to time out at the next
1225C<at + N * interval> time (for some integer N, which can also be negative) 1283C<at + N * interval> time (for some integer N, which can also be negative)
1226and then repeat, regardless of any time jumps. 1284and then repeat, regardless of any time jumps.
1227 1285
… …
1310 1368
1311When active, contains the absolute time that the watcher is supposed to 1369When active, contains the absolute time that the watcher is supposed to
1312trigger next. 1370trigger next.
1313 1371
1314=back 1372=back
1373
1374=head3 Examples
1315 1375
1316Example: Call a callback every hour, or, more precisely, whenever the 1376Example: Call a callback every hour, or, more precisely, whenever the
1317system clock is divisible by 3600. The callback invocation times have 1377system clock is divisible by 3600. The callback invocation times have
1318potentially a lot of jittering, but good long-term stability. 1378potentially a lot of jittering, but good long-term stability.
1319 1379
… …
1376 1436
1377The signal the watcher watches out for. 1437The signal the watcher watches out for.
1378 1438
1379=back 1439=back
1380 1440
1441=head3 Examples
1442
1443Example: Try to exit cleanly on SIGINT and SIGTERM.
1444
1445 static void
1446 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1447 {
1448 ev_unloop (loop, EVUNLOOP_ALL);
1449 }
1450
1451 struct ev_signal signal_watcher;
1452 ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1453 ev_signal_start (loop, &sigint_cb);
1454
1381 1455
1382=head2 C<ev_child> - watch out for process status changes 1456=head2 C<ev_child> - watch out for process status changes
1383 1457
1384Child watchers trigger when your process receives a SIGCHLD in response to 1458Child watchers trigger when your process receives a SIGCHLD in response to
1385some child status changes (most typically when a child of yours dies). 1459some child status changes (most typically when a child of yours dies).
1386 1460
1387=head3 Watcher-Specific Functions and Data Members 1461=head3 Watcher-Specific Functions and Data Members
1388 1462
1389=over 4 1463=over 4
1390 1464
1391=item ev_child_init (ev_child *, callback, int pid) 1465=item ev_child_init (ev_child *, callback, int pid, int trace)
1392 1466
1393=item ev_child_set (ev_child *, int pid) 1467=item ev_child_set (ev_child *, int pid, int trace)
1394 1468
1395Configures the watcher to wait for status changes of process C<pid> (or 1469Configures the watcher to wait for status changes of process C<pid> (or
1396I<any> process if C<pid> is specified as C<0>). The callback can look 1470I<any> process if C<pid> is specified as C<0>). The callback can look
1397at the C<rstatus> member of the C<ev_child> watcher structure to see 1471at the C<rstatus> member of the C<ev_child> watcher structure to see
1398the status word (use the macros from C<sys/wait.h> and see your systems 1472the status word (use the macros from C<sys/wait.h> and see your systems
1399C<waitpid> documentation). The C<rpid> member contains the pid of the 1473C<waitpid> documentation). The C<rpid> member contains the pid of the
1400process causing the status change. 1474process causing the status change. C<trace> must be either C<0> (only
1475activate the watcher when the process terminates) or C<1> (additionally
1476activate the watcher when the process is stopped or continued).
1401 1477
1402=item int pid [read-only] 1478=item int pid [read-only]
1403 1479
1404The process id this watcher watches out for, or C<0>, meaning any process id. 1480The process id this watcher watches out for, or C<0>, meaning any process id.
1405 1481
… …
1411 1487
1412The process exit/trace status caused by C<rpid> (see your systems 1488The process exit/trace status caused by C<rpid> (see your systems
1413C<waitpid> and C<sys/wait.h> documentation for details). 1489C<waitpid> and C<sys/wait.h> documentation for details).
1414 1490
1415=back 1491=back
1416
1417Example: Try to exit cleanly on SIGINT and SIGTERM.
1418
1419 static void
1420 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1421 {
1422 ev_unloop (loop, EVUNLOOP_ALL);
1423 }
1424
1425 struct ev_signal signal_watcher;
1426 ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1427 ev_signal_start (loop, &sigint_cb);
1428 1492
1429 1493
1430=head2 C<ev_stat> - did the file attributes just change? 1494=head2 C<ev_stat> - did the file attributes just change?
1431 1495
1432This watches a filesystem path for attribute changes. That is, it calls 1496This watches a filesystem path for attribute changes. That is, it calls
… …
1461semantics of C<ev_stat> watchers, which means that libev sometimes needs 1525semantics of C<ev_stat> watchers, which means that libev sometimes needs
1462to fall back to regular polling again even with inotify, but changes are 1526to fall back to regular polling again even with inotify, but changes are
1463usually detected immediately, and if the file exists there will be no 1527usually detected immediately, and if the file exists there will be no
1464polling. 1528polling.
1465 1529
1530=head3 Inotify
1531
1532When C<inotify (7)> support has been compiled into libev (generally only
1533available on Linux) and present at runtime, it will be used to speed up
1534change detection where possible. The inotify descriptor will be created lazily
1535when the first C<ev_stat> watcher is being started.
1536
1537Inotify presense does not change the semantics of C<ev_stat> watchers
1538except that changes might be detected earlier, and in some cases, to avoid
1539making regular C<stat> calls. Even in the presense of inotify support
1540there are many cases where libev has to resort to regular C<stat> polling.
1541
1542(There is no support for kqueue, as apparently it cannot be used to
1543implement this functionality, due to the requirement of having a file
1544descriptor open on the object at all times).
1545
1546=head3 The special problem of stat time resolution
1547
1548The C<stat ()> syscall only supports full-second resolution portably, and
1549even on systems where the resolution is higher, many filesystems still
1550only support whole seconds.
1551
1552That means that, if the time is the only thing that changes, you might
1553miss updates: on the first update, C<ev_stat> detects a change and calls
1554your callback, which does something. When there is another update within
1555the same second, C<ev_stat> will be unable to detect it.
1556
1557The solution to this is to delay acting on a change for a second (or till
1558the next second boundary), using a roughly one-second delay C<ev_timer>
1559(C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01>
1560is added to work around small timing inconsistencies of some operating
1561systems.
1562
1466=head3 Watcher-Specific Functions and Data Members 1563=head3 Watcher-Specific Functions and Data Members
1467 1564
1468=over 4 1565=over 4
1469 1566
1470=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) 1567=item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval)
… …
1479 1576
1480The callback will be receive C<EV_STAT> when a change was detected, 1577The callback will be receive C<EV_STAT> when a change was detected,
1481relative to the attributes at the time the watcher was started (or the 1578relative to the attributes at the time the watcher was started (or the
1482last change was detected). 1579last change was detected).
1483 1580
1484=item ev_stat_stat (ev_stat *) 1581=item ev_stat_stat (loop, ev_stat *)
1485 1582
1486Updates the stat buffer immediately with new values. If you change the 1583Updates the stat buffer immediately with new values. If you change the
1487watched path in your callback, you could call this fucntion to avoid 1584watched path in your callback, you could call this fucntion to avoid
1488detecting this change (while introducing a race condition). Can also be 1585detecting this change (while introducing a race condition). Can also be
1489useful simply to find out the new values. 1586useful simply to find out the new values.
… …
1507=item const char *path [read-only] 1604=item const char *path [read-only]
1508 1605
1509The filesystem path that is being watched. 1606The filesystem path that is being watched.
1510 1607
1511=back 1608=back
1609
1610=head3 Examples
1512 1611
1513Example: Watch C</etc/passwd> for attribute changes. 1612Example: Watch C</etc/passwd> for attribute changes.
1514 1613
1515 static void 1614 static void
1516 passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) 1615 passwd_cb (struct ev_loop *loop, ev_stat *w, int revents)
… …
1529 } 1628 }
1530 1629
1531 ... 1630 ...
1532 ev_stat passwd; 1631 ev_stat passwd;
1533 1632
1534 ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); 1633 ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.);
1535 ev_stat_start (loop, &passwd); 1634 ev_stat_start (loop, &passwd);
1635
1636Example: Like above, but additionally use a one-second delay so we do not
1637miss updates (however, frequent updates will delay processing, too, so
1638one might do the work both on C<ev_stat> callback invocation I<and> on
1639C<ev_timer> callback invocation).
1640
1641 static ev_stat passwd;
1642 static ev_timer timer;
1643
1644 static void
1645 timer_cb (EV_P_ ev_timer *w, int revents)
1646 {
1647 ev_timer_stop (EV_A_ w);
1648
1649 /* now it's one second after the most recent passwd change */
1650 }
1651
1652 static void
1653 stat_cb (EV_P_ ev_stat *w, int revents)
1654 {
1655 /* reset the one-second timer */
1656 ev_timer_again (EV_A_ &timer);
1657 }
1658
1659 ...
1660 ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.);
1661 ev_stat_start (loop, &passwd);
1662 ev_timer_init (&timer, timer_cb, 0., 1.01);
1536 1663
1537 1664
1538=head2 C<ev_idle> - when you've got nothing better to do... 1665=head2 C<ev_idle> - when you've got nothing better to do...
1539 1666
1540Idle watchers trigger events when no other events of the same or higher 1667Idle watchers trigger events when no other events of the same or higher
… …
1566kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, 1693kind. There is a C<ev_idle_set> macro, but using it is utterly pointless,
1567believe me. 1694believe me.
1568 1695
1569=back 1696=back
1570 1697
1698=head3 Examples
1699
1571Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the 1700Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the
1572callback, free it. Also, use no error checking, as usual. 1701callback, free it. Also, use no error checking, as usual.
1573 1702
1574 static void 1703 static void
1575 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 1704 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1576 { 1705 {
1577 free (w); 1706 free (w);
1578 // now do something you wanted to do when the program has 1707 // now do something you wanted to do when the program has
1579 // no longer asnything immediate to do. 1708 // no longer anything immediate to do.
1580 } 1709 }
1581 1710
1582 struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); 1711 struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1583 ev_idle_init (idle_watcher, idle_cb); 1712 ev_idle_init (idle_watcher, idle_cb);
1584 ev_idle_start (loop, idle_cb); 1713 ev_idle_start (loop, idle_cb);
… …
1646parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> 1775parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set>
1647macros, but using them is utterly, utterly and completely pointless. 1776macros, but using them is utterly, utterly and completely pointless.
1648 1777
1649=back 1778=back
1650 1779
1780=head3 Examples
1781
1651There are a number of principal ways to embed other event loops or modules 1782There are a number of principal ways to embed other event loops or modules
1652into libev. Here are some ideas on how to include libadns into libev 1783into libev. Here are some ideas on how to include libadns into libev
1653(there is a Perl module named C<EV::ADNS> that does this, which you could 1784(there is a Perl module named C<EV::ADNS> that does this, which you could
1654use for an actually working example. Another Perl module named C<EV::Glib> 1785use for an actually working example. Another Perl module named C<EV::Glib>
1655embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV 1786embeds a Glib main context into libev, and finally, C<Glib::EV> embeds EV
… …
1823portable one. 1954portable one.
1824 1955
1825So when you want to use this feature you will always have to be prepared 1956So when you want to use this feature you will always have to be prepared
1826that you cannot get an embeddable loop. The recommended way to get around 1957that you cannot get an embeddable loop. The recommended way to get around
1827this is to have a separate variables for your embeddable loop, try to 1958this is to have a separate variables for your embeddable loop, try to
1828create it, and if that fails, use the normal loop for everything: 1959create it, and if that fails, use the normal loop for everything.
1960
1961=head3 Watcher-Specific Functions and Data Members
1962
1963=over 4
1964
1965=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
1966
1967=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)
1968
1969Configures the watcher to embed the given loop, which must be
1970embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1971invoked automatically, otherwise it is the responsibility of the callback
1972to invoke it (it will continue to be called until the sweep has been done,
1973if you do not want thta, you need to temporarily stop the embed watcher).
1974
1975=item ev_embed_sweep (loop, ev_embed *)
1976
1977Make a single, non-blocking sweep over the embedded loop. This works
1978similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1979apropriate way for embedded loops.
1980
1981=item struct ev_loop *other [read-only]
1982
1983The embedded event loop.
1984
1985=back
1986
1987=head3 Examples
1988
1989Example: Try to get an embeddable event loop and embed it into the default
1990event loop. If that is not possible, use the default loop. The default
1991loop is stored in C<loop_hi>, while the mebeddable loop is stored in
1992C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be
1993used).
1829 1994
1830 struct ev_loop *loop_hi = ev_default_init (0); 1995 struct ev_loop *loop_hi = ev_default_init (0);
1831 struct ev_loop *loop_lo = 0; 1996 struct ev_loop *loop_lo = 0;
1832 struct ev_embed embed; 1997 struct ev_embed embed;
1833 1998
… …
1844 ev_embed_start (loop_hi, &embed); 2009 ev_embed_start (loop_hi, &embed);
1845 } 2010 }
1846 else 2011 else
1847 loop_lo = loop_hi; 2012 loop_lo = loop_hi;
1848 2013
1849=head3 Watcher-Specific Functions and Data Members 2014Example: Check if kqueue is available but not recommended and create
2015a kqueue backend for use with sockets (which usually work with any
2016kqueue implementation). Store the kqueue/socket-only event loop in
2017C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
1850 2018
1851=over 4 2019 struct ev_loop *loop = ev_default_init (0);
2020 struct ev_loop *loop_socket = 0;
2021 struct ev_embed embed;
2022
2023 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
2024 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
2025 {
2026 ev_embed_init (&embed, 0, loop_socket);
2027 ev_embed_start (loop, &embed);
2028 }
1852 2029
1853=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 2030 if (!loop_socket)
2031 loop_socket = loop;
1854 2032
1855=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 2033 // now use loop_socket for all sockets, and loop for everything else
1856
1857Configures the watcher to embed the given loop, which must be
1858embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
1859invoked automatically, otherwise it is the responsibility of the callback
1860to invoke it (it will continue to be called until the sweep has been done,
1861if you do not want thta, you need to temporarily stop the embed watcher).
1862
1863=item ev_embed_sweep (loop, ev_embed *)
1864
1865Make a single, non-blocking sweep over the embedded loop. This works
1866similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1867apropriate way for embedded loops.
1868
1869=item struct ev_loop *other [read-only]
1870
1871The embedded event loop.
1872
1873=back
1874 2034
1875 2035
1876=head2 C<ev_fork> - the audacity to resume the event loop after a fork 2036=head2 C<ev_fork> - the audacity to resume the event loop after a fork
1877 2037
1878Fork watchers are called when a C<fork ()> was detected (usually because 2038Fork watchers are called when a C<fork ()> was detected (usually because
… …
1894believe me. 2054believe me.
1895 2055
1896=back 2056=back
1897 2057
1898 2058
2059=head2 C<ev_async> - how to wake up another event loop
2060
2061In general, you cannot use an C<ev_loop> from multiple threads or other
2062asynchronous sources such as signal handlers (as opposed to multiple event
2063loops - those are of course safe to use in different threads).
2064
2065Sometimes, however, you need to wake up another event loop you do not
2066control, for example because it belongs to another thread. This is what
2067C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you
2068can signal it by calling C<ev_async_send>, which is thread- and signal
2069safe.
2070
2071This functionality is very similar to C<ev_signal> watchers, as signals,
2072too, are asynchronous in nature, and signals, too, will be compressed
2073(i.e. the number of callback invocations may be less than the number of
2074C<ev_async_sent> calls).
2075
2076Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
2077just the default loop.
2078
2079=head3 Queueing
2080
2081C<ev_async> does not support queueing of data in any way. The reason
2082is that the author does not know of a simple (or any) algorithm for a
2083multiple-writer-single-reader queue that works in all cases and doesn't
2084need elaborate support such as pthreads.
2085
2086That means that if you want to queue data, you have to provide your own
2087queue. But at least I can tell you would implement locking around your
2088queue:
2089
2090=over 4
2091
2092=item queueing from a signal handler context
2093
2094To implement race-free queueing, you simply add to the queue in the signal
2095handler but you block the signal handler in the watcher callback. Here is an example that does that for
2096some fictitiuous SIGUSR1 handler:
2097
2098 static ev_async mysig;
2099
2100 static void
2101 sigusr1_handler (void)
2102 {
2103 sometype data;
2104
2105 // no locking etc.
2106 queue_put (data);
2107 ev_async_send (DEFAULT_ &mysig);
2108 }
2109
2110 static void
2111 mysig_cb (EV_P_ ev_async *w, int revents)
2112 {
2113 sometype data;
2114 sigset_t block, prev;
2115
2116 sigemptyset (&block);
2117 sigaddset (&block, SIGUSR1);
2118 sigprocmask (SIG_BLOCK, &block, &prev);
2119
2120 while (queue_get (&data))
2121 process (data);
2122
2123 if (sigismember (&prev, SIGUSR1)
2124 sigprocmask (SIG_UNBLOCK, &block, 0);
2125 }
2126
2127(Note: pthreads in theory requires you to use C<pthread_setmask>
2128instead of C<sigprocmask> when you use threads, but libev doesn't do it
2129either...).
2130
2131=item queueing from a thread context
2132
2133The strategy for threads is different, as you cannot (easily) block
2134threads but you can easily preempt them, so to queue safely you need to
2135employ a traditional mutex lock, such as in this pthread example:
2136
2137 static ev_async mysig;
2138 static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
2139
2140 static void
2141 otherthread (void)
2142 {
2143 // only need to lock the actual queueing operation
2144 pthread_mutex_lock (&mymutex);
2145 queue_put (data);
2146 pthread_mutex_unlock (&mymutex);
2147
2148 ev_async_send (DEFAULT_ &mysig);
2149 }
2150
2151 static void
2152 mysig_cb (EV_P_ ev_async *w, int revents)
2153 {
2154 pthread_mutex_lock (&mymutex);
2155
2156 while (queue_get (&data))
2157 process (data);
2158
2159 pthread_mutex_unlock (&mymutex);
2160 }
2161
2162=back
2163
2164
2165=head3 Watcher-Specific Functions and Data Members
2166
2167=over 4
2168
2169=item ev_async_init (ev_async *, callback)
2170
2171Initialises and configures the async watcher - it has no parameters of any
2172kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,
2173believe me.
2174
2175=item ev_async_send (loop, ev_async *)
2176
2177Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2178an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2179C<ev_feed_event>, this call is safe to do in other threads, signal or
2180similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding
2181section below on what exactly this means).
2182
2183This call incurs the overhead of a syscall only once per loop iteration,
2184so while the overhead might be noticable, it doesn't apply to repeated
2185calls to C<ev_async_send>.
2186
2187=back
2188
2189
1899=head1 OTHER FUNCTIONS 2190=head1 OTHER FUNCTIONS
1900 2191
1901There are some other functions of possible interest. Described. Here. Now. 2192There are some other functions of possible interest. Described. Here. Now.
1902 2193
1903=over 4 2194=over 4
… …
2130Example: Define a class with an IO and idle watcher, start one of them in 2421Example: Define a class with an IO and idle watcher, start one of them in
2131the constructor. 2422the constructor.
2132 2423
2133 class myclass 2424 class myclass
2134 { 2425 {
2135 ev_io io; void io_cb (ev::io &w, int revents); 2426 ev::io io; void io_cb (ev::io &w, int revents);
2136 ev_idle idle void idle_cb (ev::idle &w, int revents); 2427 ev:idle idle void idle_cb (ev::idle &w, int revents);
2137 2428
2138 myclass (); 2429 myclass (int fd)
2139 }
2140
2141 myclass::myclass (int fd)
2142 { 2430 {
2143 io .set <myclass, &myclass::io_cb > (this); 2431 io .set <myclass, &myclass::io_cb > (this);
2144 idle.set <myclass, &myclass::idle_cb> (this); 2432 idle.set <myclass, &myclass::idle_cb> (this);
2145 2433
2146 io.start (fd, ev::READ); 2434 io.start (fd, ev::READ);
2435 }
2147 } 2436 };
2148 2437
2149 2438
2150=head1 MACRO MAGIC 2439=head1 MACRO MAGIC
2151 2440
2152Libev can be compiled with a variety of options, the most fundamantal 2441Libev can be compiled with a variety of options, the most fundamantal
… …
2357wants osf handles on win32 (this is the case when the select to 2646wants osf handles on win32 (this is the case when the select to
2358be used is the winsock select). This means that it will call 2647be used is the winsock select). This means that it will call
2359C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, 2648C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
2360it is assumed that all these functions actually work on fds, even 2649it is assumed that all these functions actually work on fds, even
2361on win32. Should not be defined on non-win32 platforms. 2650on win32. Should not be defined on non-win32 platforms.
2651
2652=item EV_FD_TO_WIN32_HANDLE
2653
2654If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
2655file descriptors to socket handles. When not defining this symbol (the
2656default), then libev will call C<_get_osfhandle>, which is usually
2657correct. In some cases, programs use their own file descriptor management,
2658in which case they can provide this function to map fds to socket handles.
2362 2659
2363=item EV_USE_POLL 2660=item EV_USE_POLL
2364 2661
2365If defined to be C<1>, libev will compile in support for the C<poll>(2) 2662If defined to be C<1>, libev will compile in support for the C<poll>(2)
2366backend. Otherwise it will be enabled on non-win32 platforms. It 2663backend. Otherwise it will be enabled on non-win32 platforms. It
… …
2400 2697
2401If defined to be C<1>, libev will compile in support for the Linux inotify 2698If defined to be C<1>, libev will compile in support for the Linux inotify
2402interface to speed up C<ev_stat> watchers. Its actual availability will 2699interface to speed up C<ev_stat> watchers. Its actual availability will
2403be detected at runtime. 2700be detected at runtime.
2404 2701
2702=item EV_ATOMIC_T
2703
2704Libev requires an integer type (suitable for storing C<0> or C<1>) whose
2705access is atomic with respect to other threads or signal contexts. No such
2706type is easily found in the C language, so you can provide your own type
2707that you know is safe for your purposes. It is used both for signal handler "locking"
2708as well as for signal and thread safety in C<ev_async> watchers.
2709
2710In the absense of this define, libev will use C<sig_atomic_t volatile>
2711(from F<signal.h>), which is usually good enough on most platforms.
2712
2405=item EV_H 2713=item EV_H
2406 2714
2407The name of the F<ev.h> header file used to include it. The default if 2715The name of the F<ev.h> header file used to include it. The default if
2408undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This 2716undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
2409can be used to virtually rename the F<ev.h> header file in case of conflicts. 2717used to virtually rename the F<ev.h> header file in case of conflicts.
2410 2718
2411=item EV_CONFIG_H 2719=item EV_CONFIG_H
2412 2720
2413If C<EV_STANDALONE> isn't C<1>, this variable can be used to override 2721If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
2414F<ev.c>'s idea of where to find the F<config.h> file, similarly to 2722F<ev.c>'s idea of where to find the F<config.h> file, similarly to
2415C<EV_H>, above. 2723C<EV_H>, above.
2416 2724
2417=item EV_EVENT_H 2725=item EV_EVENT_H
2418 2726
2419Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea 2727Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
2420of how the F<event.h> header can be found. 2728of how the F<event.h> header can be found, the default is C<"event.h">.
2421 2729
2422=item EV_PROTOTYPES 2730=item EV_PROTOTYPES
2423 2731
2424If defined to be C<0>, then F<ev.h> will not define any function 2732If defined to be C<0>, then F<ev.h> will not define any function
2425prototypes, but still define all the structs and other symbols. This is 2733prototypes, but still define all the structs and other symbols. This is
… …
2476=item EV_FORK_ENABLE 2784=item EV_FORK_ENABLE
2477 2785
2478If undefined or defined to be C<1>, then fork watchers are supported. If 2786If undefined or defined to be C<1>, then fork watchers are supported. If
2479defined to be C<0>, then they are not. 2787defined to be C<0>, then they are not.
2480 2788
2789=item EV_ASYNC_ENABLE
2790
2791If undefined or defined to be C<1>, then async watchers are supported. If
2792defined to be C<0>, then they are not.
2793
2481=item EV_MINIMAL 2794=item EV_MINIMAL
2482 2795
2483If you need to shave off some kilobytes of code at the expense of some 2796If you need to shave off some kilobytes of code at the expense of some
2484speed, define this symbol to C<1>. Currently only used for gcc to override 2797speed, define this symbol to C<1>. Currently only used for gcc to override
2485some inlining decisions, saves roughly 30% codesize of amd64. 2798some inlining decisions, saves roughly 30% codesize of amd64.
… …
2491than enough. If you need to manage thousands of children you might want to 2804than enough. If you need to manage thousands of children you might want to
2492increase this value (I<must> be a power of two). 2805increase this value (I<must> be a power of two).
2493 2806
2494=item EV_INOTIFY_HASHSIZE 2807=item EV_INOTIFY_HASHSIZE
2495 2808
2496C<ev_staz> watchers use a small hash table to distribute workload by 2809C<ev_stat> watchers use a small hash table to distribute workload by
2497inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), 2810inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>),
2498usually more than enough. If you need to manage thousands of C<ev_stat> 2811usually more than enough. If you need to manage thousands of C<ev_stat>
2499watchers you might want to increase this value (I<must> be a power of 2812watchers you might want to increase this value (I<must> be a power of
2500two). 2813two).
2501 2814
… …
2597 2910
2598=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) 2911=item Starting and stopping timer/periodic watchers: O(log skipped_other_timers)
2599 2912
2600This means that, when you have a watcher that triggers in one hour and 2913This means that, when you have a watcher that triggers in one hour and
2601there are 100 watchers that would trigger before that then inserting will 2914there are 100 watchers that would trigger before that then inserting will
2602have to skip those 100 watchers. 2915have to skip roughly seven (C<ld 100>) of these watchers.
2603 2916
2604=item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) 2917=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
2605 2918
2606That means that for changing a timer costs less than removing/adding them 2919That means that changing a timer costs less than removing/adding them
2607as only the relative motion in the event queue has to be paid for. 2920as only the relative motion in the event queue has to be paid for.
2608 2921
2609=item Starting io/check/prepare/idle/signal/child watchers: O(1) 2922=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
2610 2923
2611These just add the watcher into an array or at the head of a list. 2924These just add the watcher into an array or at the head of a list.
2925
2612=item Stopping check/prepare/idle watchers: O(1) 2926=item Stopping check/prepare/idle/fork/async watchers: O(1)
2613 2927
2614=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) 2928=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2615 2929
2616These watchers are stored in lists then need to be walked to find the 2930These watchers are stored in lists then need to be walked to find the
2617correct watcher to remove. The lists are usually short (you don't usually 2931correct watcher to remove. The lists are usually short (you don't usually
2618have many watchers waiting for the same fd or signal). 2932have many watchers waiting for the same fd or signal).
2619 2933
2620=item Finding the next timer per loop iteration: O(1) 2934=item Finding the next timer in each loop iteration: O(1)
2935
2936By virtue of using a binary heap, the next timer is always found at the
2937beginning of the storage array.
2621 2938
2622=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) 2939=item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd)
2623 2940
2624A change means an I/O watcher gets started or stopped, which requires 2941A change means an I/O watcher gets started or stopped, which requires
2625libev to recalculate its status (and possibly tell the kernel). 2942libev to recalculate its status (and possibly tell the kernel, depending
2943on backend and wether C<ev_io_set> was used).
2626 2944
2627=item Activating one watcher: O(1) 2945=item Activating one watcher (putting it into the pending state): O(1)
2628 2946
2629=item Priority handling: O(number_of_priorities) 2947=item Priority handling: O(number_of_priorities)
2630 2948
2631Priorities are implemented by allocating some space for each 2949Priorities are implemented by allocating some space for each
2632priority. When doing priority-based operations, libev usually has to 2950priority. When doing priority-based operations, libev usually has to
2633linearly search all the priorities. 2951linearly search all the priorities, but starting/stopping and activating
2952watchers becomes O(1) w.r.t. priority handling.
2953
2954=item Sending an ev_async: O(1)
2955
2956=item Processing ev_async_send: O(number_of_async_watchers)
2957
2958=item Processing signals: O(max_signal_number)
2959
2960Sending involves a syscall I<iff> there were no other C<ev_async_send>
2961calls in the current loop iteration. Checking for async and signal events
2962involves iterating over all running async watchers or all signal numbers.
2634 2963
2635=back 2964=back
2636 2965
2637 2966
2967=head1 Win32 platform limitations and workarounds
2968
2969Win32 doesn't support any of the standards (e.g. POSIX) that libev
2970requires, and its I/O model is fundamentally incompatible with the POSIX
2971model. Libev still offers limited functionality on this platform in
2972the form of the C<EVBACKEND_SELECT> backend, and only supports socket
2973descriptors. This only applies when using Win32 natively, not when using
2974e.g. cygwin.
2975
2976There is no supported compilation method available on windows except
2977embedding it into other applications.
2978
2979Due to the many, low, and arbitrary limits on the win32 platform and the
2980abysmal performance of winsockets, using a large number of sockets is not
2981recommended (and not reasonable). If your program needs to use more than
2982a hundred or so sockets, then likely it needs to use a totally different
2983implementation for windows, as libev offers the POSIX model, which cannot
2984be implemented efficiently on windows (microsoft monopoly games).
2985
2986=over 4
2987
2988=item The winsocket select function
2989
2990The winsocket C<select> function doesn't follow POSIX in that it requires
2991socket I<handles> and not socket I<file descriptors>. This makes select
2992very inefficient, and also requires a mapping from file descriptors
2993to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>,
2994C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor
2995symbols for more info.
2996
2997The configuration for a "naked" win32 using the microsoft runtime
2998libraries and raw winsocket select is:
2999
3000 #define EV_USE_SELECT 1
3001 #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */
3002
3003Note that winsockets handling of fd sets is O(n), so you can easily get a
3004complexity in the O(n²) range when using win32.
3005
3006=item Limited number of file descriptors
3007
3008Windows has numerous arbitrary (and low) limits on things. Early versions
3009of winsocket's select only supported waiting for a max. of C<64> handles
3010(probably owning to the fact that all windows kernels can only wait for
3011C<64> things at the same time internally; microsoft recommends spawning a
3012chain of threads and wait for 63 handles and the previous thread in each).
3013
3014Newer versions support more handles, but you need to define C<FD_SETSIZE>
3015to some high number (e.g. C<2048>) before compiling the winsocket select
3016call (which might be in libev or elsewhere, for example, perl does its own
3017select emulation on windows).
3018
3019Another limit is the number of file descriptors in the microsoft runtime
3020libraries, which by default is C<64> (there must be a hidden I<64> fetish
3021or something like this inside microsoft). You can increase this by calling
3022C<_setmaxstdio>, which can increase this limit to C<2048> (another
3023arbitrary limit), but is broken in many versions of the microsoft runtime
3024libraries.
3025
3026This might get you to about C<512> or C<2048> sockets (depending on
3027windows version and/or the phase of the moon). To get more, you need to
3028wrap all I/O functions and provide your own fd management, but the cost of
3029calling select (O(n²)) will likely make this unworkable.
3030
3031=back
3032
3033
2638=head1 AUTHOR 3034=head1 AUTHOR
2639 3035
2640Marc Lehmann <libev@schmorp.de>. 3036Marc Lehmann <libev@schmorp.de>.
2641 3037

Diff Legend

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