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

Comparing libev/ev.pod (file contents):
Revision 1.86 by root, Tue Dec 18 01:20:33 2007 UTC vs.
Revision 1.91 by root, Thu Dec 20 07:12:57 2007 UTC

… …
331 331
332=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones) 332=item C<EVBACKEND_KQUEUE> (value 8, most BSD clones)
333 333
334Kqueue deserves special mention, as at the time of this writing, it 334Kqueue deserves special mention, as at the time of this writing, it
335was broken on all BSDs except NetBSD (usually it doesn't work with 335was broken on all BSDs except NetBSD (usually it doesn't work with
336anything but sockets and pipes, except on Darwin, where of course its 336anything but sockets and pipes, except on Darwin, where of course it's
337completely useless). For this reason its not being "autodetected" 337completely useless). For this reason it's not being "autodetected"
338unless you explicitly specify it explicitly in the flags (i.e. using 338unless you explicitly specify it explicitly in the flags (i.e. using
339C<EVBACKEND_KQUEUE>). 339C<EVBACKEND_KQUEUE>).
340 340
341It scales in the same way as the epoll backend, but the interface to the 341It scales in the same way as the epoll backend, but the interface to the
342kernel is more efficient (which says nothing about its actual speed, of 342kernel is more efficient (which says nothing about its actual speed, of
… …
404Destroys the default loop again (frees all memory and kernel state 404Destroys the default loop again (frees all memory and kernel state
405etc.). None of the active event watchers will be stopped in the normal 405etc.). None of the active event watchers will be stopped in the normal
406sense, so e.g. C<ev_is_active> might still return true. It is your 406sense, so e.g. C<ev_is_active> might still return true. It is your
407responsibility to either stop all watchers cleanly yoursef I<before> 407responsibility to either stop all watchers cleanly yoursef I<before>
408calling this function, or cope with the fact afterwards (which is usually 408calling this function, or cope with the fact afterwards (which is usually
409the easiest thing, youc na just ignore the watchers and/or C<free ()> them 409the easiest thing, you can just ignore the watchers and/or C<free ()> them
410for example). 410for example).
411
412Note that certain global state, such as signal state, will not be freed by
413this function, and related watchers (such as signal and child watchers)
414would need to be stopped manually.
415
416In general it is not advisable to call this function except in the
417rare occasion where you really need to free e.g. the signal handling
418pipe fds. If you need dynamically allocated loops it is better to use
419C<ev_loop_new> and C<ev_loop_destroy>).
411 420
412=item ev_loop_destroy (loop) 421=item ev_loop_destroy (loop)
413 422
414Like C<ev_default_destroy>, but destroys an event loop created by an 423Like C<ev_default_destroy>, but destroys an event loop created by an
415earlier call to C<ev_loop_new>. 424earlier call to C<ev_loop_new>.
… …
1782 1791
1783Make a single, non-blocking sweep over the embedded loop. This works 1792Make a single, non-blocking sweep over the embedded loop. This works
1784similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most 1793similarly to C<ev_loop (embedded_loop, EVLOOP_NONBLOCK)>, but in the most
1785apropriate way for embedded loops. 1794apropriate way for embedded loops.
1786 1795
1787=item struct ev_loop *loop [read-only] 1796=item struct ev_loop *other [read-only]
1788 1797
1789The embedded event loop. 1798The embedded event loop.
1790 1799
1791=back 1800=back
1792 1801
… …
2131Libev can (and often is) directly embedded into host 2140Libev can (and often is) directly embedded into host
2132applications. Examples of applications that embed it include the Deliantra 2141applications. Examples of applications that embed it include the Deliantra
2133Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe) 2142Game Server, the EV perl module, the GNU Virtual Private Ethernet (gvpe)
2134and rxvt-unicode. 2143and rxvt-unicode.
2135 2144
2136The goal is to enable you to just copy the neecssary files into your 2145The goal is to enable you to just copy the necessary files into your
2137source directory without having to change even a single line in them, so 2146source directory without having to change even a single line in them, so
2138you can easily upgrade by simply copying (or having a checked-out copy of 2147you can easily upgrade by simply copying (or having a checked-out copy of
2139libev somewhere in your source tree). 2148libev somewhere in your source tree).
2140 2149
2141=head2 FILESETS 2150=head2 FILESETS
… …
2241 2250
2242If defined to be C<1>, libev will try to detect the availability of the 2251If defined to be C<1>, libev will try to detect the availability of the
2243realtime clock option at compiletime (and assume its availability at 2252realtime clock option at compiletime (and assume its availability at
2244runtime if successful). Otherwise no use of the realtime clock option will 2253runtime if successful). Otherwise no use of the realtime clock option will
2245be attempted. This effectively replaces C<gettimeofday> by C<clock_get 2254be attempted. This effectively replaces C<gettimeofday> by C<clock_get
2246(CLOCK_REALTIME, ...)> and will not normally affect correctness. See tzhe note about libraries 2255(CLOCK_REALTIME, ...)> and will not normally affect correctness. See the
2247in the description of C<EV_USE_MONOTONIC>, though. 2256note about libraries in the description of C<EV_USE_MONOTONIC>, though.
2248 2257
2249=item EV_USE_SELECT 2258=item EV_USE_SELECT
2250 2259
2251If undefined or defined to be C<1>, libev will compile in support for the 2260If undefined or defined to be C<1>, libev will compile in support for the
2252C<select>(2) backend. No attempt at autodetection will be done: if no 2261C<select>(2) backend. No attempt at autodetection will be done: if no
… …
2436definition and a statement, respectively. See the F<ev.v> header file for 2445definition and a statement, respectively. See the F<ev.v> header file for
2437their default definitions. One possible use for overriding these is to 2446their default definitions. One possible use for overriding these is to
2438avoid the C<struct ev_loop *> as first argument in all cases, or to use 2447avoid the C<struct ev_loop *> as first argument in all cases, or to use
2439method calls instead of plain function calls in C++. 2448method calls instead of plain function calls in C++.
2440 2449
2450=head2 EXPORTED API SYMBOLS
2451
2452If you need to re-export the API (e.g. via a dll) and you need a list of
2453exported symbols, you can use the provided F<Symbol.*> files which list
2454all public symbols, one per line:
2455
2456 Symbols.ev for libev proper
2457 Symbols.event for the libevent emulation
2458
2459This can also be used to rename all public symbols to avoid clashes with
2460multiple versions of libev linked together (which is obviously bad in
2461itself, but sometimes it is inconvinient to avoid this).
2462
2463A sed comamnd like this will create wrapper C<#define>'s that you need to
2464include before including F<ev.h>:
2465
2466 <Symbols.ev sed -e "s/.*/#define & myprefix_&/" >wrap.h
2467
2468This would create a file F<wrap.h> which essentially looks like this:
2469
2470 #define ev_backend myprefix_ev_backend
2471 #define ev_check_start myprefix_ev_check_start
2472 #define ev_check_stop myprefix_ev_check_stop
2473 ...
2474
2441=head2 EXAMPLES 2475=head2 EXAMPLES
2442 2476
2443For a real-world example of a program the includes libev 2477For a real-world example of a program the includes libev
2444verbatim, you can have a look at the EV perl module 2478verbatim, you can have a look at the EV perl module
2445(L<http://software.schmorp.de/pkg/EV.html>). It has the libev files in 2479(L<http://software.schmorp.de/pkg/EV.html>). It has the libev files in

Diff Legend

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