… | |
… | |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | #include <ev.h> |
7 | #include <ev.h> |
8 | |
8 | |
9 | =head1 EXAMPLE PROGRAM |
9 | =head2 EXAMPLE PROGRAM |
10 | |
10 | |
11 | #include <ev.h> |
11 | #include <ev.h> |
12 | |
12 | |
13 | ev_io stdin_watcher; |
13 | ev_io stdin_watcher; |
14 | ev_timer timeout_watcher; |
14 | ev_timer timeout_watcher; |
… | |
… | |
53 | The newest version of this document is also available as a html-formatted |
53 | The newest version of this document is also available as a html-formatted |
54 | web page you might find easier to navigate when reading it for the first |
54 | web page you might find easier to navigate when reading it for the first |
55 | time: L<http://cvs.schmorp.de/libev/ev.html>. |
55 | time: L<http://cvs.schmorp.de/libev/ev.html>. |
56 | |
56 | |
57 | Libev is an event loop: you register interest in certain events (such as a |
57 | Libev is an event loop: you register interest in certain events (such as a |
58 | file descriptor being readable or a timeout occuring), and it will manage |
58 | file descriptor being readable or a timeout occurring), and it will manage |
59 | these event sources and provide your program with events. |
59 | these event sources and provide your program with events. |
60 | |
60 | |
61 | To do this, it must take more or less complete control over your process |
61 | To do this, it must take more or less complete control over your process |
62 | (or thread) by executing the I<event loop> handler, and will then |
62 | (or thread) by executing the I<event loop> handler, and will then |
63 | communicate events via a callback mechanism. |
63 | communicate events via a callback mechanism. |
… | |
… | |
65 | You register interest in certain events by registering so-called I<event |
65 | You register interest in certain events by registering so-called I<event |
66 | watchers>, which are relatively small C structures you initialise with the |
66 | watchers>, which are relatively small C structures you initialise with the |
67 | details of the event, and then hand it over to libev by I<starting> the |
67 | details of the event, and then hand it over to libev by I<starting> the |
68 | watcher. |
68 | watcher. |
69 | |
69 | |
70 | =head1 FEATURES |
70 | =head2 FEATURES |
71 | |
71 | |
72 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
72 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
73 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
73 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
74 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
74 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
75 | (for C<ev_stat>), relative timers (C<ev_timer>), absolute timers |
75 | (for C<ev_stat>), relative timers (C<ev_timer>), absolute timers |
… | |
… | |
82 | |
82 | |
83 | It also is quite fast (see this |
83 | It also is quite fast (see this |
84 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
84 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
85 | for example). |
85 | for example). |
86 | |
86 | |
87 | =head1 CONVENTIONS |
87 | =head2 CONVENTIONS |
88 | |
88 | |
89 | Libev is very configurable. In this manual the default configuration will |
89 | Libev is very configurable. In this manual the default configuration will |
90 | be described, which supports multiple event loops. For more info about |
90 | be described, which supports multiple event loops. For more info about |
91 | various configuration options please have a look at B<EMBED> section in |
91 | various configuration options please have a look at B<EMBED> section in |
92 | this manual. If libev was configured without support for multiple event |
92 | this manual. If libev was configured without support for multiple event |
93 | loops, then all functions taking an initial argument of name C<loop> |
93 | loops, then all functions taking an initial argument of name C<loop> |
94 | (which is always of type C<struct ev_loop *>) will not have this argument. |
94 | (which is always of type C<struct ev_loop *>) will not have this argument. |
95 | |
95 | |
96 | =head1 TIME REPRESENTATION |
96 | =head2 TIME REPRESENTATION |
97 | |
97 | |
98 | Libev represents time as a single floating point number, representing the |
98 | Libev represents time as a single floating point number, representing the |
99 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
99 | (fractional) number of seconds since the (POSIX) epoch (somewhere near |
100 | the beginning of 1970, details are complicated, don't ask). This type is |
100 | the beginning of 1970, details are complicated, don't ask). This type is |
101 | called C<ev_tstamp>, which is what you should use too. It usually aliases |
101 | called C<ev_tstamp>, which is what you should use too. It usually aliases |
102 | to the C<double> type in C, and when you need to do any calculations on |
102 | to the C<double> type in C, and when you need to do any calculations on |
103 | it, you should treat it as such. |
103 | it, you should treat it as some floatingpoint value. Unlike the name |
|
|
104 | component C<stamp> might indicate, it is also used for time differences |
|
|
105 | throughout libev. |
104 | |
106 | |
105 | =head1 GLOBAL FUNCTIONS |
107 | =head1 GLOBAL FUNCTIONS |
106 | |
108 | |
107 | These functions can be called anytime, even before initialising the |
109 | These functions can be called anytime, even before initialising the |
108 | library in any way. |
110 | library in any way. |
… | |
… | |
112 | =item ev_tstamp ev_time () |
114 | =item ev_tstamp ev_time () |
113 | |
115 | |
114 | Returns the current time as libev would use it. Please note that the |
116 | Returns the current time as libev would use it. Please note that the |
115 | C<ev_now> function is usually faster and also often returns the timestamp |
117 | C<ev_now> function is usually faster and also often returns the timestamp |
116 | you actually want to know. |
118 | you actually want to know. |
|
|
119 | |
|
|
120 | =item ev_sleep (ev_tstamp interval) |
|
|
121 | |
|
|
122 | Sleep for the given interval: The current thread will be blocked until |
|
|
123 | either it is interrupted or the given time interval has passed. Basically |
|
|
124 | this is a subsecond-resolution C<sleep ()>. |
117 | |
125 | |
118 | =item int ev_version_major () |
126 | =item int ev_version_major () |
119 | |
127 | |
120 | =item int ev_version_minor () |
128 | =item int ev_version_minor () |
121 | |
129 | |
… | |
… | |
252 | flags. If that is troubling you, check C<ev_backend ()> afterwards). |
260 | flags. If that is troubling you, check C<ev_backend ()> afterwards). |
253 | |
261 | |
254 | If you don't know what event loop to use, use the one returned from this |
262 | If you don't know what event loop to use, use the one returned from this |
255 | function. |
263 | function. |
256 | |
264 | |
|
|
265 | The default loop is the only loop that can handle C<ev_signal> and |
|
|
266 | C<ev_child> watchers, and to do this, it always registers a handler |
|
|
267 | for C<SIGCHLD>. If this is a problem for your app you can either |
|
|
268 | create a dynamic loop with C<ev_loop_new> that doesn't do that, or you |
|
|
269 | can simply overwrite the C<SIGCHLD> signal handler I<after> calling |
|
|
270 | C<ev_default_init>. |
|
|
271 | |
257 | The flags argument can be used to specify special behaviour or specific |
272 | The flags argument can be used to specify special behaviour or specific |
258 | backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). |
273 | backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). |
259 | |
274 | |
260 | The following flags are supported: |
275 | The following flags are supported: |
261 | |
276 | |
… | |
… | |
298 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
313 | =item C<EVBACKEND_SELECT> (value 1, portable select backend) |
299 | |
314 | |
300 | This is your standard select(2) backend. Not I<completely> standard, as |
315 | This is your standard select(2) backend. Not I<completely> standard, as |
301 | libev tries to roll its own fd_set with no limits on the number of fds, |
316 | libev tries to roll its own fd_set with no limits on the number of fds, |
302 | but if that fails, expect a fairly low limit on the number of fds when |
317 | but if that fails, expect a fairly low limit on the number of fds when |
303 | using this backend. It doesn't scale too well (O(highest_fd)), but its usually |
318 | using this backend. It doesn't scale too well (O(highest_fd)), but its |
304 | the fastest backend for a low number of fds. |
319 | usually the fastest backend for a low number of (low-numbered :) fds. |
|
|
320 | |
|
|
321 | To get good performance out of this backend you need a high amount of |
|
|
322 | parallelity (most of the file descriptors should be busy). If you are |
|
|
323 | writing a server, you should C<accept ()> in a loop to accept as many |
|
|
324 | connections as possible during one iteration. You might also want to have |
|
|
325 | a look at C<ev_set_io_collect_interval ()> to increase the amount of |
|
|
326 | readyness notifications you get per iteration. |
305 | |
327 | |
306 | =item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) |
328 | =item C<EVBACKEND_POLL> (value 2, poll backend, available everywhere except on windows) |
307 | |
329 | |
308 | And this is your standard poll(2) backend. It's more complicated than |
330 | And this is your standard poll(2) backend. It's more complicated |
309 | select, but handles sparse fds better and has no artificial limit on the |
331 | than select, but handles sparse fds better and has no artificial |
310 | number of fds you can use (except it will slow down considerably with a |
332 | limit on the number of fds you can use (except it will slow down |
311 | lot of inactive fds). It scales similarly to select, i.e. O(total_fds). |
333 | considerably with a lot of inactive fds). It scales similarly to select, |
|
|
334 | i.e. O(total_fds). See the entry for C<EVBACKEND_SELECT>, above, for |
|
|
335 | performance tips. |
312 | |
336 | |
313 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
337 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
314 | |
338 | |
315 | For few fds, this backend is a bit little slower than poll and select, |
339 | For few fds, this backend is a bit little slower than poll and select, |
316 | but it scales phenomenally better. While poll and select usually scale like |
340 | but it scales phenomenally better. While poll and select usually scale |
317 | O(total_fds) where n is the total number of fds (or the highest fd), epoll scales |
341 | like O(total_fds) where n is the total number of fds (or the highest fd), |
318 | either O(1) or O(active_fds). |
342 | epoll scales either O(1) or O(active_fds). The epoll design has a number |
|
|
343 | of shortcomings, such as silently dropping events in some hard-to-detect |
|
|
344 | cases and rewiring a syscall per fd change, no fork support and bad |
|
|
345 | support for dup. |
319 | |
346 | |
320 | While stopping and starting an I/O watcher in the same iteration will |
347 | While stopping, setting and starting an I/O watcher in the same iteration |
321 | result in some caching, there is still a syscall per such incident |
348 | will result in some caching, there is still a syscall per such incident |
322 | (because the fd could point to a different file description now), so its |
349 | (because the fd could point to a different file description now), so its |
323 | best to avoid that. Also, dup()ed file descriptors might not work very |
350 | best to avoid that. Also, C<dup ()>'ed file descriptors might not work |
324 | well if you register events for both fds. |
351 | very well if you register events for both fds. |
325 | |
352 | |
326 | Please note that epoll sometimes generates spurious notifications, so you |
353 | Please note that epoll sometimes generates spurious notifications, so you |
327 | need to use non-blocking I/O or other means to avoid blocking when no data |
354 | need to use non-blocking I/O or other means to avoid blocking when no data |
328 | (or space) is available. |
355 | (or space) is available. |
329 | |
356 | |
|
|
357 | Best performance from this backend is achieved by not unregistering all |
|
|
358 | watchers for a file descriptor until it has been closed, if possible, i.e. |
|
|
359 | keep at least one watcher active per fd at all times. |
|
|
360 | |
|
|
361 | While nominally embeddeble in other event loops, this feature is broken in |
|
|
362 | all kernel versions tested so far. |
|
|
363 | |
330 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
364 | =item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) |
331 | |
365 | |
332 | Kqueue deserves special mention, as at the time of this writing, it |
366 | Kqueue deserves special mention, as at the time of this writing, it |
333 | was broken on all BSDs except NetBSD (usually it doesn't work with |
367 | was broken on all BSDs except NetBSD (usually it doesn't work reliably |
334 | anything but sockets and pipes, except on Darwin, where of course its |
368 | with anything but sockets and pipes, except on Darwin, where of course |
335 | completely useless). For this reason its not being "autodetected" |
369 | it's completely useless). For this reason it's not being "autodetected" |
336 | unless you explicitly specify it explicitly in the flags (i.e. using |
370 | unless you explicitly specify it explicitly in the flags (i.e. using |
337 | C<EVBACKEND_KQUEUE>). |
371 | C<EVBACKEND_KQUEUE>) or libev was compiled on a known-to-be-good (-enough) |
|
|
372 | system like NetBSD. |
|
|
373 | |
|
|
374 | You still can embed kqueue into a normal poll or select backend and use it |
|
|
375 | only for sockets (after having made sure that sockets work with kqueue on |
|
|
376 | the target platform). See C<ev_embed> watchers for more info. |
338 | |
377 | |
339 | It scales in the same way as the epoll backend, but the interface to the |
378 | It scales in the same way as the epoll backend, but the interface to the |
340 | kernel is more efficient (which says nothing about its actual speed, of |
379 | kernel is more efficient (which says nothing about its actual speed, of |
341 | course). While starting and stopping an I/O watcher does not cause an |
380 | course). While stopping, setting and starting an I/O watcher does never |
342 | extra syscall as with epoll, it still adds up to four event changes per |
381 | cause an extra syscall as with C<EVBACKEND_EPOLL>, it still adds up to |
343 | incident, so its best to avoid that. |
382 | two event changes per incident, support for C<fork ()> is very bad and it |
|
|
383 | drops fds silently in similarly hard-to-detect cases. |
|
|
384 | |
|
|
385 | This backend usually performs well under most conditions. |
|
|
386 | |
|
|
387 | While nominally embeddable in other event loops, this doesn't work |
|
|
388 | everywhere, so you might need to test for this. And since it is broken |
|
|
389 | almost everywhere, you should only use it when you have a lot of sockets |
|
|
390 | (for which it usually works), by embedding it into another event loop |
|
|
391 | (e.g. C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>) and using it only for |
|
|
392 | sockets. |
344 | |
393 | |
345 | =item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) |
394 | =item C<EVBACKEND_DEVPOLL> (value 16, Solaris 8) |
346 | |
395 | |
347 | This is not implemented yet (and might never be). |
396 | This is not implemented yet (and might never be, unless you send me an |
|
|
397 | implementation). According to reports, C</dev/poll> only supports sockets |
|
|
398 | and is not embeddable, which would limit the usefulness of this backend |
|
|
399 | immensely. |
348 | |
400 | |
349 | =item C<EVBACKEND_PORT> (value 32, Solaris 10) |
401 | =item C<EVBACKEND_PORT> (value 32, Solaris 10) |
350 | |
402 | |
351 | This uses the Solaris 10 port mechanism. As with everything on Solaris, |
403 | This uses the Solaris 10 event port mechanism. As with everything on Solaris, |
352 | it's really slow, but it still scales very well (O(active_fds)). |
404 | it's really slow, but it still scales very well (O(active_fds)). |
353 | |
405 | |
354 | Please note that solaris ports can result in a lot of spurious |
406 | Please note that solaris event ports can deliver a lot of spurious |
355 | notifications, so you need to use non-blocking I/O or other means to avoid |
407 | notifications, so you need to use non-blocking I/O or other means to avoid |
356 | blocking when no data (or space) is available. |
408 | blocking when no data (or space) is available. |
|
|
409 | |
|
|
410 | While this backend scales well, it requires one system call per active |
|
|
411 | file descriptor per loop iteration. For small and medium numbers of file |
|
|
412 | descriptors a "slow" C<EVBACKEND_SELECT> or C<EVBACKEND_POLL> backend |
|
|
413 | might perform better. |
|
|
414 | |
|
|
415 | On the positive side, ignoring the spurious readyness notifications, this |
|
|
416 | backend actually performed to specification in all tests and is fully |
|
|
417 | embeddable, which is a rare feat among the OS-specific backends. |
357 | |
418 | |
358 | =item C<EVBACKEND_ALL> |
419 | =item C<EVBACKEND_ALL> |
359 | |
420 | |
360 | Try all backends (even potentially broken ones that wouldn't be tried |
421 | Try all backends (even potentially broken ones that wouldn't be tried |
361 | with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as |
422 | with C<EVFLAG_AUTO>). Since this is a mask, you can do stuff such as |
362 | C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. |
423 | C<EVBACKEND_ALL & ~EVBACKEND_KQUEUE>. |
363 | |
424 | |
|
|
425 | It is definitely not recommended to use this flag. |
|
|
426 | |
364 | =back |
427 | =back |
365 | |
428 | |
366 | If one or more of these are ored into the flags value, then only these |
429 | If one or more of these are ored into the flags value, then only these |
367 | backends will be tried (in the reverse order as given here). If none are |
430 | backends will be tried (in the reverse order as listed here). If none are |
368 | specified, most compiled-in backend will be tried, usually in reverse |
431 | specified, all backends in C<ev_recommended_backends ()> will be tried. |
369 | order of their flag values :) |
|
|
370 | |
432 | |
371 | The most typical usage is like this: |
433 | The most typical usage is like this: |
372 | |
434 | |
373 | if (!ev_default_loop (0)) |
435 | if (!ev_default_loop (0)) |
374 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
436 | fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?"); |
… | |
… | |
402 | Destroys the default loop again (frees all memory and kernel state |
464 | Destroys the default loop again (frees all memory and kernel state |
403 | etc.). None of the active event watchers will be stopped in the normal |
465 | etc.). None of the active event watchers will be stopped in the normal |
404 | sense, so e.g. C<ev_is_active> might still return true. It is your |
466 | sense, so e.g. C<ev_is_active> might still return true. It is your |
405 | responsibility to either stop all watchers cleanly yoursef I<before> |
467 | responsibility to either stop all watchers cleanly yoursef I<before> |
406 | calling this function, or cope with the fact afterwards (which is usually |
468 | calling this function, or cope with the fact afterwards (which is usually |
407 | the easiest thing, youc na just ignore the watchers and/or C<free ()> them |
469 | the easiest thing, you can just ignore the watchers and/or C<free ()> them |
408 | for example). |
470 | for example). |
|
|
471 | |
|
|
472 | Note that certain global state, such as signal state, will not be freed by |
|
|
473 | this function, and related watchers (such as signal and child watchers) |
|
|
474 | would need to be stopped manually. |
|
|
475 | |
|
|
476 | In general it is not advisable to call this function except in the |
|
|
477 | rare occasion where you really need to free e.g. the signal handling |
|
|
478 | pipe fds. If you need dynamically allocated loops it is better to use |
|
|
479 | C<ev_loop_new> and C<ev_loop_destroy>). |
409 | |
480 | |
410 | =item ev_loop_destroy (loop) |
481 | =item ev_loop_destroy (loop) |
411 | |
482 | |
412 | Like C<ev_default_destroy>, but destroys an event loop created by an |
483 | Like C<ev_default_destroy>, but destroys an event loop created by an |
413 | earlier call to C<ev_loop_new>. |
484 | earlier call to C<ev_loop_new>. |
414 | |
485 | |
415 | =item ev_default_fork () |
486 | =item ev_default_fork () |
416 | |
487 | |
|
|
488 | This function sets a flag that causes subsequent C<ev_loop> iterations |
417 | This function reinitialises the kernel state for backends that have |
489 | to reinitialise the kernel state for backends that have one. Despite the |
418 | one. Despite the name, you can call it anytime, but it makes most sense |
490 | name, you can call it anytime, but it makes most sense after forking, in |
419 | after forking, in either the parent or child process (or both, but that |
491 | the child process (or both child and parent, but that again makes little |
420 | again makes little sense). |
492 | sense). You I<must> call it in the child before using any of the libev |
|
|
493 | functions, and it will only take effect at the next C<ev_loop> iteration. |
421 | |
494 | |
422 | You I<must> call this function in the child process after forking if and |
495 | On the other hand, you only need to call this function in the child |
423 | only if you want to use the event library in both processes. If you just |
496 | process if and only if you want to use the event library in the child. If |
424 | fork+exec, you don't have to call it. |
497 | you just fork+exec, you don't have to call it at all. |
425 | |
498 | |
426 | The function itself is quite fast and it's usually not a problem to call |
499 | The function itself is quite fast and it's usually not a problem to call |
427 | it just in case after a fork. To make this easy, the function will fit in |
500 | it just in case after a fork. To make this easy, the function will fit in |
428 | quite nicely into a call to C<pthread_atfork>: |
501 | quite nicely into a call to C<pthread_atfork>: |
429 | |
502 | |
430 | pthread_atfork (0, 0, ev_default_fork); |
503 | pthread_atfork (0, 0, ev_default_fork); |
431 | |
|
|
432 | At the moment, C<EVBACKEND_SELECT> and C<EVBACKEND_POLL> are safe to use |
|
|
433 | without calling this function, so if you force one of those backends you |
|
|
434 | do not need to care. |
|
|
435 | |
504 | |
436 | =item ev_loop_fork (loop) |
505 | =item ev_loop_fork (loop) |
437 | |
506 | |
438 | Like C<ev_default_fork>, but acts on an event loop created by |
507 | Like C<ev_default_fork>, but acts on an event loop created by |
439 | C<ev_loop_new>. Yes, you have to call this on every allocated event loop |
508 | C<ev_loop_new>. Yes, you have to call this on every allocated event loop |
… | |
… | |
458 | |
527 | |
459 | Returns the current "event loop time", which is the time the event loop |
528 | Returns the current "event loop time", which is the time the event loop |
460 | received events and started processing them. This timestamp does not |
529 | received events and started processing them. This timestamp does not |
461 | change as long as callbacks are being processed, and this is also the base |
530 | change as long as callbacks are being processed, and this is also the base |
462 | time used for relative timers. You can treat it as the timestamp of the |
531 | time used for relative timers. You can treat it as the timestamp of the |
463 | event occuring (or more correctly, libev finding out about it). |
532 | event occurring (or more correctly, libev finding out about it). |
464 | |
533 | |
465 | =item ev_loop (loop, int flags) |
534 | =item ev_loop (loop, int flags) |
466 | |
535 | |
467 | Finally, this is it, the event handler. This function usually is called |
536 | Finally, this is it, the event handler. This function usually is called |
468 | after you initialised all your watchers and you want to start handling |
537 | after you initialised all your watchers and you want to start handling |
… | |
… | |
490 | usually a better approach for this kind of thing. |
559 | usually a better approach for this kind of thing. |
491 | |
560 | |
492 | Here are the gory details of what C<ev_loop> does: |
561 | Here are the gory details of what C<ev_loop> does: |
493 | |
562 | |
494 | - Before the first iteration, call any pending watchers. |
563 | - Before the first iteration, call any pending watchers. |
495 | * If there are no active watchers (reference count is zero), return. |
564 | * If EVFLAG_FORKCHECK was used, check for a fork. |
496 | - Queue all prepare watchers and then call all outstanding watchers. |
565 | - If a fork was detected, queue and call all fork watchers. |
|
|
566 | - Queue and call all prepare watchers. |
497 | - If we have been forked, recreate the kernel state. |
567 | - If we have been forked, recreate the kernel state. |
498 | - Update the kernel state with all outstanding changes. |
568 | - Update the kernel state with all outstanding changes. |
499 | - Update the "event loop time". |
569 | - Update the "event loop time". |
500 | - Calculate for how long to block. |
570 | - Calculate for how long to sleep or block, if at all |
|
|
571 | (active idle watchers, EVLOOP_NONBLOCK or not having |
|
|
572 | any active watchers at all will result in not sleeping). |
|
|
573 | - Sleep if the I/O and timer collect interval say so. |
501 | - Block the process, waiting for any events. |
574 | - Block the process, waiting for any events. |
502 | - Queue all outstanding I/O (fd) events. |
575 | - Queue all outstanding I/O (fd) events. |
503 | - Update the "event loop time" and do time jump handling. |
576 | - Update the "event loop time" and do time jump handling. |
504 | - Queue all outstanding timers. |
577 | - Queue all outstanding timers. |
505 | - Queue all outstanding periodics. |
578 | - Queue all outstanding periodics. |
506 | - If no events are pending now, queue all idle watchers. |
579 | - If no events are pending now, queue all idle watchers. |
507 | - Queue all check watchers. |
580 | - Queue all check watchers. |
508 | - Call all queued watchers in reverse order (i.e. check watchers first). |
581 | - Call all queued watchers in reverse order (i.e. check watchers first). |
509 | Signals and child watchers are implemented as I/O watchers, and will |
582 | Signals and child watchers are implemented as I/O watchers, and will |
510 | be handled here by queueing them when their watcher gets executed. |
583 | be handled here by queueing them when their watcher gets executed. |
511 | - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
584 | - If ev_unloop has been called, or EVLOOP_ONESHOT or EVLOOP_NONBLOCK |
512 | were used, return, otherwise continue with step *. |
585 | were used, or there are no active watchers, return, otherwise |
|
|
586 | continue with step *. |
513 | |
587 | |
514 | Example: Queue some jobs and then loop until no events are outsanding |
588 | Example: Queue some jobs and then loop until no events are outstanding |
515 | anymore. |
589 | anymore. |
516 | |
590 | |
517 | ... queue jobs here, make sure they register event watchers as long |
591 | ... queue jobs here, make sure they register event watchers as long |
518 | ... as they still have work to do (even an idle watcher will do..) |
592 | ... as they still have work to do (even an idle watcher will do..) |
519 | ev_loop (my_loop, 0); |
593 | ev_loop (my_loop, 0); |
… | |
… | |
523 | |
597 | |
524 | Can be used to make a call to C<ev_loop> return early (but only after it |
598 | Can be used to make a call to C<ev_loop> return early (but only after it |
525 | has processed all outstanding events). The C<how> argument must be either |
599 | has processed all outstanding events). The C<how> argument must be either |
526 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
600 | C<EVUNLOOP_ONE>, which will make the innermost C<ev_loop> call return, or |
527 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
601 | C<EVUNLOOP_ALL>, which will make all nested C<ev_loop> calls return. |
|
|
602 | |
|
|
603 | This "unloop state" will be cleared when entering C<ev_loop> again. |
528 | |
604 | |
529 | =item ev_ref (loop) |
605 | =item ev_ref (loop) |
530 | |
606 | |
531 | =item ev_unref (loop) |
607 | =item ev_unref (loop) |
532 | |
608 | |
… | |
… | |
537 | returning, ev_unref() after starting, and ev_ref() before stopping it. For |
613 | returning, ev_unref() after starting, and ev_ref() before stopping it. For |
538 | example, libev itself uses this for its internal signal pipe: It is not |
614 | example, libev itself uses this for its internal signal pipe: It is not |
539 | visible to the libev user and should not keep C<ev_loop> from exiting if |
615 | visible to the libev user and should not keep C<ev_loop> from exiting if |
540 | no event watchers registered by it are active. It is also an excellent |
616 | no event watchers registered by it are active. It is also an excellent |
541 | way to do this for generic recurring timers or from within third-party |
617 | way to do this for generic recurring timers or from within third-party |
542 | libraries. Just remember to I<unref after start> and I<ref before stop>. |
618 | libraries. Just remember to I<unref after start> and I<ref before stop> |
|
|
619 | (but only if the watcher wasn't active before, or was active before, |
|
|
620 | respectively). |
543 | |
621 | |
544 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
622 | Example: Create a signal watcher, but keep it from keeping C<ev_loop> |
545 | running when nothing else is active. |
623 | running when nothing else is active. |
546 | |
624 | |
547 | struct ev_signal exitsig; |
625 | struct ev_signal exitsig; |
… | |
… | |
551 | |
629 | |
552 | Example: For some weird reason, unregister the above signal handler again. |
630 | Example: For some weird reason, unregister the above signal handler again. |
553 | |
631 | |
554 | ev_ref (loop); |
632 | ev_ref (loop); |
555 | ev_signal_stop (loop, &exitsig); |
633 | ev_signal_stop (loop, &exitsig); |
|
|
634 | |
|
|
635 | =item ev_set_io_collect_interval (loop, ev_tstamp interval) |
|
|
636 | |
|
|
637 | =item ev_set_timeout_collect_interval (loop, ev_tstamp interval) |
|
|
638 | |
|
|
639 | These advanced functions influence the time that libev will spend waiting |
|
|
640 | for events. Both are by default C<0>, meaning that libev will try to |
|
|
641 | invoke timer/periodic callbacks and I/O callbacks with minimum latency. |
|
|
642 | |
|
|
643 | Setting these to a higher value (the C<interval> I<must> be >= C<0>) |
|
|
644 | allows libev to delay invocation of I/O and timer/periodic callbacks to |
|
|
645 | increase efficiency of loop iterations. |
|
|
646 | |
|
|
647 | The background is that sometimes your program runs just fast enough to |
|
|
648 | handle one (or very few) event(s) per loop iteration. While this makes |
|
|
649 | the program responsive, it also wastes a lot of CPU time to poll for new |
|
|
650 | events, especially with backends like C<select ()> which have a high |
|
|
651 | overhead for the actual polling but can deliver many events at once. |
|
|
652 | |
|
|
653 | By setting a higher I<io collect interval> you allow libev to spend more |
|
|
654 | time collecting I/O events, so you can handle more events per iteration, |
|
|
655 | at the cost of increasing latency. Timeouts (both C<ev_periodic> and |
|
|
656 | C<ev_timer>) will be not affected. Setting this to a non-null value will |
|
|
657 | introduce an additional C<ev_sleep ()> call into most loop iterations. |
|
|
658 | |
|
|
659 | Likewise, by setting a higher I<timeout collect interval> you allow libev |
|
|
660 | to spend more time collecting timeouts, at the expense of increased |
|
|
661 | latency (the watcher callback will be called later). C<ev_io> watchers |
|
|
662 | will not be affected. Setting this to a non-null value will not introduce |
|
|
663 | any overhead in libev. |
|
|
664 | |
|
|
665 | Many (busy) programs can usually benefit by setting the io collect |
|
|
666 | interval to a value near C<0.1> or so, which is often enough for |
|
|
667 | interactive servers (of course not for games), likewise for timeouts. It |
|
|
668 | usually doesn't make much sense to set it to a lower value than C<0.01>, |
|
|
669 | as this approsaches the timing granularity of most systems. |
556 | |
670 | |
557 | =back |
671 | =back |
558 | |
672 | |
559 | |
673 | |
560 | =head1 ANATOMY OF A WATCHER |
674 | =head1 ANATOMY OF A WATCHER |
… | |
… | |
659 | |
773 | |
660 | =item C<EV_FORK> |
774 | =item C<EV_FORK> |
661 | |
775 | |
662 | The event loop has been resumed in the child process after fork (see |
776 | The event loop has been resumed in the child process after fork (see |
663 | C<ev_fork>). |
777 | C<ev_fork>). |
|
|
778 | |
|
|
779 | =item C<EV_ASYNC> |
|
|
780 | |
|
|
781 | The given async watcher has been asynchronously notified (see C<ev_async>). |
664 | |
782 | |
665 | =item C<EV_ERROR> |
783 | =item C<EV_ERROR> |
666 | |
784 | |
667 | An unspecified error has occured, the watcher has been stopped. This might |
785 | An unspecified error has occured, the watcher has been stopped. This might |
668 | happen because the watcher could not be properly started because libev |
786 | happen because the watcher could not be properly started because libev |
… | |
… | |
886 | In general you can register as many read and/or write event watchers per |
1004 | In general you can register as many read and/or write event watchers per |
887 | fd as you want (as long as you don't confuse yourself). Setting all file |
1005 | fd as you want (as long as you don't confuse yourself). Setting all file |
888 | descriptors to non-blocking mode is also usually a good idea (but not |
1006 | descriptors to non-blocking mode is also usually a good idea (but not |
889 | required if you know what you are doing). |
1007 | required if you know what you are doing). |
890 | |
1008 | |
891 | You have to be careful with dup'ed file descriptors, though. Some backends |
|
|
892 | (the linux epoll backend is a notable example) cannot handle dup'ed file |
|
|
893 | descriptors correctly if you register interest in two or more fds pointing |
|
|
894 | to the same underlying file/socket/etc. description (that is, they share |
|
|
895 | the same underlying "file open"). |
|
|
896 | |
|
|
897 | If you must do this, then force the use of a known-to-be-good backend |
1009 | If you must do this, then force the use of a known-to-be-good backend |
898 | (at the time of this writing, this includes only C<EVBACKEND_SELECT> and |
1010 | (at the time of this writing, this includes only C<EVBACKEND_SELECT> and |
899 | C<EVBACKEND_POLL>). |
1011 | C<EVBACKEND_POLL>). |
900 | |
1012 | |
901 | Another thing you have to watch out for is that it is quite easy to |
1013 | Another thing you have to watch out for is that it is quite easy to |
… | |
… | |
913 | such as poll (fortunately in our Xlib example, Xlib already does this on |
1025 | such as poll (fortunately in our Xlib example, Xlib already does this on |
914 | its own, so its quite safe to use). |
1026 | its own, so its quite safe to use). |
915 | |
1027 | |
916 | =head3 The special problem of disappearing file descriptors |
1028 | =head3 The special problem of disappearing file descriptors |
917 | |
1029 | |
918 | Some backends (e.g kqueue, epoll) need to be told about closing a file |
1030 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
919 | descriptor (either by calling C<close> explicitly or by any other means, |
1031 | descriptor (either by calling C<close> explicitly or by any other means, |
920 | such as C<dup>). The reason is that you register interest in some file |
1032 | such as C<dup>). The reason is that you register interest in some file |
921 | descriptor, but when it goes away, the operating system will silently drop |
1033 | descriptor, but when it goes away, the operating system will silently drop |
922 | this interest. If another file descriptor with the same number then is |
1034 | this interest. If another file descriptor with the same number then is |
923 | registered with libev, there is no efficient way to see that this is, in |
1035 | registered with libev, there is no efficient way to see that this is, in |
… | |
… | |
932 | |
1044 | |
933 | This is how one would do it normally anyway, the important point is that |
1045 | This is how one would do it normally anyway, the important point is that |
934 | the libev application should not optimise around libev but should leave |
1046 | the libev application should not optimise around libev but should leave |
935 | optimisations to libev. |
1047 | optimisations to libev. |
936 | |
1048 | |
|
|
1049 | =head3 The special problem of dup'ed file descriptors |
|
|
1050 | |
|
|
1051 | Some backends (e.g. epoll), cannot register events for file descriptors, |
|
|
1052 | but only events for the underlying file descriptions. That means when you |
|
|
1053 | have C<dup ()>'ed file descriptors or weirder constellations, and register |
|
|
1054 | events for them, only one file descriptor might actually receive events. |
|
|
1055 | |
|
|
1056 | There is no workaround possible except not registering events |
|
|
1057 | for potentially C<dup ()>'ed file descriptors, or to resort to |
|
|
1058 | C<EVBACKEND_SELECT> or C<EVBACKEND_POLL>. |
|
|
1059 | |
|
|
1060 | =head3 The special problem of fork |
|
|
1061 | |
|
|
1062 | Some backends (epoll, kqueue) do not support C<fork ()> at all or exhibit |
|
|
1063 | useless behaviour. Libev fully supports fork, but needs to be told about |
|
|
1064 | it in the child. |
|
|
1065 | |
|
|
1066 | To support fork in your programs, you either have to call |
|
|
1067 | C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child, |
|
|
1068 | enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or |
|
|
1069 | C<EVBACKEND_POLL>. |
|
|
1070 | |
937 | |
1071 | |
938 | =head3 Watcher-Specific Functions |
1072 | =head3 Watcher-Specific Functions |
939 | |
1073 | |
940 | =over 4 |
1074 | =over 4 |
941 | |
1075 | |
… | |
… | |
954 | =item int events [read-only] |
1088 | =item int events [read-only] |
955 | |
1089 | |
956 | The events being watched. |
1090 | The events being watched. |
957 | |
1091 | |
958 | =back |
1092 | =back |
|
|
1093 | |
|
|
1094 | =head3 Examples |
959 | |
1095 | |
960 | Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well |
1096 | Example: Call C<stdin_readable_cb> when STDIN_FILENO has become, well |
961 | readable, but only once. Since it is likely line-buffered, you could |
1097 | readable, but only once. Since it is likely line-buffered, you could |
962 | attempt to read a whole line in the callback. |
1098 | attempt to read a whole line in the callback. |
963 | |
1099 | |
… | |
… | |
1061 | or C<ev_timer_again> is called and determines the next timeout (if any), |
1197 | or C<ev_timer_again> is called and determines the next timeout (if any), |
1062 | which is also when any modifications are taken into account. |
1198 | which is also when any modifications are taken into account. |
1063 | |
1199 | |
1064 | =back |
1200 | =back |
1065 | |
1201 | |
|
|
1202 | =head3 Examples |
|
|
1203 | |
1066 | Example: Create a timer that fires after 60 seconds. |
1204 | Example: Create a timer that fires after 60 seconds. |
1067 | |
1205 | |
1068 | static void |
1206 | static void |
1069 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1207 | one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents) |
1070 | { |
1208 | { |
… | |
… | |
1227 | When active, contains the absolute time that the watcher is supposed to |
1365 | When active, contains the absolute time that the watcher is supposed to |
1228 | trigger next. |
1366 | trigger next. |
1229 | |
1367 | |
1230 | =back |
1368 | =back |
1231 | |
1369 | |
|
|
1370 | =head3 Examples |
|
|
1371 | |
1232 | Example: Call a callback every hour, or, more precisely, whenever the |
1372 | Example: Call a callback every hour, or, more precisely, whenever the |
1233 | system clock is divisible by 3600. The callback invocation times have |
1373 | system clock is divisible by 3600. The callback invocation times have |
1234 | potentially a lot of jittering, but good long-term stability. |
1374 | potentially a lot of jittering, but good long-term stability. |
1235 | |
1375 | |
1236 | static void |
1376 | static void |
… | |
… | |
1302 | |
1442 | |
1303 | =head3 Watcher-Specific Functions and Data Members |
1443 | =head3 Watcher-Specific Functions and Data Members |
1304 | |
1444 | |
1305 | =over 4 |
1445 | =over 4 |
1306 | |
1446 | |
1307 | =item ev_child_init (ev_child *, callback, int pid) |
1447 | =item ev_child_init (ev_child *, callback, int pid, int trace) |
1308 | |
1448 | |
1309 | =item ev_child_set (ev_child *, int pid) |
1449 | =item ev_child_set (ev_child *, int pid, int trace) |
1310 | |
1450 | |
1311 | Configures the watcher to wait for status changes of process C<pid> (or |
1451 | Configures the watcher to wait for status changes of process C<pid> (or |
1312 | I<any> process if C<pid> is specified as C<0>). The callback can look |
1452 | I<any> process if C<pid> is specified as C<0>). The callback can look |
1313 | at the C<rstatus> member of the C<ev_child> watcher structure to see |
1453 | at the C<rstatus> member of the C<ev_child> watcher structure to see |
1314 | the status word (use the macros from C<sys/wait.h> and see your systems |
1454 | the status word (use the macros from C<sys/wait.h> and see your systems |
1315 | C<waitpid> documentation). The C<rpid> member contains the pid of the |
1455 | C<waitpid> documentation). The C<rpid> member contains the pid of the |
1316 | process causing the status change. |
1456 | process causing the status change. C<trace> must be either C<0> (only |
|
|
1457 | activate the watcher when the process terminates) or C<1> (additionally |
|
|
1458 | activate the watcher when the process is stopped or continued). |
1317 | |
1459 | |
1318 | =item int pid [read-only] |
1460 | =item int pid [read-only] |
1319 | |
1461 | |
1320 | The process id this watcher watches out for, or C<0>, meaning any process id. |
1462 | The process id this watcher watches out for, or C<0>, meaning any process id. |
1321 | |
1463 | |
… | |
… | |
1327 | |
1469 | |
1328 | The process exit/trace status caused by C<rpid> (see your systems |
1470 | The process exit/trace status caused by C<rpid> (see your systems |
1329 | C<waitpid> and C<sys/wait.h> documentation for details). |
1471 | C<waitpid> and C<sys/wait.h> documentation for details). |
1330 | |
1472 | |
1331 | =back |
1473 | =back |
|
|
1474 | |
|
|
1475 | =head3 Examples |
1332 | |
1476 | |
1333 | Example: Try to exit cleanly on SIGINT and SIGTERM. |
1477 | Example: Try to exit cleanly on SIGINT and SIGTERM. |
1334 | |
1478 | |
1335 | static void |
1479 | static void |
1336 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
1480 | sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) |
… | |
… | |
1377 | semantics of C<ev_stat> watchers, which means that libev sometimes needs |
1521 | semantics of C<ev_stat> watchers, which means that libev sometimes needs |
1378 | to fall back to regular polling again even with inotify, but changes are |
1522 | to fall back to regular polling again even with inotify, but changes are |
1379 | usually detected immediately, and if the file exists there will be no |
1523 | usually detected immediately, and if the file exists there will be no |
1380 | polling. |
1524 | polling. |
1381 | |
1525 | |
|
|
1526 | =head3 Inotify |
|
|
1527 | |
|
|
1528 | When C<inotify (7)> support has been compiled into libev (generally only |
|
|
1529 | available on Linux) and present at runtime, it will be used to speed up |
|
|
1530 | change detection where possible. The inotify descriptor will be created lazily |
|
|
1531 | when the first C<ev_stat> watcher is being started. |
|
|
1532 | |
|
|
1533 | Inotify presense does not change the semantics of C<ev_stat> watchers |
|
|
1534 | except that changes might be detected earlier, and in some cases, to avoid |
|
|
1535 | making regular C<stat> calls. Even in the presense of inotify support |
|
|
1536 | there are many cases where libev has to resort to regular C<stat> polling. |
|
|
1537 | |
|
|
1538 | (There is no support for kqueue, as apparently it cannot be used to |
|
|
1539 | implement this functionality, due to the requirement of having a file |
|
|
1540 | descriptor open on the object at all times). |
|
|
1541 | |
|
|
1542 | =head3 The special problem of stat time resolution |
|
|
1543 | |
|
|
1544 | The C<stat ()> syscall only supports full-second resolution portably, and |
|
|
1545 | even on systems where the resolution is higher, many filesystems still |
|
|
1546 | only support whole seconds. |
|
|
1547 | |
|
|
1548 | That means that, if the time is the only thing that changes, you might |
|
|
1549 | miss updates: on the first update, C<ev_stat> detects a change and calls |
|
|
1550 | your callback, which does something. When there is another update within |
|
|
1551 | the same second, C<ev_stat> will be unable to detect it. |
|
|
1552 | |
|
|
1553 | The solution to this is to delay acting on a change for a second (or till |
|
|
1554 | the next second boundary), using a roughly one-second delay C<ev_timer> |
|
|
1555 | (C<ev_timer_set (w, 0., 1.01); ev_timer_again (loop, w)>). The C<.01> |
|
|
1556 | is added to work around small timing inconsistencies of some operating |
|
|
1557 | systems. |
|
|
1558 | |
1382 | =head3 Watcher-Specific Functions and Data Members |
1559 | =head3 Watcher-Specific Functions and Data Members |
1383 | |
1560 | |
1384 | =over 4 |
1561 | =over 4 |
1385 | |
1562 | |
1386 | =item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) |
1563 | =item ev_stat_init (ev_stat *, callback, const char *path, ev_tstamp interval) |
… | |
… | |
1423 | =item const char *path [read-only] |
1600 | =item const char *path [read-only] |
1424 | |
1601 | |
1425 | The filesystem path that is being watched. |
1602 | The filesystem path that is being watched. |
1426 | |
1603 | |
1427 | =back |
1604 | =back |
|
|
1605 | |
|
|
1606 | =head3 Examples |
1428 | |
1607 | |
1429 | Example: Watch C</etc/passwd> for attribute changes. |
1608 | Example: Watch C</etc/passwd> for attribute changes. |
1430 | |
1609 | |
1431 | static void |
1610 | static void |
1432 | passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
1611 | passwd_cb (struct ev_loop *loop, ev_stat *w, int revents) |
… | |
… | |
1445 | } |
1624 | } |
1446 | |
1625 | |
1447 | ... |
1626 | ... |
1448 | ev_stat passwd; |
1627 | ev_stat passwd; |
1449 | |
1628 | |
1450 | ev_stat_init (&passwd, passwd_cb, "/etc/passwd"); |
1629 | ev_stat_init (&passwd, passwd_cb, "/etc/passwd", 0.); |
1451 | ev_stat_start (loop, &passwd); |
1630 | ev_stat_start (loop, &passwd); |
|
|
1631 | |
|
|
1632 | Example: Like above, but additionally use a one-second delay so we do not |
|
|
1633 | miss updates (however, frequent updates will delay processing, too, so |
|
|
1634 | one might do the work both on C<ev_stat> callback invocation I<and> on |
|
|
1635 | C<ev_timer> callback invocation). |
|
|
1636 | |
|
|
1637 | static ev_stat passwd; |
|
|
1638 | static ev_timer timer; |
|
|
1639 | |
|
|
1640 | static void |
|
|
1641 | timer_cb (EV_P_ ev_timer *w, int revents) |
|
|
1642 | { |
|
|
1643 | ev_timer_stop (EV_A_ w); |
|
|
1644 | |
|
|
1645 | /* now it's one second after the most recent passwd change */ |
|
|
1646 | } |
|
|
1647 | |
|
|
1648 | static void |
|
|
1649 | stat_cb (EV_P_ ev_stat *w, int revents) |
|
|
1650 | { |
|
|
1651 | /* reset the one-second timer */ |
|
|
1652 | ev_timer_again (EV_A_ &timer); |
|
|
1653 | } |
|
|
1654 | |
|
|
1655 | ... |
|
|
1656 | ev_stat_init (&passwd, stat_cb, "/etc/passwd", 0.); |
|
|
1657 | ev_stat_start (loop, &passwd); |
|
|
1658 | ev_timer_init (&timer, timer_cb, 0., 1.01); |
1452 | |
1659 | |
1453 | |
1660 | |
1454 | =head2 C<ev_idle> - when you've got nothing better to do... |
1661 | =head2 C<ev_idle> - when you've got nothing better to do... |
1455 | |
1662 | |
1456 | Idle watchers trigger events when no other events of the same or higher |
1663 | Idle watchers trigger events when no other events of the same or higher |
… | |
… | |
1482 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
1689 | kind. There is a C<ev_idle_set> macro, but using it is utterly pointless, |
1483 | believe me. |
1690 | believe me. |
1484 | |
1691 | |
1485 | =back |
1692 | =back |
1486 | |
1693 | |
|
|
1694 | =head3 Examples |
|
|
1695 | |
1487 | Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the |
1696 | Example: Dynamically allocate an C<ev_idle> watcher, start it, and in the |
1488 | callback, free it. Also, use no error checking, as usual. |
1697 | callback, free it. Also, use no error checking, as usual. |
1489 | |
1698 | |
1490 | static void |
1699 | static void |
1491 | idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1700 | idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) |
1492 | { |
1701 | { |
1493 | free (w); |
1702 | free (w); |
1494 | // now do something you wanted to do when the program has |
1703 | // now do something you wanted to do when the program has |
1495 | // no longer asnything immediate to do. |
1704 | // no longer anything immediate to do. |
1496 | } |
1705 | } |
1497 | |
1706 | |
1498 | struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
1707 | struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); |
1499 | ev_idle_init (idle_watcher, idle_cb); |
1708 | ev_idle_init (idle_watcher, idle_cb); |
1500 | ev_idle_start (loop, idle_cb); |
1709 | ev_idle_start (loop, idle_cb); |
… | |
… | |
1542 | |
1751 | |
1543 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
1752 | It is recommended to give C<ev_check> watchers highest (C<EV_MAXPRI>) |
1544 | priority, to ensure that they are being run before any other watchers |
1753 | priority, to ensure that they are being run before any other watchers |
1545 | after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, |
1754 | after the poll. Also, C<ev_check> watchers (and C<ev_prepare> watchers, |
1546 | too) should not activate ("feed") events into libev. While libev fully |
1755 | too) should not activate ("feed") events into libev. While libev fully |
1547 | supports this, they will be called before other C<ev_check> watchers did |
1756 | supports this, they will be called before other C<ev_check> watchers |
1548 | their job. As C<ev_check> watchers are often used to embed other event |
1757 | did their job. As C<ev_check> watchers are often used to embed other |
1549 | loops those other event loops might be in an unusable state until their |
1758 | (non-libev) event loops those other event loops might be in an unusable |
1550 | C<ev_check> watcher ran (always remind yourself to coexist peacefully with |
1759 | state until their C<ev_check> watcher ran (always remind yourself to |
1551 | others). |
1760 | coexist peacefully with others). |
1552 | |
1761 | |
1553 | =head3 Watcher-Specific Functions and Data Members |
1762 | =head3 Watcher-Specific Functions and Data Members |
1554 | |
1763 | |
1555 | =over 4 |
1764 | =over 4 |
1556 | |
1765 | |
… | |
… | |
1561 | Initialises and configures the prepare or check watcher - they have no |
1770 | Initialises and configures the prepare or check watcher - they have no |
1562 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
1771 | parameters of any kind. There are C<ev_prepare_set> and C<ev_check_set> |
1563 | macros, but using them is utterly, utterly and completely pointless. |
1772 | macros, but using them is utterly, utterly and completely pointless. |
1564 | |
1773 | |
1565 | =back |
1774 | =back |
|
|
1775 | |
|
|
1776 | =head3 Examples |
1566 | |
1777 | |
1567 | There are a number of principal ways to embed other event loops or modules |
1778 | There are a number of principal ways to embed other event loops or modules |
1568 | into libev. Here are some ideas on how to include libadns into libev |
1779 | into libev. Here are some ideas on how to include libadns into libev |
1569 | (there is a Perl module named C<EV::ADNS> that does this, which you could |
1780 | (there is a Perl module named C<EV::ADNS> that does this, which you could |
1570 | use for an actually working example. Another Perl module named C<EV::Glib> |
1781 | use for an actually working example. Another Perl module named C<EV::Glib> |
… | |
… | |
1739 | portable one. |
1950 | portable one. |
1740 | |
1951 | |
1741 | So when you want to use this feature you will always have to be prepared |
1952 | So when you want to use this feature you will always have to be prepared |
1742 | that you cannot get an embeddable loop. The recommended way to get around |
1953 | that you cannot get an embeddable loop. The recommended way to get around |
1743 | this is to have a separate variables for your embeddable loop, try to |
1954 | this is to have a separate variables for your embeddable loop, try to |
1744 | create it, and if that fails, use the normal loop for everything: |
1955 | create it, and if that fails, use the normal loop for everything. |
|
|
1956 | |
|
|
1957 | =head3 Watcher-Specific Functions and Data Members |
|
|
1958 | |
|
|
1959 | =over 4 |
|
|
1960 | |
|
|
1961 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
|
|
1962 | |
|
|
1963 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
|
|
1964 | |
|
|
1965 | Configures the watcher to embed the given loop, which must be |
|
|
1966 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
|
|
1967 | invoked automatically, otherwise it is the responsibility of the callback |
|
|
1968 | to invoke it (it will continue to be called until the sweep has been done, |
|
|
1969 | if you do not want thta, you need to temporarily stop the embed watcher). |
|
|
1970 | |
|
|
1971 | =item ev_embed_sweep (loop, ev_embed *) |
|
|
1972 | |
|
|
1973 | Make a single, non-blocking sweep over the embedded loop. This works |
|
|
1974 | similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most |
|
|
1975 | apropriate way for embedded loops. |
|
|
1976 | |
|
|
1977 | =item struct ev_loop *other [read-only] |
|
|
1978 | |
|
|
1979 | The embedded event loop. |
|
|
1980 | |
|
|
1981 | =back |
|
|
1982 | |
|
|
1983 | =head3 Examples |
|
|
1984 | |
|
|
1985 | Example: Try to get an embeddable event loop and embed it into the default |
|
|
1986 | event loop. If that is not possible, use the default loop. The default |
|
|
1987 | loop is stored in C<loop_hi>, while the mebeddable loop is stored in |
|
|
1988 | C<loop_lo> (which is C<loop_hi> in the acse no embeddable loop can be |
|
|
1989 | used). |
1745 | |
1990 | |
1746 | struct ev_loop *loop_hi = ev_default_init (0); |
1991 | struct ev_loop *loop_hi = ev_default_init (0); |
1747 | struct ev_loop *loop_lo = 0; |
1992 | struct ev_loop *loop_lo = 0; |
1748 | struct ev_embed embed; |
1993 | struct ev_embed embed; |
1749 | |
1994 | |
… | |
… | |
1760 | ev_embed_start (loop_hi, &embed); |
2005 | ev_embed_start (loop_hi, &embed); |
1761 | } |
2006 | } |
1762 | else |
2007 | else |
1763 | loop_lo = loop_hi; |
2008 | loop_lo = loop_hi; |
1764 | |
2009 | |
1765 | =head3 Watcher-Specific Functions and Data Members |
2010 | Example: Check if kqueue is available but not recommended and create |
|
|
2011 | a kqueue backend for use with sockets (which usually work with any |
|
|
2012 | kqueue implementation). Store the kqueue/socket-only event loop in |
|
|
2013 | C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). |
1766 | |
2014 | |
1767 | =over 4 |
2015 | struct ev_loop *loop = ev_default_init (0); |
|
|
2016 | struct ev_loop *loop_socket = 0; |
|
|
2017 | struct ev_embed embed; |
|
|
2018 | |
|
|
2019 | if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) |
|
|
2020 | if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) |
|
|
2021 | { |
|
|
2022 | ev_embed_init (&embed, 0, loop_socket); |
|
|
2023 | ev_embed_start (loop, &embed); |
|
|
2024 | } |
1768 | |
2025 | |
1769 | =item ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop) |
2026 | if (!loop_socket) |
|
|
2027 | loop_socket = loop; |
1770 | |
2028 | |
1771 | =item ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop) |
2029 | // now use loop_socket for all sockets, and loop for everything else |
1772 | |
|
|
1773 | Configures the watcher to embed the given loop, which must be |
|
|
1774 | embeddable. If the callback is C<0>, then C<ev_embed_sweep> will be |
|
|
1775 | invoked automatically, otherwise it is the responsibility of the callback |
|
|
1776 | to invoke it (it will continue to be called until the sweep has been done, |
|
|
1777 | if you do not want thta, you need to temporarily stop the embed watcher). |
|
|
1778 | |
|
|
1779 | =item ev_embed_sweep (loop, ev_embed *) |
|
|
1780 | |
|
|
1781 | Make a single, non-blocking sweep over the embedded loop. This works |
|
|
1782 | similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most |
|
|
1783 | apropriate way for embedded loops. |
|
|
1784 | |
|
|
1785 | =item struct ev_loop *loop [read-only] |
|
|
1786 | |
|
|
1787 | The embedded event loop. |
|
|
1788 | |
|
|
1789 | =back |
|
|
1790 | |
2030 | |
1791 | |
2031 | |
1792 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
2032 | =head2 C<ev_fork> - the audacity to resume the event loop after a fork |
1793 | |
2033 | |
1794 | Fork watchers are called when a C<fork ()> was detected (usually because |
2034 | Fork watchers are called when a C<fork ()> was detected (usually because |
… | |
… | |
1810 | believe me. |
2050 | believe me. |
1811 | |
2051 | |
1812 | =back |
2052 | =back |
1813 | |
2053 | |
1814 | |
2054 | |
|
|
2055 | =head2 C<ev_async> - how to wake up another event loop |
|
|
2056 | |
|
|
2057 | In general, you cannot use an C<ev_loop> from multiple threads or other |
|
|
2058 | asynchronous sources such as signal handlers (as opposed to multiple event |
|
|
2059 | loops - those are of course safe to use in different threads). |
|
|
2060 | |
|
|
2061 | Sometimes, however, you need to wake up another event loop you do not |
|
|
2062 | control, for example because it belongs to another thread. This is what |
|
|
2063 | C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you |
|
|
2064 | can signal it by calling C<ev_async_send>, which is thread- and signal |
|
|
2065 | safe. |
|
|
2066 | |
|
|
2067 | This functionality is very similar to C<ev_signal> watchers, as signals, |
|
|
2068 | too, are asynchronous in nature, and signals, too, will be compressed |
|
|
2069 | (i.e. the number of callback invocations may be less than the number of |
|
|
2070 | C<ev_async_sent> calls). |
|
|
2071 | |
|
|
2072 | Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not |
|
|
2073 | just the default loop. |
|
|
2074 | |
|
|
2075 | =head3 Queueing |
|
|
2076 | |
|
|
2077 | C<ev_async> does not support queueing of data in any way. The reason |
|
|
2078 | is that the author does not know of a simple (or any) algorithm for a |
|
|
2079 | multiple-writer-single-reader queue that works in all cases and doesn't |
|
|
2080 | need elaborate support such as pthreads. |
|
|
2081 | |
|
|
2082 | That means that if you want to queue data, you have to provide your own |
|
|
2083 | queue. And here is how you would implement locking: |
|
|
2084 | |
|
|
2085 | =over 4 |
|
|
2086 | |
|
|
2087 | =item queueing from a signal handler context |
|
|
2088 | |
|
|
2089 | To implement race-free queueing, you simply add to the queue in the signal |
|
|
2090 | handler but you block the signal handler in the watcher callback. Here is an example that does that for |
|
|
2091 | some fictitiuous SIGUSR1 handler: |
|
|
2092 | |
|
|
2093 | static ev_async mysig; |
|
|
2094 | |
|
|
2095 | static void |
|
|
2096 | sigusr1_handler (void) |
|
|
2097 | { |
|
|
2098 | sometype data; |
|
|
2099 | |
|
|
2100 | // no locking etc. |
|
|
2101 | queue_put (data); |
|
|
2102 | ev_async_send (DEFAULT_ &mysig); |
|
|
2103 | } |
|
|
2104 | |
|
|
2105 | static void |
|
|
2106 | mysig_cb (EV_P_ ev_async *w, int revents) |
|
|
2107 | { |
|
|
2108 | sometype data; |
|
|
2109 | sigset_t block, prev; |
|
|
2110 | |
|
|
2111 | sigemptyset (&block); |
|
|
2112 | sigaddset (&block, SIGUSR1); |
|
|
2113 | sigprocmask (SIG_BLOCK, &block, &prev); |
|
|
2114 | |
|
|
2115 | while (queue_get (&data)) |
|
|
2116 | process (data); |
|
|
2117 | |
|
|
2118 | if (sigismember (&prev, SIGUSR1) |
|
|
2119 | sigprocmask (SIG_UNBLOCK, &block, 0); |
|
|
2120 | } |
|
|
2121 | |
|
|
2122 | (Note: pthreads in theory requires you to use C<pthread_setmask> |
|
|
2123 | instead of C<sigprocmask> when you use threads, but libev doesn't do it |
|
|
2124 | either...). |
|
|
2125 | |
|
|
2126 | =item queueing from a thread context |
|
|
2127 | |
|
|
2128 | The strategy for threads is different, as you cannot (easily) block |
|
|
2129 | threads but you can easily preempt them, so to queue safely you need to |
|
|
2130 | emply a traditional mutex lock, such as in this pthread example: |
|
|
2131 | |
|
|
2132 | static ev_async mysig; |
|
|
2133 | static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER; |
|
|
2134 | |
|
|
2135 | static void |
|
|
2136 | otherthread (void) |
|
|
2137 | { |
|
|
2138 | // only need to lock the actual queueing operation |
|
|
2139 | pthread_mutex_lock (&mymutex); |
|
|
2140 | queue_put (data); |
|
|
2141 | pthread_mutex_unlock (&mymutex); |
|
|
2142 | |
|
|
2143 | ev_async_send (DEFAULT_ &mysig); |
|
|
2144 | } |
|
|
2145 | |
|
|
2146 | static void |
|
|
2147 | mysig_cb (EV_P_ ev_async *w, int revents) |
|
|
2148 | { |
|
|
2149 | pthread_mutex_lock (&mymutex); |
|
|
2150 | |
|
|
2151 | while (queue_get (&data)) |
|
|
2152 | process (data); |
|
|
2153 | |
|
|
2154 | pthread_mutex_unlock (&mymutex); |
|
|
2155 | } |
|
|
2156 | |
|
|
2157 | =back |
|
|
2158 | |
|
|
2159 | |
|
|
2160 | =head3 Watcher-Specific Functions and Data Members |
|
|
2161 | |
|
|
2162 | =over 4 |
|
|
2163 | |
|
|
2164 | =item ev_async_init (ev_async *, callback) |
|
|
2165 | |
|
|
2166 | Initialises and configures the async watcher - it has no parameters of any |
|
|
2167 | kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless, |
|
|
2168 | believe me. |
|
|
2169 | |
|
|
2170 | =item ev_async_send (loop, ev_async *) |
|
|
2171 | |
|
|
2172 | Sends/signals/activates the given C<ev_async> watcher, that is, feeds |
|
|
2173 | an C<EV_ASYNC> event on the watcher into the event loop. Unlike |
|
|
2174 | C<ev_feed_event>, this call is safe to do in other threads, signal or |
|
|
2175 | similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding |
|
|
2176 | section below on what exactly this means). |
|
|
2177 | |
|
|
2178 | This call incurs the overhead of a syscall only once per loop iteration, |
|
|
2179 | so while the overhead might be noticable, it doesn't apply to repeated |
|
|
2180 | calls to C<ev_async_send>. |
|
|
2181 | |
|
|
2182 | =back |
|
|
2183 | |
|
|
2184 | |
1815 | =head1 OTHER FUNCTIONS |
2185 | =head1 OTHER FUNCTIONS |
1816 | |
2186 | |
1817 | There are some other functions of possible interest. Described. Here. Now. |
2187 | There are some other functions of possible interest. Described. Here. Now. |
1818 | |
2188 | |
1819 | =over 4 |
2189 | =over 4 |
… | |
… | |
2046 | Example: Define a class with an IO and idle watcher, start one of them in |
2416 | Example: Define a class with an IO and idle watcher, start one of them in |
2047 | the constructor. |
2417 | the constructor. |
2048 | |
2418 | |
2049 | class myclass |
2419 | class myclass |
2050 | { |
2420 | { |
2051 | ev_io io; void io_cb (ev::io &w, int revents); |
2421 | ev::io io; void io_cb (ev::io &w, int revents); |
2052 | ev_idle idle void idle_cb (ev::idle &w, int revents); |
2422 | ev:idle idle void idle_cb (ev::idle &w, int revents); |
2053 | |
2423 | |
2054 | myclass (); |
2424 | myclass (int fd) |
2055 | } |
|
|
2056 | |
|
|
2057 | myclass::myclass (int fd) |
|
|
2058 | { |
2425 | { |
2059 | io .set <myclass, &myclass::io_cb > (this); |
2426 | io .set <myclass, &myclass::io_cb > (this); |
2060 | idle.set <myclass, &myclass::idle_cb> (this); |
2427 | idle.set <myclass, &myclass::idle_cb> (this); |
2061 | |
2428 | |
2062 | io.start (fd, ev::READ); |
2429 | io.start (fd, ev::READ); |
|
|
2430 | } |
2063 | } |
2431 | }; |
2064 | |
2432 | |
2065 | |
2433 | |
2066 | =head1 MACRO MAGIC |
2434 | =head1 MACRO MAGIC |
2067 | |
2435 | |
2068 | Libev can be compiled with a variety of options, the most fundamantal |
2436 | Libev can be compiled with a variety of options, the most fundamantal |
… | |
… | |
2129 | Libev can (and often is) directly embedded into host |
2497 | Libev can (and often is) directly embedded into host |
2130 | applications. Examples of applications that embed it include the Deliantra |
2498 | applications. Examples of applications that embed it include the Deliantra |
2131 | Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe) |
2499 | Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe) |
2132 | and rxvt-unicode. |
2500 | and rxvt-unicode. |
2133 | |
2501 | |
2134 | The goal is to enable you to just copy the neecssary files into your |
2502 | The goal is to enable you to just copy the necessary files into your |
2135 | source directory without having to change even a single line in them, so |
2503 | source directory without having to change even a single line in them, so |
2136 | you can easily upgrade by simply copying (or having a checked-out copy of |
2504 | you can easily upgrade by simply copying (or having a checked-out copy of |
2137 | libev somewhere in your source tree). |
2505 | libev somewhere in your source tree). |
2138 | |
2506 | |
2139 | =head2 FILESETS |
2507 | =head2 FILESETS |
… | |
… | |
2229 | |
2597 | |
2230 | If defined to be C<1>, libev will try to detect the availability of the |
2598 | If defined to be C<1>, libev will try to detect the availability of the |
2231 | monotonic clock option at both compiletime and runtime. Otherwise no use |
2599 | monotonic clock option at both compiletime and runtime. Otherwise no use |
2232 | of the monotonic clock option will be attempted. If you enable this, you |
2600 | of the monotonic clock option will be attempted. If you enable this, you |
2233 | usually have to link against librt or something similar. Enabling it when |
2601 | usually have to link against librt or something similar. Enabling it when |
2234 | the functionality isn't available is safe, though, althoguh you have |
2602 | the functionality isn't available is safe, though, although you have |
2235 | to make sure you link against any libraries where the C<clock_gettime> |
2603 | to make sure you link against any libraries where the C<clock_gettime> |
2236 | function is hiding in (often F<-lrt>). |
2604 | function is hiding in (often F<-lrt>). |
2237 | |
2605 | |
2238 | =item EV_USE_REALTIME |
2606 | =item EV_USE_REALTIME |
2239 | |
2607 | |
2240 | If defined to be C<1>, libev will try to detect the availability of the |
2608 | If defined to be C<1>, libev will try to detect the availability of the |
2241 | realtime clock option at compiletime (and assume its availability at |
2609 | realtime clock option at compiletime (and assume its availability at |
2242 | runtime if successful). Otherwise no use of the realtime clock option will |
2610 | runtime if successful). Otherwise no use of the realtime clock option will |
2243 | be attempted. This effectively replaces C<gettimeofday> by C<clock_get |
2611 | be attempted. This effectively replaces C<gettimeofday> by C<clock_get |
2244 | (CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries |
2612 | (CLOCK_REALTIME, ...)> and will not normally affect correctness. See the |
2245 | in the description of C<EV_USE_MONOTONIC>, though. |
2613 | note about libraries in the description of C<EV_USE_MONOTONIC>, though. |
|
|
2614 | |
|
|
2615 | =item EV_USE_NANOSLEEP |
|
|
2616 | |
|
|
2617 | If defined to be C<1>, libev will assume that C<nanosleep ()> is available |
|
|
2618 | and will use it for delays. Otherwise it will use C<select ()>. |
2246 | |
2619 | |
2247 | =item EV_USE_SELECT |
2620 | =item EV_USE_SELECT |
2248 | |
2621 | |
2249 | If undefined or defined to be C<1>, libev will compile in support for the |
2622 | If undefined or defined to be C<1>, libev will compile in support for the |
2250 | C<select>(2) backend. No attempt at autodetection will be done: if no |
2623 | C<select>(2) backend. No attempt at autodetection will be done: if no |
… | |
… | |
2268 | wants osf handles on win32 (this is the case when the select to |
2641 | wants osf handles on win32 (this is the case when the select to |
2269 | be used is the winsock select). This means that it will call |
2642 | be used is the winsock select). This means that it will call |
2270 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
2643 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
2271 | it is assumed that all these functions actually work on fds, even |
2644 | it is assumed that all these functions actually work on fds, even |
2272 | on win32. Should not be defined on non-win32 platforms. |
2645 | on win32. Should not be defined on non-win32 platforms. |
|
|
2646 | |
|
|
2647 | =item EV_FD_TO_WIN32_HANDLE |
|
|
2648 | |
|
|
2649 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
|
|
2650 | file descriptors to socket handles. When not defining this symbol (the |
|
|
2651 | default), then libev will call C<_get_osfhandle>, which is usually |
|
|
2652 | correct. In some cases, programs use their own file descriptor management, |
|
|
2653 | in which case they can provide this function to map fds to socket handles. |
2273 | |
2654 | |
2274 | =item EV_USE_POLL |
2655 | =item EV_USE_POLL |
2275 | |
2656 | |
2276 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
2657 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
2277 | backend. Otherwise it will be enabled on non-win32 platforms. It |
2658 | backend. Otherwise it will be enabled on non-win32 platforms. It |
… | |
… | |
2311 | |
2692 | |
2312 | If defined to be C<1>, libev will compile in support for the Linux inotify |
2693 | If defined to be C<1>, libev will compile in support for the Linux inotify |
2313 | interface to speed up C<ev_stat> watchers. Its actual availability will |
2694 | interface to speed up C<ev_stat> watchers. Its actual availability will |
2314 | be detected at runtime. |
2695 | be detected at runtime. |
2315 | |
2696 | |
|
|
2697 | =item EV_ATOMIC_T |
|
|
2698 | |
|
|
2699 | Libev requires an integer type (suitable for storing C<0> or C<1>) whose |
|
|
2700 | access is atomic with respect to other threads or signal contexts. No such |
|
|
2701 | type is easily found in the C language, so you can provide your own type |
|
|
2702 | that you know is safe for your purposes. It is used both for signal handler "locking" |
|
|
2703 | as well as for signal and thread safety in C<ev_async> watchers. |
|
|
2704 | |
|
|
2705 | In the absense of this define, libev will use C<sig_atomic_t volatile> |
|
|
2706 | (from F<signal.h>), which is usually good enough on most platforms. |
|
|
2707 | |
2316 | =item EV_H |
2708 | =item EV_H |
2317 | |
2709 | |
2318 | The name of the F<ev.h> header file used to include it. The default if |
2710 | The name of the F<ev.h> header file used to include it. The default if |
2319 | undefined is C<< <ev.h> >> in F<event.h> and C<"ev.h"> in F<ev.c>. This |
2711 | undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be |
2320 | can be used to virtually rename the F<ev.h> header file in case of conflicts. |
2712 | used to virtually rename the F<ev.h> header file in case of conflicts. |
2321 | |
2713 | |
2322 | =item EV_CONFIG_H |
2714 | =item EV_CONFIG_H |
2323 | |
2715 | |
2324 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
2716 | If C<EV_STANDALONE> isn't C<1>, this variable can be used to override |
2325 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
2717 | F<ev.c>'s idea of where to find the F<config.h> file, similarly to |
2326 | C<EV_H>, above. |
2718 | C<EV_H>, above. |
2327 | |
2719 | |
2328 | =item EV_EVENT_H |
2720 | =item EV_EVENT_H |
2329 | |
2721 | |
2330 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
2722 | Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea |
2331 | of how the F<event.h> header can be found. |
2723 | of how the F<event.h> header can be found, the default is C<"event.h">. |
2332 | |
2724 | |
2333 | =item EV_PROTOTYPES |
2725 | =item EV_PROTOTYPES |
2334 | |
2726 | |
2335 | If defined to be C<0>, then F<ev.h> will not define any function |
2727 | If defined to be C<0>, then F<ev.h> will not define any function |
2336 | prototypes, but still define all the structs and other symbols. This is |
2728 | prototypes, but still define all the structs and other symbols. This is |
… | |
… | |
2387 | =item EV_FORK_ENABLE |
2779 | =item EV_FORK_ENABLE |
2388 | |
2780 | |
2389 | If undefined or defined to be C<1>, then fork watchers are supported. If |
2781 | If undefined or defined to be C<1>, then fork watchers are supported. If |
2390 | defined to be C<0>, then they are not. |
2782 | defined to be C<0>, then they are not. |
2391 | |
2783 | |
|
|
2784 | =item EV_ASYNC_ENABLE |
|
|
2785 | |
|
|
2786 | If undefined or defined to be C<1>, then async watchers are supported. If |
|
|
2787 | defined to be C<0>, then they are not. |
|
|
2788 | |
2392 | =item EV_MINIMAL |
2789 | =item EV_MINIMAL |
2393 | |
2790 | |
2394 | If you need to shave off some kilobytes of code at the expense of some |
2791 | If you need to shave off some kilobytes of code at the expense of some |
2395 | speed, define this symbol to C<1>. Currently only used for gcc to override |
2792 | speed, define this symbol to C<1>. Currently only used for gcc to override |
2396 | some inlining decisions, saves roughly 30% codesize of amd64. |
2793 | some inlining decisions, saves roughly 30% codesize of amd64. |
… | |
… | |
2402 | than enough. If you need to manage thousands of children you might want to |
2799 | than enough. If you need to manage thousands of children you might want to |
2403 | increase this value (I<must> be a power of two). |
2800 | increase this value (I<must> be a power of two). |
2404 | |
2801 | |
2405 | =item EV_INOTIFY_HASHSIZE |
2802 | =item EV_INOTIFY_HASHSIZE |
2406 | |
2803 | |
2407 | C<ev_staz> watchers use a small hash table to distribute workload by |
2804 | C<ev_stat> watchers use a small hash table to distribute workload by |
2408 | inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), |
2805 | inotify watch id. The default size is C<16> (or C<1> with C<EV_MINIMAL>), |
2409 | usually more than enough. If you need to manage thousands of C<ev_stat> |
2806 | usually more than enough. If you need to manage thousands of C<ev_stat> |
2410 | watchers you might want to increase this value (I<must> be a power of |
2807 | watchers you might want to increase this value (I<must> be a power of |
2411 | two). |
2808 | two). |
2412 | |
2809 | |
… | |
… | |
2429 | |
2826 | |
2430 | =item ev_set_cb (ev, cb) |
2827 | =item ev_set_cb (ev, cb) |
2431 | |
2828 | |
2432 | Can be used to change the callback member declaration in each watcher, |
2829 | Can be used to change the callback member declaration in each watcher, |
2433 | and the way callbacks are invoked and set. Must expand to a struct member |
2830 | and the way callbacks are invoked and set. Must expand to a struct member |
2434 | definition and a statement, respectively. See the F<ev.v> header file for |
2831 | definition and a statement, respectively. See the F<ev.h> header file for |
2435 | their default definitions. One possible use for overriding these is to |
2832 | their default definitions. One possible use for overriding these is to |
2436 | avoid the C<struct ev_loop *> as first argument in all cases, or to use |
2833 | avoid the C<struct ev_loop *> as first argument in all cases, or to use |
2437 | method calls instead of plain function calls in C++. |
2834 | method calls instead of plain function calls in C++. |
|
|
2835 | |
|
|
2836 | =head2 EXPORTED API SYMBOLS |
|
|
2837 | |
|
|
2838 | If you need to re-export the API (e.g. via a dll) and you need a list of |
|
|
2839 | exported symbols, you can use the provided F<Symbol.*> files which list |
|
|
2840 | all public symbols, one per line: |
|
|
2841 | |
|
|
2842 | Symbols.ev for libev proper |
|
|
2843 | Symbols.event for the libevent emulation |
|
|
2844 | |
|
|
2845 | This can also be used to rename all public symbols to avoid clashes with |
|
|
2846 | multiple versions of libev linked together (which is obviously bad in |
|
|
2847 | itself, but sometimes it is inconvinient to avoid this). |
|
|
2848 | |
|
|
2849 | A sed command like this will create wrapper C<#define>'s that you need to |
|
|
2850 | include before including F<ev.h>: |
|
|
2851 | |
|
|
2852 | <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h |
|
|
2853 | |
|
|
2854 | This would create a file F<wrap.h> which essentially looks like this: |
|
|
2855 | |
|
|
2856 | #define ev_backend myprefix_ev_backend |
|
|
2857 | #define ev_check_start myprefix_ev_check_start |
|
|
2858 | #define ev_check_stop myprefix_ev_check_stop |
|
|
2859 | ... |
2438 | |
2860 | |
2439 | =head2 EXAMPLES |
2861 | =head2 EXAMPLES |
2440 | |
2862 | |
2441 | For a real-world example of a program the includes libev |
2863 | For a real-world example of a program the includes libev |
2442 | verbatim, you can have a look at the EV perl module |
2864 | verbatim, you can have a look at the EV perl module |
… | |
… | |
2483 | |
2905 | |
2484 | =item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) |
2906 | =item Starting and stopping timer/periodic watchers: O(log skipped_other_timers) |
2485 | |
2907 | |
2486 | This means that, when you have a watcher that triggers in one hour and |
2908 | This means that, when you have a watcher that triggers in one hour and |
2487 | there are 100 watchers that would trigger before that then inserting will |
2909 | there are 100 watchers that would trigger before that then inserting will |
2488 | have to skip those 100 watchers. |
2910 | have to skip roughly seven (C<ld 100>) of these watchers. |
2489 | |
2911 | |
2490 | =item Changing timer/periodic watchers (by autorepeat, again): O(log skipped_other_timers) |
2912 | =item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers) |
2491 | |
2913 | |
2492 | That means that for changing a timer costs less than removing/adding them |
2914 | That means that changing a timer costs less than removing/adding them |
2493 | as only the relative motion in the event queue has to be paid for. |
2915 | as only the relative motion in the event queue has to be paid for. |
2494 | |
2916 | |
2495 | =item Starting io/check/prepare/idle/signal/child watchers: O(1) |
2917 | =item Starting io/check/prepare/idle/signal/child watchers: O(1) |
2496 | |
2918 | |
2497 | These just add the watcher into an array or at the head of a list. |
2919 | These just add the watcher into an array or at the head of a list. |
|
|
2920 | |
2498 | =item Stopping check/prepare/idle watchers: O(1) |
2921 | =item Stopping check/prepare/idle watchers: O(1) |
2499 | |
2922 | |
2500 | =item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) |
2923 | =item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) |
2501 | |
2924 | |
2502 | These watchers are stored in lists then need to be walked to find the |
2925 | These watchers are stored in lists then need to be walked to find the |
2503 | correct watcher to remove. The lists are usually short (you don't usually |
2926 | correct watcher to remove. The lists are usually short (you don't usually |
2504 | have many watchers waiting for the same fd or signal). |
2927 | have many watchers waiting for the same fd or signal). |
2505 | |
2928 | |
2506 | =item Finding the next timer per loop iteration: O(1) |
2929 | =item Finding the next timer in each loop iteration: O(1) |
|
|
2930 | |
|
|
2931 | By virtue of using a binary heap, the next timer is always found at the |
|
|
2932 | beginning of the storage array. |
2507 | |
2933 | |
2508 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
2934 | =item Each change on a file descriptor per loop iteration: O(number_of_watchers_for_this_fd) |
2509 | |
2935 | |
2510 | A change means an I/O watcher gets started or stopped, which requires |
2936 | A change means an I/O watcher gets started or stopped, which requires |
2511 | libev to recalculate its status (and possibly tell the kernel). |
2937 | libev to recalculate its status (and possibly tell the kernel, depending |
|
|
2938 | on backend and wether C<ev_io_set> was used). |
2512 | |
2939 | |
2513 | =item Activating one watcher: O(1) |
2940 | =item Activating one watcher (putting it into the pending state): O(1) |
2514 | |
2941 | |
2515 | =item Priority handling: O(number_of_priorities) |
2942 | =item Priority handling: O(number_of_priorities) |
2516 | |
2943 | |
2517 | Priorities are implemented by allocating some space for each |
2944 | Priorities are implemented by allocating some space for each |
2518 | priority. When doing priority-based operations, libev usually has to |
2945 | priority. When doing priority-based operations, libev usually has to |
2519 | linearly search all the priorities. |
2946 | linearly search all the priorities, but starting/stopping and activating |
|
|
2947 | watchers becomes O(1) w.r.t. prioritiy handling. |
2520 | |
2948 | |
2521 | =back |
2949 | =back |
2522 | |
2950 | |
2523 | |
2951 | |
|
|
2952 | =head1 Win32 platform limitations and workarounds |
|
|
2953 | |
|
|
2954 | Win32 doesn't support any of the standards (e.g. POSIX) that libev |
|
|
2955 | requires, and its I/O model is fundamentally incompatible with the POSIX |
|
|
2956 | model. Libev still offers limited functionality on this platform in |
|
|
2957 | the form of the C<EVBACKEND_SELECT> backend, and only supports socket |
|
|
2958 | descriptors. This only applies when using Win32 natively, not when using |
|
|
2959 | e.g. cygwin. |
|
|
2960 | |
|
|
2961 | There is no supported compilation method available on windows except |
|
|
2962 | embedding it into other applications. |
|
|
2963 | |
|
|
2964 | Due to the many, low, and arbitrary limits on the win32 platform and the |
|
|
2965 | abysmal performance of winsockets, using a large number of sockets is not |
|
|
2966 | recommended (and not reasonable). If your program needs to use more than |
|
|
2967 | a hundred or so sockets, then likely it needs to use a totally different |
|
|
2968 | implementation for windows, as libev offers the POSIX model, which cannot |
|
|
2969 | be implemented efficiently on windows (microsoft monopoly games). |
|
|
2970 | |
|
|
2971 | =over 4 |
|
|
2972 | |
|
|
2973 | =item The winsocket select function |
|
|
2974 | |
|
|
2975 | The winsocket C<select> function doesn't follow POSIX in that it requires |
|
|
2976 | socket I<handles> and not socket I<file descriptors>. This makes select |
|
|
2977 | very inefficient, and also requires a mapping from file descriptors |
|
|
2978 | to socket handles. See the discussion of the C<EV_SELECT_USE_FD_SET>, |
|
|
2979 | C<EV_SELECT_IS_WINSOCKET> and C<EV_FD_TO_WIN32_HANDLE> preprocessor |
|
|
2980 | symbols for more info. |
|
|
2981 | |
|
|
2982 | The configuration for a "naked" win32 using the microsoft runtime |
|
|
2983 | libraries and raw winsocket select is: |
|
|
2984 | |
|
|
2985 | #define EV_USE_SELECT 1 |
|
|
2986 | #define EV_SELECT_IS_WINSOCKET 1 /* forces EV_SELECT_USE_FD_SET, too */ |
|
|
2987 | |
|
|
2988 | Note that winsockets handling of fd sets is O(n), so you can easily get a |
|
|
2989 | complexity in the O(n²) range when using win32. |
|
|
2990 | |
|
|
2991 | =item Limited number of file descriptors |
|
|
2992 | |
|
|
2993 | Windows has numerous arbitrary (and low) limits on things. Early versions |
|
|
2994 | of winsocket's select only supported waiting for a max. of C<64> handles |
|
|
2995 | (probably owning to the fact that all windows kernels can only wait for |
|
|
2996 | C<64> things at the same time internally; microsoft recommends spawning a |
|
|
2997 | chain of threads and wait for 63 handles and the previous thread in each). |
|
|
2998 | |
|
|
2999 | Newer versions support more handles, but you need to define C<FD_SETSIZE> |
|
|
3000 | to some high number (e.g. C<2048>) before compiling the winsocket select |
|
|
3001 | call (which might be in libev or elsewhere, for example, perl does its own |
|
|
3002 | select emulation on windows). |
|
|
3003 | |
|
|
3004 | Another limit is the number of file descriptors in the microsoft runtime |
|
|
3005 | libraries, which by default is C<64> (there must be a hidden I<64> fetish |
|
|
3006 | or something like this inside microsoft). You can increase this by calling |
|
|
3007 | C<_setmaxstdio>, which can increase this limit to C<2048> (another |
|
|
3008 | arbitrary limit), but is broken in many versions of the microsoft runtime |
|
|
3009 | libraries. |
|
|
3010 | |
|
|
3011 | This might get you to about C<512> or C<2048> sockets (depending on |
|
|
3012 | windows version and/or the phase of the moon). To get more, you need to |
|
|
3013 | wrap all I/O functions and provide your own fd management, but the cost of |
|
|
3014 | calling select (O(n²)) will likely make this unworkable. |
|
|
3015 | |
|
|
3016 | =back |
|
|
3017 | |
|
|
3018 | |
2524 | =head1 AUTHOR |
3019 | =head1 AUTHOR |
2525 | |
3020 | |
2526 | Marc Lehmann <libev@schmorp.de>. |
3021 | Marc Lehmann <libev@schmorp.de>. |
2527 | |
3022 | |