… | |
… | |
98 | =head2 FEATURES |
98 | =head2 FEATURES |
99 | |
99 | |
100 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
100 | Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the |
101 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
101 | BSD-specific C<kqueue> and the Solaris-specific event port mechanisms |
102 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
102 | for file descriptor events (C<ev_io>), the Linux C<inotify> interface |
103 | (for C<ev_stat>), relative timers (C<ev_timer>), absolute timers |
103 | (for C<ev_stat>), Linux eventfd/signalfd (for faster and cleaner |
104 | with customised rescheduling (C<ev_periodic>), synchronous signals |
104 | inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative |
105 | (C<ev_signal>), process status change events (C<ev_child>), and event |
105 | timers (C<ev_timer>), absolute timers with customised rescheduling |
106 | watchers dealing with the event loop mechanism itself (C<ev_idle>, |
106 | (C<ev_periodic>), synchronous signals (C<ev_signal>), process status |
107 | C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as |
107 | change events (C<ev_child>), and event watchers dealing with the event |
108 | file watchers (C<ev_stat>) and even limited support for fork events |
108 | loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and |
109 | (C<ev_fork>). |
109 | C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even |
|
|
110 | limited support for fork events (C<ev_fork>). |
110 | |
111 | |
111 | It also is quite fast (see this |
112 | It also is quite fast (see this |
112 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
113 | L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent |
113 | for example). |
114 | for example). |
114 | |
115 | |
… | |
… | |
117 | Libev is very configurable. In this manual the default (and most common) |
118 | Libev is very configurable. In this manual the default (and most common) |
118 | configuration will be described, which supports multiple event loops. For |
119 | configuration will be described, which supports multiple event loops. For |
119 | more info about various configuration options please have a look at |
120 | more info about various configuration options please have a look at |
120 | B<EMBED> section in this manual. If libev was configured without support |
121 | B<EMBED> section in this manual. If libev was configured without support |
121 | for multiple event loops, then all functions taking an initial argument of |
122 | for multiple event loops, then all functions taking an initial argument of |
122 | name C<loop> (which is always of type C<ev_loop *>) will not have |
123 | name C<loop> (which is always of type C<struct ev_loop *>) will not have |
123 | this argument. |
124 | this argument. |
124 | |
125 | |
125 | =head2 TIME REPRESENTATION |
126 | =head2 TIME REPRESENTATION |
126 | |
127 | |
127 | Libev represents time as a single floating point number, representing |
128 | Libev represents time as a single floating point number, representing |
… | |
… | |
369 | When this flag is specified, then libev will not attempt to use the |
370 | When this flag is specified, then libev will not attempt to use the |
370 | I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and |
371 | I<inotify> API for it's C<ev_stat> watchers. Apart from debugging and |
371 | testing, this flag can be useful to conserve inotify file descriptors, as |
372 | testing, this flag can be useful to conserve inotify file descriptors, as |
372 | otherwise each loop using C<ev_stat> watchers consumes one inotify handle. |
373 | otherwise each loop using C<ev_stat> watchers consumes one inotify handle. |
373 | |
374 | |
374 | =item C<EVFLAG_NOSIGNALFD> |
375 | =item C<EVFLAG_NOSIGFD> |
375 | |
376 | |
376 | When this flag is specified, then libev will not attempt to use the |
377 | When this flag is specified, then libev will not attempt to use the |
377 | I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This is |
378 | I<signalfd> API for it's C<ev_signal> (and C<ev_child>) watchers. This is |
378 | probably only useful to work around any bugs in libev. Consequently, this |
379 | probably only useful to work around any bugs in libev. Consequently, this |
379 | flag might go away once the signalfd functionality is considered stable, |
380 | flag might go away once the signalfd functionality is considered stable, |
… | |
… | |
409 | |
410 | |
410 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
411 | This backend maps C<EV_READ> to C<POLLIN | POLLERR | POLLHUP>, and |
411 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
412 | C<EV_WRITE> to C<POLLOUT | POLLERR | POLLHUP>. |
412 | |
413 | |
413 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
414 | =item C<EVBACKEND_EPOLL> (value 4, Linux) |
|
|
415 | |
|
|
416 | Use the linux-specific epoll(7) interface (for both pre- and post-2.6.9 |
|
|
417 | kernels). |
414 | |
418 | |
415 | For few fds, this backend is a bit little slower than poll and select, |
419 | For few fds, this backend is a bit little slower than poll and select, |
416 | but it scales phenomenally better. While poll and select usually scale |
420 | but it scales phenomenally better. While poll and select usually scale |
417 | like O(total_fds) where n is the total number of fds (or the highest fd), |
421 | like O(total_fds) where n is the total number of fds (or the highest fd), |
418 | epoll scales either O(1) or O(active_fds). |
422 | epoll scales either O(1) or O(active_fds). |
… | |
… | |
589 | as signal and child watchers) would need to be stopped manually. |
593 | as signal and child watchers) would need to be stopped manually. |
590 | |
594 | |
591 | In general it is not advisable to call this function except in the |
595 | In general it is not advisable to call this function except in the |
592 | rare occasion where you really need to free e.g. the signal handling |
596 | rare occasion where you really need to free e.g. the signal handling |
593 | pipe fds. If you need dynamically allocated loops it is better to use |
597 | pipe fds. If you need dynamically allocated loops it is better to use |
594 | C<ev_loop_new> and C<ev_loop_destroy>). |
598 | C<ev_loop_new> and C<ev_loop_destroy>. |
595 | |
599 | |
596 | =item ev_loop_destroy (loop) |
600 | =item ev_loop_destroy (loop) |
597 | |
601 | |
598 | Like C<ev_default_destroy>, but destroys an event loop created by an |
602 | Like C<ev_default_destroy>, but destroys an event loop created by an |
599 | earlier call to C<ev_loop_new>. |
603 | earlier call to C<ev_loop_new>. |
… | |
… | |
703 | event loop time (see C<ev_now_update>). |
707 | event loop time (see C<ev_now_update>). |
704 | |
708 | |
705 | =item ev_loop (loop, int flags) |
709 | =item ev_loop (loop, int flags) |
706 | |
710 | |
707 | Finally, this is it, the event handler. This function usually is called |
711 | Finally, this is it, the event handler. This function usually is called |
708 | after you initialised all your watchers and you want to start handling |
712 | after you have initialised all your watchers and you want to start |
709 | events. |
713 | handling events. |
710 | |
714 | |
711 | If the flags argument is specified as C<0>, it will not return until |
715 | If the flags argument is specified as C<0>, it will not return until |
712 | either no event watchers are active anymore or C<ev_unloop> was called. |
716 | either no event watchers are active anymore or C<ev_unloop> was called. |
713 | |
717 | |
714 | Please note that an explicit C<ev_unloop> is usually better than |
718 | Please note that an explicit C<ev_unloop> is usually better than |
… | |
… | |
915 | |
919 | |
916 | While event loop modifications are allowed between invocations of |
920 | While event loop modifications are allowed between invocations of |
917 | C<release> and C<acquire> (that's their only purpose after all), no |
921 | C<release> and C<acquire> (that's their only purpose after all), no |
918 | modifications done will affect the event loop, i.e. adding watchers will |
922 | modifications done will affect the event loop, i.e. adding watchers will |
919 | have no effect on the set of file descriptors being watched, or the time |
923 | have no effect on the set of file descriptors being watched, or the time |
920 | waited. USe an C<ev_async> watcher to wake up C<ev_loop> when you want it |
924 | waited. Use an C<ev_async> watcher to wake up C<ev_loop> when you want it |
921 | to take note of any changes you made. |
925 | to take note of any changes you made. |
922 | |
926 | |
923 | In theory, threads executing C<ev_loop> will be async-cancel safe between |
927 | In theory, threads executing C<ev_loop> will be async-cancel safe between |
924 | invocations of C<release> and C<acquire>. |
928 | invocations of C<release> and C<acquire>. |
925 | |
929 | |
… | |
… | |
1122 | |
1126 | |
1123 | ev_io w; |
1127 | ev_io w; |
1124 | ev_init (&w, my_cb); |
1128 | ev_init (&w, my_cb); |
1125 | ev_io_set (&w, STDIN_FILENO, EV_READ); |
1129 | ev_io_set (&w, STDIN_FILENO, EV_READ); |
1126 | |
1130 | |
1127 | =item C<ev_TYPE_set> (ev_TYPE *, [args]) |
1131 | =item C<ev_TYPE_set> (ev_TYPE *watcher, [args]) |
1128 | |
1132 | |
1129 | This macro initialises the type-specific parts of a watcher. You need to |
1133 | This macro initialises the type-specific parts of a watcher. You need to |
1130 | call C<ev_init> at least once before you call this macro, but you can |
1134 | call C<ev_init> at least once before you call this macro, but you can |
1131 | call C<ev_TYPE_set> any number of times. You must not, however, call this |
1135 | call C<ev_TYPE_set> any number of times. You must not, however, call this |
1132 | macro on a watcher that is active (it can be pending, however, which is a |
1136 | macro on a watcher that is active (it can be pending, however, which is a |
… | |
… | |
1145 | |
1149 | |
1146 | Example: Initialise and set an C<ev_io> watcher in one step. |
1150 | Example: Initialise and set an C<ev_io> watcher in one step. |
1147 | |
1151 | |
1148 | ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); |
1152 | ev_io_init (&w, my_cb, STDIN_FILENO, EV_READ); |
1149 | |
1153 | |
1150 | =item C<ev_TYPE_start> (loop *, ev_TYPE *watcher) |
1154 | =item C<ev_TYPE_start> (loop, ev_TYPE *watcher) |
1151 | |
1155 | |
1152 | Starts (activates) the given watcher. Only active watchers will receive |
1156 | Starts (activates) the given watcher. Only active watchers will receive |
1153 | events. If the watcher is already active nothing will happen. |
1157 | events. If the watcher is already active nothing will happen. |
1154 | |
1158 | |
1155 | Example: Start the C<ev_io> watcher that is being abused as example in this |
1159 | Example: Start the C<ev_io> watcher that is being abused as example in this |
1156 | whole section. |
1160 | whole section. |
1157 | |
1161 | |
1158 | ev_io_start (EV_DEFAULT_UC, &w); |
1162 | ev_io_start (EV_DEFAULT_UC, &w); |
1159 | |
1163 | |
1160 | =item C<ev_TYPE_stop> (loop *, ev_TYPE *watcher) |
1164 | =item C<ev_TYPE_stop> (loop, ev_TYPE *watcher) |
1161 | |
1165 | |
1162 | Stops the given watcher if active, and clears the pending status (whether |
1166 | Stops the given watcher if active, and clears the pending status (whether |
1163 | the watcher was active or not). |
1167 | the watcher was active or not). |
1164 | |
1168 | |
1165 | It is possible that stopped watchers are pending - for example, |
1169 | It is possible that stopped watchers are pending - for example, |
… | |
… | |
1190 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1194 | =item ev_cb_set (ev_TYPE *watcher, callback) |
1191 | |
1195 | |
1192 | Change the callback. You can change the callback at virtually any time |
1196 | Change the callback. You can change the callback at virtually any time |
1193 | (modulo threads). |
1197 | (modulo threads). |
1194 | |
1198 | |
1195 | =item ev_set_priority (ev_TYPE *watcher, priority) |
1199 | =item ev_set_priority (ev_TYPE *watcher, int priority) |
1196 | |
1200 | |
1197 | =item int ev_priority (ev_TYPE *watcher) |
1201 | =item int ev_priority (ev_TYPE *watcher) |
1198 | |
1202 | |
1199 | Set and query the priority of the watcher. The priority is a small |
1203 | Set and query the priority of the watcher. The priority is a small |
1200 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
1204 | integer between C<EV_MAXPRI> (default: C<2>) and C<EV_MINPRI> |
… | |
… | |
1231 | returns its C<revents> bitset (as if its callback was invoked). If the |
1235 | returns its C<revents> bitset (as if its callback was invoked). If the |
1232 | watcher isn't pending it does nothing and returns C<0>. |
1236 | watcher isn't pending it does nothing and returns C<0>. |
1233 | |
1237 | |
1234 | Sometimes it can be useful to "poll" a watcher instead of waiting for its |
1238 | Sometimes it can be useful to "poll" a watcher instead of waiting for its |
1235 | callback to be invoked, which can be accomplished with this function. |
1239 | callback to be invoked, which can be accomplished with this function. |
|
|
1240 | |
|
|
1241 | =item ev_feed_event (loop, ev_TYPE *watcher, int revents) |
|
|
1242 | |
|
|
1243 | Feeds the given event set into the event loop, as if the specified event |
|
|
1244 | had happened for the specified watcher (which must be a pointer to an |
|
|
1245 | initialised but not necessarily started event watcher). Obviously you must |
|
|
1246 | not free the watcher as long as it has pending events. |
|
|
1247 | |
|
|
1248 | Stopping the watcher, letting libev invoke it, or calling |
|
|
1249 | C<ev_clear_pending> will clear the pending event, even if the watcher was |
|
|
1250 | not started in the first place. |
|
|
1251 | |
|
|
1252 | See also C<ev_feed_fd_event> and C<ev_feed_signal_event> for related |
|
|
1253 | functions that do not need a watcher. |
1236 | |
1254 | |
1237 | =back |
1255 | =back |
1238 | |
1256 | |
1239 | |
1257 | |
1240 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
1258 | =head2 ASSOCIATING CUSTOM DATA WITH A WATCHER |
… | |
… | |
1836 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1854 | C<repeat> value), or reset the running timer to the C<repeat> value. |
1837 | |
1855 | |
1838 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
1856 | This sounds a bit complicated, see L<Be smart about timeouts>, above, for a |
1839 | usage example. |
1857 | usage example. |
1840 | |
1858 | |
1841 | =item ev_timer_remaining (loop, ev_timer *) |
1859 | =item ev_tstamp ev_timer_remaining (loop, ev_timer *) |
1842 | |
1860 | |
1843 | Returns the remaining time until a timer fires. If the timer is active, |
1861 | Returns the remaining time until a timer fires. If the timer is active, |
1844 | then this time is relative to the current event loop time, otherwise it's |
1862 | then this time is relative to the current event loop time, otherwise it's |
1845 | the timeout value currently configured. |
1863 | the timeout value currently configured. |
1846 | |
1864 | |
… | |
… | |
2107 | |
2125 | |
2108 | When the first watcher gets started will libev actually register something |
2126 | When the first watcher gets started will libev actually register something |
2109 | with the kernel (thus it coexists with your own signal handlers as long as |
2127 | with the kernel (thus it coexists with your own signal handlers as long as |
2110 | you don't register any with libev for the same signal). |
2128 | you don't register any with libev for the same signal). |
2111 | |
2129 | |
2112 | Both the signal mask state (C<sigprocmask>) and the signal handler state |
|
|
2113 | (C<sigaction>) are unspecified after starting a signal watcher (and after |
|
|
2114 | sotpping it again), that is, libev might or might not block the signal, |
|
|
2115 | and might or might not set or restore the installed signal handler. |
|
|
2116 | |
|
|
2117 | If possible and supported, libev will install its handlers with |
2130 | If possible and supported, libev will install its handlers with |
2118 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2131 | C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should |
2119 | not be unduly interrupted. If you have a problem with system calls getting |
2132 | not be unduly interrupted. If you have a problem with system calls getting |
2120 | interrupted by signals you can block all signals in an C<ev_check> watcher |
2133 | interrupted by signals you can block all signals in an C<ev_check> watcher |
2121 | and unblock them in an C<ev_prepare> watcher. |
2134 | and unblock them in an C<ev_prepare> watcher. |
|
|
2135 | |
|
|
2136 | =head3 The special problem of inheritance over execve |
|
|
2137 | |
|
|
2138 | Both the signal mask (C<sigprocmask>) and the signal disposition |
|
|
2139 | (C<sigaction>) are unspecified after starting a signal watcher (and after |
|
|
2140 | stopping it again), that is, libev might or might not block the signal, |
|
|
2141 | and might or might not set or restore the installed signal handler. |
|
|
2142 | |
|
|
2143 | While this does not matter for the signal disposition (libev never |
|
|
2144 | sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on |
|
|
2145 | C<execve>), this matters for the signal mask: many programs do not expect |
|
|
2146 | certain signals to be blocked. |
|
|
2147 | |
|
|
2148 | This means that before calling C<exec> (from the child) you should reset |
|
|
2149 | the signal mask to whatever "default" you expect (all clear is a good |
|
|
2150 | choice usually). |
|
|
2151 | |
|
|
2152 | The simplest way to ensure that the signal mask is reset in the child is |
|
|
2153 | to install a fork handler with C<pthread_atfork> that resets it. That will |
|
|
2154 | catch fork calls done by libraries (such as the libc) as well. |
|
|
2155 | |
|
|
2156 | In current versions of libev, you can also ensure that the signal mask is |
|
|
2157 | not blocking any signals (except temporarily, so thread users watch out) |
|
|
2158 | by specifying the C<EVFLAG_NOSIGFD> when creating the event loop. This |
|
|
2159 | is not guaranteed for future versions, however. |
2122 | |
2160 | |
2123 | =head3 Watcher-Specific Functions and Data Members |
2161 | =head3 Watcher-Specific Functions and Data Members |
2124 | |
2162 | |
2125 | =over 4 |
2163 | =over 4 |
2126 | |
2164 | |
… | |
… | |
2943 | =head3 Queueing |
2981 | =head3 Queueing |
2944 | |
2982 | |
2945 | C<ev_async> does not support queueing of data in any way. The reason |
2983 | C<ev_async> does not support queueing of data in any way. The reason |
2946 | is that the author does not know of a simple (or any) algorithm for a |
2984 | is that the author does not know of a simple (or any) algorithm for a |
2947 | multiple-writer-single-reader queue that works in all cases and doesn't |
2985 | multiple-writer-single-reader queue that works in all cases and doesn't |
2948 | need elaborate support such as pthreads. |
2986 | need elaborate support such as pthreads or unportable memory access |
|
|
2987 | semantics. |
2949 | |
2988 | |
2950 | That means that if you want to queue data, you have to provide your own |
2989 | That means that if you want to queue data, you have to provide your own |
2951 | queue. But at least I can tell you how to implement locking around your |
2990 | queue. But at least I can tell you how to implement locking around your |
2952 | queue: |
2991 | queue: |
2953 | |
2992 | |
… | |
… | |
3111 | /* doh, nothing entered */; |
3150 | /* doh, nothing entered */; |
3112 | } |
3151 | } |
3113 | |
3152 | |
3114 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3153 | ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0); |
3115 | |
3154 | |
3116 | =item ev_feed_event (struct ev_loop *, watcher *, int revents) |
|
|
3117 | |
|
|
3118 | Feeds the given event set into the event loop, as if the specified event |
|
|
3119 | had happened for the specified watcher (which must be a pointer to an |
|
|
3120 | initialised but not necessarily started event watcher). |
|
|
3121 | |
|
|
3122 | =item ev_feed_fd_event (struct ev_loop *, int fd, int revents) |
3155 | =item ev_feed_fd_event (loop, int fd, int revents) |
3123 | |
3156 | |
3124 | Feed an event on the given fd, as if a file descriptor backend detected |
3157 | Feed an event on the given fd, as if a file descriptor backend detected |
3125 | the given events it. |
3158 | the given events it. |
3126 | |
3159 | |
3127 | =item ev_feed_signal_event (struct ev_loop *loop, int signum) |
3160 | =item ev_feed_signal_event (loop, int signum) |
3128 | |
3161 | |
3129 | Feed an event as if the given signal occurred (C<loop> must be the default |
3162 | Feed an event as if the given signal occurred (C<loop> must be the default |
3130 | loop!). |
3163 | loop!). |
3131 | |
3164 | |
3132 | =back |
3165 | =back |
… | |
… | |
3212 | |
3245 | |
3213 | =over 4 |
3246 | =over 4 |
3214 | |
3247 | |
3215 | =item ev::TYPE::TYPE () |
3248 | =item ev::TYPE::TYPE () |
3216 | |
3249 | |
3217 | =item ev::TYPE::TYPE (struct ev_loop *) |
3250 | =item ev::TYPE::TYPE (loop) |
3218 | |
3251 | |
3219 | =item ev::TYPE::~TYPE |
3252 | =item ev::TYPE::~TYPE |
3220 | |
3253 | |
3221 | The constructor (optionally) takes an event loop to associate the watcher |
3254 | The constructor (optionally) takes an event loop to associate the watcher |
3222 | with. If it is omitted, it will use C<EV_DEFAULT>. |
3255 | with. If it is omitted, it will use C<EV_DEFAULT>. |
… | |
… | |
3299 | Example: Use a plain function as callback. |
3332 | Example: Use a plain function as callback. |
3300 | |
3333 | |
3301 | static void io_cb (ev::io &w, int revents) { } |
3334 | static void io_cb (ev::io &w, int revents) { } |
3302 | iow.set <io_cb> (); |
3335 | iow.set <io_cb> (); |
3303 | |
3336 | |
3304 | =item w->set (struct ev_loop *) |
3337 | =item w->set (loop) |
3305 | |
3338 | |
3306 | Associates a different C<struct ev_loop> with this watcher. You can only |
3339 | Associates a different C<struct ev_loop> with this watcher. You can only |
3307 | do this when the watcher is inactive (and not pending either). |
3340 | do this when the watcher is inactive (and not pending either). |
3308 | |
3341 | |
3309 | =item w->set ([arguments]) |
3342 | =item w->set ([arguments]) |
… | |
… | |
3406 | =item Ocaml |
3439 | =item Ocaml |
3407 | |
3440 | |
3408 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
3441 | Erkki Seppala has written Ocaml bindings for libev, to be found at |
3409 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
3442 | L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. |
3410 | |
3443 | |
|
|
3444 | =item Lua |
|
|
3445 | |
|
|
3446 | Brian Maher has written a partial interface to libev |
|
|
3447 | for lua (only C<ev_io> and C<ev_timer>), to be found at |
|
|
3448 | L<http://github.com/brimworks/lua-ev>. |
|
|
3449 | |
3411 | =back |
3450 | =back |
3412 | |
3451 | |
3413 | |
3452 | |
3414 | =head1 MACRO MAGIC |
3453 | =head1 MACRO MAGIC |
3415 | |
3454 | |
… | |
… | |
3581 | keeps libev from including F<config.h>, and it also defines dummy |
3620 | keeps libev from including F<config.h>, and it also defines dummy |
3582 | implementations for some libevent functions (such as logging, which is not |
3621 | implementations for some libevent functions (such as logging, which is not |
3583 | supported). It will also not define any of the structs usually found in |
3622 | supported). It will also not define any of the structs usually found in |
3584 | F<event.h> that are not directly supported by the libev core alone. |
3623 | F<event.h> that are not directly supported by the libev core alone. |
3585 | |
3624 | |
3586 | In stanbdalone mode, libev will still try to automatically deduce the |
3625 | In standalone mode, libev will still try to automatically deduce the |
3587 | configuration, but has to be more conservative. |
3626 | configuration, but has to be more conservative. |
3588 | |
3627 | |
3589 | =item EV_USE_MONOTONIC |
3628 | =item EV_USE_MONOTONIC |
3590 | |
3629 | |
3591 | If defined to be C<1>, libev will try to detect the availability of the |
3630 | If defined to be C<1>, libev will try to detect the availability of the |
… | |
… | |
3656 | be used is the winsock select). This means that it will call |
3695 | be used is the winsock select). This means that it will call |
3657 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
3696 | C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, |
3658 | it is assumed that all these functions actually work on fds, even |
3697 | it is assumed that all these functions actually work on fds, even |
3659 | on win32. Should not be defined on non-win32 platforms. |
3698 | on win32. Should not be defined on non-win32 platforms. |
3660 | |
3699 | |
3661 | =item EV_FD_TO_WIN32_HANDLE |
3700 | =item EV_FD_TO_WIN32_HANDLE(fd) |
3662 | |
3701 | |
3663 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
3702 | If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map |
3664 | file descriptors to socket handles. When not defining this symbol (the |
3703 | file descriptors to socket handles. When not defining this symbol (the |
3665 | default), then libev will call C<_get_osfhandle>, which is usually |
3704 | default), then libev will call C<_get_osfhandle>, which is usually |
3666 | correct. In some cases, programs use their own file descriptor management, |
3705 | correct. In some cases, programs use their own file descriptor management, |
3667 | in which case they can provide this function to map fds to socket handles. |
3706 | in which case they can provide this function to map fds to socket handles. |
|
|
3707 | |
|
|
3708 | =item EV_WIN32_HANDLE_TO_FD(handle) |
|
|
3709 | |
|
|
3710 | If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors |
|
|
3711 | using the standard C<_open_osfhandle> function. For programs implementing |
|
|
3712 | their own fd to handle mapping, overwriting this function makes it easier |
|
|
3713 | to do so. This can be done by defining this macro to an appropriate value. |
|
|
3714 | |
|
|
3715 | =item EV_WIN32_CLOSE_FD(fd) |
|
|
3716 | |
|
|
3717 | If programs implement their own fd to handle mapping on win32, then this |
|
|
3718 | macro can be used to override the C<close> function, useful to unregister |
|
|
3719 | file descriptors again. Note that the replacement function has to close |
|
|
3720 | the underlying OS handle. |
3668 | |
3721 | |
3669 | =item EV_USE_POLL |
3722 | =item EV_USE_POLL |
3670 | |
3723 | |
3671 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
3724 | If defined to be C<1>, libev will compile in support for the C<poll>(2) |
3672 | backend. Otherwise it will be enabled on non-win32 platforms. It |
3725 | backend. Otherwise it will be enabled on non-win32 platforms. It |