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

Comparing libev/ev.pod (file contents):
Revision 1.216 by root, Thu Nov 13 15:55:38 2008 UTC vs.
Revision 1.219 by root, Thu Nov 20 00:43:58 2008 UTC

… …
8 8
9=head2 EXAMPLE PROGRAM 9=head2 EXAMPLE PROGRAM
10 10
11 // a single header file is required 11 // a single header file is required
12 #include <ev.h> 12 #include <ev.h>
13
14 #include <stdio.h> // for puts
13 15
14 // every watcher type has its own typedef'd struct 16 // every watcher type has its own typedef'd struct
15 // with the name ev_TYPE 17 // with the name ev_TYPE
16 ev_io stdin_watcher; 18 ev_io stdin_watcher;
17 ev_timer timeout_watcher; 19 ev_timer timeout_watcher;
… …
2997Tony Arcieri has written a ruby extension that offers access to a subset 2999Tony Arcieri has written a ruby extension that offers access to a subset
2998of the libev API and adds file handle abstractions, asynchronous DNS and 3000of the libev API and adds file handle abstractions, asynchronous DNS and
2999more on top of it. It can be found via gem servers. Its homepage is at 3001more on top of it. It can be found via gem servers. Its homepage is at
3000L<http://rev.rubyforge.org/>. 3002L<http://rev.rubyforge.org/>.
3001 3003
3004Roger Pack reports that using the link order C<-lws2_32 -lmsvcrt-ruby-190>
3005makes rev work even on mingw.
3006
3002=item D 3007=item D
3003 3008
3004Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 3009Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
3005be found at L<http://proj.llucax.com.ar/wiki/evd>. 3010be found at L<http://proj.llucax.com.ar/wiki/evd>.
3006 3011
… …
3182keeps libev from including F<config.h>, and it also defines dummy 3187keeps libev from including F<config.h>, and it also defines dummy
3183implementations for some libevent functions (such as logging, which is not 3188implementations for some libevent functions (such as logging, which is not
3184supported). It will also not define any of the structs usually found in 3189supported). It will also not define any of the structs usually found in
3185F<event.h> that are not directly supported by the libev core alone. 3190F<event.h> that are not directly supported by the libev core alone.
3186 3191
3192In stanbdalone mode, libev will still try to automatically deduce the
3193configuration, but has to be more conservative.
3194
3187=item EV_USE_MONOTONIC 3195=item EV_USE_MONOTONIC
3188 3196
3189If defined to be C<1>, libev will try to detect the availability of the 3197If defined to be C<1>, libev will try to detect the availability of the
3190monotonic clock option at both compile time and runtime. Otherwise no use 3198monotonic clock option at both compile time and runtime. Otherwise no
3191of the monotonic clock option will be attempted. If you enable this, you 3199use of the monotonic clock option will be attempted. If you enable this,
3192usually have to link against librt or something similar. Enabling it when 3200you usually have to link against librt or something similar. Enabling it
3193the functionality isn't available is safe, though, although you have 3201when the functionality isn't available is safe, though, although you have
3194to make sure you link against any libraries where the C<clock_gettime> 3202to make sure you link against any libraries where the C<clock_gettime>
3195function is hiding in (often F<-lrt>). 3203function is hiding in (often F<-lrt>). See also C<EV_USE_CLOCK_SYSCALL>.
3196 3204
3197=item EV_USE_REALTIME 3205=item EV_USE_REALTIME
3198 3206
3199If defined to be C<1>, libev will try to detect the availability of the 3207If defined to be C<1>, libev will try to detect the availability of the
3200real-time clock option at compile time (and assume its availability at 3208real-time clock option at compile time (and assume its availability at
3201runtime if successful). Otherwise no use of the real-time clock option will 3209runtime if successful). Otherwise no use of the real-time clock option will
3202be attempted. This effectively replaces C<gettimeofday> by C<clock_get 3210be attempted. This effectively replaces C<gettimeofday> by C<clock_get
3203(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the 3211(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
3204note about libraries in the description of C<EV_USE_MONOTONIC>, though. 3212note about libraries in the description of C<EV_USE_MONOTONIC>, though.
3205 3213
3214=item EV_USE_CLOCK_SYSCALL
3215
3216If defined to be C<1>, libev will try to use a direct syscall instead
3217of calling the system-provided C<clock_gettime> function. This option
3218exists because on GNU/Linux, C<clock_gettime> is in C<librt>, but C<librt>
3219unconditionally pulls in C<libpthread>, slowing down single-threaded
3220programs needlessly. Using a direct syscall is slightly slower (in
3221theory), because no optimised vdso implementation can be used, but avoids
3222the pthread dependency. Defaults to C<1> on GNU/Linux with glibc 2.x or
3223higher, as it simplifies linking (no need for C<-lrt>).
3224
3206=item EV_USE_NANOSLEEP 3225=item EV_USE_NANOSLEEP
3207 3226
3208If defined to be C<1>, libev will assume that C<nanosleep ()> is available 3227If defined to be C<1>, libev will assume that C<nanosleep ()> is available
3209and will use it for delays. Otherwise it will use C<select ()>. 3228and will use it for delays. Otherwise it will use C<select ()>.
3210 3229
… …
3225 3244
3226=item EV_SELECT_USE_FD_SET 3245=item EV_SELECT_USE_FD_SET
3227 3246
3228If defined to C<1>, then the select backend will use the system C<fd_set> 3247If defined to C<1>, then the select backend will use the system C<fd_set>
3229structure. This is useful if libev doesn't compile due to a missing 3248structure. This is useful if libev doesn't compile due to a missing
3230C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout on 3249C<NFDBITS> or C<fd_mask> definition or it mis-guesses the bitset layout
3231exotic systems. This usually limits the range of file descriptors to some 3250on exotic systems. This usually limits the range of file descriptors to
3232low limit such as 1024 or might have other limitations (winsocket only 3251some low limit such as 1024 or might have other limitations (winsocket
3233allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation, might 3252only allows 64 sockets). The C<FD_SETSIZE> macro, set before compilation,
3234influence the size of the C<fd_set> used. 3253configures the maximum size of the C<fd_set>.
3235 3254
3236=item EV_SELECT_IS_WINSOCKET 3255=item EV_SELECT_IS_WINSOCKET
3237 3256
3238When defined to C<1>, the select backend will assume that 3257When defined to C<1>, the select backend will assume that
3239select/socket/connect etc. don't understand file descriptors but 3258select/socket/connect etc. don't understand file descriptors but

Diff Legend

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