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

Comparing libev/ev.pod (file contents):
Revision 1.426 by root, Sat Feb 23 23:06:40 2013 UTC vs.
Revision 1.431 by root, Fri Nov 22 16:42:10 2013 UTC

1=encoding utf-8
2
1=head1 NAME 3=head1 NAME
2 4
3libev - a high performance full-featured event loop written in C 5libev - a high performance full-featured event loop written in C
4 6
5=head1 SYNOPSIS 7=head1 SYNOPSIS
… …
396 398
397If this flag bit is or'ed into the flag value (or the program runs setuid 399If this flag bit is or'ed into the flag value (or the program runs setuid
398or setgid) then libev will I<not> look at the environment variable 400or setgid) then libev will I<not> look at the environment variable
399C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will 401C<LIBEV_FLAGS>. Otherwise (the default), this environment variable will
400override the flags completely if it is found in the environment. This is 402override the flags completely if it is found in the environment. This is
401useful to try out specific backends to test their performance, or to work 403useful to try out specific backends to test their performance, to work
402around bugs. 404around bugs, or to make libev threadsafe (accessing environment variables
405cannot be done in a threadsafe way, but usually it works if no other
406thread modifies them).
403 407
404=item C<EVFLAG_FORKCHECK> 408=item C<EVFLAG_FORKCHECK>
405 409
406Instead of calling C<ev_loop_fork> manually after a fork, you can also 410Instead of calling C<ev_loop_fork> manually after a fork, you can also
407make libev check for a fork in each iteration by enabling this flag. 411make libev check for a fork in each iteration by enabling this flag.
… …
684reinitialise the kernel state for backends that have one. Despite the 688reinitialise the kernel state for backends that have one. Despite the
685name, you can call it anytime, but it makes most sense after forking, in 689name, you can call it anytime, but it makes most sense after forking, in
686the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the 690the child process. You I<must> call it (or use C<EVFLAG_FORKCHECK>) in the
687child before resuming or calling C<ev_run>. 691child before resuming or calling C<ev_run>.
688 692
689Again, you I<have> to call it on I<any> loop that you want to re-use after 693Again, you I<have> to call it on I<any> loop that you want to re-use after
690a fork, I<even if you do not plan to use the loop in the parent>. This is 694a fork, I<even if you do not plan to use the loop in the parent>. This is
691because some kernel interfaces *cough* I<kqueue> *cough* do funny things 695because some kernel interfaces *cough* I<kqueue> *cough* do funny things
692during fork. 696during fork.
693 697
694On the other hand, you only need to call this function in the child 698On the other hand, you only need to call this function in the child
… …
2409only within the same loop, i.e. you can watch for C<SIGINT> in your 2413only within the same loop, i.e. you can watch for C<SIGINT> in your
2410default loop and for C<SIGIO> in another loop, but you cannot watch for 2414default loop and for C<SIGIO> in another loop, but you cannot watch for
2411C<SIGINT> in both the default loop and another loop at the same time. At 2415C<SIGINT> in both the default loop and another loop at the same time. At
2412the moment, C<SIGCHLD> is permanently tied to the default loop. 2416the moment, C<SIGCHLD> is permanently tied to the default loop.
2413 2417
2414When the first watcher gets started will libev actually register something 2418Only after the first watcher for a signal is started will libev actually
2415with the kernel (thus it coexists with your own signal handlers as long as 2419register something with the kernel. It thus coexists with your own signal
2416you don't register any with libev for the same signal). 2420handlers as long as you don't register any with libev for the same signal.
2417 2421
2418If possible and supported, libev will install its handlers with 2422If possible and supported, libev will install its handlers with
2419C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2423C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2420not be unduly interrupted. If you have a problem with system calls getting 2424not be unduly interrupted. If you have a problem with system calls getting
2421interrupted by signals you can block all signals in an C<ev_check> watcher 2425interrupted by signals you can block all signals in an C<ev_check> watcher
… …
3980Libev comes with some simplistic wrapper classes for C++ that mainly allow 3984Libev comes with some simplistic wrapper classes for C++ that mainly allow
3981you to use some convenience methods to start/stop watchers and also change 3985you to use some convenience methods to start/stop watchers and also change
3982the callback model to a model using method callbacks on objects. 3986the callback model to a model using method callbacks on objects.
3983 3987
3984To use it, 3988To use it,
3985 3989
3986 #include <ev++.h> 3990 #include <ev++.h>
3987 3991
3988This automatically includes F<ev.h> and puts all of its definitions (many 3992This automatically includes F<ev.h> and puts all of its definitions (many
3989of them macros) into the global namespace. All C++ specific things are 3993of them macros) into the global namespace. All C++ specific things are
3990put into the C<ev> namespace. It should support all the same embedding 3994put into the C<ev> namespace. It should support all the same embedding
… …
5427=over 4 5431=over 4
5428 5432
5429=item C<EV_COMPAT3> backwards compatibility mechanism 5433=item C<EV_COMPAT3> backwards compatibility mechanism
5430 5434
5431The backward compatibility mechanism can be controlled by 5435The backward compatibility mechanism can be controlled by
5432C<EV_COMPAT3>. See L</PREPROCESSOR SYMBOLS/MACROS> in the L</EMBEDDING> 5436C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5433section. 5437section.
5434 5438
5435=item C<ev_default_destroy> and C<ev_default_fork> have been removed 5439=item C<ev_default_destroy> and C<ev_default_fork> have been removed
5436 5440
5437These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 5441These calls can be replaced easily by their C<ev_loop_xxx> counterparts:

Diff Legend

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