… | |
… | |
62 | our $VERSION = '1.2'; |
62 | our $VERSION = '1.2'; |
63 | use XSLoader; |
63 | use XSLoader; |
64 | XSLoader::load "EV", $VERSION; |
64 | XSLoader::load "EV", $VERSION; |
65 | } |
65 | } |
66 | |
66 | |
67 | @EV::Io::ISA = |
67 | @EV::IO::ISA = |
68 | @EV::Timer::ISA = |
68 | @EV::Timer::ISA = |
69 | @EV::Periodic::ISA = |
69 | @EV::Periodic::ISA = |
70 | @EV::Signal::ISA = |
70 | @EV::Signal::ISA = |
71 | @EV::Idle::ISA = |
71 | @EV::Idle::ISA = |
72 | @EV::Prepare::ISA = |
72 | @EV::Prepare::ISA = |
… | |
… | |
117 | innermost call to EV::loop return. |
117 | innermost call to EV::loop return. |
118 | |
118 | |
119 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
119 | When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as |
120 | fast as possible. |
120 | fast as possible. |
121 | |
121 | |
|
|
122 | =item EV::once $fh_or_undef, $events, $timeout, $cb->($revents) |
|
|
123 | |
|
|
124 | This function rolls together an I/O and a timer watcher for a single |
|
|
125 | one-shot event without the need for managing a watcher object. |
|
|
126 | |
|
|
127 | If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events> |
|
|
128 | must be a bitset containing either C<EV::READ>, C<EV::WRITE> or C<EV::READ |
|
|
129 | | EV::WRITE>, indicating the type of I/O event you want to wait for. If |
|
|
130 | you do not want to wait for some I/O event, specify C<undef> for |
|
|
131 | C<$fh_or_undef> and C<0> for C<$events>). |
|
|
132 | |
|
|
133 | If timeout is C<undef> or negative, then there will be no |
|
|
134 | timeout. Otherwise a EV::timer with this value will be started. |
|
|
135 | |
|
|
136 | When an error occurs or either the timeout or I/O watcher triggers, then |
|
|
137 | the callback will be called with the received event set (in general |
|
|
138 | you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>, |
|
|
139 | C<EV::WRITE> and C<EV::TIMEOUT>). |
|
|
140 | |
|
|
141 | EV::once doesn't return anything: the watchers stay active till either |
|
|
142 | of them triggers, then they will be stopped and freed, and the callback |
|
|
143 | invoked. |
|
|
144 | |
122 | =back |
145 | =back |
123 | |
146 | |
124 | =head2 WATCHER |
147 | =head2 WATCHER |
125 | |
148 | |
126 | A watcher is an object that gets created to record your interest in some |
149 | A watcher is an object that gets created to record your interest in some |
… | |
… | |
210 | watchers with higher priority will be invoked first. The valid range of |
233 | watchers with higher priority will be invoked first. The valid range of |
211 | priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default |
234 | priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default |
212 | -2). If the priority is outside this range it will automatically be |
235 | -2). If the priority is outside this range it will automatically be |
213 | normalised to the nearest valid priority. |
236 | normalised to the nearest valid priority. |
214 | |
237 | |
215 | The default priority of any newly-created weatcher is 0. |
238 | The default priority of any newly-created watcher is 0. |
|
|
239 | |
|
|
240 | Note that the priority semantics have not yet been fleshed out and are |
|
|
241 | subject to almost certain change. |
216 | |
242 | |
217 | =item $w->trigger ($revents) |
243 | =item $w->trigger ($revents) |
218 | |
244 | |
219 | Call the callback *now* with the given event mask. |
245 | Call the callback *now* with the given event mask. |
220 | |
246 | |
|
|
247 | =item $previous_state = $w->keepalive ($bool) |
|
|
248 | |
|
|
249 | Normally, C<EV::loop> will return when there are no active watchers |
|
|
250 | (which is a "deadlock" because no progress can be made anymore). This is |
|
|
251 | convinient because it allows you to start your watchers (and your jobs), |
|
|
252 | call C<EV::loop> once and when it returns you know that all your jobs are |
|
|
253 | finished (or they forgot to register some watchers for their task :). |
|
|
254 | |
|
|
255 | Sometimes, however, this gets in your way, for example when you the module |
|
|
256 | that calls C<EV::loop> (usually the main program) is not the same module |
|
|
257 | as a long-living watcher (for example a DNS client module written by |
|
|
258 | somebody else even). Then you might want any outstanding requests to be |
|
|
259 | handled, but you would not want to keep C<EV::loop> from returning just |
|
|
260 | because you happen to have this long-running UDP port watcher. |
|
|
261 | |
|
|
262 | In this case you can clear the keepalive status, which means that even |
|
|
263 | though your watcher is active, it won't keep C<EV::loop> from returning. |
|
|
264 | |
|
|
265 | The initial value for keepalive is true (enabled), and you cna change it |
|
|
266 | any time. |
|
|
267 | |
|
|
268 | Example: Register an IO watcher for some UDP socket but do not keep the |
|
|
269 | event loop from running just because of that watcher. |
|
|
270 | |
|
|
271 | my $udp_socket = ... |
|
|
272 | my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... }; |
|
|
273 | $udp_watcher->keepalive (0); |
221 | |
274 | |
222 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
275 | =item $w = EV::io $fileno_or_fh, $eventmask, $callback |
223 | |
276 | |
224 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
277 | =item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback |
225 | |
278 | |