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

Comparing libev/ev.pod (file contents):
Revision 1.278 by root, Thu Dec 31 06:59:47 2009 UTC vs.
Revision 1.281 by root, Tue Mar 9 08:46:17 2010 UTC

… …
1867Returns the remaining time until a timer fires. If the timer is active, 1867Returns the remaining time until a timer fires. If the timer is active,
1868then this time is relative to the current event loop time, otherwise it's 1868then this time is relative to the current event loop time, otherwise it's
1869the timeout value currently configured. 1869the timeout value currently configured.
1870 1870
1871That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns 1871That is, after an C<ev_timer_set (w, 5, 7)>, C<ev_timer_remaining> returns
1872C<5>. When the timer is started and one second passes, C<ev_timer_remain> 1872C<5>. When the timer is started and one second passes, C<ev_timer_remaining>
1873will return C<4>. When the timer expires and is restarted, it will return 1873will return C<4>. When the timer expires and is restarted, it will return
1874roughly C<7> (likely slightly less as callback invocation takes some time, 1874roughly C<7> (likely slightly less as callback invocation takes some time,
1875too), and so on. 1875too), and so on.
1876 1876
1877=item ev_tstamp repeat [read-write] 1877=item ev_tstamp repeat [read-write]
… …
3451Erkki Seppala has written Ocaml bindings for libev, to be found at 3451Erkki Seppala has written Ocaml bindings for libev, to be found at
3452L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>. 3452L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
3453 3453
3454=item Lua 3454=item Lua
3455 3455
3456Brian Maher has written a partial interface to libev 3456Brian Maher has written a partial interface to libev for lua (at the
3457for lua (only C<ev_io> and C<ev_timer>), to be found at 3457time of this writing, only C<ev_io> and C<ev_timer>), to be found at
3458L<http://github.com/brimworks/lua-ev>. 3458L<http://github.com/brimworks/lua-ev>.
3459 3459
3460=back 3460=back
3461 3461
3462 3462
… …
3617 libev.m4 3617 libev.m4
3618 3618
3619=head2 PREPROCESSOR SYMBOLS/MACROS 3619=head2 PREPROCESSOR SYMBOLS/MACROS
3620 3620
3621Libev can be configured via a variety of preprocessor symbols you have to 3621Libev can be configured via a variety of preprocessor symbols you have to
3622define before including any of its files. The default in the absence of 3622define before including (or compiling) any of its files. The default in
3623autoconf is documented for every option. 3623the absence of autoconf is documented for every option.
3624
3625Symbols marked with "(h)" do not change the ABI, and can have different
3626values when compiling libev vs. including F<ev.h>, so it is permissible
3627to redefine them before including F<ev.h> without breakign compatibility
3628to a compiled library. All other symbols change the ABI, which means all
3629users of libev and the libev code itself must be compiled with compatible
3630settings.
3624 3631
3625=over 4 3632=over 4
3626 3633
3627=item EV_STANDALONE 3634=item EV_STANDALONE (h)
3628 3635
3629Must always be C<1> if you do not use autoconf configuration, which 3636Must always be C<1> if you do not use autoconf configuration, which
3630keeps libev from including F<config.h>, and it also defines dummy 3637keeps libev from including F<config.h>, and it also defines dummy
3631implementations for some libevent functions (such as logging, which is not 3638implementations for some libevent functions (such as logging, which is not
3632supported). It will also not define any of the structs usually found in 3639supported). It will also not define any of the structs usually found in
… …
3782as well as for signal and thread safety in C<ev_async> watchers. 3789as well as for signal and thread safety in C<ev_async> watchers.
3783 3790
3784In the absence of this define, libev will use C<sig_atomic_t volatile> 3791In the absence of this define, libev will use C<sig_atomic_t volatile>
3785(from F<signal.h>), which is usually good enough on most platforms. 3792(from F<signal.h>), which is usually good enough on most platforms.
3786 3793
3787=item EV_H 3794=item EV_H (h)
3788 3795
3789The name of the F<ev.h> header file used to include it. The default if 3796The name of the F<ev.h> header file used to include it. The default if
3790undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be 3797undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
3791used to virtually rename the F<ev.h> header file in case of conflicts. 3798used to virtually rename the F<ev.h> header file in case of conflicts.
3792 3799
3793=item EV_CONFIG_H 3800=item EV_CONFIG_H (h)
3794 3801
3795If C<EV_STANDALONE> isn't C<1>, this variable can be used to override 3802If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
3796F<ev.c>'s idea of where to find the F<config.h> file, similarly to 3803F<ev.c>'s idea of where to find the F<config.h> file, similarly to
3797C<EV_H>, above. 3804C<EV_H>, above.
3798 3805
3799=item EV_EVENT_H 3806=item EV_EVENT_H (h)
3800 3807
3801Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea 3808Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
3802of how the F<event.h> header can be found, the default is C<"event.h">. 3809of how the F<event.h> header can be found, the default is C<"event.h">.
3803 3810
3804=item EV_PROTOTYPES 3811=item EV_PROTOTYPES (h)
3805 3812
3806If defined to be C<0>, then F<ev.h> will not define any function 3813If defined to be C<0>, then F<ev.h> will not define any function
3807prototypes, but still define all the structs and other symbols. This is 3814prototypes, but still define all the structs and other symbols. This is
3808occasionally useful if you want to provide your own wrapper functions 3815occasionally useful if you want to provide your own wrapper functions
3809around libev functions. 3816around libev functions.
… …
3880 3887
3881Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to 3888Defining C<EV_MINIMAL> to C<2> will additionally reduce the core API to
3882provide a bare-bones event library. See C<ev.h> for details on what parts 3889provide a bare-bones event library. See C<ev.h> for details on what parts
3883of the API are still available, and do not complain if this subset changes 3890of the API are still available, and do not complain if this subset changes
3884over time. 3891over time.
3892
3893=item EV_AVOID_STDIO
3894
3895If this is set to C<1> at compiletime, then libev will avoid using stdio
3896functions (printf, scanf, perror etc.). This will increase the codesize
3897somewhat, but if your program doesn't otherwise depend on stdio and your
3898libc allows it, this avoids linking in the stdio library which is quite
3899big.
3900
3901Note that error messages might become less precise when this option is
3902enabled.
3885 3903
3886=item EV_NSIG 3904=item EV_NSIG
3887 3905
3888The highest supported signal number, +1 (or, the number of 3906The highest supported signal number, +1 (or, the number of
3889signals): Normally, libev tries to deduce the maximum number of signals 3907signals): Normally, libev tries to deduce the maximum number of signals

Diff Legend

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