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

Comparing libev/ev.pod (file contents):
Revision 1.399 by root, Mon Apr 2 23:14:41 2012 UTC vs.
Revision 1.427 by root, Sun Apr 28 14:57:12 2013 UTC

82 82
83=head1 WHAT TO READ WHEN IN A HURRY 83=head1 WHAT TO READ WHEN IN A HURRY
84 84
85This manual tries to be very detailed, but unfortunately, this also makes 85This 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 86it 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 87reading 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 88look up the missing functions in L</GLOBAL FUNCTIONS> and the C<ev_io> and
89C<ev_timer> sections in L<WATCHER TYPES>. 89C<ev_timer> sections in L</WATCHER TYPES>.
90 90
91=head1 ABOUT LIBEV 91=head1 ABOUT LIBEV
92 92
93Libev is an event loop: you register interest in certain events (such as a 93Libev 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 94file descriptor being readable or a timeout occurring), and it will manage
247the current system, you would need to look at C<ev_embeddable_backends () 247the current system, you would need to look at C<ev_embeddable_backends ()
248& ev_supported_backends ()>, likewise for recommended ones. 248& ev_supported_backends ()>, likewise for recommended ones.
249 249
250See the description of C<ev_embed> watchers for more info. 250See the description of C<ev_embed> watchers for more info.
251 251
252=item ev_set_allocator (void *(*cb)(void *ptr, long size)) 252=item ev_set_allocator (void *(*cb)(void *ptr, long size) throw ())
253 253
254Sets the allocation function to use (the prototype is similar - the 254Sets the allocation function to use (the prototype is similar - the
255semantics are identical to the C<realloc> C89/SuS/POSIX function). It is 255semantics are identical to the C<realloc> C89/SuS/POSIX function). It is
256used to allocate and free memory (no surprises here). If it returns zero 256used to allocate and free memory (no surprises here). If it returns zero
257when memory needs to be allocated (C<size != 0>), the library might abort 257when memory needs to be allocated (C<size != 0>), the library might abort
283 } 283 }
284 284
285 ... 285 ...
286 ev_set_allocator (persistent_realloc); 286 ev_set_allocator (persistent_realloc);
287 287
288=item ev_set_syserr_cb (void (*cb)(const char *msg)) 288=item ev_set_syserr_cb (void (*cb)(const char *msg) throw ())
289 289
290Set the callback function to call on a retryable system call error (such 290Set the callback function to call on a retryable system call error (such
291as failed select, poll, epoll_wait). The message is a printable string 291as failed select, poll, epoll_wait). The message is a printable string
292indicating the system call or subsystem causing the problem. If this 292indicating the system call or subsystem causing the problem. If this
293callback is set, then libev will expect it to remedy the situation, no 293callback is set, then libev will expect it to remedy the situation, no
396 396
397If this flag bit is or'ed into the flag value (or the program runs setuid 397If 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 398or setgid) then libev will I<not> look at the environment variable
399C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will 399C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
400override the flags completely if it is found in the environment. This is 400override 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 401useful to try out specific backends to test their performance, to work
402around bugs. 402around bugs, or to make libev threadsafe (accessing environment variables
403cannot be done in a threadsafe way, but usually it works if no other
404thread modifies them).
403 405
404=item C<EVFLAG_FORKCHECK> 406=item C<EVFLAG_FORKCHECK>
405 407
406Instead of calling C<ev_loop_fork> manually after a fork, you can also 408Instead 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. 409make libev check for a fork in each iteration by enabling this flag.
569kernel is more efficient (which says nothing about its actual speed, of 571kernel is more efficient (which says nothing about its actual speed, of
570course). While stopping, setting and starting an I/O watcher does never 572course). 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 573cause 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 574two 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 575might 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 576drops fds silently in similarly hard-to-detect cases.
575 577
576This backend usually performs well under most conditions. 578This backend usually performs well under most conditions.
577 579
578While nominally embeddable in other event loops, this doesn't work 580While nominally embeddable in other event loops, this doesn't work
579everywhere, so you might need to test for this. And since it is broken 581everywhere, so you might need to test for this. And since it is broken
764 766
765This function is rarely useful, but when some event callback runs for a 767This 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 768very long time without entering the event loop, updating libev's idea of
767the current time is a good idea. 769the current time is a good idea.
768 770
769See also L<The special problem of time updates> in the C<ev_timer> section. 771See also L</The special problem of time updates> in the C<ev_timer> section.
770 772
771=item ev_suspend (loop) 773=item ev_suspend (loop)
772 774
773=item ev_resume (loop) 775=item ev_resume (loop)
774 776
1016invoke the actual watchers inside another context (another thread etc.). 1018invoke the actual watchers inside another context (another thread etc.).
1017 1019
1018If you want to reset the callback, use C<ev_invoke_pending> as new 1020If you want to reset the callback, use C<ev_invoke_pending> as new
1019callback. 1021callback.
1020 1022
1021=item ev_set_loop_release_cb (loop, void (*release)(EV_P), void (*acquire)(EV_P)) 1023=item ev_set_loop_release_cb (loop, void (*release)(EV_P) throw (), void (*acquire)(EV_P) throw ())
1022 1024
1023Sometimes you want to share the same loop between multiple threads. This 1025Sometimes you want to share the same loop between multiple threads. This
1024can be done relatively simply by putting mutex_lock/unlock calls around 1026can be done relatively simply by putting mutex_lock/unlock calls around
1025each call to a libev function. 1027each call to a libev function.
1026 1028
1174 1176
1175=item C<EV_PREPARE> 1177=item C<EV_PREPARE>
1176 1178
1177=item C<EV_CHECK> 1179=item C<EV_CHECK>
1178 1180
1179All C<ev_prepare> watchers are invoked just I<before> C<ev_run> starts 1181All 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 1182gather 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 1183just after C<ev_run> has gathered them, but before it queues any callbacks
1184for any received events. That means C<ev_prepare> watchers are the last
1185watchers invoked before the event loop sleeps or polls for new events, and
1186C<ev_check> watchers will be invoked before any other watchers of the same
1187or lower priority within an event loop iteration.
1188
1182received events. Callbacks of both watcher types can start and stop as 1189Callbacks 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 1190they 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 1191C<ev_prepare> watcher might start an idle watcher to keep C<ev_run> from
1185C<ev_run> from blocking). 1192blocking).
1186 1193
1187=item C<EV_EMBED> 1194=item C<EV_EMBED>
1188 1195
1189The embedded event loop specified in the C<ev_embed> watcher needs attention. 1196The embedded event loop specified in the C<ev_embed> watcher needs attention.
1190 1197
1313 1320
1314=item callback ev_cb (ev_TYPE *watcher) 1321=item callback ev_cb (ev_TYPE *watcher)
1315 1322
1316Returns the callback currently set on the watcher. 1323Returns the callback currently set on the watcher.
1317 1324
1318=item ev_cb_set (ev_TYPE *watcher, callback) 1325=item ev_set_cb (ev_TYPE *watcher, callback)
1319 1326
1320Change the callback. You can change the callback at virtually any time 1327Change the callback. You can change the callback at virtually any time
1321(modulo threads). 1328(modulo threads).
1322 1329
1323=item ev_set_priority (ev_TYPE *watcher, int priority) 1330=item ev_set_priority (ev_TYPE *watcher, int priority)
1341or might not have been clamped to the valid range. 1348or might not have been clamped to the valid range.
1342 1349
1343The default priority used by watchers when no priority has been set is 1350The 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 :). 1351always C<0>, which is supposed to not be too high and not be too low :).
1345 1352
1346See L<WATCHER PRIORITY MODELS>, below, for a more thorough treatment of 1353See L</WATCHER PRIORITY MODELS>, below, for a more thorough treatment of
1347priorities. 1354priorities.
1348 1355
1349=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1356=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1350 1357
1351Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1358Invoke 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 1383See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related
1377functions that do not need a watcher. 1384functions that do not need a watcher.
1378 1385
1379=back 1386=back
1380 1387
1381See also the L<ASSOCIATING CUSTOM DATA WITH A WATCHER> and L<BUILDING YOUR 1388See also the L</ASSOCIATING CUSTOM DATA WITH A WATCHER> and L</BUILDING YOUR
1382OWN COMPOSITE WATCHERS> idioms. 1389OWN COMPOSITE WATCHERS> idioms.
1383 1390
1384=head2 WATCHER STATES 1391=head2 WATCHER STATES
1385 1392
1386There are various watcher states mentioned throughout this manual - 1393There are various watcher states mentioned throughout this manual -
1388transition between them will be described in more detail - and while these 1395transition between them will be described in more detail - and while these
1389rules might look complicated, they usually do "the right thing". 1396rules might look complicated, they usually do "the right thing".
1390 1397
1391=over 4 1398=over 4
1392 1399
1393=item initialiased 1400=item initialised
1394 1401
1395Before a watcher can be registered with the event loop it has to be 1402Before 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 1403initialised. 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. 1404C<ev_init> followed by the watcher-specific C<ev_TYPE_set> function.
1398 1405
1874 callback (EV_P_ ev_timer *w, int revents) 1881 callback (EV_P_ ev_timer *w, int revents)
1875 { 1882 {
1876 // calculate when the timeout would happen 1883 // calculate when the timeout would happen
1877 ev_tstamp after = last_activity - ev_now (EV_A) + timeout; 1884 ev_tstamp after = last_activity - ev_now (EV_A) + timeout;
1878 1885
1879 // if negative, it means we the timeout already occured 1886 // if negative, it means we the timeout already occurred
1880 if (after < 0.) 1887 if (after < 0.)
1881 { 1888 {
1882 // timeout occurred, take action 1889 // timeout occurred, take action
1883 } 1890 }
1884 else 1891 else
1902 1909
1903Otherwise, we now the earliest time at which the timeout would trigger, 1910Otherwise, we now the earliest time at which the timeout would trigger,
1904and simply start the timer with this timeout value. 1911and simply start the timer with this timeout value.
1905 1912
1906In other words, each time the callback is invoked it will check whether 1913In other words, each time the callback is invoked it will check whether
1907the timeout cocured. If not, it will simply reschedule itself to check 1914the timeout occurred. If not, it will simply reschedule itself to check
1908again at the earliest time it could time out. Rinse. Repeat. 1915again at the earliest time it could time out. Rinse. Repeat.
1909 1916
1910This scheme causes more callback invocations (about one every 60 seconds 1917This scheme causes more callback invocations (about one every 60 seconds
1911minus half the average time between activity), but virtually no calls to 1918minus half the average time between activity), but virtually no calls to
1912libev to change the timeout. 1919libev to change the timeout.
1926 if (activity detected) 1933 if (activity detected)
1927 last_activity = ev_now (EV_A); 1934 last_activity = ev_now (EV_A);
1928 1935
1929When your timeout value changes, then the timeout can be changed by simply 1936When your timeout value changes, then the timeout can be changed by simply
1930providing a new value, stopping the timer and calling the callback, which 1937providing a new value, stopping the timer and calling the callback, which
1931will agaion do the right thing (for example, time out immediately :). 1938will again do the right thing (for example, time out immediately :).
1932 1939
1933 timeout = new_value; 1940 timeout = new_value;
1934 ev_timer_stop (EV_A_ &timer); 1941 ev_timer_stop (EV_A_ &timer);
1935 callback (EV_A_ &timer, 0); 1942 callback (EV_A_ &timer, 0);
1936 1943
2131=item If the timer is repeating, make the C<repeat> value the new timeout 2138=item If the timer is repeating, make the C<repeat> value the new timeout
2132and start the timer, if necessary. 2139and start the timer, if necessary.
2133 2140
2134=back 2141=back
2135 2142
2136This sounds a bit complicated, see L<Be smart about timeouts>, above, for a 2143This sounds a bit complicated, see L</Be smart about timeouts>, above, for a
2137usage example. 2144usage example.
2138 2145
2139=item ev_tstamp ev_timer_remaining (loop, ev_timer *) 2146=item ev_tstamp ev_timer_remaining (loop, ev_timer *)
2140 2147
2141Returns the remaining time until a timer fires. If the timer is active, 2148Returns the remaining time until a timer fires. If the timer is active,
2601 2608
2602=head2 C<ev_stat> - did the file attributes just change? 2609=head2 C<ev_stat> - did the file attributes just change?
2603 2610
2604This watches a file system path for attribute changes. That is, it calls 2611This 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) 2612C<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 2613and sees if it changed compared to the last time, invoking the callback
2607it did. 2614if it did. Starting the watcher C<stat>'s the file, so only changes that
2615happen after the watcher has been started will be reported.
2608 2616
2609The path does not need to exist: changing from "path exists" to "path does 2617The 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 2618not 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 2619exist" (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 2620C<st_nlink> field being zero (which is otherwise always forced to be at
2842Apart from keeping your process non-blocking (which is a useful 2850Apart from keeping your process non-blocking (which is a useful
2843effect on its own sometimes), idle watchers are a good place to do 2851effect on its own sometimes), idle watchers are a good place to do
2844"pseudo-background processing", or delay processing stuff to after the 2852"pseudo-background processing", or delay processing stuff to after the
2845event loop has handled all outstanding events. 2853event loop has handled all outstanding events.
2846 2854
2855=head3 Abusing an C<ev_idle> watcher for its side-effect
2856
2857As long as there is at least one active idle watcher, libev will never
2858sleep unnecessarily. Or in other words, it will loop as fast as possible.
2859For this to work, the idle watcher doesn't need to be invoked at all - the
2860lowest priority will do.
2861
2862This mode of operation can be useful together with an C<ev_check> watcher,
2863to do something on each event loop iteration - for example to balance load
2864between different connections.
2865
2866See L</Abusing an ev_check watcher for its side-effect> for a longer
2867example.
2868
2847=head3 Watcher-Specific Functions and Data Members 2869=head3 Watcher-Specific Functions and Data Members
2848 2870
2849=over 4 2871=over 4
2850 2872
2851=item ev_idle_init (ev_idle *, callback) 2873=item ev_idle_init (ev_idle *, callback)
2862callback, free it. Also, use no error checking, as usual. 2884callback, free it. Also, use no error checking, as usual.
2863 2885
2864 static void 2886 static void
2865 idle_cb (struct ev_loop *loop, ev_idle *w, int revents) 2887 idle_cb (struct ev_loop *loop, ev_idle *w, int revents)
2866 { 2888 {
2889 // stop the watcher
2890 ev_idle_stop (loop, w);
2891
2892 // now we can free it
2867 free (w); 2893 free (w);
2894
2868 // now do something you wanted to do when the program has 2895 // now do something you wanted to do when the program has
2869 // no longer anything immediate to do. 2896 // no longer anything immediate to do.
2870 } 2897 }
2871 2898
2872 ev_idle *idle_watcher = malloc (sizeof (ev_idle)); 2899 ev_idle *idle_watcher = malloc (sizeof (ev_idle));
2874 ev_idle_start (loop, idle_watcher); 2901 ev_idle_start (loop, idle_watcher);
2875 2902
2876 2903
2877=head2 C<ev_prepare> and C<ev_check> - customise your event loop! 2904=head2 C<ev_prepare> and C<ev_check> - customise your event loop!
2878 2905
2879Prepare and check watchers are usually (but not always) used in pairs: 2906Prepare and check watchers are often (but not always) used in pairs:
2880prepare watchers get invoked before the process blocks and check watchers 2907prepare watchers get invoked before the process blocks and check watchers
2881afterwards. 2908afterwards.
2882 2909
2883You I<must not> call C<ev_run> or similar functions that enter 2910You I<must not> call C<ev_run> or similar functions that enter
2884the current event loop from either C<ev_prepare> or C<ev_check> 2911the current event loop from either C<ev_prepare> or C<ev_check>
2912with priority higher than or equal to the event loop and one coroutine 2939with 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 2940of lower priority, but only once, using idle watchers to keep the event
2914loop from blocking if lower-priority coroutines are active, thus mapping 2941loop from blocking if lower-priority coroutines are active, thus mapping
2915low-priority coroutines to idle/background tasks). 2942low-priority coroutines to idle/background tasks).
2916 2943
2917It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) 2944When 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 2945highest (C<EV_MAXPRI>) priority, to ensure that they are being run before
2919after the poll (this doesn't matter for C<ev_prepare> watchers). 2946any other watchers after the poll (this doesn't matter for C<ev_prepare>
2947watchers).
2920 2948
2921Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not 2949Also, C<ev_check> watchers (and C<ev_prepare> watchers, too) should not
2922activate ("feed") events into libev. While libev fully supports this, they 2950activate ("feed") events into libev. While libev fully supports this, they
2923might get executed before other C<ev_check> watchers did their job. As 2951might 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 2952C<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 2953loops those other event loops might be in an unusable state until their
2926C<ev_check> watcher ran (always remind yourself to coexist peacefully with 2954C<ev_check> watcher ran (always remind yourself to coexist peacefully with
2927others). 2955others).
2956
2957=head3 Abusing an C<ev_check> watcher for its side-effect
2958
2959C<ev_check> (and less often also C<ev_prepare>) watchers can also be
2960useful because they are called once per event loop iteration. For
2961example, if you want to handle a large number of connections fairly, you
2962normally only do a bit of work for each active connection, and if there
2963is more work to do, you wait for the next event loop iteration, so other
2964connections have a chance of making progress.
2965
2966Using an C<ev_check> watcher is almost enough: it will be called on the
2967next event loop iteration. However, that isn't as soon as possible -
2968without external events, your C<ev_check> watcher will not be invoked.
2969
2970This is where C<ev_idle> watchers come in handy - all you need is a
2971single global idle watcher that is active as long as you have one active
2972C<ev_check> watcher. The C<ev_idle> watcher makes sure the event loop
2973will not sleep, and the C<ev_check> watcher makes sure a callback gets
2974invoked. Neither watcher alone can do that.
2928 2975
2929=head3 Watcher-Specific Functions and Data Members 2976=head3 Watcher-Specific Functions and Data Members
2930 2977
2931=over 4 2978=over 4
2932 2979
3133 3180
3134=over 4 3181=over 4
3135 3182
3136=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) 3183=item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)
3137 3184
3138=item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) 3185=item ev_embed_set (ev_embed *, struct ev_loop *embedded_loop)
3139 3186
3140Configures the watcher to embed the given loop, which must be 3187Configures the watcher to embed the given loop, which must be
3141embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be 3188embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be
3142invoked automatically, otherwise it is the responsibility of the callback 3189invoked automatically, otherwise it is the responsibility of the callback
3143to invoke it (it will continue to be called until the sweep has been done, 3190to invoke it (it will continue to be called until the sweep has been done,
3206 3253
3207=head2 C<ev_fork> - the audacity to resume the event loop after a fork 3254=head2 C<ev_fork> - the audacity to resume the event loop after a fork
3208 3255
3209Fork watchers are called when a C<fork ()> was detected (usually because 3256Fork watchers are called when a C<fork ()> was detected (usually because
3210whoever is a good citizen cared to tell libev about it by calling 3257whoever 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 3258C<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, 3259and 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 3260after 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 3261and calls it in the wrong process, the fork handlers will be invoked, too,
3215handlers will be invoked, too, of course. 3262of course.
3216 3263
3217=head3 The special problem of life after fork - how is it possible? 3264=head3 The special problem of life after fork - how is it possible?
3218 3265
3219Most uses of C<fork()> consist of forking, then some simple calls to set 3266Most 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 3267up/change the process environment, followed by a call to C<exec()>. This
3313it by calling C<ev_async_send>, which is thread- and signal safe. 3360it by calling C<ev_async_send>, which is thread- and signal safe.
3314 3361
3315This functionality is very similar to C<ev_signal> watchers, as signals, 3362This functionality is very similar to C<ev_signal> watchers, as signals,
3316too, are asynchronous in nature, and signals, too, will be compressed 3363too, are asynchronous in nature, and signals, too, will be compressed
3317(i.e. the number of callback invocations may be less than the number of 3364(i.e. the number of callback invocations may be less than the number of
3318C<ev_async_sent> calls). In fact, you could use signal watchers as a kind 3365C<ev_async_send> calls). In fact, you could use signal watchers as a kind
3319of "global async watchers" by using a watcher on an otherwise unused 3366of "global async watchers" by using a watcher on an otherwise unused
3320signal, and C<ev_feed_signal> to signal this watcher from another thread, 3367signal, and C<ev_feed_signal> to signal this watcher from another thread,
3321even without knowing which loop owns the signal. 3368even without knowing which loop owns the signal.
3322 3369
3323=head3 Queueing 3370=head3 Queueing
3614already been invoked. 3661already been invoked.
3615 3662
3616A common way around all these issues is to make sure that 3663A common way around all these issues is to make sure that
3617C<start_new_request> I<always> returns before the callback is invoked. If 3664C<start_new_request> I<always> returns before the callback is invoked. If
3618C<start_new_request> immediately knows the result, it can artificially 3665C<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 3666delay invoking the callback by using a C<prepare> or C<idle> watcher for
3620for example, or more sneakily, by reusing an existing (stopped) watcher 3667example, or more sneakily, by reusing an existing (stopped) watcher and
3621and pushing it into the pending queue: 3668pushing it into the pending queue:
3622 3669
3623 ev_set_cb (watcher, callback); 3670 ev_set_cb (watcher, callback);
3624 ev_feed_event (EV_A_ watcher, 0); 3671 ev_feed_event (EV_A_ watcher, 0);
3625 3672
3626This way, C<start_new_request> can safely return before the callback is 3673This way, C<start_new_request> can safely return before the callback is
3634 3681
3635This brings the problem of exiting - a callback might want to finish the 3682This 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 3683main 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 3684a 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 3685and 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. 3686other combination: In these cases, a simple C<ev_break> will not work.
3640 3687
3641The solution is to maintain "break this loop" variable for each C<ev_run> 3688The 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 3689invocation, and use a loop around C<ev_run> until the condition is
3643triggered, using C<EVRUN_ONCE>: 3690triggered, using C<EVRUN_ONCE>:
3644 3691
3830called): 3877called):
3831 3878
3832 void 3879 void
3833 wait_for_event (ev_watcher *w) 3880 wait_for_event (ev_watcher *w)
3834 { 3881 {
3835 ev_cb_set (w) = current_coro; 3882 ev_set_cb (w, current_coro);
3836 switch_to (libev_coro); 3883 switch_to (libev_coro);
3837 } 3884 }
3838 3885
3839That basically suspends the coroutine inside C<wait_for_event> and 3886That basically suspends the coroutine inside C<wait_for_event> and
3840continues the libev coroutine, which, when appropriate, switches back to 3887continues the libev coroutine, which, when appropriate, switches back to
3843You can do similar tricks if you have, say, threads with an event queue - 3890You 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 3891instead 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 3892switching to a coroutine, you push the watcher onto the queue and notify
3846any waiters. 3893any waiters.
3847 3894
3848To embed libev, see L<EMBEDDING>, but in short, it's easiest to create two 3895To 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: 3896files, F<my_ev.h> and F<my_ev.c> that include the respective libev files:
3850 3897
3851 // my_ev.h 3898 // my_ev.h
3852 #define EV_CB_DECLARE(type) struct my_coro *cb; 3899 #define EV_CB_DECLARE(type) struct my_coro *cb;
3853 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb); 3900 #define EV_CB_INVOKE(watcher) switch_to ((watcher)->cb);
3896to use the libev header file and library. 3943to use the libev header file and library.
3897 3944
3898=back 3945=back
3899 3946
3900=head1 C++ SUPPORT 3947=head1 C++ SUPPORT
3948
3949=head2 C API
3950
3951The normal C API should work fine when used from C++: both ev.h and the
3952libev sources can be compiled as C++. Therefore, code that uses the C API
3953will work fine.
3954
3955Proper exception specifications might have to be added to callbacks passed
3956to libev: exceptions may be thrown only from watcher callbacks, all
3957other callbacks (allocator, syserr, loop acquire/release and periodic
3958reschedule callbacks) must not throw exceptions, and might need a C<throw
3959()> specification. If you have code that needs to be compiled as both C
3960and C++ you can use the C<EV_THROW> macro for this:
3961
3962 static void
3963 fatal_error (const char *msg) EV_THROW
3964 {
3965 perror (msg);
3966 abort ();
3967 }
3968
3969 ...
3970 ev_set_syserr_cb (fatal_error);
3971
3972The only API functions that can currently throw exceptions are C<ev_run>,
3973C<ev_invoke>, C<ev_invoke_pending> and C<ev_loop_destroy> (the latter
3974because it runs cleanup watchers).
3975
3976Throwing exceptions in watcher callbacks is only supported if libev itself
3977is compiled with a C++ compiler or your C and C++ environments allow
3978throwing exceptions through C libraries (most do).
3979
3980=head2 C++ API
3901 3981
3902Libev comes with some simplistic wrapper classes for C++ that mainly allow 3982Libev comes with some simplistic wrapper classes for C++ that mainly allow
3903you to use some convenience methods to start/stop watchers and also change 3983you to use some convenience methods to start/stop watchers and also change
3904the callback model to a model using method callbacks on objects. 3984the callback model to a model using method callbacks on objects.
3905 3985
4043Associates a different C<struct ev_loop> with this watcher. You can only 4123Associates a different C<struct ev_loop> with this watcher. You can only
4044do this when the watcher is inactive (and not pending either). 4124do this when the watcher is inactive (and not pending either).
4045 4125
4046=item w->set ([arguments]) 4126=item w->set ([arguments])
4047 4127
4048Basically the same as C<ev_TYPE_set>, with the same arguments. Either this 4128Basically the same as C<ev_TYPE_set> (except for C<ev::embed> watchers>),
4049method or a suitable start method must be called at least once. Unlike the 4129with the same arguments. Either this method or a suitable start method
4050C counterpart, an active watcher gets automatically stopped and restarted 4130must be called at least once. Unlike the C counterpart, an active watcher
4051when reconfiguring it with this method. 4131gets automatically stopped and restarted when reconfiguring it with this
4132method.
4133
4134For C<ev::embed> watchers this method is called C<set_embed>, to avoid
4135clashing with the C<set (loop)> method.
4052 4136
4053=item w->start () 4137=item w->start ()
4054 4138
4055Starts the watcher. Note that there is no C<loop> argument, as the 4139Starts the watcher. Note that there is no C<loop> argument, as the
4056constructor already stores the event loop. 4140constructor already stores the event loop.
4159=item Lua 4243=item Lua
4160 4244
4161Brian Maher has written a partial interface to libev for lua (at the 4245Brian Maher has written a partial interface to libev for lua (at the
4162time of this writing, only C<ev_io> and C<ev_timer>), to be found at 4246time of this writing, only C<ev_io> and C<ev_timer>), to be found at
4163L<http://github.com/brimworks/lua-ev>. 4247L<http://github.com/brimworks/lua-ev>.
4248
4249=item Javascript
4250
4251Node.js (L<http://nodejs.org>) uses libev as the underlying event library.
4252
4253=item Others
4254
4255There are others, and I stopped counting.
4164 4256
4165=back 4257=back
4166 4258
4167 4259
4168=head1 MACRO MAGIC 4260=head1 MACRO MAGIC
4467 4559
4468If programs implement their own fd to handle mapping on win32, then this 4560If programs implement their own fd to handle mapping on win32, then this
4469macro can be used to override the C<close> function, useful to unregister 4561macro can be used to override the C<close> function, useful to unregister
4470file descriptors again. Note that the replacement function has to close 4562file descriptors again. Note that the replacement function has to close
4471the underlying OS handle. 4563the underlying OS handle.
4564
4565=item EV_USE_WSASOCKET
4566
4567If defined to be C<1>, libev will use C<WSASocket> to create its internal
4568communication socket, which works better in some environments. Otherwise,
4569the normal C<socket> function will be used, which works better in other
4570environments.
4472 4571
4473=item EV_USE_POLL 4572=item EV_USE_POLL
4474 4573
4475If defined to be C<1>, libev will compile in support for the C<poll>(2) 4574If defined to be C<1>, libev will compile in support for the C<poll>(2)
4476backend. Otherwise it will be enabled on non-win32 platforms. It 4575backend. Otherwise it will be enabled on non-win32 platforms. It
4521different cpus (or different cpu cores). This reduces dependencies 4620different cpus (or different cpu cores). This reduces dependencies
4522and makes libev faster. 4621and makes libev faster.
4523 4622
4524=item EV_NO_THREADS 4623=item EV_NO_THREADS
4525 4624
4526If defined to be C<1>, libev will assume that it will never be called 4625If defined to be C<1>, libev will assume that it will never be called from
4527from different threads, which is a stronger assumption than C<EV_NO_SMP>, 4626different threads (that includes signal handlers), which is a stronger
4528above. This reduces dependencies and makes libev faster. 4627assumption than C<EV_NO_SMP>, above. This reduces dependencies and makes
4628libev faster.
4529 4629
4530=item EV_ATOMIC_T 4630=item EV_ATOMIC_T
4531 4631
4532Libev requires an integer type (suitable for storing C<0> or C<1>) whose 4632Libev requires an integer type (suitable for storing C<0> or C<1>) whose
4533access is atomic and serialised with respect to other threads or signal 4633access is atomic with respect to other threads or signal contexts. No
4534contexts. No such type is easily found in the C language, so you can 4634such type is easily found in the C language, so you can provide your own
4535provide your own type that you know is safe for your purposes. It is used 4635type that you know is safe for your purposes. It is used both for signal
4536both for signal handler "locking" as well as for signal and thread safety 4636handler "locking" as well as for signal and thread safety in C<ev_async>
4537in C<ev_async> watchers. 4637watchers.
4538 4638
4539In the absence of this define, libev will use C<sig_atomic_t volatile> 4639In the absence of this define, libev will use C<sig_atomic_t volatile>
4540(from F<signal.h>), which is usually good enough on most platforms, 4640(from F<signal.h>), which is usually good enough on most platforms.
4541although strictly speaking using a type that also implies a memory fence
4542is required.
4543 4641
4544=item EV_H (h) 4642=item EV_H (h)
4545 4643
4546The name of the F<ev.h> header file used to include it. The default if 4644The name of the F<ev.h> header file used to include it. The default if
4547undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be 4645undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
4620 #define EV_USE_POLL 1 4718 #define EV_USE_POLL 1
4621 #define EV_CHILD_ENABLE 1 4719 #define EV_CHILD_ENABLE 1
4622 #define EV_ASYNC_ENABLE 1 4720 #define EV_ASYNC_ENABLE 1
4623 4721
4624The actual value is a bitset, it can be a combination of the following 4722The actual value is a bitset, it can be a combination of the following
4625values: 4723values (by default, all of these are enabled):
4626 4724
4627=over 4 4725=over 4
4628 4726
4629=item C<1> - faster/larger code 4727=item C<1> - faster/larger code
4630 4728
4634code size by roughly 30% on amd64). 4732code size by roughly 30% on amd64).
4635 4733
4636When optimising for size, use of compiler flags such as C<-Os> with 4734When optimising for size, use of compiler flags such as C<-Os> with
4637gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of 4735gcc is recommended, as well as C<-DNDEBUG>, as libev contains a number of
4638assertions. 4736assertions.
4737
4738The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4739(e.g. gcc with C<-Os>).
4639 4740
4640=item C<2> - faster/larger data structures 4741=item C<2> - faster/larger data structures
4641 4742
4642Replaces the small 2-heap for timer management by a faster 4-heap, larger 4743Replaces the small 2-heap for timer management by a faster 4-heap, larger
4643hash table sizes and so on. This will usually further increase code size 4744hash table sizes and so on. This will usually further increase code size
4644and can additionally have an effect on the size of data structures at 4745and can additionally have an effect on the size of data structures at
4645runtime. 4746runtime.
4747
4748The default is off when C<__OPTIMIZE_SIZE__> is defined by your compiler
4749(e.g. gcc with C<-Os>).
4646 4750
4647=item C<4> - full API configuration 4751=item C<4> - full API configuration
4648 4752
4649This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and 4753This enables priorities (sets C<EV_MAXPRI>=2 and C<EV_MINPRI>=-2), and
4650enables multiplicity (C<EV_MULTIPLICITY>=1). 4754enables multiplicity (C<EV_MULTIPLICITY>=1).
4909default loop and triggering an C<ev_async> watcher from the default loop 5013default loop and triggering an C<ev_async> watcher from the default loop
4910watcher callback into the event loop interested in the signal. 5014watcher callback into the event loop interested in the signal.
4911 5015
4912=back 5016=back
4913 5017
4914See also L<THREAD LOCKING EXAMPLE>. 5018See also L</THREAD LOCKING EXAMPLE>.
4915 5019
4916=head3 COROUTINES 5020=head3 COROUTINES
4917 5021
4918Libev is very accommodating to coroutines ("cooperative threads"): 5022Libev is very accommodating to coroutines ("cooperative threads"):
4919libev fully supports nesting calls to its functions from different 5023libev fully supports nesting calls to its functions from different
5210thread" or will block signals process-wide, both behaviours would 5314thread" or will block signals process-wide, both behaviours would
5211be compatible with libev. Interaction between C<sigprocmask> and 5315be compatible with libev. Interaction between C<sigprocmask> and
5212C<pthread_sigmask> could complicate things, however. 5316C<pthread_sigmask> could complicate things, however.
5213 5317
5214The most portable way to handle signals is to block signals in all threads 5318The most portable way to handle signals is to block signals in all threads
5215except the initial one, and run the default loop in the initial thread as 5319except the initial one, and run the signal handling loop in the initial
5216well. 5320thread as well.
5217 5321
5218=item C<long> must be large enough for common memory allocation sizes 5322=item C<long> must be large enough for common memory allocation sizes
5219 5323
5220To improve portability and simplify its API, libev uses C<long> internally 5324To improve portability and simplify its API, libev uses C<long> internally
5221instead of C<size_t> when allocating its data structures. On non-POSIX 5325instead of C<size_t> when allocating its data structures. On non-POSIX
5325=over 4 5429=over 4
5326 5430
5327=item C<EV_COMPAT3> backwards compatibility mechanism 5431=item C<EV_COMPAT3> backwards compatibility mechanism
5328 5432
5329The backward compatibility mechanism can be controlled by 5433The backward compatibility mechanism can be controlled by
5330C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING> 5434C<EV_COMPAT3>. See L</PREPROCESSOR SYMBOLS/MACROS> in the L</EMBEDDING>
5331section. 5435section.
5332 5436
5333=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5437=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5334 5438
5335These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5439These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
5378=over 4 5482=over 4
5379 5483
5380=item active 5484=item active
5381 5485
5382A watcher is active as long as it has been started and not yet stopped. 5486A watcher is active as long as it has been started and not yet stopped.
5383See L<WATCHER STATES> for details. 5487See L</WATCHER STATES> for details.
5384 5488
5385=item application 5489=item application
5386 5490
5387In this document, an application is whatever is using libev. 5491In this document, an application is whatever is using libev.
5388 5492
5424watchers and events. 5528watchers and events.
5425 5529
5426=item pending 5530=item pending
5427 5531
5428A watcher is pending as soon as the corresponding event has been 5532A watcher is pending as soon as the corresponding event has been
5429detected. See L<WATCHER STATES> for details. 5533detected. See L</WATCHER STATES> for details.
5430 5534
5431=item real time 5535=item real time
5432 5536
5433The physical time that is observed. It is apparently strictly monotonic :) 5537The physical time that is observed. It is apparently strictly monotonic :)
5434 5538

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines