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

Comparing libev/ev.pod (file contents):
Revision 1.326 by root, Sun Oct 24 19:44:27 2010 UTC vs.
Revision 1.332 by root, Sun Oct 24 23:30:23 2010 UTC

… …
300An event loop is described by a C<struct ev_loop *> (the C<struct> is 300An event loop is described by a C<struct ev_loop *> (the C<struct> is
301I<not> optional in this case unless libev 3 compatibility is disabled, as 301I<not> optional in this case unless libev 3 compatibility is disabled, as
302libev 3 had an C<ev_loop> function colliding with the struct name). 302libev 3 had an C<ev_loop> function colliding with the struct name).
303 303
304The library knows two types of such loops, the I<default> loop, which 304The library knows two types of such loops, the I<default> loop, which
305supports signals and child events, and dynamically created event loops 305supports child process events, and dynamically created event loops which
306which do not. 306do not.
307 307
308=over 4 308=over 4
309 309
310=item struct ev_loop *ev_default_loop (unsigned int flags) 310=item struct ev_loop *ev_default_loop (unsigned int flags)
311 311
… …
1114The event loop has been resumed in the child process after fork (see 1114The event loop has been resumed in the child process after fork (see
1115C<ev_fork>). 1115C<ev_fork>).
1116 1116
1117=item C<EV_CLEANUP> 1117=item C<EV_CLEANUP>
1118 1118
1119The event loop is abotu to be destroyed (see C<ev_cleanup>). 1119The event loop is about to be destroyed (see C<ev_cleanup>).
1120 1120
1121=item C<EV_ASYNC> 1121=item C<EV_ASYNC>
1122 1122
1123The given async watcher has been asynchronously notified (see C<ev_async>). 1123The given async watcher has been asynchronously notified (see C<ev_async>).
1124 1124
… …
3098 3098
3099=item ev_fork_init (ev_fork *, callback) 3099=item ev_fork_init (ev_fork *, callback)
3100 3100
3101Initialises and configures the fork watcher - it has no parameters of any 3101Initialises and configures the fork watcher - it has no parameters of any
3102kind. There is a C<ev_fork_set> macro, but using it is utterly pointless, 3102kind. There is a C<ev_fork_set> macro, but using it is utterly pointless,
3103believe me. 3103really.
3104 3104
3105=back 3105=back
3106 3106
3107 3107
3108=head2 C<ev_cleanup> - even the best things end 3108=head2 C<ev_cleanup> - even the best things end
3109 3109
3110Cleanup watchers are called just before the event loop they are registered 3110Cleanup watchers are called just before the event loop is being destroyed
3111with is being destroyed. 3111by a call to C<ev_loop_destroy>.
3112 3112
3113While there is no guarantee that the event loop gets destroyed, cleanup 3113While there is no guarantee that the event loop gets destroyed, cleanup
3114watchers provide a convenient method to install cleanup hooks for your 3114watchers provide a convenient method to install cleanup hooks for your
3115program, worker threads and so on - you just to make sure to destroy the 3115program, worker threads and so on - you just to make sure to destroy the
3116loop when you want them to be invoked. 3116loop when you want them to be invoked.
3117 3117
3118Cleanup watchers are invoked in the same way as any other watcher. Unlike
3119all other watchers, they do not keep a reference to the event loop (which
3120makes a lot of sense if you think about it). Like all other watchers, you
3121can call libev functions in the callback, except C<ev_cleanup_start>.
3122
3118=head3 Watcher-Specific Functions and Data Members 3123=head3 Watcher-Specific Functions and Data Members
3119 3124
3120=over 4 3125=over 4
3121 3126
3122=item ev_cleanup_init (ev_cleanup *, callback) 3127=item ev_cleanup_init (ev_cleanup *, callback)
3123 3128
3124Initialises and configures the cleanup watcher - it has no parameters of 3129Initialises and configures the cleanup watcher - it has no parameters of
3125any kind. There is a C<ev_cleanup_set> macro, but using it is utterly 3130any kind. There is a C<ev_cleanup_set> macro, but using it is utterly
3126pointless, believe me. 3131pointless, I assure you.
3127 3132
3128=back 3133=back
3129 3134
3130Example: Register an atexit handler to destroy the default loop, so any 3135Example: Register an atexit handler to destroy the default loop, so any
3131cleanup functions are called. 3136cleanup functions are called.
… …
4867=back 4872=back
4868 4873
4869 4874
4870=head1 PORTING FROM LIBEV 3.X TO 4.X 4875=head1 PORTING FROM LIBEV 3.X TO 4.X
4871 4876
4872The major version 4 introduced some minor incompatible changes to the API. 4877The major version 4 introduced some incompatible changes to the API.
4873 4878
4874At the moment, the C<ev.h> header file tries to implement superficial 4879At the moment, the C<ev.h> header file provides compatibility definitions
4875compatibility, so most programs should still compile. Those might be 4880for all changes, so most programs should still compile. The compatibility
4876removed in later versions of libev, so better update early than late. 4881layer might be removed in later versions of libev, so better update to the
4882new API early than late.
4877 4883
4878=over 4 4884=over 4
4885
4886=item C<EV_COMPAT3> backwards compatibility mechanism
4887
4888The backward compatibility mechanism can be controlled by
4889C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
4890section.
4879 4891
4880=item C<ev_default_destroy> and C<ev_default_fork> have been removed 4892=item C<ev_default_destroy> and C<ev_default_fork> have been removed
4881 4893
4882These calls can be replaced easily by their C<ev_loop_xxx> counterparts: 4894These calls can be replaced easily by their C<ev_loop_xxx> counterparts:
4883 4895
… …
4909ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme 4921ev_loop> anymore and C<EV_TIMER> now follows the same naming scheme
4910as all other watcher types. Note that C<ev_loop_fork> is still called 4922as all other watcher types. Note that C<ev_loop_fork> is still called
4911C<ev_loop_fork> because it would otherwise clash with the C<ev_fork> 4923C<ev_loop_fork> because it would otherwise clash with the C<ev_fork>
4912typedef. 4924typedef.
4913 4925
4914=item C<EV_COMPAT3> backwards compatibility mechanism
4915
4916The backward compatibility mechanism can be controlled by
4917C<EV_COMPAT3>. See L<PREPROCESSOR SYMBOLS/MACROS> in the L<EMBEDDING>
4918section.
4919
4920=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES> 4926=item C<EV_MINIMAL> mechanism replaced by C<EV_FEATURES>
4921 4927
4922The preprocessor symbol C<EV_MINIMAL> has been replaced by a different 4928The preprocessor symbol C<EV_MINIMAL> has been replaced by a different
4923mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile 4929mechanism, C<EV_FEATURES>. Programs using C<EV_MINIMAL> usually compile
4924and work, but the library code will of course be larger. 4930and work, but the library code will of course be larger.

Diff Legend

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