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

Comparing libev/ev.pod (file contents):
Revision 1.249 by root, Wed Jul 8 04:29:31 2009 UTC vs.
Revision 1.293 by root, Wed Mar 24 18:27:13 2010 UTC

98=head2 FEATURES 98=head2 FEATURES
99 99
100Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the 100Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
101BSD-specific C<kqueue> and the Solaris-specific event port mechanisms 101BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
102for file descriptor events (C<ev_io>), the Linux C<inotify> interface 102for file descriptor events (C<ev_io>), the Linux C<inotify> interface
103(for C<ev_stat>), relative timers (C<ev_timer>), absolute timers 103(for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner
104with customised rescheduling (C<ev_periodic>), synchronous signals 104inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
105(C<ev_signal>), process status change events (C<ev_child>), and event 105timers (C<ev_timer>), absolute timers with customised rescheduling
106watchers dealing with the event loop mechanism itself (C<ev_idle>, 106(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
107C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as 107change events (C<ev_child>), and event watchers dealing with the event
108file watchers (C<ev_stat>) and even limited support for fork events 108loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
109(C<ev_fork>). 109C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even
110limited support for fork events (C<ev_fork>).
110 111
111It also is quite fast (see this 112It also is quite fast (see this
112L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent 113L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
113for example). 114for example).
114 115
117Libev is very configurable. In this manual the default (and most common) 118Libev is very configurable. In this manual the default (and most common)
118configuration will be described, which supports multiple event loops. For 119configuration will be described, which supports multiple event loops. For
119more info about various configuration options please have a look at 120more info about various configuration options please have a look at
120B<EMBED> section in this manual. If libev was configured without support 121B<EMBED> section in this manual. If libev was configured without support
121for multiple event loops, then all functions taking an initial argument of 122for multiple event loops, then all functions taking an initial argument of
122name C<loop> (which is always of type C<ev_loop *>) will not have 123name C<loop> (which is always of type C<struct ev_loop *>) will not have
123this argument. 124this argument.
124 125
125=head2 TIME REPRESENTATION 126=head2 TIME REPRESENTATION
126 127
127Libev represents time as a single floating point number, representing 128Libev represents time as a single floating point number, representing
128the (fractional) number of seconds since the (POSIX) epoch (somewhere 129the (fractional) number of seconds since the (POSIX) epoch (in practise
129near the beginning of 1970, details are complicated, don't ask). This 130somewhere near the beginning of 1970, details are complicated, don't
130type is called C<ev_tstamp>, which is what you should use too. It usually 131ask). This type is called C<ev_tstamp>, which is what you should use
131aliases to the C<double> type in C. When you need to do any calculations 132too. It usually aliases to the C<double> type in C. When you need to do
132on it, you should treat it as some floating point value. Unlike the name 133any calculations on it, you should treat it as some floating point value.
134
133component C<stamp> might indicate, it is also used for time differences 135Unlike the name component C<stamp> might indicate, it is also used for
134throughout libev. 136time differences (e.g. delays) throughout libev.
135 137
136=head1 ERROR HANDLING 138=head1 ERROR HANDLING
137 139
138Libev knows three classes of errors: operating system errors, usage errors 140Libev knows three classes of errors: operating system errors, usage errors
139and internal errors (bugs). 141and internal errors (bugs).
344useful to try out specific backends to test their performance, or to work 346useful to try out specific backends to test their performance, or to work
345around bugs. 347around bugs.
346 348
347=item C<EVFLAG_FORKCHECK> 349=item C<EVFLAG_FORKCHECK>
348 350
349Instead of calling C<ev_default_fork> or C<ev_loop_fork> manually after 351Instead of calling C<ev_loop_fork> manually after a fork, you can also
350a fork, you can also make libev check for a fork in each iteration by 352make libev check for a fork in each iteration by enabling this flag.
351enabling this flag.
352 353
353This works by calling C<getpid ()> on every iteration of the loop, 354This works by calling C<getpid ()> on every iteration of the loop,
354and thus this might slow down your event loop if you do a lot of loop 355and thus this might slow down your event loop if you do a lot of loop
355iterations and little real work, but is usually not noticeable (on my 356iterations and little real work, but is usually not noticeable (on my
356GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence 357GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
362flag. 363flag.
363 364
364This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> 365This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
365environment variable. 366environment variable.
366 367
368=item C<EVFLAG_NOINOTIFY>
369
370When this flag is specified, then libev will not attempt to use the
371I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and
372testing, this flag can be useful to conserve inotify file descriptors, as
373otherwise each loop using C<ev_stat> watchers consumes one inotify handle.
374
375=item C<EVFLAG_SIGNALFD>
376
377When this flag is specified, then libev will attempt to use the
378I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This API
379delivers signals synchronously, which makes it both faster and might make
380it possible to get the queued signal data. It can also simplify signal
381handling with threads, as long as you properly block signals in your
382threads that are not interested in handling them.
383
384Signalfd will not be used by default as this changes your signal mask, and
385there are a lot of shoddy libraries and programs (glib's threadpool for
386example) that can't properly initialise their signal masks.
387
367=item C<EVBACKEND_SELECT> (value 1, portable select backend) 388=item C<EVBACKEND_SELECT> (value 1, portable select backend)
368 389
369This is your standard select(2) backend. Not I<completely> standard, as 390This is your standard select(2) backend. Not I<completely> standard, as
370libev tries to roll its own fd_set with no limits on the number of fds, 391libev tries to roll its own fd_set with no limits on the number of fds,
371but if that fails, expect a fairly low limit on the number of fds when 392but if that fails, expect a fairly low limit on the number of fds when
394 415
395This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and 416This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and
396C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. 417C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>.
397 418
398=item C<EVBACKEND_EPOLL> (value 4, Linux) 419=item C<EVBACKEND_EPOLL> (value 4, Linux)
420
421Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9
422kernels).
399 423
400For few fds, this backend is a bit little slower than poll and select, 424For few fds, this backend is a bit little slower than poll and select,
401but it scales phenomenally better. While poll and select usually scale 425but it scales phenomenally better. While poll and select usually scale
402like O(total_fds) where n is the total number of fds (or the highest fd), 426like O(total_fds) where n is the total number of fds (or the highest fd),
403epoll scales either O(1) or O(active_fds). 427epoll scales either O(1) or O(active_fds).
518 542
519It is definitely not recommended to use this flag. 543It is definitely not recommended to use this flag.
520 544
521=back 545=back
522 546
523If one or more of these are or'ed into the flags value, then only these 547If one or more of the backend flags are or'ed into the flags value,
524backends will be tried (in the reverse order as listed here). If none are 548then only these backends will be tried (in the reverse order as listed
525specified, all backends in C<ev_recommended_backends ()> will be tried. 549here). If none are specified, all backends in C<ev_recommended_backends
550()> will be tried.
526 551
527Example: This is the most typical usage. 552Example: This is the most typical usage.
528 553
529 if (!ev_default_loop (0)) 554 if (!ev_default_loop (0))
530 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); 555 fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
542 ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE); 567 ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
543 568
544=item struct ev_loop *ev_loop_new (unsigned int flags) 569=item struct ev_loop *ev_loop_new (unsigned int flags)
545 570
546Similar to C<ev_default_loop>, but always creates a new event loop that is 571Similar to C<ev_default_loop>, but always creates a new event loop that is
547always distinct from the default loop. Unlike the default loop, it cannot 572always distinct from the default loop.
548handle signal and child watchers, and attempts to do so will be greeted by
549undefined behaviour (or a failed assertion if assertions are enabled).
550 573
551Note that this function I<is> thread-safe, and the recommended way to use 574Note that this function I<is> thread-safe, and one common way to use
552libev with threads is indeed to create one loop per thread, and using the 575libev with threads is indeed to create one loop per thread, and using the
553default loop in the "main" or "initial" thread. 576default loop in the "main" or "initial" thread.
554 577
555Example: Try to create a event loop that uses epoll and nothing else. 578Example: Try to create a event loop that uses epoll and nothing else.
556 579
558 if (!epoller) 581 if (!epoller)
559 fatal ("no epoll found here, maybe it hides under your chair"); 582 fatal ("no epoll found here, maybe it hides under your chair");
560 583
561=item ev_default_destroy () 584=item ev_default_destroy ()
562 585
563Destroys the default loop again (frees all memory and kernel state 586Destroys the default loop (frees all memory and kernel state etc.). None
564etc.). None of the active event watchers will be stopped in the normal 587of the active event watchers will be stopped in the normal sense, so
565sense, so e.g. C<ev_is_active> might still return true. It is your 588e.g. C<ev_is_active> might still return true. It is your responsibility to
566responsibility to either stop all watchers cleanly yourself I<before> 589either stop all watchers cleanly yourself I<before> calling this function,
567calling this function, or cope with the fact afterwards (which is usually 590or cope with the fact afterwards (which is usually the easiest thing, you
568the easiest thing, you can just ignore the watchers and/or C<free ()> them 591can just ignore the watchers and/or C<free ()> them for example).
569for example).
570 592
571Note that certain global state, such as signal state (and installed signal 593Note that certain global state, such as signal state (and installed signal
572handlers), will not be freed by this function, and related watchers (such 594handlers), will not be freed by this function, and related watchers (such
573as signal and child watchers) would need to be stopped manually. 595as signal and child watchers) would need to be stopped manually.
574 596
575In general it is not advisable to call this function except in the 597In general it is not advisable to call this function except in the
576rare occasion where you really need to free e.g. the signal handling 598rare occasion where you really need to free e.g. the signal handling
577pipe fds. If you need dynamically allocated loops it is better to use 599pipe fds. If you need dynamically allocated loops it is better to use
578C<ev_loop_new> and C<ev_loop_destroy>). 600C<ev_loop_new> and C<ev_loop_destroy>.
579 601
580=item ev_loop_destroy (loop) 602=item ev_loop_destroy (loop)
581 603
582Like C<ev_default_destroy>, but destroys an event loop created by an 604Like C<ev_default_destroy>, but destroys an event loop created by an
583earlier call to C<ev_loop_new>. 605earlier call to C<ev_loop_new>.
589name, you can call it anytime, but it makes most sense after forking, in 611name, you can call it anytime, but it makes most sense after forking, in
590the child process (or both child and parent, but that again makes little 612the child process (or both child and parent, but that again makes little
591sense). You I<must> call it in the child before using any of the libev 613sense). You I<must> call it in the child before using any of the libev
592functions, and it will only take effect at the next C<ev_loop> iteration. 614functions, and it will only take effect at the next C<ev_loop> iteration.
593 615
616Again, you I<have> to call it on I<any> loop that you want to re-use after
617a fork, I<even if you do not plan to use the loop in the parent>. This is
618because some kernel interfaces *cough* I<kqueue> *cough* do funny things
619during fork.
620
594On the other hand, you only need to call this function in the child 621On the other hand, you only need to call this function in the child
595process if and only if you want to use the event library in the child. If 622process if and only if you want to use the event loop in the child. If you
596you just fork+exec, you don't have to call it at all. 623just fork+exec or create a new loop in the child, you don't have to call
624it at all.
597 625
598The function itself is quite fast and it's usually not a problem to call 626The function itself is quite fast and it's usually not a problem to call
599it just in case after a fork. To make this easy, the function will fit in 627it just in case after a fork. To make this easy, the function will fit in
600quite nicely into a call to C<pthread_atfork>: 628quite nicely into a call to C<pthread_atfork>:
601 629
603 631
604=item ev_loop_fork (loop) 632=item ev_loop_fork (loop)
605 633
606Like C<ev_default_fork>, but acts on an event loop created by 634Like C<ev_default_fork>, but acts on an event loop created by
607C<ev_loop_new>. Yes, you have to call this on every allocated event loop 635C<ev_loop_new>. Yes, you have to call this on every allocated event loop
608after fork that you want to re-use in the child, and how you do this is 636after fork that you want to re-use in the child, and how you keep track of
609entirely your own problem. 637them is entirely your own problem.
610 638
611=item int ev_is_default_loop (loop) 639=item int ev_is_default_loop (loop)
612 640
613Returns true when the given loop is, in fact, the default loop, and false 641Returns true when the given loop is, in fact, the default loop, and false
614otherwise. 642otherwise.
615 643
616=item unsigned int ev_loop_count (loop) 644=item unsigned int ev_iteration (loop)
617 645
618Returns the count of loop iterations for the loop, which is identical to 646Returns the current iteration count for the loop, which is identical to
619the number of times libev did poll for new events. It starts at C<0> and 647the number of times libev did poll for new events. It starts at C<0> and
620happily wraps around with enough iterations. 648happily wraps around with enough iterations.
621 649
622This value can sometimes be useful as a generation counter of sorts (it 650This value can sometimes be useful as a generation counter of sorts (it
623"ticks" the number of loop iterations), as it roughly corresponds with 651"ticks" the number of loop iterations), as it roughly corresponds with
624C<ev_prepare> and C<ev_check> calls. 652C<ev_prepare> and C<ev_check> calls - and is incremented between the
653prepare and check phases.
625 654
626=item unsigned int ev_loop_depth (loop) 655=item unsigned int ev_depth (loop)
627 656
628Returns the number of times C<ev_loop> was entered minus the number of 657Returns the number of times C<ev_loop> was entered minus the number of
629times C<ev_loop> was exited, in other words, the recursion depth. 658times C<ev_loop> was exited, in other words, the recursion depth.
630 659
631Outside C<ev_loop>, this number is zero. In a callback, this number is 660Outside C<ev_loop>, this number is zero. In a callback, this number is
632C<1>, unless C<ev_loop> was invoked recursively (or from another thread), 661C<1>, unless C<ev_loop> was invoked recursively (or from another thread),
633in which case it is higher. 662in which case it is higher.
634 663
635Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread 664Leaving C<ev_loop> abnormally (setjmp/longjmp, cancelling the thread
636etc.), doesn't count as exit. 665etc.), doesn't count as "exit" - consider this as a hint to avoid such
666ungentleman behaviour unless it's really convenient.
637 667
638=item unsigned int ev_backend (loop) 668=item unsigned int ev_backend (loop)
639 669
640Returns one of the C<EVBACKEND_*> flags indicating the event backend in 670Returns one of the C<EVBACKEND_*> flags indicating the event backend in
641use. 671use.
687event loop time (see C<ev_now_update>). 717event loop time (see C<ev_now_update>).
688 718
689=item ev_loop (loop, int flags) 719=item ev_loop (loop, int flags)
690 720
691Finally, this is it, the event handler. This function usually is called 721Finally, this is it, the event handler. This function usually is called
692after you initialised all your watchers and you want to start handling 722after you have initialised all your watchers and you want to start
693events. 723handling events.
694 724
695If the flags argument is specified as C<0>, it will not return until 725If the flags argument is specified as C<0>, it will not return until
696either no event watchers are active anymore or C<ev_unloop> was called. 726either no event watchers are active anymore or C<ev_unloop> was called.
697 727
698Please note that an explicit C<ev_unloop> is usually better than 728Please note that an explicit C<ev_unloop> is usually better than
772 802
773Ref/unref can be used to add or remove a reference count on the event 803Ref/unref can be used to add or remove a reference count on the event
774loop: Every watcher keeps one reference, and as long as the reference 804loop: Every watcher keeps one reference, and as long as the reference
775count is nonzero, C<ev_loop> will not return on its own. 805count is nonzero, C<ev_loop> will not return on its own.
776 806
777If you have a watcher you never unregister that should not keep C<ev_loop> 807This is useful when you have a watcher that you never intend to
778from returning, call ev_unref() after starting, and ev_ref() before 808unregister, but that nevertheless should not keep C<ev_loop> from
809returning. In such a case, call C<ev_unref> after starting, and C<ev_ref>
779stopping it. 810before stopping it.
780 811
781As an example, libev itself uses this for its internal signal pipe: It 812As an example, libev itself uses this for its internal signal pipe: It
782is not visible to the libev user and should not keep C<ev_loop> from 813is not visible to the libev user and should not keep C<ev_loop> from
783exiting if no event watchers registered by it are active. It is also an 814exiting if no event watchers registered by it are active. It is also an
784excellent way to do this for generic recurring timers or from within 815excellent way to do this for generic recurring timers or from within
856more often than 100 times per second: 887more often than 100 times per second:
857 888
858 ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1); 889 ev_set_timeout_collect_interval (EV_DEFAULT_UC_ 0.1);
859 ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01); 890 ev_set_io_collect_interval (EV_DEFAULT_UC_ 0.01);
860 891
892=item ev_invoke_pending (loop)
893
894This call will simply invoke all pending watchers while resetting their
895pending state. Normally, C<ev_loop> does this automatically when required,
896but when overriding the invoke callback this call comes handy.
897
898=item int ev_pending_count (loop)
899
900Returns the number of pending watchers - zero indicates that no watchers
901are pending.
902
903=item ev_set_invoke_pending_cb (loop, void (*invoke_pending_cb)(EV_P))
904
905This overrides the invoke pending functionality of the loop: Instead of
906invoking all pending watchers when there are any, C<ev_loop> will call
907this callback instead. This is useful, for example, when you want to
908invoke the actual watchers inside another context (another thread etc.).
909
910If you want to reset the callback, use C<ev_invoke_pending> as new
911callback.
912
913=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P))
914
915Sometimes you want to share the same loop between multiple threads. This
916can be done relatively simply by putting mutex_lock/unlock calls around
917each call to a libev function.
918
919However, C<ev_loop> can run an indefinite time, so it is not feasible to
920wait for it to return. One way around this is to wake up the loop via
921C<ev_unloop> and C<av_async_send>, another way is to set these I<release>
922and I<acquire> callbacks on the loop.
923
924When set, then C<release> will be called just before the thread is
925suspended waiting for new events, and C<acquire> is called just
926afterwards.
927
928Ideally, C<release> will just call your mutex_unlock function, and
929C<acquire> will just call the mutex_lock function again.
930
931While event loop modifications are allowed between invocations of
932C<release> and C<acquire> (that's their only purpose after all), no
933modifications done will affect the event loop, i.e. adding watchers will
934have no effect on the set of file descriptors being watched, or the time
935waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it
936to take note of any changes you made.
937
938In theory, threads executing C<ev_loop> will be async-cancel safe between
939invocations of C<release> and C<acquire>.
940
941See also the locking example in the C<THREADS> section later in this
942document.
943
944=item ev_set_userdata (loop, void *data)
945
946=item ev_userdata (loop)
947
948Set and retrieve a single C<void *> associated with a loop. When
949C<ev_set_userdata> has never been called, then C<ev_userdata> returns
950C<0.>
951
952These two functions can be used to associate arbitrary data with a loop,
953and are intended solely for the C<invoke_pending_cb>, C<release> and
954C<acquire> callbacks described above, but of course can be (ab-)used for
955any other purpose as well.
956
861=item ev_loop_verify (loop) 957=item ev_loop_verify (loop)
862 958
863This function only does something when C<EV_VERIFY> support has been 959This function only does something when C<EV_VERIFY> support has been
864compiled in, which is the default for non-minimal builds. It tries to go 960compiled in, which is the default for non-minimal builds. It tries to go
865through all internal structures and checks them for validity. If anything 961through all internal structures and checks them for validity. If anything
941=item C<EV_WRITE> 1037=item C<EV_WRITE>
942 1038
943The file descriptor in the C<ev_io> watcher has become readable and/or 1039The file descriptor in the C<ev_io> watcher has become readable and/or
944writable. 1040writable.
945 1041
946=item C<EV_TIMEOUT> 1042=item C<EV_TIMER>
947 1043
948The C<ev_timer> watcher has timed out. 1044The C<ev_timer> watcher has timed out.
949 1045
950=item C<EV_PERIODIC> 1046=item C<EV_PERIODIC>
951 1047
1041 1137
1042 ev_io w; 1138 ev_io w;
1043 ev_init (&w, my_cb); 1139 ev_init (&w, my_cb);
1044 ev_io_set (&w, STDIN_FILENO, EV_READ); 1140 ev_io_set (&w, STDIN_FILENO, EV_READ);
1045 1141
1046=item C<ev_TYPE_set> (ev_TYPE *, [args]) 1142=item C<ev_TYPE_set> (ev_TYPE *watcher, [args])
1047 1143
1048This macro initialises the type-specific parts of a watcher. You need to 1144This macro initialises the type-specific parts of a watcher. You need to
1049call C<ev_init> at least once before you call this macro, but you can 1145call C<ev_init> at least once before you call this macro, but you can
1050call C<ev_TYPE_set> any number of times. You must not, however, call this 1146call C<ev_TYPE_set> any number of times. You must not, however, call this
1051macro on a watcher that is active (it can be pending, however, which is a 1147macro on a watcher that is active (it can be pending, however, which is a
1064 1160
1065Example: Initialise and set an C<ev_io> watcher in one step. 1161Example: Initialise and set an C<ev_io> watcher in one step.
1066 1162
1067 ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); 1163 ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ);
1068 1164
1069=item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) 1165=item C<ev_TYPE_start> (loop, ev_TYPE *watcher)
1070 1166
1071Starts (activates) the given watcher. Only active watchers will receive 1167Starts (activates) the given watcher. Only active watchers will receive
1072events. If the watcher is already active nothing will happen. 1168events. If the watcher is already active nothing will happen.
1073 1169
1074Example: Start the C<ev_io> watcher that is being abused as example in this 1170Example: Start the C<ev_io> watcher that is being abused as example in this
1075whole section. 1171whole section.
1076 1172
1077 ev_io_start (EV_DEFAULT_UC, &w); 1173 ev_io_start (EV_DEFAULT_UC, &w);
1078 1174
1079=item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) 1175=item C<ev_TYPE_stop> (loop, ev_TYPE *watcher)
1080 1176
1081Stops the given watcher if active, and clears the pending status (whether 1177Stops the given watcher if active, and clears the pending status (whether
1082the watcher was active or not). 1178the watcher was active or not).
1083 1179
1084It is possible that stopped watchers are pending - for example, 1180It is possible that stopped watchers are pending - for example,
1109=item ev_cb_set (ev_TYPE *watcher, callback) 1205=item ev_cb_set (ev_TYPE *watcher, callback)
1110 1206
1111Change the callback. You can change the callback at virtually any time 1207Change the callback. You can change the callback at virtually any time
1112(modulo threads). 1208(modulo threads).
1113 1209
1114=item ev_set_priority (ev_TYPE *watcher, priority) 1210=item ev_set_priority (ev_TYPE *watcher, int priority)
1115 1211
1116=item int ev_priority (ev_TYPE *watcher) 1212=item int ev_priority (ev_TYPE *watcher)
1117 1213
1118Set and query the priority of the watcher. The priority is a small 1214Set and query the priority of the watcher. The priority is a small
1119integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> 1215integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI>
1150returns its C<revents> bitset (as if its callback was invoked). If the 1246returns its C<revents> bitset (as if its callback was invoked). If the
1151watcher isn't pending it does nothing and returns C<0>. 1247watcher isn't pending it does nothing and returns C<0>.
1152 1248
1153Sometimes it can be useful to "poll" a watcher instead of waiting for its 1249Sometimes it can be useful to "poll" a watcher instead of waiting for its
1154callback to be invoked, which can be accomplished with this function. 1250callback to be invoked, which can be accomplished with this function.
1251
1252=item ev_feed_event (loop, ev_TYPE *watcher, int revents)
1253
1254Feeds the given event set into the event loop, as if the specified event
1255had happened for the specified watcher (which must be a pointer to an
1256initialised but not necessarily started event watcher). Obviously you must
1257not free the watcher as long as it has pending events.
1258
1259Stopping the watcher, letting libev invoke it, or calling
1260C<ev_clear_pending> will clear the pending event, even if the watcher was
1261not started in the first place.
1262
1263See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1264functions that do not need a watcher.
1155 1265
1156=back 1266=back
1157 1267
1158 1268
1159=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER 1269=head2 ASSOCIATING CUSTOM DATA WITH A WATCHER
1433 1543
1434So when you encounter spurious, unexplained daemon exits, make sure you 1544So when you encounter spurious, unexplained daemon exits, make sure you
1435ignore SIGPIPE (and maybe make sure you log the exit status of your daemon 1545ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1436somewhere, as that would have given you a big clue). 1546somewhere, as that would have given you a big clue).
1437 1547
1548=head3 The special problem of accept()ing when you can't
1549
1550Many implementations of the POSIX C<accept> function (for example,
1551found in post-2004 Linux) have the peculiar behaviour of not removing a
1552connection from the pending queue in all error cases.
1553
1554For example, larger servers often run out of file descriptors (because
1555of resource limits), causing C<accept> to fail with C<ENFILE> but not
1556rejecting the connection, leading to libev signalling readiness on
1557the next iteration again (the connection still exists after all), and
1558typically causing the program to loop at 100% CPU usage.
1559
1560Unfortunately, the set of errors that cause this issue differs between
1561operating systems, there is usually little the app can do to remedy the
1562situation, and no known thread-safe method of removing the connection to
1563cope with overload is known (to me).
1564
1565One of the easiest ways to handle this situation is to just ignore it
1566- when the program encounters an overload, it will just loop until the
1567situation is over. While this is a form of busy waiting, no OS offers an
1568event-based way to handle this situation, so it's the best one can do.
1569
1570A better way to handle the situation is to log any errors other than
1571C<EAGAIN> and C<EWOULDBLOCK>, making sure not to flood the log with such
1572messages, and continue as usual, which at least gives the user an idea of
1573what could be wrong ("raise the ulimit!"). For extra points one could stop
1574the C<ev_io> watcher on the listening fd "for a while", which reduces CPU
1575usage.
1576
1577If your program is single-threaded, then you could also keep a dummy file
1578descriptor for overload situations (e.g. by opening F</dev/null>), and
1579when you run into C<ENFILE> or C<EMFILE>, close it, run C<accept>,
1580close that fd, and create a new dummy fd. This will gracefully refuse
1581clients under typical overload conditions.
1582
1583The last way to handle it is to simply log the error and C<exit>, as
1584is often done with C<malloc> failures, but this results in an easy
1585opportunity for a DoS attack.
1438 1586
1439=head3 Watcher-Specific Functions 1587=head3 Watcher-Specific Functions
1440 1588
1441=over 4 1589=over 4
1442 1590
1621to the current time (meaning we just have some activity :), then call the 1769to the current time (meaning we just have some activity :), then call the
1622callback, which will "do the right thing" and start the timer: 1770callback, which will "do the right thing" and start the timer:
1623 1771
1624 ev_init (timer, callback); 1772 ev_init (timer, callback);
1625 last_activity = ev_now (loop); 1773 last_activity = ev_now (loop);
1626 callback (loop, timer, EV_TIMEOUT); 1774 callback (loop, timer, EV_TIMER);
1627 1775
1628And when there is some activity, simply store the current time in 1776And when there is some activity, simply store the current time in
1629C<last_activity>, no libev calls at all: 1777C<last_activity>, no libev calls at all:
1630 1778
1631 last_actiivty = ev_now (loop); 1779 last_actiivty = ev_now (loop);
1690 1838
1691If the event loop is suspended for a long time, you can also force an 1839If the event loop is suspended for a long time, you can also force an
1692update of the time returned by C<ev_now ()> by calling C<ev_now_update 1840update of the time returned by C<ev_now ()> by calling C<ev_now_update
1693()>. 1841()>.
1694 1842
1843=head3 The special problems of suspended animation
1844
1845When you leave the server world it is quite customary to hit machines that
1846can suspend/hibernate - what happens to the clocks during such a suspend?
1847
1848Some quick tests made with a Linux 2.6.28 indicate that a suspend freezes
1849all processes, while the clocks (C<times>, C<CLOCK_MONOTONIC>) continue
1850to run until the system is suspended, but they will not advance while the
1851system is suspended. That means, on resume, it will be as if the program
1852was frozen for a few seconds, but the suspend time will not be counted
1853towards C<ev_timer> when a monotonic clock source is used. The real time
1854clock advanced as expected, but if it is used as sole clocksource, then a
1855long suspend would be detected as a time jump by libev, and timers would
1856be adjusted accordingly.
1857
1858I would not be surprised to see different behaviour in different between
1859operating systems, OS versions or even different hardware.
1860
1861The other form of suspend (job control, or sending a SIGSTOP) will see a
1862time jump in the monotonic clocks and the realtime clock. If the program
1863is suspended for a very long time, and monotonic clock sources are in use,
1864then you can expect C<ev_timer>s to expire as the full suspension time
1865will be counted towards the timers. When no monotonic clock source is in
1866use, then libev will again assume a timejump and adjust accordingly.
1867
1868It might be beneficial for this latter case to call C<ev_suspend>
1869and C<ev_resume> in code that handles C<SIGTSTP>, to at least get
1870deterministic behaviour in this case (you can do nothing against
1871C<SIGSTOP>).
1872
1695=head3 Watcher-Specific Functions and Data Members 1873=head3 Watcher-Specific Functions and Data Members
1696 1874
1697=over 4 1875=over 4
1698 1876
1699=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat) 1877=item ev_timer_init (ev_timer *, callback, ev_tstamp after, ev_tstamp repeat)
1724If the timer is repeating, either start it if necessary (with the 1902If the timer is repeating, either start it if necessary (with the
1725C<repeat> value), or reset the running timer to the C<repeat> value. 1903C<repeat> value), or reset the running timer to the C<repeat> value.
1726 1904
1727This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 1905This sounds a bit complicated, see L<Be smart about timeouts>, above, for a
1728usage example. 1906usage example.
1907
1908=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
1909
1910Returns the remaining time until a timer fires. If the timer is active,
1911then this time is relative to the current event loop time, otherwise it's
1912the timeout value currently configured.
1913
1914That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
1915C<5>. When the timer is started and one second passes, C<ev_timer_remaining>
1916will return C<4>. When the timer expires and is restarted, it will return
1917roughly C<7> (likely slightly less as callback invocation takes some time,
1918too), and so on.
1729 1919
1730=item ev_tstamp repeat [read-write] 1920=item ev_tstamp repeat [read-write]
1731 1921
1732The current C<repeat> value. Will be used each time the watcher times out 1922The current C<repeat> value. Will be used each time the watcher times out
1733or C<ev_timer_again> is called, and determines the next timeout (if any), 1923or C<ev_timer_again> is called, and determines the next timeout (if any),
1969Signal watchers will trigger an event when the process receives a specific 2159Signal watchers will trigger an event when the process receives a specific
1970signal one or more times. Even though signals are very asynchronous, libev 2160signal one or more times. Even though signals are very asynchronous, libev
1971will try it's best to deliver signals synchronously, i.e. as part of the 2161will try it's best to deliver signals synchronously, i.e. as part of the
1972normal event processing, like any other event. 2162normal event processing, like any other event.
1973 2163
1974If you want signals asynchronously, just use C<sigaction> as you would 2164If you want signals to be delivered truly asynchronously, just use
1975do without libev and forget about sharing the signal. You can even use 2165C<sigaction> as you would do without libev and forget about sharing
1976C<ev_async> from a signal handler to synchronously wake up an event loop. 2166the signal. You can even use C<ev_async> from a signal handler to
2167synchronously wake up an event loop.
1977 2168
1978You can configure as many watchers as you like per signal. Only when the 2169You can configure as many watchers as you like for the same signal, but
2170only within the same loop, i.e. you can watch for C<SIGINT> in your
2171default loop and for C<SIGIO> in another loop, but you cannot watch for
2172C<SIGINT> in both the default loop and another loop at the same time. At
2173the moment, C<SIGCHLD> is permanently tied to the default loop.
2174
1979first watcher gets started will libev actually register a signal handler 2175When the first watcher gets started will libev actually register something
1980with the kernel (thus it coexists with your own signal handlers as long as 2176with the kernel (thus it coexists with your own signal handlers as long as
1981you don't register any with libev for the same signal). Similarly, when 2177you don't register any with libev for the same signal).
1982the last signal watcher for a signal is stopped, libev will reset the
1983signal handler to SIG_DFL (regardless of what it was set to before).
1984 2178
1985If possible and supported, libev will install its handlers with 2179If possible and supported, libev will install its handlers with
1986C<SA_RESTART> behaviour enabled, so system calls should not be unduly 2180C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
1987interrupted. If you have a problem with system calls getting interrupted by 2181not be unduly interrupted. If you have a problem with system calls getting
1988signals you can block all signals in an C<ev_check> watcher and unblock 2182interrupted by signals you can block all signals in an C<ev_check> watcher
1989them in an C<ev_prepare> watcher. 2183and unblock them in an C<ev_prepare> watcher.
2184
2185=head3 The special problem of inheritance over fork/execve/pthread_create
2186
2187Both the signal mask (C<sigprocmask>) and the signal disposition
2188(C<sigaction>) are unspecified after starting a signal watcher (and after
2189stopping it again), that is, libev might or might not block the signal,
2190and might or might not set or restore the installed signal handler.
2191
2192While this does not matter for the signal disposition (libev never
2193sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2194C<execve>), this matters for the signal mask: many programs do not expect
2195certain signals to be blocked.
2196
2197This means that before calling C<exec> (from the child) you should reset
2198the signal mask to whatever "default" you expect (all clear is a good
2199choice usually).
2200
2201The simplest way to ensure that the signal mask is reset in the child is
2202to install a fork handler with C<pthread_atfork> that resets it. That will
2203catch fork calls done by libraries (such as the libc) as well.
2204
2205In current versions of libev, the signal will not be blocked indefinitely
2206unless you use the C<signalfd> API (C<EV_SIGNALFD>). While this reduces
2207the window of opportunity for problems, it will not go away, as libev
2208I<has> to modify the signal mask, at least temporarily.
2209
2210So I can't stress this enough: I<If you do not reset your signal mask when
2211you expect it to be empty, you have a race condition in your code>. This
2212is not a libev-specific thing, this is true for most event libraries.
1990 2213
1991=head3 Watcher-Specific Functions and Data Members 2214=head3 Watcher-Specific Functions and Data Members
1992 2215
1993=over 4 2216=over 4
1994 2217
2039libev) 2262libev)
2040 2263
2041=head3 Process Interaction 2264=head3 Process Interaction
2042 2265
2043Libev grabs C<SIGCHLD> as soon as the default event loop is 2266Libev grabs C<SIGCHLD> as soon as the default event loop is
2044initialised. This is necessary to guarantee proper behaviour even if 2267initialised. This is necessary to guarantee proper behaviour even if the
2045the first child watcher is started after the child exits. The occurrence 2268first child watcher is started after the child exits. The occurrence
2046of C<SIGCHLD> is recorded asynchronously, but child reaping is done 2269of C<SIGCHLD> is recorded asynchronously, but child reaping is done
2047synchronously as part of the event loop processing. Libev always reaps all 2270synchronously as part of the event loop processing. Libev always reaps all
2048children, even ones not watched. 2271children, even ones not watched.
2049 2272
2050=head3 Overriding the Built-In Processing 2273=head3 Overriding the Built-In Processing
2060=head3 Stopping the Child Watcher 2283=head3 Stopping the Child Watcher
2061 2284
2062Currently, the child watcher never gets stopped, even when the 2285Currently, the child watcher never gets stopped, even when the
2063child terminates, so normally one needs to stop the watcher in the 2286child terminates, so normally one needs to stop the watcher in the
2064callback. Future versions of libev might stop the watcher automatically 2287callback. Future versions of libev might stop the watcher automatically
2065when a child exit is detected. 2288when a child exit is detected (calling C<ev_child_stop> twice is not a
2289problem).
2066 2290
2067=head3 Watcher-Specific Functions and Data Members 2291=head3 Watcher-Specific Functions and Data Members
2068 2292
2069=over 4 2293=over 4
2070 2294
2810=head3 Queueing 3034=head3 Queueing
2811 3035
2812C<ev_async> does not support queueing of data in any way. The reason 3036C<ev_async> does not support queueing of data in any way. The reason
2813is that the author does not know of a simple (or any) algorithm for a 3037is that the author does not know of a simple (or any) algorithm for a
2814multiple-writer-single-reader queue that works in all cases and doesn't 3038multiple-writer-single-reader queue that works in all cases and doesn't
2815need elaborate support such as pthreads. 3039need elaborate support such as pthreads or unportable memory access
3040semantics.
2816 3041
2817That means that if you want to queue data, you have to provide your own 3042That means that if you want to queue data, you have to provide your own
2818queue. But at least I can tell you how to implement locking around your 3043queue. But at least I can tell you how to implement locking around your
2819queue: 3044queue:
2820 3045
2959 3184
2960If C<timeout> is less than 0, then no timeout watcher will be 3185If C<timeout> is less than 0, then no timeout watcher will be
2961started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and 3186started. Otherwise an C<ev_timer> watcher with after = C<timeout> (and
2962repeat = 0) will be started. C<0> is a valid timeout. 3187repeat = 0) will be started. C<0> is a valid timeout.
2963 3188
2964The callback has the type C<void (*cb)(int revents, void *arg)> and gets 3189The callback has the type C<void (*cb)(int revents, void *arg)> and is
2965passed an C<revents> set like normal event callbacks (a combination of 3190passed an C<revents> set like normal event callbacks (a combination of
2966C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMEOUT>) and the C<arg> 3191C<EV_ERROR>, C<EV_READ>, C<EV_WRITE> or C<EV_TIMER>) and the C<arg>
2967value passed to C<ev_once>. Note that it is possible to receive I<both> 3192value passed to C<ev_once>. Note that it is possible to receive I<both>
2968a timeout and an io event at the same time - you probably should give io 3193a timeout and an io event at the same time - you probably should give io
2969events precedence. 3194events precedence.
2970 3195
2971Example: wait up to ten seconds for data to appear on STDIN_FILENO. 3196Example: wait up to ten seconds for data to appear on STDIN_FILENO.
2972 3197
2973 static void stdin_ready (int revents, void *arg) 3198 static void stdin_ready (int revents, void *arg)
2974 { 3199 {
2975 if (revents & EV_READ) 3200 if (revents & EV_READ)
2976 /* stdin might have data for us, joy! */; 3201 /* stdin might have data for us, joy! */;
2977 else if (revents & EV_TIMEOUT) 3202 else if (revents & EV_TIMER)
2978 /* doh, nothing entered */; 3203 /* doh, nothing entered */;
2979 } 3204 }
2980 3205
2981 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); 3206 ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
2982 3207
2983=item ev_feed_event (struct ev_loop *, watcher *, int revents)
2984
2985Feeds the given event set into the event loop, as if the specified event
2986had happened for the specified watcher (which must be a pointer to an
2987initialised but not necessarily started event watcher).
2988
2989=item ev_feed_fd_event (struct ev_loop *, int fd, int revents) 3208=item ev_feed_fd_event (loop, int fd, int revents)
2990 3209
2991Feed an event on the given fd, as if a file descriptor backend detected 3210Feed an event on the given fd, as if a file descriptor backend detected
2992the given events it. 3211the given events it.
2993 3212
2994=item ev_feed_signal_event (struct ev_loop *loop, int signum) 3213=item ev_feed_signal_event (loop, int signum)
2995 3214
2996Feed an event as if the given signal occurred (C<loop> must be the default 3215Feed an event as if the given signal occurred (C<loop> must be the default
2997loop!). 3216loop!).
2998 3217
2999=back 3218=back
3079 3298
3080=over 4 3299=over 4
3081 3300
3082=item ev::TYPE::TYPE () 3301=item ev::TYPE::TYPE ()
3083 3302
3084=item ev::TYPE::TYPE (struct ev_loop *) 3303=item ev::TYPE::TYPE (loop)
3085 3304
3086=item ev::TYPE::~TYPE 3305=item ev::TYPE::~TYPE
3087 3306
3088The constructor (optionally) takes an event loop to associate the watcher 3307The constructor (optionally) takes an event loop to associate the watcher
3089with. If it is omitted, it will use C<EV_DEFAULT>. 3308with. If it is omitted, it will use C<EV_DEFAULT>.
3166Example: Use a plain function as callback. 3385Example: Use a plain function as callback.
3167 3386
3168 static void io_cb (ev::io &w, int revents) { } 3387 static void io_cb (ev::io &w, int revents) { }
3169 iow.set <io_cb> (); 3388 iow.set <io_cb> ();
3170 3389
3171=item w->set (struct ev_loop *) 3390=item w->set (loop)
3172 3391
3173Associates a different C<struct ev_loop> with this watcher. You can only 3392Associates a different C<struct ev_loop> with this watcher. You can only
3174do this when the watcher is inactive (and not pending either). 3393do this when the watcher is inactive (and not pending either).
3175 3394
3176=item w->set ([arguments]) 3395=item w->set ([arguments])
3273=item Ocaml 3492=item Ocaml
3274 3493
3275Erkki Seppala has written Ocaml bindings for libev, to be found at 3494Erkki Seppala has written Ocaml bindings for libev, to be found at
3276L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 3495L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3277 3496
3497=item Lua
3498
3499Brian Maher has written a partial interface to libev for lua (at the
3500time of this writing, only C<ev_io> and C<ev_timer>), to be found at
3501L<http://github.com/brimworks/lua-ev>.
3502
3278=back 3503=back
3279 3504
3280 3505
3281=head1 MACRO MAGIC 3506=head1 MACRO MAGIC
3282 3507
3435 libev.m4 3660 libev.m4
3436 3661
3437=head2 PREPROCESSOR SYMBOLS/MACROS 3662=head2 PREPROCESSOR SYMBOLS/MACROS
3438 3663
3439Libev can be configured via a variety of preprocessor symbols you have to 3664Libev can be configured via a variety of preprocessor symbols you have to
3440define before including any of its files. The default in the absence of 3665define before including (or compiling) any of its files. The default in
3441autoconf is documented for every option. 3666the absence of autoconf is documented for every option.
3667
3668Symbols marked with "(h)" do not change the ABI, and can have different
3669values when compiling libev vs. including F<ev.h>, so it is permissible
3670to redefine them before including F<ev.h> without breaking compatibility
3671to a compiled library. All other symbols change the ABI, which means all
3672users of libev and the libev code itself must be compiled with compatible
3673settings.
3442 3674
3443=over 4 3675=over 4
3444 3676
3445=item EV_STANDALONE 3677=item EV_STANDALONE (h)
3446 3678
3447Must always be C<1> if you do not use autoconf configuration, which 3679Must always be C<1> if you do not use autoconf configuration, which
3448keeps libev from including F<config.h>, and it also defines dummy 3680keeps libev from including F<config.h>, and it also defines dummy
3449implementations for some libevent functions (such as logging, which is not 3681implementations for some libevent functions (such as logging, which is not
3450supported). It will also not define any of the structs usually found in 3682supported). It will also not define any of the structs usually found in
3451F<event.h> that are not directly supported by the libev core alone. 3683F<event.h> that are not directly supported by the libev core alone.
3452 3684
3453In stanbdalone mode, libev will still try to automatically deduce the 3685In standalone mode, libev will still try to automatically deduce the
3454configuration, but has to be more conservative. 3686configuration, but has to be more conservative.
3455 3687
3456=item EV_USE_MONOTONIC 3688=item EV_USE_MONOTONIC
3457 3689
3458If defined to be C<1>, libev will try to detect the availability of the 3690If defined to be C<1>, libev will try to detect the availability of the
3523be used is the winsock select). This means that it will call 3755be used is the winsock select). This means that it will call
3524C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, 3756C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
3525it is assumed that all these functions actually work on fds, even 3757it is assumed that all these functions actually work on fds, even
3526on win32. Should not be defined on non-win32 platforms. 3758on win32. Should not be defined on non-win32 platforms.
3527 3759
3528=item EV_FD_TO_WIN32_HANDLE 3760=item EV_FD_TO_WIN32_HANDLE(fd)
3529 3761
3530If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map 3762If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
3531file descriptors to socket handles. When not defining this symbol (the 3763file descriptors to socket handles. When not defining this symbol (the
3532default), then libev will call C<_get_osfhandle>, which is usually 3764default), then libev will call C<_get_osfhandle>, which is usually
3533correct. In some cases, programs use their own file descriptor management, 3765correct. In some cases, programs use their own file descriptor management,
3534in which case they can provide this function to map fds to socket handles. 3766in which case they can provide this function to map fds to socket handles.
3767
3768=item EV_WIN32_HANDLE_TO_FD(handle)
3769
3770If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
3771using the standard C<_open_osfhandle> function. For programs implementing
3772their own fd to handle mapping, overwriting this function makes it easier
3773to do so. This can be done by defining this macro to an appropriate value.
3774
3775=item EV_WIN32_CLOSE_FD(fd)
3776
3777If programs implement their own fd to handle mapping on win32, then this
3778macro can be used to override the C<close> function, useful to unregister
3779file descriptors again. Note that the replacement function has to close
3780the underlying OS handle.
3535 3781
3536=item EV_USE_POLL 3782=item EV_USE_POLL
3537 3783
3538If defined to be C<1>, libev will compile in support for the C<poll>(2) 3784If defined to be C<1>, libev will compile in support for the C<poll>(2)
3539backend. Otherwise it will be enabled on non-win32 platforms. It 3785backend. Otherwise it will be enabled on non-win32 platforms. It
3586as well as for signal and thread safety in C<ev_async> watchers. 3832as well as for signal and thread safety in C<ev_async> watchers.
3587 3833
3588In the absence of this define, libev will use C<sig_atomic_t volatile> 3834In the absence of this define, libev will use C<sig_atomic_t volatile>
3589(from F<signal.h>), which is usually good enough on most platforms. 3835(from F<signal.h>), which is usually good enough on most platforms.
3590 3836
3591=item EV_H 3837=item EV_H (h)
3592 3838
3593The name of the F<ev.h> header file used to include it. The default if 3839The name of the F<ev.h> header file used to include it. The default if
3594undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be 3840undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
3595used to virtually rename the F<ev.h> header file in case of conflicts. 3841used to virtually rename the F<ev.h> header file in case of conflicts.
3596 3842
3597=item EV_CONFIG_H 3843=item EV_CONFIG_H (h)
3598 3844
3599If C<EV_STANDALONE> isn't C<1>, this variable can be used to override 3845If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
3600F<ev.c>'s idea of where to find the F<config.h> file, similarly to 3846F<ev.c>'s idea of where to find the F<config.h> file, similarly to
3601C<EV_H>, above. 3847C<EV_H>, above.
3602 3848
3603=item EV_EVENT_H 3849=item EV_EVENT_H (h)
3604 3850
3605Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea 3851Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
3606of how the F<event.h> header can be found, the default is C<"event.h">. 3852of how the F<event.h> header can be found, the default is C<"event.h">.
3607 3853
3608=item EV_PROTOTYPES 3854=item EV_PROTOTYPES (h)
3609 3855
3610If defined to be C<0>, then F<ev.h> will not define any function 3856If defined to be C<0>, then F<ev.h> will not define any function
3611prototypes, but still define all the structs and other symbols. This is 3857prototypes, but still define all the structs and other symbols. This is
3612occasionally useful if you want to provide your own wrapper functions 3858occasionally useful if you want to provide your own wrapper functions
3613around libev functions. 3859around libev functions.
3635fine. 3881fine.
3636 3882
3637If your embedding application does not need any priorities, defining these 3883If your embedding application does not need any priorities, defining these
3638both to C<0> will save some memory and CPU. 3884both to C<0> will save some memory and CPU.
3639 3885
3640=item EV_PERIODIC_ENABLE 3886=item EV_PERIODIC_ENABLE, EV_IDLE_ENABLE, EV_EMBED_ENABLE, EV_STAT_ENABLE,
3887EV_PREPARE_ENABLE, EV_CHECK_ENABLE, EV_FORK_ENABLE, EV_SIGNAL_ENABLE,
3888EV_ASYNC_ENABLE, EV_CHILD_ENABLE.
3641 3889
3642If undefined or defined to be C<1>, then periodic timers are supported. If 3890If undefined or defined to be C<1> (and the platform supports it), then
3643defined to be C<0>, then they are not. Disabling them saves a few kB of 3891the respective watcher type is supported. If defined to be C<0>, then it
3644code. 3892is not. Disabling watcher types mainly saves codesize.
3645 3893
3646=item EV_IDLE_ENABLE 3894=item EV_FEATURES
3647
3648If undefined or defined to be C<1>, then idle watchers are supported. If
3649defined to be C<0>, then they are not. Disabling them saves a few kB of
3650code.
3651
3652=item EV_EMBED_ENABLE
3653
3654If undefined or defined to be C<1>, then embed watchers are supported. If
3655defined to be C<0>, then they are not. Embed watchers rely on most other
3656watcher types, which therefore must not be disabled.
3657
3658=item EV_STAT_ENABLE
3659
3660If undefined or defined to be C<1>, then stat watchers are supported. If
3661defined to be C<0>, then they are not.
3662
3663=item EV_FORK_ENABLE
3664
3665If undefined or defined to be C<1>, then fork watchers are supported. If
3666defined to be C<0>, then they are not.
3667
3668=item EV_ASYNC_ENABLE
3669
3670If undefined or defined to be C<1>, then async watchers are supported. If
3671defined to be C<0>, then they are not.
3672
3673=item EV_MINIMAL
3674 3895
3675If you need to shave off some kilobytes of code at the expense of some 3896If you need to shave off some kilobytes of code at the expense of some
3676speed, define this symbol to C<1>. Currently this is used to override some 3897speed (but with the full API), you can define this symbol to request
3677inlining decisions, saves roughly 30% code size on amd64. It also selects a 3898certain subsets of functionality. The default is to enable all features
3678much smaller 2-heap for timer management over the default 4-heap. 3899that can be enabled on the platform.
3900
3901A typical way to use this symbol is to define it to C<0> (or to a bitset
3902with some broad features you want) and then selectively re-enable
3903additional parts you want, for example if you want everything minimal,
3904but multiple event loop support, async and child watchers and the poll
3905backend, use this:
3906
3907 #define EV_FEATURES 0
3908 #define EV_MULTIPLICITY 1
3909 #define EV_USE_POLL 1
3910 #define EV_CHILD_ENABLE 1
3911 #define EV_ASYNC_ENABLE 1
3912
3913The actual value is a bitset, it can be a combination of the following
3914values:
3915
3916=over 4
3917
3918=item C<1> - faster/larger code
3919
3920Use larger code to speed up some operations.
3921
3922Currently this is used to override some inlining decisions (enlarging the roughly
392330% code size on amd64.
3924
3925When optimising for size, use of compiler flags such as C<-Os> with
3926gcc recommended, as well as C<-DNDEBUG>, as libev contains a number of
3927assertions.
3928
3929=item C<2> - faster/larger data structures
3930
3931Replaces the small 2-heap for timer management by a faster 4-heap, larger
3932hash table sizes and so on. This will usually further increase codesize
3933and can additionally have an effect on the size of data structures at
3934runtime.
3935
3936=item C<4> - full API configuration
3937
3938This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
3939enables multiplicity (C<EV_MULTIPLICITY>=1).
3940
3941=item C<8> - full API
3942
3943This enables a lot of the "lesser used" API functions. See C<ev.h> for
3944details on which parts of the API are still available without this
3945feature, and do not complain if this subset changes over time.
3946
3947=item C<16> - enable all optional watcher types
3948
3949Enables all optional watcher types. If you want to selectively enable
3950only some watcher types other than I/O and timers (e.g. prepare,
3951embed, async, child...) you can enable them manually by defining
3952C<EV_watchertype_ENABLE> to C<1> instead.
3953
3954=item C<32> - enable all backends
3955
3956This enables all backends - without this feature, you need to enable at
3957least one backend manually (C<EV_USE_SELECT> is a good choice).
3958
3959=item C<64> - enable OS-specific "helper" APIs
3960
3961Enable inotify, eventfd, signalfd and similar OS-specific helper APIs by
3962default.
3963
3964=back
3965
3966Compiling with C<gcc -Os -DEV_STANDALONE -DEV_USE_EPOLL=1 -DEV_FEATURES=0>
3967reduces the compiled size of libev from 24.7Kb code/2.8Kb data to 6.5Kb
3968code/0.3Kb data on my GNU/Linux amd64 system, while still giving you I/O
3969watchers, timers and monotonic clock support.
3970
3971With an intelligent-enough linker (gcc+binutils are intelligent enough
3972when you use C<-Wl,--gc-sections -ffunction-sections>) functions unused by
3973your program might be left out as well - a binary starting a timer and an
3974I/O watcher then might come out at only 5Kb.
3975
3976=item EV_AVOID_STDIO
3977
3978If this is set to C<1> at compiletime, then libev will avoid using stdio
3979functions (printf, scanf, perror etc.). This will increase the codesize
3980somewhat, but if your program doesn't otherwise depend on stdio and your
3981libc allows it, this avoids linking in the stdio library which is quite
3982big.
3983
3984Note that error messages might become less precise when this option is
3985enabled.
3986
3987=item EV_NSIG
3988
3989The highest supported signal number, +1 (or, the number of
3990signals): Normally, libev tries to deduce the maximum number of signals
3991automatically, but sometimes this fails, in which case it can be
3992specified. Also, using a lower number than detected (C<32> should be
3993good for about any system in existance) can save some memory, as libev
3994statically allocates some 12-24 bytes per signal number.
3679 3995
3680=item EV_PID_HASHSIZE 3996=item EV_PID_HASHSIZE
3681 3997
3682C<ev_child> watchers use a small hash table to distribute workload by 3998C<ev_child> watchers use a small hash table to distribute workload by
3683pid. The default size is C<16> (or C<1> with C<EV_MINIMAL>), usually more 3999pid. The default size is C<16> (or C<1> with C<EV_FEATURES> disabled),
3684than enough. If you need to manage thousands of children you might want to 4000usually more than enough. If you need to manage thousands of children you
3685increase this value (I<must> be a power of two). 4001might want to increase this value (I<must> be a power of two).
3686 4002
3687=item EV_INOTIFY_HASHSIZE 4003=item EV_INOTIFY_HASHSIZE
3688 4004
3689C<ev_stat> watchers use a small hash table to distribute workload by 4005C<ev_stat> watchers use a small hash table to distribute workload by
3690inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), 4006inotify watch id. The default size is C<16> (or C<1> with C<EV_FEATURES>
3691usually more than enough. If you need to manage thousands of C<ev_stat> 4007disabled), usually more than enough. If you need to manage thousands of
3692watchers you might want to increase this value (I<must> be a power of 4008C<ev_stat> watchers you might want to increase this value (I<must> be a
3693two). 4009power of two).
3694 4010
3695=item EV_USE_4HEAP 4011=item EV_USE_4HEAP
3696 4012
3697Heaps are not very cache-efficient. To improve the cache-efficiency of the 4013Heaps are not very cache-efficient. To improve the cache-efficiency of the
3698timer and periodics heaps, libev uses a 4-heap when this symbol is defined 4014timer and periodics heaps, libev uses a 4-heap when this symbol is defined
3699to C<1>. The 4-heap uses more complicated (longer) code but has noticeably 4015to C<1>. The 4-heap uses more complicated (longer) code but has noticeably
3700faster performance with many (thousands) of watchers. 4016faster performance with many (thousands) of watchers.
3701 4017
3702The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> 4018The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3703(disabled). 4019will be C<0>.
3704 4020
3705=item EV_HEAP_CACHE_AT 4021=item EV_HEAP_CACHE_AT
3706 4022
3707Heaps are not very cache-efficient. To improve the cache-efficiency of the 4023Heaps are not very cache-efficient. To improve the cache-efficiency of the
3708timer and periodics heaps, libev can cache the timestamp (I<at>) within 4024timer and periodics heaps, libev can cache the timestamp (I<at>) within
3709the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>), 4025the heap structure (selected by defining C<EV_HEAP_CACHE_AT> to C<1>),
3710which uses 8-12 bytes more per watcher and a few hundred bytes more code, 4026which uses 8-12 bytes more per watcher and a few hundred bytes more code,
3711but avoids random read accesses on heap changes. This improves performance 4027but avoids random read accesses on heap changes. This improves performance
3712noticeably with many (hundreds) of watchers. 4028noticeably with many (hundreds) of watchers.
3713 4029
3714The default is C<1> unless C<EV_MINIMAL> is set in which case it is C<0> 4030The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3715(disabled). 4031will be C<0>.
3716 4032
3717=item EV_VERIFY 4033=item EV_VERIFY
3718 4034
3719Controls how much internal verification (see C<ev_loop_verify ()>) will 4035Controls how much internal verification (see C<ev_loop_verify ()>) will
3720be done: If set to C<0>, no internal verification code will be compiled 4036be done: If set to C<0>, no internal verification code will be compiled
3722called. If set to C<2>, then the internal verification code will be 4038called. If set to C<2>, then the internal verification code will be
3723called once per loop, which can slow down libev. If set to C<3>, then the 4039called once per loop, which can slow down libev. If set to C<3>, then the
3724verification code will be called very frequently, which will slow down 4040verification code will be called very frequently, which will slow down
3725libev considerably. 4041libev considerably.
3726 4042
3727The default is C<1>, unless C<EV_MINIMAL> is set, in which case it will be 4043The default is C<1>, unless C<EV_FEATURES> overrides it, in which case it
3728C<0>. 4044will be C<0>.
3729 4045
3730=item EV_COMMON 4046=item EV_COMMON
3731 4047
3732By default, all watchers have a C<void *data> member. By redefining 4048By default, all watchers have a C<void *data> member. By redefining
3733this macro to a something else you can include more and other types of 4049this macro to a something else you can include more and other types of
3791file. 4107file.
3792 4108
3793The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file 4109The usage in rxvt-unicode is simpler. It has a F<ev_cpp.h> header file
3794that everybody includes and which overrides some configure choices: 4110that everybody includes and which overrides some configure choices:
3795 4111
3796 #define EV_MINIMAL 1 4112 #define EV_FEATURES 8
3797 #define EV_USE_POLL 0 4113 #define EV_USE_SELECT 1
3798 #define EV_MULTIPLICITY 0
3799 #define EV_PERIODIC_ENABLE 0 4114 #define EV_PREPARE_ENABLE 1
4115 #define EV_IDLE_ENABLE 1
3800 #define EV_STAT_ENABLE 0 4116 #define EV_SIGNAL_ENABLE 1
3801 #define EV_FORK_ENABLE 0 4117 #define EV_CHILD_ENABLE 1
4118 #define EV_USE_STDEXCEPT 0
3802 #define EV_CONFIG_H <config.h> 4119 #define EV_CONFIG_H <config.h>
3803 #define EV_MINPRI 0
3804 #define EV_MAXPRI 0
3805 4120
3806 #include "ev++.h" 4121 #include "ev++.h"
3807 4122
3808And a F<ev_cpp.C> implementation file that contains libev proper and is compiled: 4123And a F<ev_cpp.C> implementation file that contains libev proper and is compiled:
3809 4124
3869default loop and triggering an C<ev_async> watcher from the default loop 4184default loop and triggering an C<ev_async> watcher from the default loop
3870watcher callback into the event loop interested in the signal. 4185watcher callback into the event loop interested in the signal.
3871 4186
3872=back 4187=back
3873 4188
4189=head4 THREAD LOCKING EXAMPLE
4190
4191Here is a fictitious example of how to run an event loop in a different
4192thread than where callbacks are being invoked and watchers are
4193created/added/removed.
4194
4195For a real-world example, see the C<EV::Loop::Async> perl module,
4196which uses exactly this technique (which is suited for many high-level
4197languages).
4198
4199The example uses a pthread mutex to protect the loop data, a condition
4200variable to wait for callback invocations, an async watcher to notify the
4201event loop thread and an unspecified mechanism to wake up the main thread.
4202
4203First, you need to associate some data with the event loop:
4204
4205 typedef struct {
4206 mutex_t lock; /* global loop lock */
4207 ev_async async_w;
4208 thread_t tid;
4209 cond_t invoke_cv;
4210 } userdata;
4211
4212 void prepare_loop (EV_P)
4213 {
4214 // for simplicity, we use a static userdata struct.
4215 static userdata u;
4216
4217 ev_async_init (&u->async_w, async_cb);
4218 ev_async_start (EV_A_ &u->async_w);
4219
4220 pthread_mutex_init (&u->lock, 0);
4221 pthread_cond_init (&u->invoke_cv, 0);
4222
4223 // now associate this with the loop
4224 ev_set_userdata (EV_A_ u);
4225 ev_set_invoke_pending_cb (EV_A_ l_invoke);
4226 ev_set_loop_release_cb (EV_A_ l_release, l_acquire);
4227
4228 // then create the thread running ev_loop
4229 pthread_create (&u->tid, 0, l_run, EV_A);
4230 }
4231
4232The callback for the C<ev_async> watcher does nothing: the watcher is used
4233solely to wake up the event loop so it takes notice of any new watchers
4234that might have been added:
4235
4236 static void
4237 async_cb (EV_P_ ev_async *w, int revents)
4238 {
4239 // just used for the side effects
4240 }
4241
4242The C<l_release> and C<l_acquire> callbacks simply unlock/lock the mutex
4243protecting the loop data, respectively.
4244
4245 static void
4246 l_release (EV_P)
4247 {
4248 userdata *u = ev_userdata (EV_A);
4249 pthread_mutex_unlock (&u->lock);
4250 }
4251
4252 static void
4253 l_acquire (EV_P)
4254 {
4255 userdata *u = ev_userdata (EV_A);
4256 pthread_mutex_lock (&u->lock);
4257 }
4258
4259The event loop thread first acquires the mutex, and then jumps straight
4260into C<ev_loop>:
4261
4262 void *
4263 l_run (void *thr_arg)
4264 {
4265 struct ev_loop *loop = (struct ev_loop *)thr_arg;
4266
4267 l_acquire (EV_A);
4268 pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
4269 ev_loop (EV_A_ 0);
4270 l_release (EV_A);
4271
4272 return 0;
4273 }
4274
4275Instead of invoking all pending watchers, the C<l_invoke> callback will
4276signal the main thread via some unspecified mechanism (signals? pipe
4277writes? C<Async::Interrupt>?) and then waits until all pending watchers
4278have been called (in a while loop because a) spurious wakeups are possible
4279and b) skipping inter-thread-communication when there are no pending
4280watchers is very beneficial):
4281
4282 static void
4283 l_invoke (EV_P)
4284 {
4285 userdata *u = ev_userdata (EV_A);
4286
4287 while (ev_pending_count (EV_A))
4288 {
4289 wake_up_other_thread_in_some_magic_or_not_so_magic_way ();
4290 pthread_cond_wait (&u->invoke_cv, &u->lock);
4291 }
4292 }
4293
4294Now, whenever the main thread gets told to invoke pending watchers, it
4295will grab the lock, call C<ev_invoke_pending> and then signal the loop
4296thread to continue:
4297
4298 static void
4299 real_invoke_pending (EV_P)
4300 {
4301 userdata *u = ev_userdata (EV_A);
4302
4303 pthread_mutex_lock (&u->lock);
4304 ev_invoke_pending (EV_A);
4305 pthread_cond_signal (&u->invoke_cv);
4306 pthread_mutex_unlock (&u->lock);
4307 }
4308
4309Whenever you want to start/stop a watcher or do other modifications to an
4310event loop, you will now have to lock:
4311
4312 ev_timer timeout_watcher;
4313 userdata *u = ev_userdata (EV_A);
4314
4315 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
4316
4317 pthread_mutex_lock (&u->lock);
4318 ev_timer_start (EV_A_ &timeout_watcher);
4319 ev_async_send (EV_A_ &u->async_w);
4320 pthread_mutex_unlock (&u->lock);
4321
4322Note that sending the C<ev_async> watcher is required because otherwise
4323an event loop currently blocking in the kernel will have no knowledge
4324about the newly added timer. By waking up the loop it will pick up any new
4325watchers in the next event loop iteration.
4326
3874=head3 COROUTINES 4327=head3 COROUTINES
3875 4328
3876Libev is very accommodating to coroutines ("cooperative threads"): 4329Libev is very accommodating to coroutines ("cooperative threads"):
3877libev fully supports nesting calls to its functions from different 4330libev fully supports nesting calls to its functions from different
3878coroutines (e.g. you can call C<ev_loop> on the same loop from two 4331coroutines (e.g. you can call C<ev_loop> on the same loop from two
3879different coroutines, and switch freely between both coroutines running the 4332different coroutines, and switch freely between both coroutines running
3880loop, as long as you don't confuse yourself). The only exception is that 4333the loop, as long as you don't confuse yourself). The only exception is
3881you must not do this from C<ev_periodic> reschedule callbacks. 4334that you must not do this from C<ev_periodic> reschedule callbacks.
3882 4335
3883Care has been taken to ensure that libev does not keep local state inside 4336Care has been taken to ensure that libev does not keep local state inside
3884C<ev_loop>, and other calls do not usually allow for coroutine switches as 4337C<ev_loop>, and other calls do not usually allow for coroutine switches as
3885they do not call any callbacks. 4338they do not call any callbacks.
3886 4339
4173involves iterating over all running async watchers or all signal numbers. 4626involves iterating over all running async watchers or all signal numbers.
4174 4627
4175=back 4628=back
4176 4629
4177 4630
4631=head1 PORTING FROM LIBEV 3.X TO 4.X
4632
4633The major version 4 introduced some minor incompatible changes to the API.
4634
4635At the moment, the C<ev.h> header file tries to implement superficial
4636compatibility, so most programs should still compile. Those might be
4637removed in later versions of libev, so better update early than late.
4638
4639=over 4
4640
4641=item C<ev_loop_count> renamed to C<ev_iteration>
4642
4643=item C<ev_loop_depth> renamed to C<ev_depth>
4644
4645=item C<ev_loop_verify> renamed to C<ev_verify>
4646
4647Most functions working on C<struct ev_loop> objects don't have an
4648C<ev_loop_> prefix, so it was removed. Note that C<ev_loop_fork> is
4649still called C<ev_loop_fork> because it would otherwise clash with the
4650C<ev_fork> typedef.
4651
4652=item C<EV_TIMEOUT> renamed to C<EV_TIMER> in C<revents>
4653
4654This is a simple rename - all other watcher types use their name
4655as revents flag, and now C<ev_timer> does, too.
4656
4657Both C<EV_TIMER> and C<EV_TIMEOUT> symbols were present in 3.x versions
4658and continue to be present for the forseeable future, so this is mostly a
4659documentation change.
4660
4661=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
4662
4663The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
4664mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
4665and work, but the library code will of course be larger.
4666
4667=back
4668
4669
4178=head1 GLOSSARY 4670=head1 GLOSSARY
4179 4671
4180=over 4 4672=over 4
4181 4673
4182=item active 4674=item active
4203A change of state of some external event, such as data now being available 4695A change of state of some external event, such as data now being available
4204for reading on a file descriptor, time having passed or simply not having 4696for reading on a file descriptor, time having passed or simply not having
4205any other events happening anymore. 4697any other events happening anymore.
4206 4698
4207In libev, events are represented as single bits (such as C<EV_READ> or 4699In libev, events are represented as single bits (such as C<EV_READ> or
4208C<EV_TIMEOUT>). 4700C<EV_TIMER>).
4209 4701
4210=item event library 4702=item event library
4211 4703
4212A software package implementing an event model and loop. 4704A software package implementing an event model and loop.
4213 4705

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines