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

Comparing libev/ev.pod (file contents):
Revision 1.261 by root, Mon Jul 20 04:18:20 2009 UTC vs.
Revision 1.265 by root, Wed Aug 26 17:11:42 2009 UTC

… …
2108 2108
2109When the first watcher gets started will libev actually register something 2109When the first watcher gets started will libev actually register something
2110with the kernel (thus it coexists with your own signal handlers as long as 2110with the kernel (thus it coexists with your own signal handlers as long as
2111you don't register any with libev for the same signal). 2111you don't register any with libev for the same signal).
2112 2112
2113Both the signal mask state (C<sigprocmask>) and the signal handler state
2114(C<sigaction>) are unspecified after starting a signal watcher (and after
2115sotpping it again), that is, libev might or might not block the signal,
2116and might or might not set or restore the installed signal handler.
2117
2118If possible and supported, libev will install its handlers with 2113If possible and supported, libev will install its handlers with
2119C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2114C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2120not be unduly interrupted. If you have a problem with system calls getting 2115not be unduly interrupted. If you have a problem with system calls getting
2121interrupted by signals you can block all signals in an C<ev_check> watcher 2116interrupted by signals you can block all signals in an C<ev_check> watcher
2122and unblock them in an C<ev_prepare> watcher. 2117and unblock them in an C<ev_prepare> watcher.
2118
2119=head3 The special problem of inheritance over execve
2120
2121Both the signal mask (C<sigprocmask>) and the signal disposition
2122(C<sigaction>) are unspecified after starting a signal watcher (and after
2123stopping it again), that is, libev might or might not block the signal,
2124and might or might not set or restore the installed signal handler.
2125
2126While this does not matter for the signal disposition (libev never
2127sets signals to C<SIG_IGN>, so handlers will be reset to C<SIG_DFL> on
2128C<execve>), this matters for the signal mask: many programs do not expect
2129many signals to be blocked.
2130
2131This means that before calling C<exec> (from the child) you should reset
2132the signal mask to whatever "default" you expect (all clear is a good
2133choice usually).
2123 2134
2124=head3 Watcher-Specific Functions and Data Members 2135=head3 Watcher-Specific Functions and Data Members
2125 2136
2126=over 4 2137=over 4
2127 2138
… …
3407=item Ocaml 3418=item Ocaml
3408 3419
3409Erkki Seppala has written Ocaml bindings for libev, to be found at 3420Erkki Seppala has written Ocaml bindings for libev, to be found at
3410L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 3421L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3411 3422
3423=item Lua
3424
3425Brian Maher has written a partial interface to libev
3426for lua (only C<ev_io> and C<ev_timer>), to be found at
3427L<http://github.com/brimworks/lua-ev>.
3428
3412=back 3429=back
3413 3430
3414 3431
3415=head1 MACRO MAGIC 3432=head1 MACRO MAGIC
3416 3433
… …
3582keeps libev from including F<config.h>, and it also defines dummy 3599keeps libev from including F<config.h>, and it also defines dummy
3583implementations for some libevent functions (such as logging, which is not 3600implementations for some libevent functions (such as logging, which is not
3584supported). It will also not define any of the structs usually found in 3601supported). It will also not define any of the structs usually found in
3585F<event.h> that are not directly supported by the libev core alone. 3602F<event.h> that are not directly supported by the libev core alone.
3586 3603
3587In stanbdalone mode, libev will still try to automatically deduce the 3604In standalone mode, libev will still try to automatically deduce the
3588configuration, but has to be more conservative. 3605configuration, but has to be more conservative.
3589 3606
3590=item EV_USE_MONOTONIC 3607=item EV_USE_MONOTONIC
3591 3608
3592If defined to be C<1>, libev will try to detect the availability of the 3609If defined to be C<1>, libev will try to detect the availability of the
… …
3657be used is the winsock select). This means that it will call 3674be used is the winsock select). This means that it will call
3658C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise, 3675C<_get_osfhandle> on the fd to convert it to an OS handle. Otherwise,
3659it is assumed that all these functions actually work on fds, even 3676it is assumed that all these functions actually work on fds, even
3660on win32. Should not be defined on non-win32 platforms. 3677on win32. Should not be defined on non-win32 platforms.
3661 3678
3662=item EV_FD_TO_WIN32_HANDLE 3679=item EV_FD_TO_WIN32_HANDLE(fd)
3663 3680
3664If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map 3681If C<EV_SELECT_IS_WINSOCKET> is enabled, then libev needs a way to map
3665file descriptors to socket handles. When not defining this symbol (the 3682file descriptors to socket handles. When not defining this symbol (the
3666default), then libev will call C<_get_osfhandle>, which is usually 3683default), then libev will call C<_get_osfhandle>, which is usually
3667correct. In some cases, programs use their own file descriptor management, 3684correct. In some cases, programs use their own file descriptor management,
3668in which case they can provide this function to map fds to socket handles. 3685in which case they can provide this function to map fds to socket handles.
3686
3687=item EV_WIN32_HANDLE_TO_FD(handle)
3688
3689If C<EV_SELECT_IS_WINSOCKET> then libev maps handles to file descriptors
3690using the standard C<_open_osfhandle> function. For programs implementing
3691their own fd to handle mapping, overwriting this function makes it easier
3692to do so. This can be done by defining this macro to an appropriate value.
3693
3694=item EV_WIN32_CLOSE_FD(fd)
3695
3696If programs implement their own fd to handle mapping on win32, then this
3697macro can be used to override the C<close> function, useful to unregister
3698file descriptors again. Note that the replacement function has to close
3699the underlying OS handle.
3669 3700
3670=item EV_USE_POLL 3701=item EV_USE_POLL
3671 3702
3672If defined to be C<1>, libev will compile in support for the C<poll>(2) 3703If defined to be C<1>, libev will compile in support for the C<poll>(2)
3673backend. Otherwise it will be enabled on non-win32 platforms. It 3704backend. Otherwise it will be enabled on non-win32 platforms. It

Diff Legend

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