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

Comparing libev/ev.pod (file contents):
Revision 1.135 by root, Sat Mar 8 10:38:40 2008 UTC vs.
Revision 1.139 by root, Wed Apr 2 05:51:40 2008 UTC

275flags. If that is troubling you, check C<ev_backend ()> afterwards). 275flags. If that is troubling you, check C<ev_backend ()> afterwards).
276 276
277If you don't know what event loop to use, use the one returned from this 277If you don't know what event loop to use, use the one returned from this
278function. 278function.
279 279
280Note that this function is I<not> thread-safe, so if you want to use it
281from multiple threads, you have to lock (note also that this is unlikely,
282as loops cannot bes hared easily between threads anyway).
283
280The default loop is the only loop that can handle C<ev_signal> and 284The default loop is the only loop that can handle C<ev_signal> and
281C<ev_child> watchers, and to do this, it always registers a handler 285C<ev_child> watchers, and to do this, it always registers a handler
282for C<SIGCHLD>. If this is a problem for your app you can either 286for C<SIGCHLD>. If this is a problem for your app you can either
283create a dynamic loop with C<ev_loop_new> that doesn't do that, or you 287create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
284can simply overwrite the C<SIGCHLD> signal handler I<after> calling 288can simply overwrite the C<SIGCHLD> signal handler I<after> calling
465 469
466Similar to C<ev_default_loop>, but always creates a new event loop that is 470Similar to C<ev_default_loop>, but always creates a new event loop that is
467always distinct from the default loop. Unlike the default loop, it cannot 471always distinct from the default loop. Unlike the default loop, it cannot
468handle signal and child watchers, and attempts to do so will be greeted by 472handle signal and child watchers, and attempts to do so will be greeted by
469undefined behaviour (or a failed assertion if assertions are enabled). 473undefined behaviour (or a failed assertion if assertions are enabled).
474
475Note that this function I<is> thread-safe, and the recommended way to use
476libev with threads is indeed to create one loop per thread, and using the
477default loop in the "main" or "initial" thread.
470 478
471Example: Try to create a event loop that uses epoll and nothing else. 479Example: Try to create a event loop that uses epoll and nothing else.
472 480
473 struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 481 struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
474 if (!epoller) 482 if (!epoller)
1085To support fork in your programs, you either have to call 1093To support fork in your programs, you either have to call
1086C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child, 1094C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
1087enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or 1095enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1088C<EVBACKEND_POLL>. 1096C<EVBACKEND_POLL>.
1089 1097
1098=head3 The special problem of SIGPIPE
1099
1100While not really specific to libev, it is easy to forget about SIGPIPE:
1101when reading from a pipe whose other end has been closed, your program
1102gets send a SIGPIPE, which, by default, aborts your program. For most
1103programs this is sensible behaviour, for daemons, this is usually
1104undesirable.
1105
1106So when you encounter spurious, unexplained daemon exits, make sure you
1107ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1108somewhere, as that would have given you a big clue).
1109
1090 1110
1091=head3 Watcher-Specific Functions 1111=head3 Watcher-Specific Functions
1092 1112
1093=over 4 1113=over 4
1094 1114
1599reader). Inotify will be used to give hints only and should not change the 1619reader). Inotify will be used to give hints only and should not change the
1600semantics of C<ev_stat> watchers, which means that libev sometimes needs 1620semantics of C<ev_stat> watchers, which means that libev sometimes needs
1601to fall back to regular polling again even with inotify, but changes are 1621to fall back to regular polling again even with inotify, but changes are
1602usually detected immediately, and if the file exists there will be no 1622usually detected immediately, and if the file exists there will be no
1603polling. 1623polling.
1624
1625=head3 ABI Issues (Largefile Support)
1626
1627Libev by default (unless the user overrides this) uses the default
1628compilation environment, which means that on systems with optionally
1629disabled large file support, you get the 32 bit version of the stat
1630structure. When using the library from programs that change the ABI to
1631use 64 bit file offsets the programs will fail. In that case you have to
1632compile libev with the same flags to get binary compatibility. This is
1633obviously the case with any flags that change the ABI, but the problem is
1634most noticably with ev_stat and largefile support.
1604 1635
1605=head3 Inotify 1636=head3 Inotify
1606 1637
1607When C<inotify (7)> support has been compiled into libev (generally only 1638When C<inotify (7)> support has been compiled into libev (generally only
1608available on Linux) and present at runtime, it will be used to speed up 1639available on Linux) and present at runtime, it will be used to speed up
2509 io.start (fd, ev::READ); 2540 io.start (fd, ev::READ);
2510 } 2541 }
2511 }; 2542 };
2512 2543
2513 2544
2545=head1 OTHER LANGUAGE BINDINGS
2546
2547Libev does not offer other language bindings itself, but bindings for a
2548numbe rof languages exist in the form of third-party packages. If you know
2549any interesting language binding in addition to the ones listed here, drop
2550me a note.
2551
2552=over 4
2553
2554=item Perl
2555
2556The EV module implements the full libev API and is actually used to test
2557libev. EV is developed together with libev. Apart from the EV core module,
2558there are additional modules that implement libev-compatible interfaces
2559to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the
2560C<libglib> event core (C<Glib::EV> and C<EV::Glib>).
2561
2562It can be found and installed via CPAN, its homepage is found at
2563L<http://software.schmorp.de/pkg/EV>.
2564
2565=item Ruby
2566
2567Tony Arcieri has written a ruby extension that offers access to a subset
2568of the libev API and adds filehandle abstractions, asynchronous DNS and
2569more on top of it. It can be found via gem servers. Its homepage is at
2570L<http://rev.rubyforge.org/>.
2571
2572=item D
2573
2574Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2575be found at L<http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>.
2576
2577=back
2578
2579
2514=head1 MACRO MAGIC 2580=head1 MACRO MAGIC
2515 2581
2516Libev can be compiled with a variety of options, the most fundamantal 2582Libev can be compiled with a variety of options, the most fundamantal
2517of which is C<EV_MULTIPLICITY>. This option determines whether (most) 2583of which is C<EV_MULTIPLICITY>. This option determines whether (most)
2518functions and callbacks have an initial C<struct ev_loop *> argument. 2584functions and callbacks have an initial C<struct ev_loop *> argument.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines