… | |
… | |
127 | .\} |
127 | .\} |
128 | .rm #[ #] #H #V #F C |
128 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
129 | .\" ======================================================================== |
130 | .\" |
130 | .\" |
131 | .IX Title "EV 1" |
131 | .IX Title "EV 1" |
132 | .TH EV 1 "2007-12-19" "perl v5.8.8" "User Contributed Perl Documentation" |
132 | .TH EV 1 "2007-12-21" "perl v5.8.8" "User Contributed Perl Documentation" |
133 | .SH "NAME" |
133 | .SH "NAME" |
134 | libev \- a high performance full\-featured event loop written in C |
134 | libev \- a high performance full\-featured event loop written in C |
135 | .SH "SYNOPSIS" |
135 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
137 | .Vb 1 |
137 | .Vb 1 |
… | |
… | |
201 | The newest version of this document is also available as a html-formatted |
201 | The newest version of this document is also available as a html-formatted |
202 | web page you might find easier to navigate when reading it for the first |
202 | web page you might find easier to navigate when reading it for the first |
203 | time: <http://cvs.schmorp.de/libev/ev.html>. |
203 | time: <http://cvs.schmorp.de/libev/ev.html>. |
204 | .PP |
204 | .PP |
205 | Libev is an event loop: you register interest in certain events (such as a |
205 | Libev is an event loop: you register interest in certain events (such as a |
206 | file descriptor being readable or a timeout occuring), and it will manage |
206 | file descriptor being readable or a timeout occurring), and it will manage |
207 | these event sources and provide your program with events. |
207 | these event sources and provide your program with events. |
208 | .PP |
208 | .PP |
209 | To do this, it must take more or less complete control over your process |
209 | To do this, it must take more or less complete control over your process |
210 | (or thread) by executing the \fIevent loop\fR handler, and will then |
210 | (or thread) by executing the \fIevent loop\fR handler, and will then |
211 | communicate events via a callback mechanism. |
211 | communicate events via a callback mechanism. |
… | |
… | |
459 | lot of inactive fds). It scales similarly to select, i.e. O(total_fds). |
459 | lot of inactive fds). It scales similarly to select, i.e. O(total_fds). |
460 | .ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 |
460 | .ie n .IP """EVBACKEND_EPOLL"" (value 4, Linux)" 4 |
461 | .el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 |
461 | .el .IP "\f(CWEVBACKEND_EPOLL\fR (value 4, Linux)" 4 |
462 | .IX Item "EVBACKEND_EPOLL (value 4, Linux)" |
462 | .IX Item "EVBACKEND_EPOLL (value 4, Linux)" |
463 | For few fds, this backend is a bit little slower than poll and select, |
463 | For few fds, this backend is a bit little slower than poll and select, |
464 | but it scales phenomenally better. While poll and select usually scale like |
464 | but it scales phenomenally better. While poll and select usually scale |
465 | O(total_fds) where n is the total number of fds (or the highest fd), epoll scales |
465 | like O(total_fds) where n is the total number of fds (or the highest fd), |
466 | either O(1) or O(active_fds). |
466 | epoll scales either O(1) or O(active_fds). The epoll design has a number |
|
|
467 | of shortcomings, such as silently dropping events in some hard-to-detect |
|
|
468 | cases and rewuiring a syscall per fd change, no fork support and bad |
|
|
469 | support for dup: |
467 | .Sp |
470 | .Sp |
468 | While stopping and starting an I/O watcher in the same iteration will |
471 | While stopping, setting and starting an I/O watcher in the same iteration |
469 | result in some caching, there is still a syscall per such incident |
472 | will result in some caching, there is still a syscall per such incident |
470 | (because the fd could point to a different file description now), so its |
473 | (because the fd could point to a different file description now), so its |
471 | best to avoid that. Also, \fIdup()\fRed file descriptors might not work very |
474 | best to avoid that. Also, \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors might not work |
472 | well if you register events for both fds. |
475 | very well if you register events for both fds. |
473 | .Sp |
476 | .Sp |
474 | Please note that epoll sometimes generates spurious notifications, so you |
477 | Please note that epoll sometimes generates spurious notifications, so you |
475 | need to use non-blocking I/O or other means to avoid blocking when no data |
478 | need to use non-blocking I/O or other means to avoid blocking when no data |
476 | (or space) is available. |
479 | (or space) is available. |
477 | .ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 |
480 | .ie n .IP """EVBACKEND_KQUEUE"" (value 8, most \s-1BSD\s0 clones)" 4 |
478 | .el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 |
481 | .el .IP "\f(CWEVBACKEND_KQUEUE\fR (value 8, most \s-1BSD\s0 clones)" 4 |
479 | .IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" |
482 | .IX Item "EVBACKEND_KQUEUE (value 8, most BSD clones)" |
480 | Kqueue deserves special mention, as at the time of this writing, it |
483 | Kqueue deserves special mention, as at the time of this writing, it |
481 | was broken on all BSDs except NetBSD (usually it doesn't work with |
484 | was broken on \fIall\fR BSDs (usually it doesn't work with anything but |
482 | anything but sockets and pipes, except on Darwin, where of course its |
485 | sockets and pipes, except on Darwin, where of course it's completely |
|
|
486 | useless. On NetBSD, it seems to work for all the \s-1FD\s0 types I tested, so it |
483 | completely useless). For this reason its not being \*(L"autodetected\*(R" |
487 | is used by default there). For this reason it's not being \*(L"autodetected\*(R" |
484 | unless you explicitly specify it explicitly in the flags (i.e. using |
488 | unless you explicitly specify it explicitly in the flags (i.e. using |
485 | \&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR). |
489 | \&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR) or libev was compiled on a known-to-be-good (\-enough) |
|
|
490 | system like NetBSD. |
486 | .Sp |
491 | .Sp |
487 | It scales in the same way as the epoll backend, but the interface to the |
492 | It scales in the same way as the epoll backend, but the interface to the |
488 | kernel is more efficient (which says nothing about its actual speed, of |
493 | kernel is more efficient (which says nothing about its actual speed, |
489 | course). While starting and stopping an I/O watcher does not cause an |
494 | of course). While stopping, setting and starting an I/O watcher does |
490 | extra syscall as with epoll, it still adds up to four event changes per |
495 | never cause an extra syscall as with epoll, it still adds up to two event |
491 | incident, so its best to avoid that. |
496 | changes per incident, support for \f(CW\*(C`fork ()\*(C'\fR is very bad and it drops fds |
|
|
497 | silently in similarly hard-to-detetc cases. |
492 | .ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 |
498 | .ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4 |
493 | .el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 |
499 | .el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4 |
494 | .IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" |
500 | .IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)" |
495 | This is not implemented yet (and might never be). |
501 | This is not implemented yet (and might never be). |
496 | .ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 |
502 | .ie n .IP """EVBACKEND_PORT"" (value 32, Solaris 10)" 4 |
497 | .el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 |
503 | .el .IP "\f(CWEVBACKEND_PORT\fR (value 32, Solaris 10)" 4 |
498 | .IX Item "EVBACKEND_PORT (value 32, Solaris 10)" |
504 | .IX Item "EVBACKEND_PORT (value 32, Solaris 10)" |
499 | This uses the Solaris 10 port mechanism. As with everything on Solaris, |
505 | This uses the Solaris 10 event port mechanism. As with everything on Solaris, |
500 | it's really slow, but it still scales very well (O(active_fds)). |
506 | it's really slow, but it still scales very well (O(active_fds)). |
501 | .Sp |
507 | .Sp |
502 | Please note that solaris ports can result in a lot of spurious |
508 | Please note that solaris event ports can deliver a lot of spurious |
503 | notifications, so you need to use non-blocking I/O or other means to avoid |
509 | notifications, so you need to use non-blocking I/O or other means to avoid |
504 | blocking when no data (or space) is available. |
510 | blocking when no data (or space) is available. |
505 | .ie n .IP """EVBACKEND_ALL""" 4 |
511 | .ie n .IP """EVBACKEND_ALL""" 4 |
506 | .el .IP "\f(CWEVBACKEND_ALL\fR" 4 |
512 | .el .IP "\f(CWEVBACKEND_ALL\fR" 4 |
507 | .IX Item "EVBACKEND_ALL" |
513 | .IX Item "EVBACKEND_ALL" |
… | |
… | |
560 | responsibility to either stop all watchers cleanly yoursef \fIbefore\fR |
566 | responsibility to either stop all watchers cleanly yoursef \fIbefore\fR |
561 | calling this function, or cope with the fact afterwards (which is usually |
567 | calling this function, or cope with the fact afterwards (which is usually |
562 | the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them |
568 | the easiest thing, you can just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them |
563 | for example). |
569 | for example). |
564 | .Sp |
570 | .Sp |
565 | Not that certain global state, such as signal state, will not be freed by |
571 | Note that certain global state, such as signal state, will not be freed by |
566 | this function, and related watchers (such as signal and child watchers) |
572 | this function, and related watchers (such as signal and child watchers) |
567 | would need to be stopped manually. |
573 | would need to be stopped manually. |
568 | .Sp |
574 | .Sp |
569 | In general it is not advisable to call this function except in the |
575 | In general it is not advisable to call this function except in the |
570 | rare occasion where you really need to free e.g. the signal handling |
576 | rare occasion where you really need to free e.g. the signal handling |
… | |
… | |
618 | .IX Item "ev_tstamp ev_now (loop)" |
624 | .IX Item "ev_tstamp ev_now (loop)" |
619 | Returns the current \*(L"event loop time\*(R", which is the time the event loop |
625 | Returns the current \*(L"event loop time\*(R", which is the time the event loop |
620 | received events and started processing them. This timestamp does not |
626 | received events and started processing them. This timestamp does not |
621 | change as long as callbacks are being processed, and this is also the base |
627 | change as long as callbacks are being processed, and this is also the base |
622 | time used for relative timers. You can treat it as the timestamp of the |
628 | time used for relative timers. You can treat it as the timestamp of the |
623 | event occuring (or more correctly, libev finding out about it). |
629 | event occurring (or more correctly, libev finding out about it). |
624 | .IP "ev_loop (loop, int flags)" 4 |
630 | .IP "ev_loop (loop, int flags)" 4 |
625 | .IX Item "ev_loop (loop, int flags)" |
631 | .IX Item "ev_loop (loop, int flags)" |
626 | Finally, this is it, the event handler. This function usually is called |
632 | Finally, this is it, the event handler. This function usually is called |
627 | after you initialised all your watchers and you want to start handling |
633 | after you initialised all your watchers and you want to start handling |
628 | events. |
634 | events. |
… | |
… | |
1080 | its own, so its quite safe to use). |
1086 | its own, so its quite safe to use). |
1081 | .PP |
1087 | .PP |
1082 | \fIThe special problem of disappearing file descriptors\fR |
1088 | \fIThe special problem of disappearing file descriptors\fR |
1083 | .IX Subsection "The special problem of disappearing file descriptors" |
1089 | .IX Subsection "The special problem of disappearing file descriptors" |
1084 | .PP |
1090 | .PP |
1085 | Some backends (e.g kqueue, epoll) need to be told about closing a file |
1091 | Some backends (e.g. kqueue, epoll) need to be told about closing a file |
1086 | descriptor (either by calling \f(CW\*(C`close\*(C'\fR explicitly or by any other means, |
1092 | descriptor (either by calling \f(CW\*(C`close\*(C'\fR explicitly or by any other means, |
1087 | such as \f(CW\*(C`dup\*(C'\fR). The reason is that you register interest in some file |
1093 | such as \f(CW\*(C`dup\*(C'\fR). The reason is that you register interest in some file |
1088 | descriptor, but when it goes away, the operating system will silently drop |
1094 | descriptor, but when it goes away, the operating system will silently drop |
1089 | this interest. If another file descriptor with the same number then is |
1095 | this interest. If another file descriptor with the same number then is |
1090 | registered with libev, there is no efficient way to see that this is, in |
1096 | registered with libev, there is no efficient way to see that this is, in |
… | |
… | |
1098 | descriptor even if the file descriptor number itself did not change. |
1104 | descriptor even if the file descriptor number itself did not change. |
1099 | .PP |
1105 | .PP |
1100 | This is how one would do it normally anyway, the important point is that |
1106 | This is how one would do it normally anyway, the important point is that |
1101 | the libev application should not optimise around libev but should leave |
1107 | the libev application should not optimise around libev but should leave |
1102 | optimisations to libev. |
1108 | optimisations to libev. |
|
|
1109 | .PP |
|
|
1110 | \fIThs special problem of dup'ed file descriptors\fR |
|
|
1111 | .IX Subsection "Ths special problem of dup'ed file descriptors" |
|
|
1112 | .PP |
|
|
1113 | Some backends (e.g. epoll), cannot register events for file descriptors, |
|
|
1114 | but only events for the underlying file descriptions. That menas when you |
|
|
1115 | have \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors and register events for them, only one |
|
|
1116 | file descriptor might actually receive events. |
|
|
1117 | .PP |
|
|
1118 | There is no workaorund possible except not registering events |
|
|
1119 | for potentially \f(CW\*(C`dup ()\*(C'\fR'ed file descriptors or to resort to |
|
|
1120 | \&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR. |
|
|
1121 | .PP |
|
|
1122 | \fIThe special problem of fork\fR |
|
|
1123 | .IX Subsection "The special problem of fork" |
|
|
1124 | .PP |
|
|
1125 | Some backends (epoll, kqueue) do not support \f(CW\*(C`fork ()\*(C'\fR at all or exhibit |
|
|
1126 | useless behaviour. Libev fully supports fork, but needs to be told about |
|
|
1127 | it in the child. |
|
|
1128 | .PP |
|
|
1129 | To support fork in your programs, you either have to call |
|
|
1130 | \&\f(CW\*(C`ev_default_fork ()\*(C'\fR or \f(CW\*(C`ev_loop_fork ()\*(C'\fR after a fork in the child, |
|
|
1131 | enable \f(CW\*(C`EVFLAG_FORKCHECK\*(C'\fR, or resort to \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or |
|
|
1132 | \&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR. |
1103 | .PP |
1133 | .PP |
1104 | \fIWatcher-Specific Functions\fR |
1134 | \fIWatcher-Specific Functions\fR |
1105 | .IX Subsection "Watcher-Specific Functions" |
1135 | .IX Subsection "Watcher-Specific Functions" |
1106 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1136 | .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4 |
1107 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
1137 | .IX Item "ev_io_init (ev_io *, callback, int fd, int events)" |
… | |
… | |
1906 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
1936 | .el .Sh "\f(CWev_embed\fP \- when one backend isn't enough..." |
1907 | .IX Subsection "ev_embed - when one backend isn't enough..." |
1937 | .IX Subsection "ev_embed - when one backend isn't enough..." |
1908 | This is a rather advanced watcher type that lets you embed one event loop |
1938 | This is a rather advanced watcher type that lets you embed one event loop |
1909 | into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded |
1939 | into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded |
1910 | loop, other types of watchers might be handled in a delayed or incorrect |
1940 | loop, other types of watchers might be handled in a delayed or incorrect |
1911 | fashion and must not be used). |
1941 | fashion and must not be used). (See portability notes, below). |
1912 | .PP |
1942 | .PP |
1913 | There are primarily two reasons you would want that: work around bugs and |
1943 | There are primarily two reasons you would want that: work around bugs and |
1914 | prioritise I/O. |
1944 | prioritise I/O. |
1915 | .PP |
1945 | .PP |
1916 | As an example for a bug workaround, the kqueue backend might only support |
1946 | As an example for a bug workaround, the kqueue backend might only support |
… | |
… | |
1976 | \& ev_embed_start (loop_hi, &embed); |
2006 | \& ev_embed_start (loop_hi, &embed); |
1977 | \& } |
2007 | \& } |
1978 | \& else |
2008 | \& else |
1979 | \& loop_lo = loop_hi; |
2009 | \& loop_lo = loop_hi; |
1980 | .Ve |
2010 | .Ve |
|
|
2011 | .Sh "Portability notes" |
|
|
2012 | .IX Subsection "Portability notes" |
|
|
2013 | Kqueue is nominally embeddable, but this is broken on all BSDs that I |
|
|
2014 | tried, in various ways. Usually the embedded event loop will simply never |
|
|
2015 | receive events, sometimes it will only trigger a few times, sometimes in a |
|
|
2016 | loop. Epoll is also nominally embeddable, but many Linux kernel versions |
|
|
2017 | will always eport the epoll fd as ready, even when no events are pending. |
|
|
2018 | .PP |
|
|
2019 | While libev allows embedding these backends (they are contained in |
|
|
2020 | \&\f(CW\*(C`ev_embeddable_backends ()\*(C'\fR), take extreme care that it will actually |
|
|
2021 | work. |
|
|
2022 | .PP |
|
|
2023 | When in doubt, create a dynamic event loop forced to use sockets (this |
|
|
2024 | usually works) and possibly another thread and a pipe or so to report to |
|
|
2025 | your main event loop. |
1981 | .PP |
2026 | .PP |
1982 | \fIWatcher-Specific Functions and Data Members\fR |
2027 | \fIWatcher-Specific Functions and Data Members\fR |
1983 | .IX Subsection "Watcher-Specific Functions and Data Members" |
2028 | .IX Subsection "Watcher-Specific Functions and Data Members" |
1984 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
2029 | .IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4 |
1985 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
2030 | .IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" |
… | |
… | |
1995 | .IP "ev_embed_sweep (loop, ev_embed *)" 4 |
2040 | .IP "ev_embed_sweep (loop, ev_embed *)" 4 |
1996 | .IX Item "ev_embed_sweep (loop, ev_embed *)" |
2041 | .IX Item "ev_embed_sweep (loop, ev_embed *)" |
1997 | Make a single, non-blocking sweep over the embedded loop. This works |
2042 | Make a single, non-blocking sweep over the embedded loop. This works |
1998 | similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most |
2043 | similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most |
1999 | apropriate way for embedded loops. |
2044 | apropriate way for embedded loops. |
2000 | .IP "struct ev_loop *loop [read\-only]" 4 |
2045 | .IP "struct ev_loop *other [read\-only]" 4 |
2001 | .IX Item "struct ev_loop *loop [read-only]" |
2046 | .IX Item "struct ev_loop *other [read-only]" |
2002 | The embedded event loop. |
2047 | The embedded event loop. |
2003 | .ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork" |
2048 | .ie n .Sh """ev_fork"" \- the audacity to resume the event loop after a fork" |
2004 | .el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" |
2049 | .el .Sh "\f(CWev_fork\fP \- the audacity to resume the event loop after a fork" |
2005 | .IX Subsection "ev_fork - the audacity to resume the event loop after a fork" |
2050 | .IX Subsection "ev_fork - the audacity to resume the event loop after a fork" |
2006 | Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because |
2051 | Fork watchers are called when a \f(CW\*(C`fork ()\*(C'\fR was detected (usually because |
… | |
… | |
2330 | Libev can (and often is) directly embedded into host |
2375 | Libev can (and often is) directly embedded into host |
2331 | applications. Examples of applications that embed it include the Deliantra |
2376 | applications. Examples of applications that embed it include the Deliantra |
2332 | Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) |
2377 | Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe) |
2333 | and rxvt\-unicode. |
2378 | and rxvt\-unicode. |
2334 | .PP |
2379 | .PP |
2335 | The goal is to enable you to just copy the neecssary files into your |
2380 | The goal is to enable you to just copy the necessary files into your |
2336 | source directory without having to change even a single line in them, so |
2381 | source directory without having to change even a single line in them, so |
2337 | you can easily upgrade by simply copying (or having a checked-out copy of |
2382 | you can easily upgrade by simply copying (or having a checked-out copy of |
2338 | libev somewhere in your source tree). |
2383 | libev somewhere in your source tree). |
2339 | .Sh "\s-1FILESETS\s0" |
2384 | .Sh "\s-1FILESETS\s0" |
2340 | .IX Subsection "FILESETS" |
2385 | .IX Subsection "FILESETS" |
… | |
… | |
2445 | .IX Item "EV_USE_MONOTONIC" |
2490 | .IX Item "EV_USE_MONOTONIC" |
2446 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
2491 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
2447 | monotonic clock option at both compiletime and runtime. Otherwise no use |
2492 | monotonic clock option at both compiletime and runtime. Otherwise no use |
2448 | of the monotonic clock option will be attempted. If you enable this, you |
2493 | of the monotonic clock option will be attempted. If you enable this, you |
2449 | usually have to link against librt or something similar. Enabling it when |
2494 | usually have to link against librt or something similar. Enabling it when |
2450 | the functionality isn't available is safe, though, althoguh you have |
2495 | the functionality isn't available is safe, though, although you have |
2451 | to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR |
2496 | to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR |
2452 | function is hiding in (often \fI\-lrt\fR). |
2497 | function is hiding in (often \fI\-lrt\fR). |
2453 | .IP "\s-1EV_USE_REALTIME\s0" 4 |
2498 | .IP "\s-1EV_USE_REALTIME\s0" 4 |
2454 | .IX Item "EV_USE_REALTIME" |
2499 | .IX Item "EV_USE_REALTIME" |
2455 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
2500 | If defined to be \f(CW1\fR, libev will try to detect the availability of the |
2456 | realtime clock option at compiletime (and assume its availability at |
2501 | realtime clock option at compiletime (and assume its availability at |
2457 | runtime if successful). Otherwise no use of the realtime clock option will |
2502 | runtime if successful). Otherwise no use of the realtime clock option will |
2458 | be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get |
2503 | be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get |
2459 | (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See tzhe note about libraries |
2504 | (CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See the |
2460 | in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. |
2505 | note about libraries in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though. |
2461 | .IP "\s-1EV_USE_SELECT\s0" 4 |
2506 | .IP "\s-1EV_USE_SELECT\s0" 4 |
2462 | .IX Item "EV_USE_SELECT" |
2507 | .IX Item "EV_USE_SELECT" |
2463 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
2508 | If undefined or defined to be \f(CW1\fR, libev will compile in support for the |
2464 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no |
2509 | \&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no |
2465 | other method takes over, select will be it. Otherwise the select backend |
2510 | other method takes over, select will be it. Otherwise the select backend |
… | |
… | |
2625 | .IP "ev_set_cb (ev, cb)" 4 |
2670 | .IP "ev_set_cb (ev, cb)" 4 |
2626 | .IX Item "ev_set_cb (ev, cb)" |
2671 | .IX Item "ev_set_cb (ev, cb)" |
2627 | .PD |
2672 | .PD |
2628 | Can be used to change the callback member declaration in each watcher, |
2673 | Can be used to change the callback member declaration in each watcher, |
2629 | and the way callbacks are invoked and set. Must expand to a struct member |
2674 | and the way callbacks are invoked and set. Must expand to a struct member |
2630 | definition and a statement, respectively. See the \fIev.v\fR header file for |
2675 | definition and a statement, respectively. See the \fIev.h\fR header file for |
2631 | their default definitions. One possible use for overriding these is to |
2676 | their default definitions. One possible use for overriding these is to |
2632 | avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use |
2677 | avoid the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument in all cases, or to use |
2633 | method calls instead of plain function calls in \*(C+. |
2678 | method calls instead of plain function calls in \*(C+. |
2634 | .Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" |
2679 | .Sh "\s-1EXPORTED\s0 \s-1API\s0 \s-1SYMBOLS\s0" |
2635 | .IX Subsection "EXPORTED API SYMBOLS" |
2680 | .IX Subsection "EXPORTED API SYMBOLS" |
… | |
… | |
2644 | .Sp |
2689 | .Sp |
2645 | This can also be used to rename all public symbols to avoid clashes with |
2690 | This can also be used to rename all public symbols to avoid clashes with |
2646 | multiple versions of libev linked together (which is obviously bad in |
2691 | multiple versions of libev linked together (which is obviously bad in |
2647 | itself, but sometimes it is inconvinient to avoid this). |
2692 | itself, but sometimes it is inconvinient to avoid this). |
2648 | .Sp |
2693 | .Sp |
2649 | A sed comamnd like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to |
2694 | A sed command like this will create wrapper \f(CW\*(C`#define\*(C'\fR's that you need to |
2650 | include before including \fIev.h\fR: |
2695 | include before including \fIev.h\fR: |
2651 | .Sp |
2696 | .Sp |
2652 | .Vb 1 |
2697 | .Vb 1 |
2653 | \& <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h |
2698 | \& <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h |
2654 | .Ve |
2699 | .Ve |