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

Comparing libev/ev.pod (file contents):
Revision 1.411 by root, Fri May 4 20:47:27 2012 UTC vs.
Revision 1.441 by root, Thu Jul 13 10:46:52 2017 UTC

1=encoding utf-8
2
1=head1 NAME 3=head1 NAME
2 4
3libev - a high performance full-featured event loop written in C 5libev - a high performance full-featured event loop written in C
4 6
5=head1 SYNOPSIS 7=head1 SYNOPSIS
82 84
83=head1 WHAT TO READ WHEN IN A HURRY 85=head1 WHAT TO READ WHEN IN A HURRY
84 86
85This manual tries to be very detailed, but unfortunately, this also makes 87This manual tries to be very detailed, but unfortunately, this also makes
86it very long. If you just want to know the basics of libev, I suggest 88it very long. If you just want to know the basics of libev, I suggest
87reading L<ANATOMY OF A WATCHER>, then the L<EXAMPLE PROGRAM> above and 89reading L</ANATOMY OF A WATCHER>, then the L</EXAMPLE PROGRAM> above and
88look up the missing functions in L<GLOBAL FUNCTIONS> and the C<ev_io> and 90look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and
89C<ev_timer> sections in L<WATCHER TYPES>. 91C<ev_timer> sections in L</WATCHER TYPES>.
90 92
91=head1 ABOUT LIBEV 93=head1 ABOUT LIBEV
92 94
93Libev is an event loop: you register interest in certain events (such as a 95Libev is an event loop: you register interest in certain events (such as a
94file descriptor being readable or a timeout occurring), and it will manage 96file descriptor being readable or a timeout occurring), and it will manage
396 398
397If this flag bit is or'ed into the flag value (or the program runs setuid 399If this flag bit is or'ed into the flag value (or the program runs setuid
398or setgid) then libev will I<not> look at the environment variable 400or setgid) then libev will I<not> look at the environment variable
399C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will 401C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
400override the flags completely if it is found in the environment. This is 402override the flags completely if it is found in the environment. This is
401useful to try out specific backends to test their performance, or to work 403useful to try out specific backends to test their performance, to work
402around bugs. 404around bugs, or to make libev threadsafe (accessing environment variables
405cannot be done in a threadsafe way, but usually it works if no other
406thread modifies them).
403 407
404=item C<EVFLAG_FORKCHECK> 408=item C<EVFLAG_FORKCHECK>
405 409
406Instead of calling C<ev_loop_fork> manually after a fork, you can also 410Instead of calling C<ev_loop_fork> manually after a fork, you can also
407make libev check for a fork in each iteration by enabling this flag. 411make libev check for a fork in each iteration by enabling this flag.
408 412
409This works by calling C<getpid ()> on every iteration of the loop, 413This works by calling C<getpid ()> on every iteration of the loop,
410and thus this might slow down your event loop if you do a lot of loop 414and thus this might slow down your event loop if you do a lot of loop
411iterations and little real work, but is usually not noticeable (on my 415iterations and little real work, but is usually not noticeable (on my
412GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence 416GNU/Linux system for example, C<getpid> is actually a simple 5-insn
413without a system call and thus I<very> fast, but my GNU/Linux system also has 417sequence without a system call and thus I<very> fast, but my GNU/Linux
414C<pthread_atfork> which is even faster). 418system also has C<pthread_atfork> which is even faster). (Update: glibc
419versions 2.25 apparently removed the C<getpid> optimisation again).
415 420
416The big advantage of this flag is that you can forget about fork (and 421The big advantage of this flag is that you can forget about fork (and
417forget about forgetting to tell libev about forking) when you use this 422forget about forgetting to tell libev about forking, although you still
418flag. 423have to ignore C<SIGPIPE>) when you use this flag.
419 424
420This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS> 425This flag setting cannot be overridden or specified in the C<LIBEV_FLAGS>
421environment variable. 426environment variable.
422 427
423=item C<EVFLAG_NOINOTIFY> 428=item C<EVFLAG_NOINOTIFY>
569kernel is more efficient (which says nothing about its actual speed, of 574kernel is more efficient (which says nothing about its actual speed, of
570course). While stopping, setting and starting an I/O watcher does never 575course). While stopping, setting and starting an I/O watcher does never
571cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to 576cause an extra system call as with C<EVBACKEND_EPOLL>, it still adds up to
572two event changes per incident. Support for C<fork ()> is very bad (you 577two event changes per incident. Support for C<fork ()> is very bad (you
573might have to leak fd's on fork, but it's more sane than epoll) and it 578might have to leak fd's on fork, but it's more sane than epoll) and it
574drops fds silently in similarly hard-to-detect cases 579drops fds silently in similarly hard-to-detect cases.
575 580
576This backend usually performs well under most conditions. 581This backend usually performs well under most conditions.
577 582
578While nominally embeddable in other event loops, this doesn't work 583While nominally embeddable in other event loops, this doesn't work
579everywhere, so you might need to test for this. And since it is broken 584everywhere, so you might need to test for this. And since it is broken
678If you need dynamically allocated loops it is better to use C<ev_loop_new> 683If you need dynamically allocated loops it is better to use C<ev_loop_new>
679and C<ev_loop_destroy>. 684and C<ev_loop_destroy>.
680 685
681=item ev_loop_fork (loop) 686=item ev_loop_fork (loop)
682 687
683This function sets a flag that causes subsequent C<ev_run> iterations to 688This function sets a flag that causes subsequent C<ev_run> iterations
684reinitialise the kernel state for backends that have one. Despite the 689to reinitialise the kernel state for backends that have one. Despite
685name, you can call it anytime, but it makes most sense after forking, in 690the name, you can call it anytime you are allowed to start or stop
686the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the 691watchers (except inside an C<ev_prepare> callback), but it makes most
692sense after forking, in the child process. You I<must> call it (or use
687child before resuming or calling C<ev_run>. 693C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>.
688 694
695In addition, if you want to reuse a loop (via this function or
696C<EVFLAG_FORKCHECK>), you I<also> have to ignore C<SIGPIPE>.
697
689Again, you I<have> to call it on I<any> loop that you want to re-use after 698Again, you I<have> to call it on I<any> loop that you want to re-use after
690a fork, I<even if you do not plan to use the loop in the parent>. This is 699a fork, I<even if you do not plan to use the loop in the parent>. This is
691because some kernel interfaces *cough* I<kqueue> *cough* do funny things 700because some kernel interfaces *cough* I<kqueue> *cough* do funny things
692during fork. 701during fork.
693 702
694On the other hand, you only need to call this function in the child 703On the other hand, you only need to call this function in the child
764 773
765This function is rarely useful, but when some event callback runs for a 774This function is rarely useful, but when some event callback runs for a
766very long time without entering the event loop, updating libev's idea of 775very long time without entering the event loop, updating libev's idea of
767the current time is a good idea. 776the current time is a good idea.
768 777
769See also L<The special problem of time updates> in the C<ev_timer> section. 778See also L</The special problem of time updates> in the C<ev_timer> section.
770 779
771=item ev_suspend (loop) 780=item ev_suspend (loop)
772 781
773=item ev_resume (loop) 782=item ev_resume (loop)
774 783
1346or might not have been clamped to the valid range. 1355or might not have been clamped to the valid range.
1347 1356
1348The default priority used by watchers when no priority has been set is 1357The default priority used by watchers when no priority has been set is
1349always C<0>, which is supposed to not be too high and not be too low :). 1358always C<0>, which is supposed to not be too high and not be too low :).
1350 1359
1351See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of 1360See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1352priorities. 1361priorities.
1353 1362
1354=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1363=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1355 1364
1356Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1365Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1381See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related 1390See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1382functions that do not need a watcher. 1391functions that do not need a watcher.
1383 1392
1384=back 1393=back
1385 1394
1386See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR 1395See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
1387OWN COMPOSITE WATCHERS> idioms. 1396OWN COMPOSITE WATCHERS> idioms.
1388 1397
1389=head2 WATCHER STATES 1398=head2 WATCHER STATES
1390 1399
1391There are various watcher states mentioned throughout this manual - 1400There are various watcher states mentioned throughout this manual -
1393transition between them will be described in more detail - and while these 1402transition between them will be described in more detail - and while these
1394rules might look complicated, they usually do "the right thing". 1403rules might look complicated, they usually do "the right thing".
1395 1404
1396=over 4 1405=over 4
1397 1406
1398=item initialiased 1407=item initialised
1399 1408
1400Before a watcher can be registered with the event loop it has to be 1409Before a watcher can be registered with the event loop it has to be
1401initialised. This can be done with a call to C<ev_TYPE_init>, or calls to 1410initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1402C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. 1411C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1403 1412
2024 2033
2025The relative timeouts are calculated relative to the C<ev_now ()> 2034The relative timeouts are calculated relative to the C<ev_now ()>
2026time. This is usually the right thing as this timestamp refers to the time 2035time. This is usually the right thing as this timestamp refers to the time
2027of the event triggering whatever timeout you are modifying/starting. If 2036of the event triggering whatever timeout you are modifying/starting. If
2028you suspect event processing to be delayed and you I<need> to base the 2037you suspect event processing to be delayed and you I<need> to base the
2029timeout on the current time, use something like this to adjust for this: 2038timeout on the current time, use something like the following to adjust
2039for it:
2030 2040
2031 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2041 ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
2032 2042
2033If the event loop is suspended for a long time, you can also force an 2043If the event loop is suspended for a long time, you can also force an
2034update of the time returned by C<ev_now ()> by calling C<ev_now_update 2044update of the time returned by C<ev_now ()> by calling C<ev_now_update
2035()>. 2045()>, although that will push the event time of all outstanding events
2046further into the future.
2036 2047
2037=head3 The special problem of unsynchronised clocks 2048=head3 The special problem of unsynchronised clocks
2038 2049
2039Modern systems have a variety of clocks - libev itself uses the normal 2050Modern systems have a variety of clocks - libev itself uses the normal
2040"wall clock" clock and, if available, the monotonic clock (to avoid time 2051"wall clock" clock and, if available, the monotonic clock (to avoid time
2136=item If the timer is repeating, make the C<repeat> value the new timeout 2147=item If the timer is repeating, make the C<repeat> value the new timeout
2137and start the timer, if necessary. 2148and start the timer, if necessary.
2138 2149
2139=back 2150=back
2140 2151
2141This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 2152This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
2142usage example. 2153usage example.
2143 2154
2144=item ev_tstamp ev_timer_remaining (loop, ev_timer *) 2155=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
2145 2156
2146Returns the remaining time until a timer fires. If the timer is active, 2157Returns the remaining time until a timer fires. If the timer is active,
2199Periodic watchers are also timers of a kind, but they are very versatile 2210Periodic watchers are also timers of a kind, but they are very versatile
2200(and unfortunately a bit complex). 2211(and unfortunately a bit complex).
2201 2212
2202Unlike C<ev_timer>, periodic watchers are not based on real time (or 2213Unlike C<ev_timer>, periodic watchers are not based on real time (or
2203relative time, the physical time that passes) but on wall clock time 2214relative time, the physical time that passes) but on wall clock time
2204(absolute time, the thing you can read on your calender or clock). The 2215(absolute time, the thing you can read on your calendar or clock). The
2205difference is that wall clock time can run faster or slower than real 2216difference is that wall clock time can run faster or slower than real
2206time, and time jumps are not uncommon (e.g. when you adjust your 2217time, and time jumps are not uncommon (e.g. when you adjust your
2207wrist-watch). 2218wrist-watch).
2208 2219
2209You can tell a periodic watcher to trigger after some specific point 2220You can tell a periodic watcher to trigger after some specific point
2389 2400
2390 ev_periodic hourly_tick; 2401 ev_periodic hourly_tick;
2391 ev_periodic_init (&hourly_tick, clock_cb, 2402 ev_periodic_init (&hourly_tick, clock_cb,
2392 fmod (ev_now (loop), 3600.), 3600., 0); 2403 fmod (ev_now (loop), 3600.), 3600., 0);
2393 ev_periodic_start (loop, &hourly_tick); 2404 ev_periodic_start (loop, &hourly_tick);
2394 2405
2395 2406
2396=head2 C<ev_signal> - signal me when a signal gets signalled! 2407=head2 C<ev_signal> - signal me when a signal gets signalled!
2397 2408
2398Signal watchers will trigger an event when the process receives a specific 2409Signal watchers will trigger an event when the process receives a specific
2399signal one or more times. Even though signals are very asynchronous, libev 2410signal one or more times. Even though signals are very asynchronous, libev
2409only within the same loop, i.e. you can watch for C<SIGINT> in your 2420only within the same loop, i.e. you can watch for C<SIGINT> in your
2410default loop and for C<SIGIO> in another loop, but you cannot watch for 2421default loop and for C<SIGIO> in another loop, but you cannot watch for
2411C<SIGINT> in both the default loop and another loop at the same time. At 2422C<SIGINT> in both the default loop and another loop at the same time. At
2412the moment, C<SIGCHLD> is permanently tied to the default loop. 2423the moment, C<SIGCHLD> is permanently tied to the default loop.
2413 2424
2414When the first watcher gets started will libev actually register something 2425Only after the first watcher for a signal is started will libev actually
2415with the kernel (thus it coexists with your own signal handlers as long as 2426register something with the kernel. It thus coexists with your own signal
2416you don't register any with libev for the same signal). 2427handlers as long as you don't register any with libev for the same signal.
2417 2428
2418If possible and supported, libev will install its handlers with 2429If possible and supported, libev will install its handlers with
2419C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2430C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2420not be unduly interrupted. If you have a problem with system calls getting 2431not be unduly interrupted. If you have a problem with system calls getting
2421interrupted by signals you can block all signals in an C<ev_check> watcher 2432interrupted by signals you can block all signals in an C<ev_check> watcher
2606 2617
2607=head2 C<ev_stat> - did the file attributes just change? 2618=head2 C<ev_stat> - did the file attributes just change?
2608 2619
2609This watches a file system path for attribute changes. That is, it calls 2620This watches a file system path for attribute changes. That is, it calls
2610C<stat> on that path in regular intervals (or when the OS says it changed) 2621C<stat> on that path in regular intervals (or when the OS says it changed)
2611and sees if it changed compared to the last time, invoking the callback if 2622and sees if it changed compared to the last time, invoking the callback
2612it did. 2623if it did. Starting the watcher C<stat>'s the file, so only changes that
2624happen after the watcher has been started will be reported.
2613 2625
2614The path does not need to exist: changing from "path exists" to "path does 2626The path does not need to exist: changing from "path exists" to "path does
2615not exist" is a status change like any other. The condition "path does not 2627not exist" is a status change like any other. The condition "path does not
2616exist" (or more correctly "path cannot be stat'ed") is signified by the 2628exist" (or more correctly "path cannot be stat'ed") is signified by the
2617C<st_nlink> field being zero (which is otherwise always forced to be at 2629C<st_nlink> field being zero (which is otherwise always forced to be at
2858 2870
2859This mode of operation can be useful together with an C<ev_check> watcher, 2871This mode of operation can be useful together with an C<ev_check> watcher,
2860to do something on each event loop iteration - for example to balance load 2872to do something on each event loop iteration - for example to balance load
2861between different connections. 2873between different connections.
2862 2874
2863See L<Abusing an ev_check watcher for its side-effect> for a longer 2875See L</Abusing an ev_check watcher for its side-effect> for a longer
2864example. 2876example.
2865 2877
2866=head3 Watcher-Specific Functions and Data Members 2878=head3 Watcher-Specific Functions and Data Members
2867 2879
2868=over 4 2880=over 4
2902 2914
2903Prepare and check watchers are often (but not always) used in pairs: 2915Prepare and check watchers are often (but not always) used in pairs:
2904prepare watchers get invoked before the process blocks and check watchers 2916prepare watchers get invoked before the process blocks and check watchers
2905afterwards. 2917afterwards.
2906 2918
2907You I<must not> call C<ev_run> or similar functions that enter 2919You I<must not> call C<ev_run> (or similar functions that enter the
2908the current event loop from either C<ev_prepare> or C<ev_check> 2920current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2909watchers. Other loops than the current one are fine, however. The 2921C<ev_check> watchers. Other loops than the current one are fine,
2910rationale behind this is that you do not need to check for recursion in 2922however. The rationale behind this is that you do not need to check
2911those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, 2923for recursion in those watchers, i.e. the sequence will always be
2912C<ev_check> so if you have one watcher of each kind they will always be 2924C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2913called in pairs bracketing the blocking call. 2925kind they will always be called in pairs bracketing the blocking call.
2914 2926
2915Their main purpose is to integrate other event mechanisms into libev and 2927Their main purpose is to integrate other event mechanisms into libev and
2916their use is somewhat advanced. They could be used, for example, to track 2928their use is somewhat advanced. They could be used, for example, to track
2917variable changes, implement your own watchers, integrate net-snmp or a 2929variable changes, implement your own watchers, integrate net-snmp or a
2918coroutine library and lots more. They are also occasionally useful if 2930coroutine library and lots more. They are also occasionally useful if
2962 2974
2963Using an C<ev_check> watcher is almost enough: it will be called on the 2975Using an C<ev_check> watcher is almost enough: it will be called on the
2964next event loop iteration. However, that isn't as soon as possible - 2976next event loop iteration. However, that isn't as soon as possible -
2965without external events, your C<ev_check> watcher will not be invoked. 2977without external events, your C<ev_check> watcher will not be invoked.
2966 2978
2967
2968This is where C<ev_idle> watchers come in handy - all you need is a 2979This is where C<ev_idle> watchers come in handy - all you need is a
2969single global idle watcher that is active as long as you have one active 2980single global idle watcher that is active as long as you have one active
2970C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop 2981C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
2971will not sleep, and the C<ev_check> watcher makes sure a callback gets 2982will not sleep, and the C<ev_check> watcher makes sure a callback gets
2972invoked. Neither watcher alone can do that. 2983invoked. Neither watcher alone can do that.
3178 3189
3179=over 4 3190=over 4
3180 3191
3181=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 3192=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
3182 3193
3183=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 3194=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
3184 3195
3185Configures the watcher to embed the given loop, which must be 3196Configures the watcher to embed the given loop, which must be
3186embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be 3197embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
3187invoked automatically, otherwise it is the responsibility of the callback 3198invoked automatically, otherwise it is the responsibility of the callback
3188to invoke it (it will continue to be called until the sweep has been done, 3199to invoke it (it will continue to be called until the sweep has been done,
3209used). 3220used).
3210 3221
3211 struct ev_loop *loop_hi = ev_default_init (0); 3222 struct ev_loop *loop_hi = ev_default_init (0);
3212 struct ev_loop *loop_lo = 0; 3223 struct ev_loop *loop_lo = 0;
3213 ev_embed embed; 3224 ev_embed embed;
3214 3225
3215 // see if there is a chance of getting one that works 3226 // see if there is a chance of getting one that works
3216 // (remember that a flags value of 0 means autodetection) 3227 // (remember that a flags value of 0 means autodetection)
3217 loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3228 loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3218 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3229 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3219 : 0; 3230 : 0;
3233C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). 3244C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3234 3245
3235 struct ev_loop *loop = ev_default_init (0); 3246 struct ev_loop *loop = ev_default_init (0);
3236 struct ev_loop *loop_socket = 0; 3247 struct ev_loop *loop_socket = 0;
3237 ev_embed embed; 3248 ev_embed embed;
3238 3249
3239 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3250 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3240 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3251 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3241 { 3252 {
3242 ev_embed_init (&embed, 0, loop_socket); 3253 ev_embed_init (&embed, 0, loop_socket);
3243 ev_embed_start (loop, &embed); 3254 ev_embed_start (loop, &embed);
3251 3262
3252=head2 C<ev_fork> - the audacity to resume the event loop after a fork 3263=head2 C<ev_fork> - the audacity to resume the event loop after a fork
3253 3264
3254Fork watchers are called when a C<fork ()> was detected (usually because 3265Fork watchers are called when a C<fork ()> was detected (usually because
3255whoever is a good citizen cared to tell libev about it by calling 3266whoever is a good citizen cared to tell libev about it by calling
3256C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the 3267C<ev_loop_fork>). The invocation is done before the event loop blocks next
3257event loop blocks next and before C<ev_check> watchers are being called, 3268and before C<ev_check> watchers are being called, and only in the child
3258and only in the child after the fork. If whoever good citizen calling 3269after the fork. If whoever good citizen calling C<ev_default_fork> cheats
3259C<ev_default_fork> cheats and calls it in the wrong process, the fork 3270and calls it in the wrong process, the fork handlers will be invoked, too,
3260handlers will be invoked, too, of course. 3271of course.
3261 3272
3262=head3 The special problem of life after fork - how is it possible? 3273=head3 The special problem of life after fork - how is it possible?
3263 3274
3264Most uses of C<fork()> consist of forking, then some simple calls to set 3275Most uses of C<fork ()> consist of forking, then some simple calls to set
3265up/change the process environment, followed by a call to C<exec()>. This 3276up/change the process environment, followed by a call to C<exec()>. This
3266sequence should be handled by libev without any problems. 3277sequence should be handled by libev without any problems.
3267 3278
3268This changes when the application actually wants to do event handling 3279This changes when the application actually wants to do event handling
3269in the child, or both parent in child, in effect "continuing" after the 3280in the child, or both parent in child, in effect "continuing" after the
3659already been invoked. 3670already been invoked.
3660 3671
3661A common way around all these issues is to make sure that 3672A common way around all these issues is to make sure that
3662C<start_new_request> I<always> returns before the callback is invoked. If 3673C<start_new_request> I<always> returns before the callback is invoked. If
3663C<start_new_request> immediately knows the result, it can artificially 3674C<start_new_request> immediately knows the result, it can artificially
3664delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher 3675delay invoking the callback by using a C<prepare> or C<idle> watcher for
3665for example, or more sneakily, by reusing an existing (stopped) watcher 3676example, or more sneakily, by reusing an existing (stopped) watcher and
3666and pushing it into the pending queue: 3677pushing it into the pending queue:
3667 3678
3668 ev_set_cb (watcher, callback); 3679 ev_set_cb (watcher, callback);
3669 ev_feed_event (EV_A_ watcher, 0); 3680 ev_feed_event (EV_A_ watcher, 0);
3670 3681
3671This way, C<start_new_request> can safely return before the callback is 3682This way, C<start_new_request> can safely return before the callback is
3679 3690
3680This brings the problem of exiting - a callback might want to finish the 3691This brings the problem of exiting - a callback might want to finish the
3681main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but 3692main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
3682a modal "Are you sure?" dialog is still waiting), or just the nested one 3693a modal "Are you sure?" dialog is still waiting), or just the nested one
3683and not the main one (e.g. user clocked "Ok" in a modal dialog), or some 3694and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
3684other combination: In these cases, C<ev_break> will not work alone. 3695other combination: In these cases, a simple C<ev_break> will not work.
3685 3696
3686The solution is to maintain "break this loop" variable for each C<ev_run> 3697The solution is to maintain "break this loop" variable for each C<ev_run>
3687invocation, and use a loop around C<ev_run> until the condition is 3698invocation, and use a loop around C<ev_run> until the condition is
3688triggered, using C<EVRUN_ONCE>: 3699triggered, using C<EVRUN_ONCE>:
3689 3700
3888You can do similar tricks if you have, say, threads with an event queue - 3899You can do similar tricks if you have, say, threads with an event queue -
3889instead of storing a coroutine, you store the queue object and instead of 3900instead of storing a coroutine, you store the queue object and instead of
3890switching to a coroutine, you push the watcher onto the queue and notify 3901switching to a coroutine, you push the watcher onto the queue and notify
3891any waiters. 3902any waiters.
3892 3903
3893To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two 3904To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
3894files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: 3905files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3895 3906
3896 // my_ev.h 3907 // my_ev.h
3897 #define EV_CB_DECLARE(type) struct my_coro *cb; 3908 #define EV_CB_DECLARE(type) struct my_coro *cb;
3898 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 3909 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
3899 #include "../libev/ev.h" 3910 #include "../libev/ev.h"
3900 3911
3901 // my_ev.c 3912 // my_ev.c
3902 #define EV_H "my_ev.h" 3913 #define EV_H "my_ev.h"
3903 #include "../libev/ev.c" 3914 #include "../libev/ev.c"
3950libev sources can be compiled as C++. Therefore, code that uses the C API 3961libev sources can be compiled as C++. Therefore, code that uses the C API
3951will work fine. 3962will work fine.
3952 3963
3953Proper exception specifications might have to be added to callbacks passed 3964Proper exception specifications might have to be added to callbacks passed
3954to libev: exceptions may be thrown only from watcher callbacks, all 3965to libev: exceptions may be thrown only from watcher callbacks, all
3955other callbacks (allocator, syserr, loop acquire/release and periodioc 3966other callbacks (allocator, syserr, loop acquire/release and periodic
3956reschedule callbacks) must not throw exceptions, and might need a C<throw 3967reschedule callbacks) must not throw exceptions, and might need a C<throw
3957()> specification. If you have code that needs to be compiled as both C 3968()> specification. If you have code that needs to be compiled as both C
3958and C++ you can use the C<EV_THROW> macro for this: 3969and C++ you can use the C<EV_THROW> macro for this:
3959 3970
3960 static void 3971 static void
3980Libev comes with some simplistic wrapper classes for C++ that mainly allow 3991Libev comes with some simplistic wrapper classes for C++ that mainly allow
3981you to use some convenience methods to start/stop watchers and also change 3992you to use some convenience methods to start/stop watchers and also change
3982the callback model to a model using method callbacks on objects. 3993the callback model to a model using method callbacks on objects.
3983 3994
3984To use it, 3995To use it,
3985 3996
3986 #include <ev++.h> 3997 #include <ev++.h>
3987 3998
3988This automatically includes F<ev.h> and puts all of its definitions (many 3999This automatically includes F<ev.h> and puts all of its definitions (many
3989of them macros) into the global namespace. All C++ specific things are 4000of them macros) into the global namespace. All C++ specific things are
3990put into the C<ev> namespace. It should support all the same embedding 4001put into the C<ev> namespace. It should support all the same embedding
4093 void operator() (ev::io &w, int revents) 4104 void operator() (ev::io &w, int revents)
4094 { 4105 {
4095 ... 4106 ...
4096 } 4107 }
4097 } 4108 }
4098 4109
4099 myfunctor f; 4110 myfunctor f;
4100 4111
4101 ev::io w; 4112 ev::io w;
4102 w.set (&f); 4113 w.set (&f);
4103 4114
4121Associates a different C<struct ev_loop> with this watcher. You can only 4132Associates a different C<struct ev_loop> with this watcher. You can only
4122do this when the watcher is inactive (and not pending either). 4133do this when the watcher is inactive (and not pending either).
4123 4134
4124=item w->set ([arguments]) 4135=item w->set ([arguments])
4125 4136
4126Basically the same as C<ev_TYPE_set>, with the same arguments. Either this 4137Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
4127method or a suitable start method must be called at least once. Unlike the 4138with the same arguments. Either this method or a suitable start method
4128C counterpart, an active watcher gets automatically stopped and restarted 4139must be called at least once. Unlike the C counterpart, an active watcher
4129when reconfiguring it with this method. 4140gets automatically stopped and restarted when reconfiguring it with this
4141method.
4142
4143For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4144clashing with the C<set (loop)> method.
4130 4145
4131=item w->start () 4146=item w->start ()
4132 4147
4133Starts the watcher. Note that there is no C<loop> argument, as the 4148Starts the watcher. Note that there is no C<loop> argument, as the
4134constructor already stores the event loop. 4149constructor already stores the event loop.
4238 4253
4239Brian Maher has written a partial interface to libev for lua (at the 4254Brian Maher has written a partial interface to libev for lua (at the
4240time of this writing, only C<ev_io> and C<ev_timer>), to be found at 4255time of this writing, only C<ev_io> and C<ev_timer>), to be found at
4241L<http://github.com/brimworks/lua-ev>. 4256L<http://github.com/brimworks/lua-ev>.
4242 4257
4258=item Javascript
4259
4260Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
4261
4262=item Others
4263
4264There are others, and I stopped counting.
4265
4243=back 4266=back
4244 4267
4245 4268
4246=head1 MACRO MAGIC 4269=head1 MACRO MAGIC
4247 4270
4364 ev_vars.h 4387 ev_vars.h
4365 ev_wrap.h 4388 ev_wrap.h
4366 4389
4367 ev_win32.c required on win32 platforms only 4390 ev_win32.c required on win32 platforms only
4368 4391
4369 ev_select.c only when select backend is enabled (which is enabled by default) 4392 ev_select.c only when select backend is enabled
4370 ev_poll.c only when poll backend is enabled (disabled by default) 4393 ev_poll.c only when poll backend is enabled
4371 ev_epoll.c only when the epoll backend is enabled (disabled by default) 4394 ev_epoll.c only when the epoll backend is enabled
4372 ev_kqueue.c only when the kqueue backend is enabled (disabled by default) 4395 ev_kqueue.c only when the kqueue backend is enabled
4373 ev_port.c only when the solaris port backend is enabled (disabled by default) 4396 ev_port.c only when the solaris port backend is enabled
4374 4397
4375F<ev.c> includes the backend files directly when enabled, so you only need 4398F<ev.c> includes the backend files directly when enabled, so you only need
4376to compile this single file. 4399to compile this single file.
4377 4400
4378=head3 LIBEVENT COMPATIBILITY API 4401=head3 LIBEVENT COMPATIBILITY API
4545 4568
4546If programs implement their own fd to handle mapping on win32, then this 4569If programs implement their own fd to handle mapping on win32, then this
4547macro can be used to override the C<close> function, useful to unregister 4570macro can be used to override the C<close> function, useful to unregister
4548file descriptors again. Note that the replacement function has to close 4571file descriptors again. Note that the replacement function has to close
4549the underlying OS handle. 4572the underlying OS handle.
4573
4574=item EV_USE_WSASOCKET
4575
4576If defined to be C<1>, libev will use C<WSASocket> to create its internal
4577communication socket, which works better in some environments. Otherwise,
4578the normal C<socket> function will be used, which works better in other
4579environments.
4550 4580
4551=item EV_USE_POLL 4581=item EV_USE_POLL
4552 4582
4553If defined to be C<1>, libev will compile in support for the C<poll>(2) 4583If defined to be C<1>, libev will compile in support for the C<poll>(2)
4554backend. Otherwise it will be enabled on non-win32 platforms. It 4584backend. Otherwise it will be enabled on non-win32 platforms. It
4599different cpus (or different cpu cores). This reduces dependencies 4629different cpus (or different cpu cores). This reduces dependencies
4600and makes libev faster. 4630and makes libev faster.
4601 4631
4602=item EV_NO_THREADS 4632=item EV_NO_THREADS
4603 4633
4604If defined to be C<1>, libev will assume that it will never be called 4634If defined to be C<1>, libev will assume that it will never be called from
4605from different threads, which is a stronger assumption than C<EV_NO_SMP>, 4635different threads (that includes signal handlers), which is a stronger
4606above. This reduces dependencies and makes libev faster. 4636assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
4637libev faster.
4607 4638
4608=item EV_ATOMIC_T 4639=item EV_ATOMIC_T
4609 4640
4610Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4641Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4611access is atomic and serialised with respect to other threads or signal 4642access is atomic with respect to other threads or signal contexts. No
4612contexts. No such type is easily found in the C language, so you can 4643such type is easily found in the C language, so you can provide your own
4613provide your own type that you know is safe for your purposes. It is used 4644type that you know is safe for your purposes. It is used both for signal
4614both for signal handler "locking" as well as for signal and thread safety 4645handler "locking" as well as for signal and thread safety in C<ev_async>
4615in C<ev_async> watchers. 4646watchers.
4616 4647
4617In the absence of this define, libev will use C<sig_atomic_t volatile> 4648In the absence of this define, libev will use C<sig_atomic_t volatile>
4618(from F<signal.h>), which is usually good enough on most platforms, 4649(from F<signal.h>), which is usually good enough on most platforms.
4619although strictly speaking using a type that also implies a memory fence
4620is required.
4621 4650
4622=item EV_H (h) 4651=item EV_H (h)
4623 4652
4624The name of the F<ev.h> header file used to include it. The default if 4653The name of the F<ev.h> header file used to include it. The default if
4625undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be 4654undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
4993default loop and triggering an C<ev_async> watcher from the default loop 5022default loop and triggering an C<ev_async> watcher from the default loop
4994watcher callback into the event loop interested in the signal. 5023watcher callback into the event loop interested in the signal.
4995 5024
4996=back 5025=back
4997 5026
4998See also L<THREAD LOCKING EXAMPLE>. 5027See also L</THREAD LOCKING EXAMPLE>.
4999 5028
5000=head3 COROUTINES 5029=head3 COROUTINES
5001 5030
5002Libev is very accommodating to coroutines ("cooperative threads"): 5031Libev is very accommodating to coroutines ("cooperative threads"):
5003libev fully supports nesting calls to its functions from different 5032libev fully supports nesting calls to its functions from different
5272structure (guaranteed by POSIX but not by ISO C for example), but it also 5301structure (guaranteed by POSIX but not by ISO C for example), but it also
5273assumes that the same (machine) code can be used to call any watcher 5302assumes that the same (machine) code can be used to call any watcher
5274callback: The watcher callbacks have different type signatures, but libev 5303callback: The watcher callbacks have different type signatures, but libev
5275calls them using an C<ev_watcher *> internally. 5304calls them using an C<ev_watcher *> internally.
5276 5305
5306=item null pointers and integer zero are represented by 0 bytes
5307
5308Libev uses C<memset> to initialise structs and arrays to C<0> bytes, and
5309relies on this setting pointers and integers to null.
5310
5277=item pointer accesses must be thread-atomic 5311=item pointer accesses must be thread-atomic
5278 5312
5279Accessing a pointer value must be atomic, it must both be readable and 5313Accessing a pointer value must be atomic, it must both be readable and
5280writable in one piece - this is the case on all current architectures. 5314writable in one piece - this is the case on all current architectures.
5281 5315
5294thread" or will block signals process-wide, both behaviours would 5328thread" or will block signals process-wide, both behaviours would
5295be compatible with libev. Interaction between C<sigprocmask> and 5329be compatible with libev. Interaction between C<sigprocmask> and
5296C<pthread_sigmask> could complicate things, however. 5330C<pthread_sigmask> could complicate things, however.
5297 5331
5298The most portable way to handle signals is to block signals in all threads 5332The most portable way to handle signals is to block signals in all threads
5299except the initial one, and run the default loop in the initial thread as 5333except the initial one, and run the signal handling loop in the initial
5300well. 5334thread as well.
5301 5335
5302=item C<long> must be large enough for common memory allocation sizes 5336=item C<long> must be large enough for common memory allocation sizes
5303 5337
5304To improve portability and simplify its API, libev uses C<long> internally 5338To improve portability and simplify its API, libev uses C<long> internally
5305instead of C<size_t> when allocating its data structures. On non-POSIX 5339instead of C<size_t> when allocating its data structures. On non-POSIX
5409=over 4 5443=over 4
5410 5444
5411=item C<EV_COMPAT3> backwards compatibility mechanism 5445=item C<EV_COMPAT3> backwards compatibility mechanism
5412 5446
5413The backward compatibility mechanism can be controlled by 5447The backward compatibility mechanism can be controlled by
5414C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> 5448C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5415section. 5449section.
5416 5450
5417=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5451=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5418 5452
5419These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5453These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
5462=over 4 5496=over 4
5463 5497
5464=item active 5498=item active
5465 5499
5466A watcher is active as long as it has been started and not yet stopped. 5500A watcher is active as long as it has been started and not yet stopped.
5467See L<WATCHER STATES> for details. 5501See L</WATCHER STATES> for details.
5468 5502
5469=item application 5503=item application
5470 5504
5471In this document, an application is whatever is using libev. 5505In this document, an application is whatever is using libev.
5472 5506
5508watchers and events. 5542watchers and events.
5509 5543
5510=item pending 5544=item pending
5511 5545
5512A watcher is pending as soon as the corresponding event has been 5546A watcher is pending as soon as the corresponding event has been
5513detected. See L<WATCHER STATES> for details. 5547detected. See L</WATCHER STATES> for details.
5514 5548
5515=item real time 5549=item real time
5516 5550
5517The physical time that is observed. It is apparently strictly monotonic :) 5551The physical time that is observed. It is apparently strictly monotonic :)
5518 5552

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines