ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/EV/EV.pm
(Generate patch)

Comparing EV/EV.pm (file contents):
Revision 1.98 by root, Sat May 31 23:17:50 2008 UTC vs.
Revision 1.103 by root, Thu Oct 2 07:49:09 2008 UTC

… …
71 71
72=cut 72=cut
73 73
74package EV; 74package EV;
75 75
76no warnings;
76use strict; 77use strict;
77 78
78BEGIN { 79BEGIN {
79 our $VERSION = '3.42'; 80 our $VERSION = '3.44';
80 use XSLoader; 81 use XSLoader;
81 XSLoader::load "EV", $VERSION; 82 XSLoader::load "EV", $VERSION;
82} 83}
83 84
84@EV::IO::ISA = 85@EV::IO::ISA =
… …
111default loop as this is fastest (perl-wise), best supported by other 112default loop as this is fastest (perl-wise), best supported by other
112modules (e.g. AnyEvent or Coro) and most portable event loop. 113modules (e.g. AnyEvent or Coro) and most portable event loop.
113 114
114For specific programs you can create additional event loops dynamically. 115For specific programs you can create additional event loops dynamically.
115 116
117If you want to take avdantage of kqueue (which often works properly for
118sockets only) even though the default loop doesn't enable it, you can
119I<embed> a kqueue loop into the default loop: running the default loop
120will then also service the kqueue loop to some extent. See the example in
121the section about embed watchers for an example on how to achieve that.
122
116=over 4 123=over 4
117 124
118=item $loop = new EV::loop [$flags] 125=item $loop = new EV::loop [$flags]
119 126
120Create a new event loop as per the specified flags. Please refer to the 127Create a new event loop as per the specified flags. Please refer to the
… …
123for more info. 130for more info.
124 131
125The loop will automatically be destroyed when it is no longer referenced 132The loop will automatically be destroyed when it is no longer referenced
126by any watcher and the loop object goes out of scope. 133by any watcher and the loop object goes out of scope.
127 134
128Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop 135If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK>
129is protected by this module. 136is recommended, as only the default event loop is protected by this
137module. If you I<are> embedding this loop in the default loop, this is not
138necessary, as C<EV::embed> automatically does the right thing on fork.
130 139
131=item $loop->loop_fork 140=item $loop->loop_fork
132 141
133Must be called after a fork in the child, before entering or continuing 142Must be called after a fork in the child, before entering or continuing
134the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls 143the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
… …
136documentation). 145documentation).
137 146
138=item $loop->loop_verify 147=item $loop->loop_verify
139 148
140Calls C<ev_verify> to make internal consistency checks (for debugging 149Calls C<ev_verify> to make internal consistency checks (for debugging
141libev) and abort the program if any data structures wree found to be 150libev) and abort the program if any data structures were found to be
142corrupted. 151corrupted.
143 152
144=item $loop = EV::default_loop [$flags] 153=item $loop = EV::default_loop [$flags]
145 154
146Return the default loop (which is a singleton object). Since this module 155Return the default loop (which is a singleton object). Since this module
147already creates the default loop with default flags, specifying flags here 156already creates the default loop with default flags, specifying flags here
148will not have any effect unless you destroy the default loop. 157will not have any effect unless you destroy the default loop first, which
158isn't supported. So in short: don't do it, and if you break it, you get to
159keep the pieces.
149 160
150=back 161=back
151 162
152 163
153=head1 BASIC INTERFACE 164=head1 BASIC INTERFACE
… …
967 # use the default loop otherwise 978 # use the default loop otherwise
968 $socket_loop ||= EV::default_loop; 979 $socket_loop ||= EV::default_loop;
969 980
970=over 4 981=over 4
971 982
972=item $w = EV::embed $otherloop, $callback 983=item $w = EV::embed $otherloop[, $callback]
973 984
974=item $w = EV::embed_ns $otherloop, $callback 985=item $w = EV::embed_ns $otherloop[, $callback]
975 986
976=item $w = $loop->embed ($otherloop, $callback) 987=item $w = $loop->embed ($otherloop[, $callback])
977 988
978=item $w = $loop->embed_ns ($otherloop, $callback) 989=item $w = $loop->embed_ns ($otherloop[, $callback])
979 990
980Call the callback when the embedded event loop (C<$otherloop>) has any 991Call the callback when the embedded event loop (C<$otherloop>) has any
981I/O activity. The C<$callback> should alwas be specified as C<undef> in 992I/O activity. The C<$callback> is optional: if it is missing, then the
982this version of EV, which means the embedded event loop will be managed 993embedded event loop will be managed automatically (which is recommended),
983automatically. 994otherwise you have to invoke C<sweep> yourself.
984 995
985The C<embed_ns> variant doesn't start (activate) the newly created watcher. 996The C<embed_ns> variant doesn't start (activate) the newly created watcher.
986 997
987=back 998=back
988 999

Diff Legend

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