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

Comparing libev/ev.pod (file contents):
Revision 1.260 by root, Sun Jul 19 21:18:03 2009 UTC vs.
Revision 1.264 by root, Wed Aug 19 23:44:51 2009 UTC

… …
98=head2 FEATURES 98=head2 FEATURES
99 99
100Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the 100Libev supports C<select>, C<poll>, the Linux-specific C<epoll>, the
101BSD-specific C<kqueue> and the Solaris-specific event port mechanisms 101BSD-specific C<kqueue> and the Solaris-specific event port mechanisms
102for file descriptor events (C<ev_io>), the Linux C<inotify> interface 102for 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
104with customised rescheduling (C<ev_periodic>), synchronous signals 104inter-thread wakeup (C<ev_async>)/signal handling (C<ev_signal>)) relative
105(C<ev_signal>), process status change events (C<ev_child>), and event 105timers (C<ev_timer>), absolute timers with customised rescheduling
106watchers dealing with the event loop mechanism itself (C<ev_idle>, 106(C<ev_periodic>), synchronous signals (C<ev_signal>), process status
107C<ev_embed>, C<ev_prepare> and C<ev_check> watchers) as well as 107change events (C<ev_child>), and event watchers dealing with the event
108file watchers (C<ev_stat>) and even limited support for fork events 108loop mechanism itself (C<ev_idle>, C<ev_embed>, C<ev_prepare> and
109(C<ev_fork>). 109C<ev_check> watchers) as well as file watchers (C<ev_stat>) and even
110limited support for fork events (C<ev_fork>).
110 111
111It also is quite fast (see this 112It also is quite fast (see this
112L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent 113L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
113for example). 114for example).
114 115
… …
3406=item Ocaml 3407=item Ocaml
3407 3408
3408Erkki Seppala has written Ocaml bindings for libev, to be found at 3409Erkki Seppala has written Ocaml bindings for libev, to be found at
3409L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 3410L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3410 3411
3412=item Lua
3413
3414Brian Maher has written a partial interface to libev
3415for lua (only C<ev_io> and C<ev_timer>), to be found at
3416L<http://github.com/brimworks/lua-ev>.
3417
3411=back 3418=back
3412 3419
3413 3420
3414=head1 MACRO MAGIC 3421=head1 MACRO MAGIC
3415 3422
… …
3581keeps libev from including F<config.h>, and it also defines dummy 3588keeps libev from including F<config.h>, and it also defines dummy
3582implementations for some libevent functions (such as logging, which is not 3589implementations for some libevent functions (such as logging, which is not
3583supported). It will also not define any of the structs usually found in 3590supported). It will also not define any of the structs usually found in
3584F<event.h> that are not directly supported by the libev core alone. 3591F<event.h> that are not directly supported by the libev core alone.
3585 3592
3586In stanbdalone mode, libev will still try to automatically deduce the 3593In standalone mode, libev will still try to automatically deduce the
3587configuration, but has to be more conservative. 3594configuration, but has to be more conservative.
3588 3595
3589=item EV_USE_MONOTONIC 3596=item EV_USE_MONOTONIC
3590 3597
3591If defined to be C<1>, libev will try to detect the availability of the 3598If defined to be C<1>, libev will try to detect the availability of the
… …
3656be used is the winsock select). This means that it will call 3663be used is the winsock select). This means that it will call
3657C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, 3664C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
3658it is assumed that all these functions actually work on fds, even 3665it is assumed that all these functions actually work on fds, even
3659on win32. Should not be defined on non-win32 platforms. 3666on win32. Should not be defined on non-win32 platforms.
3660 3667
3661=item EV_FD_TO_WIN32_HANDLE 3668=item EV_FD_TO_WIN32_HANDLE(fd)
3662 3669
3663If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map 3670If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
3664file descriptors to socket handles. When not defining this symbol (the 3671file descriptors to socket handles. When not defining this symbol (the
3665default), then libev will call C<_get_osfhandle>, which is usually 3672default), then libev will call C<_get_osfhandle>, which is usually
3666correct. In some cases, programs use their own file descriptor management, 3673correct. In some cases, programs use their own file descriptor management,
3667in which case they can provide this function to map fds to socket handles. 3674in which case they can provide this function to map fds to socket handles.
3675
3676=item EV_WIN32_HANDLE_TO_FD(handle)
3677
3678If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
3679using the standard C<_open_osfhandle> function. For programs implementing
3680their own fd to handle mapping, overwriting this function makes it easier
3681to do so. This can be done by defining this macro to an appropriate value.
3682
3683=item EV_WIN32_CLOSE_FD(fd)
3684
3685If programs implement their own fd to handle mapping on win32, then this
3686macro can be used to override the C<close> function, useful to unregister
3687file descriptors again. Note that the replacement function has to close
3688the underlying OS handle.
3668 3689
3669=item EV_USE_POLL 3690=item EV_USE_POLL
3670 3691
3671If defined to be C<1>, libev will compile in support for the C<poll>(2) 3692If defined to be C<1>, libev will compile in support for the C<poll>(2)
3672backend. Otherwise it will be enabled on non-win32 platforms. It 3693backend. Otherwise it will be enabled on non-win32 platforms. It

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines