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

Comparing libev/ev.pod (file contents):
Revision 1.85 by root, Mon Dec 17 07:24:12 2007 UTC vs.
Revision 1.89 by root, Wed Dec 19 01:59:29 2007 UTC

98Libev represents time as a single floating point number, representing the 98Libev represents time as a single floating point number, representing the
99(fractional) number of seconds since the (POSIX) epoch (somewhere near 99(fractional) number of seconds since the (POSIX) epoch (somewhere near
100the beginning of 1970, details are complicated, don't ask). This type is 100the beginning of 1970, details are complicated, don't ask). This type is
101called C<ev_tstamp>, which is what you should use too. It usually aliases 101called C<ev_tstamp>, which is what you should use too. It usually aliases
102to the C<double> type in C, and when you need to do any calculations on 102to the C<double> type in C, and when you need to do any calculations on
103it, you should treat it as such. 103it, you should treat it as some floatingpoint value. Unlike the name
104component C<stamp> might indicate, it is also used for time differences
105throughout libev.
104 106
105=head1 GLOBAL FUNCTIONS 107=head1 GLOBAL FUNCTIONS
106 108
107These functions can be called anytime, even before initialising the 109These functions can be called anytime, even before initialising the
108library in any way. 110library in any way.
402Destroys the default loop again (frees all memory and kernel state 404Destroys the default loop again (frees all memory and kernel state
403etc.). 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
404sense, 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
405responsibility to either stop all watchers cleanly yoursef I<before> 407responsibility to either stop all watchers cleanly yoursef I<before>
406calling this function, or cope with the fact afterwards (which is usually 408calling this function, or cope with the fact afterwards (which is usually
407the 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
408for 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>).
409 420
410=item ev_loop_destroy (loop) 421=item ev_loop_destroy (loop)
411 422
412Like 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
413earlier call to C<ev_loop_new>. 424earlier call to C<ev_loop_new>.
2434definition 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
2435their default definitions. One possible use for overriding these is to 2446their default definitions. One possible use for overriding these is to
2436avoid 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
2437method calls instead of plain function calls in C++. 2448method calls instead of plain function calls in C++.
2438 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
2439=head2 EXAMPLES 2475=head2 EXAMPLES
2440 2476
2441For a real-world example of a program the includes libev 2477For a real-world example of a program the includes libev
2442verbatim, you can have a look at the EV perl module 2478verbatim, you can have a look at the EV perl module
2443(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