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

Comparing libev/ev.pod (file contents):
Revision 1.427 by root, Sun Apr 28 14:57:12 2013 UTC vs.
Revision 1.432 by root, Sat Apr 26 14:28:48 2014 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
… …
686reinitialise the kernel state for backends that have one. Despite the 688reinitialise the kernel state for backends that have one. Despite the
687name, 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
688the 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
689child before resuming or calling C<ev_run>. 691child before resuming or calling C<ev_run>.
690 692
691Again, 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
692a 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
693because some kernel interfaces *cough* I<kqueue> *cough* do funny things 695because some kernel interfaces *cough* I<kqueue> *cough* do funny things
694during fork. 696during fork.
695 697
696On 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
… …
2391 2393
2392 ev_periodic hourly_tick; 2394 ev_periodic hourly_tick;
2393 ev_periodic_init (&hourly_tick, clock_cb, 2395 ev_periodic_init (&hourly_tick, clock_cb,
2394 fmod (ev_now (loop), 3600.), 3600., 0); 2396 fmod (ev_now (loop), 3600.), 3600., 0);
2395 ev_periodic_start (loop, &hourly_tick); 2397 ev_periodic_start (loop, &hourly_tick);
2396 2398
2397 2399
2398=head2 C<ev_signal> - signal me when a signal gets signalled! 2400=head2 C<ev_signal> - signal me when a signal gets signalled!
2399 2401
2400Signal watchers will trigger an event when the process receives a specific 2402Signal watchers will trigger an event when the process receives a specific
2401signal one or more times. Even though signals are very asynchronous, libev 2403signal one or more times. Even though signals are very asynchronous, libev
… …
2411only 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
2412default 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
2413C<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
2414the moment, C<SIGCHLD> is permanently tied to the default loop. 2416the moment, C<SIGCHLD> is permanently tied to the default loop.
2415 2417
2416When the first watcher gets started will libev actually register something 2418Only after the first watcher for a signal is started will libev actually
2417with 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
2418you 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.
2419 2421
2420If possible and supported, libev will install its handlers with 2422If possible and supported, libev will install its handlers with
2421C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should 2423C<SA_RESTART> (or equivalent) behaviour enabled, so system calls should
2422not 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
2423interrupted 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
… …
3211used). 3213used).
3212 3214
3213 struct ev_loop *loop_hi = ev_default_init (0); 3215 struct ev_loop *loop_hi = ev_default_init (0);
3214 struct ev_loop *loop_lo = 0; 3216 struct ev_loop *loop_lo = 0;
3215 ev_embed embed; 3217 ev_embed embed;
3216 3218
3217 // see if there is a chance of getting one that works 3219 // see if there is a chance of getting one that works
3218 // (remember that a flags value of 0 means autodetection) 3220 // (remember that a flags value of 0 means autodetection)
3219 loop_lo = ev_embeddable_backends () & ev_recommended_backends () 3221 loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
3220 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ()) 3222 ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
3221 : 0; 3223 : 0;
… …
3235C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too). 3237C<loop_socket>. (One might optionally use C<EVFLAG_NOENV>, too).
3236 3238
3237 struct ev_loop *loop = ev_default_init (0); 3239 struct ev_loop *loop = ev_default_init (0);
3238 struct ev_loop *loop_socket = 0; 3240 struct ev_loop *loop_socket = 0;
3239 ev_embed embed; 3241 ev_embed embed;
3240 3242
3241 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE) 3243 if (ev_supported_backends () & ~ev_recommended_backends () & EVBACKEND_KQUEUE)
3242 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE)) 3244 if ((loop_socket = ev_loop_new (EVBACKEND_KQUEUE))
3243 { 3245 {
3244 ev_embed_init (&embed, 0, loop_socket); 3246 ev_embed_init (&embed, 0, loop_socket);
3245 ev_embed_start (loop, &embed); 3247 ev_embed_start (loop, &embed);
… …
3982Libev comes with some simplistic wrapper classes for C++ that mainly allow 3984Libev comes with some simplistic wrapper classes for C++ that mainly allow
3983you 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
3984the callback model to a model using method callbacks on objects. 3986the callback model to a model using method callbacks on objects.
3985 3987
3986To use it, 3988To use it,
3987 3989
3988 #include <ev++.h> 3990 #include <ev++.h>
3989 3991
3990This 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
3991of them macros) into the global namespace. All C++ specific things are 3993of them macros) into the global namespace. All C++ specific things are
3992put 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
… …
4095 void operator() (ev::io &w, int revents) 4097 void operator() (ev::io &w, int revents)
4096 { 4098 {
4097 ... 4099 ...
4098 } 4100 }
4099 } 4101 }
4100 4102
4101 myfunctor f; 4103 myfunctor f;
4102 4104
4103 ev::io w; 4105 ev::io w;
4104 w.set (&f); 4106 w.set (&f);
4105 4107
… …
5429=over 4 5431=over 4
5430 5432
5431=item C<EV_COMPAT3> backwards compatibility mechanism 5433=item C<EV_COMPAT3> backwards compatibility mechanism
5432 5434
5433The backward compatibility mechanism can be controlled by 5435The backward compatibility mechanism can be controlled by
5434C<EV_COMPAT3>. See L</PREPROCESSOR SYMBOLS/MACROS> in the L</EMBEDDING> 5436C<EV_COMPAT3>. See L</"PREPROCESSOR SYMBOLS/MACROS"> in the L</EMBEDDING>
5435section. 5437section.
5436 5438
5437=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
5438 5440
5439These 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