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

Comparing libev/ev.pod (file contents):
Revision 1.404 by root, Sat Apr 28 12:10:07 2012 UTC vs.
Revision 1.435 by root, Tue Apr 21 10:10:57 2015 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.
569kernel is more efficient (which says nothing about its actual speed, of 573kernel is more efficient (which says nothing about its actual speed, of
570course). While stopping, setting and starting an I/O watcher does never 574course). 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 575cause 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 576two 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 577might 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 578drops fds silently in similarly hard-to-detect cases.
575 579
576This backend usually performs well under most conditions. 580This backend usually performs well under most conditions.
577 581
578While nominally embeddable in other event loops, this doesn't work 582While nominally embeddable in other event loops, this doesn't work
579everywhere, so you might need to test for this. And since it is broken 583everywhere, 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> 682If you need dynamically allocated loops it is better to use C<ev_loop_new>
679and C<ev_loop_destroy>. 683and C<ev_loop_destroy>.
680 684
681=item ev_loop_fork (loop) 685=item ev_loop_fork (loop)
682 686
683This function sets a flag that causes subsequent C<ev_run> iterations to 687This function sets a flag that causes subsequent C<ev_run> iterations
684reinitialise the kernel state for backends that have one. Despite the 688to reinitialise the kernel state for backends that have one. Despite
685name, you can call it anytime, but it makes most sense after forking, in 689the 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 690watchers (except inside an C<ev_prepare> callback), but it makes most
691sense after forking, in the child process. You I<must> call it (or use
687child before resuming or calling C<ev_run>. 692C<EVFLAG_FORKCHECK>) in the child before resuming or calling C<ev_run>.
688 693
689Again, you I<have> to call it on I<any> loop that you want to re-use after 694Again, 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 695a 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 696because some kernel interfaces *cough* I<kqueue> *cough* do funny things
692during fork. 697during fork.
693 698
694On the other hand, you only need to call this function in the child 699On the other hand, you only need to call this function in the child
764 769
765This function is rarely useful, but when some event callback runs for a 770This 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 771very long time without entering the event loop, updating libev's idea of
767the current time is a good idea. 772the current time is a good idea.
768 773
769See also L<The special problem of time updates> in the C<ev_timer> section. 774See also L</The special problem of time updates> in the C<ev_timer> section.
770 775
771=item ev_suspend (loop) 776=item ev_suspend (loop)
772 777
773=item ev_resume (loop) 778=item ev_resume (loop)
774 779
1174 1179
1175=item C<EV_PREPARE> 1180=item C<EV_PREPARE>
1176 1181
1177=item C<EV_CHECK> 1182=item C<EV_CHECK>
1178 1183
1179All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts 1184All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts to
1180to gather new events, and all C<ev_check> watchers are invoked just after 1185gather new events, and all C<ev_check> watchers are queued (not invoked)
1181C<ev_run> has gathered them, but before it invokes any callbacks for any 1186just after C<ev_run> has gathered them, but before it queues any callbacks
1187for any received events. That means C<ev_prepare> watchers are the last
1188watchers invoked before the event loop sleeps or polls for new events, and
1189C<ev_check> watchers will be invoked before any other watchers of the same
1190or lower priority within an event loop iteration.
1191
1182received events. Callbacks of both watcher types can start and stop as 1192Callbacks of both watcher types can start and stop as many watchers as
1183many watchers as they want, and all of them will be taken into account 1193they want, and all of them will be taken into account (for example, a
1184(for example, a C<ev_prepare> watcher might start an idle watcher to keep 1194C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1185C<ev_run> from blocking). 1195blocking).
1186 1196
1187=item C<EV_EMBED> 1197=item C<EV_EMBED>
1188 1198
1189The embedded event loop specified in the C<ev_embed> watcher needs attention. 1199The embedded event loop specified in the C<ev_embed> watcher needs attention.
1190 1200
1313 1323
1314=item callback ev_cb (ev_TYPE *watcher) 1324=item callback ev_cb (ev_TYPE *watcher)
1315 1325
1316Returns the callback currently set on the watcher. 1326Returns the callback currently set on the watcher.
1317 1327
1318=item ev_cb_set (ev_TYPE *watcher, callback) 1328=item ev_set_cb (ev_TYPE *watcher, callback)
1319 1329
1320Change the callback. You can change the callback at virtually any time 1330Change the callback. You can change the callback at virtually any time
1321(modulo threads). 1331(modulo threads).
1322 1332
1323=item ev_set_priority (ev_TYPE *watcher, int priority) 1333=item ev_set_priority (ev_TYPE *watcher, int priority)
1341or might not have been clamped to the valid range. 1351or might not have been clamped to the valid range.
1342 1352
1343The default priority used by watchers when no priority has been set is 1353The default priority used by watchers when no priority has been set is
1344always C<0>, which is supposed to not be too high and not be too low :). 1354always C<0>, which is supposed to not be too high and not be too low :).
1345 1355
1346See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of 1356See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1347priorities. 1357priorities.
1348 1358
1349=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1359=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1350 1360
1351Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1361Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1376See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related 1386See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1377functions that do not need a watcher. 1387functions that do not need a watcher.
1378 1388
1379=back 1389=back
1380 1390
1381See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR 1391See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
1382OWN COMPOSITE WATCHERS> idioms. 1392OWN COMPOSITE WATCHERS> idioms.
1383 1393
1384=head2 WATCHER STATES 1394=head2 WATCHER STATES
1385 1395
1386There are various watcher states mentioned throughout this manual - 1396There are various watcher states mentioned throughout this manual -
1388transition between them will be described in more detail - and while these 1398transition between them will be described in more detail - and while these
1389rules might look complicated, they usually do "the right thing". 1399rules might look complicated, they usually do "the right thing".
1390 1400
1391=over 4 1401=over 4
1392 1402
1393=item initialiased 1403=item initialised
1394 1404
1395Before a watcher can be registered with the event loop it has to be 1405Before a watcher can be registered with the event loop it has to be
1396initialised. This can be done with a call to C<ev_TYPE_init>, or calls to 1406initialised. This can be done with a call to C<ev_TYPE_init>, or calls to
1397C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function. 1407C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1398 1408
2019 2029
2020The relative timeouts are calculated relative to the C<ev_now ()> 2030The relative timeouts are calculated relative to the C<ev_now ()>
2021time. This is usually the right thing as this timestamp refers to the time 2031time. This is usually the right thing as this timestamp refers to the time
2022of the event triggering whatever timeout you are modifying/starting. If 2032of the event triggering whatever timeout you are modifying/starting. If
2023you suspect event processing to be delayed and you I<need> to base the 2033you suspect event processing to be delayed and you I<need> to base the
2024timeout on the current time, use something like this to adjust for this: 2034timeout on the current time, use something like the following to adjust
2035for it:
2025 2036
2026 ev_timer_set (&timer, after + ev_now () - ev_time (), 0.); 2037 ev_timer_set (&timer, after + (ev_time () - ev_now ()), 0.);
2027 2038
2028If the event loop is suspended for a long time, you can also force an 2039If the event loop is suspended for a long time, you can also force an
2029update of the time returned by C<ev_now ()> by calling C<ev_now_update 2040update of the time returned by C<ev_now ()> by calling C<ev_now_update
2030()>. 2041()>, although that will push the event time of all outstanding events
2042further into the future.
2031 2043
2032=head3 The special problem of unsynchronised clocks 2044=head3 The special problem of unsynchronised clocks
2033 2045
2034Modern systems have a variety of clocks - libev itself uses the normal 2046Modern systems have a variety of clocks - libev itself uses the normal
2035"wall clock" clock and, if available, the monotonic clock (to avoid time 2047"wall clock" clock and, if available, the monotonic clock (to avoid time
2131=item If the timer is repeating, make the C<repeat> value the new timeout 2143=item If the timer is repeating, make the C<repeat> value the new timeout
2132and start the timer, if necessary. 2144and start the timer, if necessary.
2133 2145
2134=back 2146=back
2135 2147
2136This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 2148This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
2137usage example. 2149usage example.
2138 2150
2139=item ev_tstamp ev_timer_remaining (loop, ev_timer *) 2151=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
2140 2152
2141Returns the remaining time until a timer fires. If the timer is active, 2153Returns the remaining time until a timer fires. If the timer is active,
2384 2396
2385 ev_periodic hourly_tick; 2397 ev_periodic hourly_tick;
2386 ev_periodic_init (&hourly_tick, clock_cb, 2398 ev_periodic_init (&hourly_tick, clock_cb,
2387 fmod (ev_now (loop), 3600.), 3600., 0); 2399 fmod (ev_now (loop), 3600.), 3600., 0);
2388 ev_periodic_start (loop, &hourly_tick); 2400 ev_periodic_start (loop, &hourly_tick);
2389 2401
2390 2402
2391=head2 C<ev_signal> - signal me when a signal gets signalled! 2403=head2 C<ev_signal> - signal me when a signal gets signalled!
2392 2404
2393Signal watchers will trigger an event when the process receives a specific 2405Signal watchers will trigger an event when the process receives a specific
2394signal one or more times. Even though signals are very asynchronous, libev 2406signal one or more times. Even though signals are very asynchronous, libev
2404only within the same loop, i.e. you can watch for C<SIGINT> in your 2416only within the same loop, i.e. you can watch for C<SIGINT> in your
2405default loop and for C<SIGIO> in another loop, but you cannot watch for 2417default loop and for C<SIGIO> in another loop, but you cannot watch for
2406C<SIGINT> in both the default loop and another loop at the same time. At 2418C<SIGINT> in both the default loop and another loop at the same time. At
2407the moment, C<SIGCHLD> is permanently tied to the default loop. 2419the moment, C<SIGCHLD> is permanently tied to the default loop.
2408 2420
2409When the first watcher gets started will libev actually register something 2421Only after the first watcher for a signal is started will libev actually
2410with the kernel (thus it coexists with your own signal handlers as long as 2422register something with the kernel. It thus coexists with your own signal
2411you don't register any with libev for the same signal). 2423handlers as long as you don't register any with libev for the same signal.
2412 2424
2413If possible and supported, libev will install its handlers with 2425If possible and supported, libev will install its handlers with
2414C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2426C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2415not be unduly interrupted. If you have a problem with system calls getting 2427not be unduly interrupted. If you have a problem with system calls getting
2416interrupted by signals you can block all signals in an C<ev_check> watcher 2428interrupted by signals you can block all signals in an C<ev_check> watcher
2601 2613
2602=head2 C<ev_stat> - did the file attributes just change? 2614=head2 C<ev_stat> - did the file attributes just change?
2603 2615
2604This watches a file system path for attribute changes. That is, it calls 2616This watches a file system path for attribute changes. That is, it calls
2605C<stat> on that path in regular intervals (or when the OS says it changed) 2617C<stat> on that path in regular intervals (or when the OS says it changed)
2606and sees if it changed compared to the last time, invoking the callback if 2618and sees if it changed compared to the last time, invoking the callback
2607it did. 2619if it did. Starting the watcher C<stat>'s the file, so only changes that
2620happen after the watcher has been started will be reported.
2608 2621
2609The path does not need to exist: changing from "path exists" to "path does 2622The path does not need to exist: changing from "path exists" to "path does
2610not exist" is a status change like any other. The condition "path does not 2623not exist" is a status change like any other. The condition "path does not
2611exist" (or more correctly "path cannot be stat'ed") is signified by the 2624exist" (or more correctly "path cannot be stat'ed") is signified by the
2612C<st_nlink> field being zero (which is otherwise always forced to be at 2625C<st_nlink> field being zero (which is otherwise always forced to be at
2842Apart from keeping your process non-blocking (which is a useful 2855Apart from keeping your process non-blocking (which is a useful
2843effect on its own sometimes), idle watchers are a good place to do 2856effect on its own sometimes), idle watchers are a good place to do
2844"pseudo-background processing", or delay processing stuff to after the 2857"pseudo-background processing", or delay processing stuff to after the
2845event loop has handled all outstanding events. 2858event loop has handled all outstanding events.
2846 2859
2860=head3 Abusing an C<ev_idle> watcher for its side-effect
2861
2862As long as there is at least one active idle watcher, libev will never
2863sleep unnecessarily. Or in other words, it will loop as fast as possible.
2864For this to work, the idle watcher doesn't need to be invoked at all - the
2865lowest priority will do.
2866
2867This mode of operation can be useful together with an C<ev_check> watcher,
2868to do something on each event loop iteration - for example to balance load
2869between different connections.
2870
2871See L</Abusing an ev_check watcher for its side-effect> for a longer
2872example.
2873
2847=head3 Watcher-Specific Functions and Data Members 2874=head3 Watcher-Specific Functions and Data Members
2848 2875
2849=over 4 2876=over 4
2850 2877
2851=item ev_idle_init (ev_idle *, callback) 2878=item ev_idle_init (ev_idle *, callback)
2862callback, free it. Also, use no error checking, as usual. 2889callback, free it. Also, use no error checking, as usual.
2863 2890
2864 static void 2891 static void
2865 idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 2892 idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2866 { 2893 {
2894 // stop the watcher
2895 ev_idle_stop (loop, w);
2896
2897 // now we can free it
2867 free (w); 2898 free (w);
2899
2868 // now do something you wanted to do when the program has 2900 // now do something you wanted to do when the program has
2869 // no longer anything immediate to do. 2901 // no longer anything immediate to do.
2870 } 2902 }
2871 2903
2872 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2904 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2874 ev_idle_start (loop, idle_watcher); 2906 ev_idle_start (loop, idle_watcher);
2875 2907
2876 2908
2877=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 2909=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2878 2910
2879Prepare and check watchers are usually (but not always) used in pairs: 2911Prepare and check watchers are often (but not always) used in pairs:
2880prepare watchers get invoked before the process blocks and check watchers 2912prepare watchers get invoked before the process blocks and check watchers
2881afterwards. 2913afterwards.
2882 2914
2883You I<must not> call C<ev_run> or similar functions that enter 2915You I<must not> call C<ev_run> (or similar functions that enter the
2884the current event loop from either C<ev_prepare> or C<ev_check> 2916current event loop) or C<ev_loop_fork> from either C<ev_prepare> or
2885watchers. Other loops than the current one are fine, however. The 2917C<ev_check> watchers. Other loops than the current one are fine,
2886rationale behind this is that you do not need to check for recursion in 2918however. The rationale behind this is that you do not need to check
2887those watchers, i.e. the sequence will always be C<ev_prepare>, blocking, 2919for recursion in those watchers, i.e. the sequence will always be
2888C<ev_check> so if you have one watcher of each kind they will always be 2920C<ev_prepare>, blocking, C<ev_check> so if you have one watcher of each
2889called in pairs bracketing the blocking call. 2921kind they will always be called in pairs bracketing the blocking call.
2890 2922
2891Their main purpose is to integrate other event mechanisms into libev and 2923Their main purpose is to integrate other event mechanisms into libev and
2892their use is somewhat advanced. They could be used, for example, to track 2924their use is somewhat advanced. They could be used, for example, to track
2893variable changes, implement your own watchers, integrate net-snmp or a 2925variable changes, implement your own watchers, integrate net-snmp or a
2894coroutine library and lots more. They are also occasionally useful if 2926coroutine library and lots more. They are also occasionally useful if
2912with priority higher than or equal to the event loop and one coroutine 2944with priority higher than or equal to the event loop and one coroutine
2913of lower priority, but only once, using idle watchers to keep the event 2945of lower priority, but only once, using idle watchers to keep the event
2914loop from blocking if lower-priority coroutines are active, thus mapping 2946loop from blocking if lower-priority coroutines are active, thus mapping
2915low-priority coroutines to idle/background tasks). 2947low-priority coroutines to idle/background tasks).
2916 2948
2917It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 2949When used for this purpose, it is recommended to give C<ev_check> watchers
2918priority, to ensure that they are being run before any other watchers 2950highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2919after the poll (this doesn't matter for C<ev_prepare> watchers). 2951any other watchers after the poll (this doesn't matter for C<ev_prepare>
2952watchers).
2920 2953
2921Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not 2954Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2922activate ("feed") events into libev. While libev fully supports this, they 2955activate ("feed") events into libev. While libev fully supports this, they
2923might get executed before other C<ev_check> watchers did their job. As 2956might get executed before other C<ev_check> watchers did their job. As
2924C<ev_check> watchers are often used to embed other (non-libev) event 2957C<ev_check> watchers are often used to embed other (non-libev) event
2925loops those other event loops might be in an unusable state until their 2958loops those other event loops might be in an unusable state until their
2926C<ev_check> watcher ran (always remind yourself to coexist peacefully with 2959C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2927others). 2960others).
2961
2962=head3 Abusing an C<ev_check> watcher for its side-effect
2963
2964C<ev_check> (and less often also C<ev_prepare>) watchers can also be
2965useful because they are called once per event loop iteration. For
2966example, if you want to handle a large number of connections fairly, you
2967normally only do a bit of work for each active connection, and if there
2968is more work to do, you wait for the next event loop iteration, so other
2969connections have a chance of making progress.
2970
2971Using an C<ev_check> watcher is almost enough: it will be called on the
2972next event loop iteration. However, that isn't as soon as possible -
2973without external events, your C<ev_check> watcher will not be invoked.
2974
2975This is where C<ev_idle> watchers come in handy - all you need is a
2976single global idle watcher that is active as long as you have one active
2977C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
2978will not sleep, and the C<ev_check> watcher makes sure a callback gets
2979invoked. Neither watcher alone can do that.
2928 2980
2929=head3 Watcher-Specific Functions and Data Members 2981=head3 Watcher-Specific Functions and Data Members
2930 2982
2931=over 4 2983=over 4
2932 2984
3133 3185
3134=over 4 3186=over 4
3135 3187
3136=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 3188=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
3137 3189
3138=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 3190=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
3139 3191
3140Configures the watcher to embed the given loop, which must be 3192Configures the watcher to embed the given loop, which must be
3141embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be 3193embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
3142invoked automatically, otherwise it is the responsibility of the callback 3194invoked automatically, otherwise it is the responsibility of the callback
3143to invoke it (it will continue to be called until the sweep has been done, 3195to invoke it (it will continue to be called until the sweep has been done,
3164used). 3216used).
3165 3217
3166 struct ev_loop *loop_hi = ev_default_init (0); 3218 struct ev_loop *loop_hi = ev_default_init (0);
3167 struct ev_loop *loop_lo = 0; 3219 struct ev_loop *loop_lo = 0;
3168 ev_embed embed; 3220 ev_embed embed;
3169 3221
3170 // see if there is a chance of getting one that works 3222 // see if there is a chance of getting one that works
3171 // (remember that a flags value of 0 means autodetection) 3223 // (remember that a flags value of 0 means autodetection)
3172 loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3224 loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3173 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3225 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3174 : 0; 3226 : 0;
3188C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). 3240C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3189 3241
3190 struct ev_loop *loop = ev_default_init (0); 3242 struct ev_loop *loop = ev_default_init (0);
3191 struct ev_loop *loop_socket = 0; 3243 struct ev_loop *loop_socket = 0;
3192 ev_embed embed; 3244 ev_embed embed;
3193 3245
3194 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3246 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3195 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3247 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3196 { 3248 {
3197 ev_embed_init (&embed, 0, loop_socket); 3249 ev_embed_init (&embed, 0, loop_socket);
3198 ev_embed_start (loop, &embed); 3250 ev_embed_start (loop, &embed);
3206 3258
3207=head2 C<ev_fork> - the audacity to resume the event loop after a fork 3259=head2 C<ev_fork> - the audacity to resume the event loop after a fork
3208 3260
3209Fork watchers are called when a C<fork ()> was detected (usually because 3261Fork watchers are called when a C<fork ()> was detected (usually because
3210whoever is a good citizen cared to tell libev about it by calling 3262whoever is a good citizen cared to tell libev about it by calling
3211C<ev_default_fork> or C<ev_loop_fork>). The invocation is done before the 3263C<ev_loop_fork>). The invocation is done before the event loop blocks next
3212event loop blocks next and before C<ev_check> watchers are being called, 3264and before C<ev_check> watchers are being called, and only in the child
3213and only in the child after the fork. If whoever good citizen calling 3265after the fork. If whoever good citizen calling C<ev_default_fork> cheats
3214C<ev_default_fork> cheats and calls it in the wrong process, the fork 3266and calls it in the wrong process, the fork handlers will be invoked, too,
3215handlers will be invoked, too, of course. 3267of course.
3216 3268
3217=head3 The special problem of life after fork - how is it possible? 3269=head3 The special problem of life after fork - how is it possible?
3218 3270
3219Most uses of C<fork()> consist of forking, then some simple calls to set 3271Most uses of C<fork ()> consist of forking, then some simple calls to set
3220up/change the process environment, followed by a call to C<exec()>. This 3272up/change the process environment, followed by a call to C<exec()>. This
3221sequence should be handled by libev without any problems. 3273sequence should be handled by libev without any problems.
3222 3274
3223This changes when the application actually wants to do event handling 3275This changes when the application actually wants to do event handling
3224in the child, or both parent in child, in effect "continuing" after the 3276in the child, or both parent in child, in effect "continuing" after the
3614already been invoked. 3666already been invoked.
3615 3667
3616A common way around all these issues is to make sure that 3668A common way around all these issues is to make sure that
3617C<start_new_request> I<always> returns before the callback is invoked. If 3669C<start_new_request> I<always> returns before the callback is invoked. If
3618C<start_new_request> immediately knows the result, it can artificially 3670C<start_new_request> immediately knows the result, it can artificially
3619delay invoking the callback by e.g. using a C<prepare> or C<idle> watcher 3671delay invoking the callback by using a C<prepare> or C<idle> watcher for
3620for example, or more sneakily, by reusing an existing (stopped) watcher 3672example, or more sneakily, by reusing an existing (stopped) watcher and
3621and pushing it into the pending queue: 3673pushing it into the pending queue:
3622 3674
3623 ev_set_cb (watcher, callback); 3675 ev_set_cb (watcher, callback);
3624 ev_feed_event (EV_A_ watcher, 0); 3676 ev_feed_event (EV_A_ watcher, 0);
3625 3677
3626This way, C<start_new_request> can safely return before the callback is 3678This way, C<start_new_request> can safely return before the callback is
3634 3686
3635This brings the problem of exiting - a callback might want to finish the 3687This brings the problem of exiting - a callback might want to finish the
3636main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but 3688main C<ev_run> call, but not the nested one (e.g. user clicked "Quit", but
3637a modal "Are you sure?" dialog is still waiting), or just the nested one 3689a modal "Are you sure?" dialog is still waiting), or just the nested one
3638and not the main one (e.g. user clocked "Ok" in a modal dialog), or some 3690and not the main one (e.g. user clocked "Ok" in a modal dialog), or some
3639other combination: In these cases, C<ev_break> will not work alone. 3691other combination: In these cases, a simple C<ev_break> will not work.
3640 3692
3641The solution is to maintain "break this loop" variable for each C<ev_run> 3693The solution is to maintain "break this loop" variable for each C<ev_run>
3642invocation, and use a loop around C<ev_run> until the condition is 3694invocation, and use a loop around C<ev_run> until the condition is
3643triggered, using C<EVRUN_ONCE>: 3695triggered, using C<EVRUN_ONCE>:
3644 3696
3830called): 3882called):
3831 3883
3832 void 3884 void
3833 wait_for_event (ev_watcher *w) 3885 wait_for_event (ev_watcher *w)
3834 { 3886 {
3835 ev_cb_set (w) = current_coro; 3887 ev_set_cb (w, current_coro);
3836 switch_to (libev_coro); 3888 switch_to (libev_coro);
3837 } 3889 }
3838 3890
3839That basically suspends the coroutine inside C<wait_for_event> and 3891That basically suspends the coroutine inside C<wait_for_event> and
3840continues the libev coroutine, which, when appropriate, switches back to 3892continues the libev coroutine, which, when appropriate, switches back to
3843You can do similar tricks if you have, say, threads with an event queue - 3895You can do similar tricks if you have, say, threads with an event queue -
3844instead of storing a coroutine, you store the queue object and instead of 3896instead of storing a coroutine, you store the queue object and instead of
3845switching to a coroutine, you push the watcher onto the queue and notify 3897switching to a coroutine, you push the watcher onto the queue and notify
3846any waiters. 3898any waiters.
3847 3899
3848To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two 3900To embed libev, see L</EMBEDDING>, but in short, it's easiest to create two
3849files, F<my_ev.h> and F<my_ev.c> that include the respective libev files: 3901files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3850 3902
3851 // my_ev.h 3903 // my_ev.h
3852 #define EV_CB_DECLARE(type) struct my_coro *cb; 3904 #define EV_CB_DECLARE(type) struct my_coro *cb;
3853 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 3905 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb)
3854 #include "../libev/ev.h" 3906 #include "../libev/ev.h"
3855 3907
3856 // my_ev.c 3908 // my_ev.c
3857 #define EV_H "my_ev.h" 3909 #define EV_H "my_ev.h"
3858 #include "../libev/ev.c" 3910 #include "../libev/ev.c"
3905libev sources can be compiled as C++. Therefore, code that uses the C API 3957libev sources can be compiled as C++. Therefore, code that uses the C API
3906will work fine. 3958will work fine.
3907 3959
3908Proper exception specifications might have to be added to callbacks passed 3960Proper exception specifications might have to be added to callbacks passed
3909to libev: exceptions may be thrown only from watcher callbacks, all 3961to libev: exceptions may be thrown only from watcher callbacks, all
3910other callbacks (allocator, syserr, loop acquire/release and periodioc 3962other callbacks (allocator, syserr, loop acquire/release and periodic
3911reschedule callbacks) must not throw exceptions, and might need a C<throw 3963reschedule callbacks) must not throw exceptions, and might need a C<throw
3912()> specification. If you have code that needs to be compiled as both C 3964()> specification. If you have code that needs to be compiled as both C
3913and C++ you can use the C<EV_THROW> macro for this: 3965and C++ you can use the C<EV_THROW> macro for this:
3914 3966
3915 static void 3967 static void
3935Libev comes with some simplistic wrapper classes for C++ that mainly allow 3987Libev comes with some simplistic wrapper classes for C++ that mainly allow
3936you to use some convenience methods to start/stop watchers and also change 3988you to use some convenience methods to start/stop watchers and also change
3937the callback model to a model using method callbacks on objects. 3989the callback model to a model using method callbacks on objects.
3938 3990
3939To use it, 3991To use it,
3940 3992
3941 #include <ev++.h> 3993 #include <ev++.h>
3942 3994
3943This automatically includes F<ev.h> and puts all of its definitions (many 3995This automatically includes F<ev.h> and puts all of its definitions (many
3944of them macros) into the global namespace. All C++ specific things are 3996of them macros) into the global namespace. All C++ specific things are
3945put into the C<ev> namespace. It should support all the same embedding 3997put into the C<ev> namespace. It should support all the same embedding
4048 void operator() (ev::io &w, int revents) 4100 void operator() (ev::io &w, int revents)
4049 { 4101 {
4050 ... 4102 ...
4051 } 4103 }
4052 } 4104 }
4053 4105
4054 myfunctor f; 4106 myfunctor f;
4055 4107
4056 ev::io w; 4108 ev::io w;
4057 w.set (&f); 4109 w.set (&f);
4058 4110
4076Associates a different C<struct ev_loop> with this watcher. You can only 4128Associates a different C<struct ev_loop> with this watcher. You can only
4077do this when the watcher is inactive (and not pending either). 4129do this when the watcher is inactive (and not pending either).
4078 4130
4079=item w->set ([arguments]) 4131=item w->set ([arguments])
4080 4132
4081Basically the same as C<ev_TYPE_set>, with the same arguments. Either this 4133Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
4082method or a suitable start method must be called at least once. Unlike the 4134with the same arguments. Either this method or a suitable start method
4083C counterpart, an active watcher gets automatically stopped and restarted 4135must be called at least once. Unlike the C counterpart, an active watcher
4084when reconfiguring it with this method. 4136gets automatically stopped and restarted when reconfiguring it with this
4137method.
4138
4139For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4140clashing with the C<set (loop)> method.
4085 4141
4086=item w->start () 4142=item w->start ()
4087 4143
4088Starts the watcher. Note that there is no C<loop> argument, as the 4144Starts the watcher. Note that there is no C<loop> argument, as the
4089constructor already stores the event loop. 4145constructor already stores the event loop.
4192=item Lua 4248=item Lua
4193 4249
4194Brian Maher has written a partial interface to libev for lua (at the 4250Brian Maher has written a partial interface to libev for lua (at the
4195time of this writing, only C<ev_io> and C<ev_timer>), to be found at 4251time of this writing, only C<ev_io> and C<ev_timer>), to be found at
4196L<http://github.com/brimworks/lua-ev>. 4252L<http://github.com/brimworks/lua-ev>.
4253
4254=item Javascript
4255
4256Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
4257
4258=item Others
4259
4260There are others, and I stopped counting.
4197 4261
4198=back 4262=back
4199 4263
4200 4264
4201=head1 MACRO MAGIC 4265=head1 MACRO MAGIC
4500 4564
4501If programs implement their own fd to handle mapping on win32, then this 4565If programs implement their own fd to handle mapping on win32, then this
4502macro can be used to override the C<close> function, useful to unregister 4566macro can be used to override the C<close> function, useful to unregister
4503file descriptors again. Note that the replacement function has to close 4567file descriptors again. Note that the replacement function has to close
4504the underlying OS handle. 4568the underlying OS handle.
4569
4570=item EV_USE_WSASOCKET
4571
4572If defined to be C<1>, libev will use C<WSASocket> to create its internal
4573communication socket, which works better in some environments. Otherwise,
4574the normal C<socket> function will be used, which works better in other
4575environments.
4505 4576
4506=item EV_USE_POLL 4577=item EV_USE_POLL
4507 4578
4508If defined to be C<1>, libev will compile in support for the C<poll>(2) 4579If defined to be C<1>, libev will compile in support for the C<poll>(2)
4509backend. Otherwise it will be enabled on non-win32 platforms. It 4580backend. Otherwise it will be enabled on non-win32 platforms. It
4554different cpus (or different cpu cores). This reduces dependencies 4625different cpus (or different cpu cores). This reduces dependencies
4555and makes libev faster. 4626and makes libev faster.
4556 4627
4557=item EV_NO_THREADS 4628=item EV_NO_THREADS
4558 4629
4559If defined to be C<1>, libev will assume that it will never be called 4630If defined to be C<1>, libev will assume that it will never be called from
4560from different threads, which is a stronger assumption than C<EV_NO_SMP>, 4631different threads (that includes signal handlers), which is a stronger
4561above. This reduces dependencies and makes libev faster. 4632assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
4633libev faster.
4562 4634
4563=item EV_ATOMIC_T 4635=item EV_ATOMIC_T
4564 4636
4565Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4637Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4566access is atomic and serialised with respect to other threads or signal 4638access is atomic with respect to other threads or signal contexts. No
4567contexts. No such type is easily found in the C language, so you can 4639such type is easily found in the C language, so you can provide your own
4568provide your own type that you know is safe for your purposes. It is used 4640type that you know is safe for your purposes. It is used both for signal
4569both for signal handler "locking" as well as for signal and thread safety 4641handler "locking" as well as for signal and thread safety in C<ev_async>
4570in C<ev_async> watchers. 4642watchers.
4571 4643
4572In the absence of this define, libev will use C<sig_atomic_t volatile> 4644In the absence of this define, libev will use C<sig_atomic_t volatile>
4573(from F<signal.h>), which is usually good enough on most platforms, 4645(from F<signal.h>), which is usually good enough on most platforms.
4574although strictly speaking using a type that also implies a memory fence
4575is required.
4576 4646
4577=item EV_H (h) 4647=item EV_H (h)
4578 4648
4579The name of the F<ev.h> header file used to include it. The default if 4649The name of the F<ev.h> header file used to include it. The default if
4580undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be 4650undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
4948default loop and triggering an C<ev_async> watcher from the default loop 5018default loop and triggering an C<ev_async> watcher from the default loop
4949watcher callback into the event loop interested in the signal. 5019watcher callback into the event loop interested in the signal.
4950 5020
4951=back 5021=back
4952 5022
4953See also L<THREAD LOCKING EXAMPLE>. 5023See also L</THREAD LOCKING EXAMPLE>.
4954 5024
4955=head3 COROUTINES 5025=head3 COROUTINES
4956 5026
4957Libev is very accommodating to coroutines ("cooperative threads"): 5027Libev is very accommodating to coroutines ("cooperative threads"):
4958libev fully supports nesting calls to its functions from different 5028libev fully supports nesting calls to its functions from different
5249thread" or will block signals process-wide, both behaviours would 5319thread" or will block signals process-wide, both behaviours would
5250be compatible with libev. Interaction between C<sigprocmask> and 5320be compatible with libev. Interaction between C<sigprocmask> and
5251C<pthread_sigmask> could complicate things, however. 5321C<pthread_sigmask> could complicate things, however.
5252 5322
5253The most portable way to handle signals is to block signals in all threads 5323The most portable way to handle signals is to block signals in all threads
5254except the initial one, and run the default loop in the initial thread as 5324except the initial one, and run the signal handling loop in the initial
5255well. 5325thread as well.
5256 5326
5257=item C<long> must be large enough for common memory allocation sizes 5327=item C<long> must be large enough for common memory allocation sizes
5258 5328
5259To improve portability and simplify its API, libev uses C<long> internally 5329To improve portability and simplify its API, libev uses C<long> internally
5260instead of C<size_t> when allocating its data structures. On non-POSIX 5330instead of C<size_t> when allocating its data structures. On non-POSIX
5364=over 4 5434=over 4
5365 5435
5366=item C<EV_COMPAT3> backwards compatibility mechanism 5436=item C<EV_COMPAT3> backwards compatibility mechanism
5367 5437
5368The backward compatibility mechanism can be controlled by 5438The backward compatibility mechanism can be controlled by
5369C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> 5439C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5370section. 5440section.
5371 5441
5372=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5442=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5373 5443
5374These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5444These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
5417=over 4 5487=over 4
5418 5488
5419=item active 5489=item active
5420 5490
5421A watcher is active as long as it has been started and not yet stopped. 5491A watcher is active as long as it has been started and not yet stopped.
5422See L<WATCHER STATES> for details. 5492See L</WATCHER STATES> for details.
5423 5493
5424=item application 5494=item application
5425 5495
5426In this document, an application is whatever is using libev. 5496In this document, an application is whatever is using libev.
5427 5497
5463watchers and events. 5533watchers and events.
5464 5534
5465=item pending 5535=item pending
5466 5536
5467A watcher is pending as soon as the corresponding event has been 5537A watcher is pending as soon as the corresponding event has been
5468detected. See L<WATCHER STATES> for details. 5538detected. See L</WATCHER STATES> for details.
5469 5539
5470=item real time 5540=item real time
5471 5541
5472The physical time that is observed. It is apparently strictly monotonic :) 5542The physical time that is observed. It is apparently strictly monotonic :)
5473 5543

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines