[ViewVC] Diff of: cvs/EV/EV.pm

Comparing EV/EV.pm (file contents):
Revision 1.27 by root, Sat Nov 3 09:19:58 2007 UTC vs.
Revision 1.53 by root, Sat Nov 24 16:57:30 2007 UTC

…		…
10		10
11	my $w = EV::timer 2, 0, sub {	11	my $w = EV::timer 2, 0, sub {
12	warn "is called after 2s";	12	warn "is called after 2s";
13	};	13	};
14		14
15	my $w = EV::timer 2, 1, sub {	15	my $w = EV::timer 2, 2, sub {
16	warn "is called roughly every 2s (repeat = 1)";	16	warn "is called roughly every 2s (repeat = 2)";
17	};	17	};
18		18
19	undef $w; # destroy event watcher again	19	undef $w; # destroy event watcher again
20		20
21	my $w = EV::periodic 0, 60, sub {	21	my $w = EV::periodic 0, 60, 0, sub {
22	warn "is called every minute, on the minute, exactly";	22	warn "is called every minute, on the minute, exactly";
23	};	23	};
24		24
25	# IO	25	# IO
26		26
27	my $w = EV::io *STDIN, EV::READ, sub {	27	my $w = EV::io *STDIN, EV::READ, sub {
28	my ($w, $revents) = @_; # all callbacks get the watcher object and event mask	28	my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
29	warn "stdin is readable, you entered: ", <STDIN>;	29	warn "stdin is readable, you entered: ", <STDIN>;
30	};	30	};
31		31
32	# SIGNALS	32	# SIGNALS
33		33
34	my $w = EV::signal 'QUIT', sub {	34	my $w = EV::signal 'QUIT', sub {
35	warn "sigquit received\n";	35	warn "sigquit received\n";
36	};	36	};
37		37
38	my $w = EV::signal 3, sub {
39	warn "sigquit received (this is GNU/Linux, right?)\n";
40	};
41
42	# CHILD/PID STATUS CHANGES	38	# CHILD/PID STATUS CHANGES
43		39
44	my $w = EV::child 666, sub {	40	my $w = EV::child 666, sub {
45	my ($w, $revents) = @_;	41	my ($w, $revents) = @_;
46	# my $pid = $w->rpid;
47	my $status = $w->rstatus;	42	my $status = $w->rstatus;
48	};	43	};
49		44
50	# MAINLOOP	45	# MAINLOOP
51	EV::loop; # loop until EV::loop_done is called	46	EV::loop; # loop until EV::unloop is called or all watchers stop
52	EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled	47	EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled
53	EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block	48	EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block
54		49
55	=head1 DESCRIPTION	50	=head1 DESCRIPTION
56		51
57	This module provides an interface to libev	52	This module provides an interface to libev
58	(L<http://software.schmorp.de/pkg/libev.html>).	53	(L<http://software.schmorp.de/pkg/libev.html>). While the documentation
		54	below is comprehensive, one might also consult the documentation of libev
		55	itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on
		56	watcher semantics or some discussion on the available backends, or how to
		57	force a specific backend with C<LIBEV_FLAGS>.
59		58
60	=cut	59	=cut
61		60
62	package EV;	61	package EV;
63		62
64	use strict;	63	use strict;
65		64
66	BEGIN {	65	BEGIN {
67	our $VERSION = '0.5';	66	our $VERSION = '1.3';
68	use XSLoader;	67	use XSLoader;
69	XSLoader::load "EV", $VERSION;	68	XSLoader::load "EV", $VERSION;
70	}	69	}
71		70
72	@EV::Io::ISA =	71	@EV::IO::ISA =
73	@EV::Timer::ISA =	72	@EV::Timer::ISA =
74	@EV::Periodic::ISA =	73	@EV::Periodic::ISA =
75	@EV::Signal::ISA =	74	@EV::Signal::ISA =
76	@EV::Idle::ISA =	75	@EV::Idle::ISA =
77	@EV::Prepare::ISA =	76	@EV::Prepare::ISA =
…		…
98		97
99	Returns the time the last event loop iteration has been started. This	98	Returns the time the last event loop iteration has been started. This
100	is the time that (relative) timers are based on, and refering to it is	99	is the time that (relative) timers are based on, and refering to it is
101	usually faster then calling EV::time.	100	usually faster then calling EV::time.
102		101
103	=item $method = EV::ev_method	102	=item $method = EV::method
104		103
105	Returns an integer describing the backend used by libev (EV::METHOD_SELECT	104	Returns an integer describing the backend used by libev (EV::METHOD_SELECT
106	or EV::METHOD_EPOLL).	105	or EV::METHOD_EPOLL).
107		106
108	=item EV::loop [$flags]	107	=item EV::loop [$flags]
109		108
110	Begin checking for events and calling callbacks. It returns when a	109	Begin checking for events and calling callbacks. It returns when a
111	callback calls EV::loop_done.	110	callback calls EV::unloop.
112		111
113	The $flags argument can be one of the following:	112	The $flags argument can be one of the following:
114		113
115	0 as above	114	0 as above
116	EV::LOOP_ONESHOT block at most once (wait, but do not loop)	115	EV::LOOP_ONESHOT block at most once (wait, but do not loop)
117	EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait)	116	EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait)
118		117
119	=item EV::loop_done [$how]	118	=item EV::unloop [$how]
120		119
121	When called with no arguments or an argument of 1, makes the innermost	120	When called with no arguments or an argument of EV::UNLOOP_ONE, makes the
122	call to EV::loop return.	121	innermost call to EV::loop return.
123		122
124	When called with an agrument of 2, all calls to EV::loop will return as	123	When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as
125	fast as possible.	124	fast as possible.
		125
		126	=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
		127
		128	This function rolls together an I/O and a timer watcher for a single
		129	one-shot event without the need for managing a watcher object.
		130
		131	If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events>
		132	must be a bitset containing either C<EV::READ>, C<EV::WRITE> or C<EV::READ
		133	\| EV::WRITE>, indicating the type of I/O event you want to wait for. If
		134	you do not want to wait for some I/O event, specify C<undef> for
		135	C<$fh_or_undef> and C<0> for C<$events>).
		136
		137	If timeout is C<undef> or negative, then there will be no
		138	timeout. Otherwise a EV::timer with this value will be started.
		139
		140	When an error occurs or either the timeout or I/O watcher triggers, then
		141	the callback will be called with the received event set (in general
		142	you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>,
		143	C<EV::WRITE> and C<EV::TIMEOUT>).
		144
		145	EV::once doesn't return anything: the watchers stay active till either
		146	of them triggers, then they will be stopped and freed, and the callback
		147	invoked.
126		148
127	=back	149	=back
128		150
129	=head2 WATCHER	151	=head2 WATCHER
130		152
…		…
186		208
187	=item $bool = $w->is_active	209	=item $bool = $w->is_active
188		210
189	Returns true if the watcher is active, false otherwise.	211	Returns true if the watcher is active, false otherwise.
190		212
		213	=item $current_data = $w->data
		214
		215	=item $old_data = $w->data ($new_data)
		216
		217	Queries a freely usable data scalar on the watcher and optionally changes
		218	it. This is a way to associate custom data with a watcher:
		219
		220	my $w = EV::timer 60, 0, sub {
		221	warn $_[0]->data;
		222	};
		223	$w->data ("print me!");
		224
191	=item $current_cb = $w->cb	225	=item $current_cb = $w->cb
192		226
193	=item $old_cb = $w->cb ($new_cb)	227	=item $old_cb = $w->cb ($new_cb)
194		228
195	Queries the callback on the watcher and optionally changes it. You can do	229	Queries the callback on the watcher and optionally changes it. You can do
…		…
203	watchers with higher priority will be invoked first. The valid range of	237	watchers with higher priority will be invoked first. The valid range of
204	priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default	238	priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default
205	-2). If the priority is outside this range it will automatically be	239	-2). If the priority is outside this range it will automatically be
206	normalised to the nearest valid priority.	240	normalised to the nearest valid priority.
207		241
208	The default priority of any newly-created weatcher is 0.	242	The default priority of any newly-created watcher is 0.
		243
		244	Note that the priority semantics have not yet been fleshed out and are
		245	subject to almost certain change.
209		246
210	=item $w->trigger ($revents)	247	=item $w->trigger ($revents)
211		248
212	Call the callback now with the given event mask.	249	Call the callback now with the given event mask.
213		250
		251	=item $previous_state = $w->keepalive ($bool)
		252
		253	Normally, C<EV::loop> will return when there are no active watchers
		254	(which is a "deadlock" because no progress can be made anymore). This is
		255	convinient because it allows you to start your watchers (and your jobs),
		256	call C<EV::loop> once and when it returns you know that all your jobs are
		257	finished (or they forgot to register some watchers for their task :).
		258
		259	Sometimes, however, this gets in your way, for example when you the module
		260	that calls C<EV::loop> (usually the main program) is not the same module
		261	as a long-living watcher (for example a DNS client module written by
		262	somebody else even). Then you might want any outstanding requests to be
		263	handled, but you would not want to keep C<EV::loop> from returning just
		264	because you happen to have this long-running UDP port watcher.
		265
		266	In this case you can clear the keepalive status, which means that even
		267	though your watcher is active, it won't keep C<EV::loop> from returning.
		268
		269	The initial value for keepalive is true (enabled), and you cna change it
		270	any time.
		271
		272	Example: Register an IO watcher for some UDP socket but do not keep the
		273	event loop from running just because of that watcher.
		274
		275	my $udp_socket = ...
		276	my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
		277	$udp_watcher->keepalive (0);
214		278
215	=item $w = EV::io $fileno_or_fh, $eventmask, $callback	279	=item $w = EV::io $fileno_or_fh, $eventmask, $callback
216		280
217	=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback	281	=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
218		282
…		…
246		310
247	=item $w = EV::timer $after, $repeat, $callback	311	=item $w = EV::timer $after, $repeat, $callback
248		312
249	=item $w = EV::timer_ns $after, $repeat, $callback	313	=item $w = EV::timer_ns $after, $repeat, $callback
250		314
251	Calls the callback after C<$after> seconds. If C<$repeat> is non-zero,	315	Calls the callback after C<$after> seconds (which may be fractional). If
252	the timer will be restarted (with the $repeat value as $after) after the	316	C<$repeat> is non-zero, the timer will be restarted (with the $repeat
253	callback returns.	317	value as $after) after the callback returns.
254		318
255	This means that the callback would be called roughly after C<$after>	319	This means that the callback would be called roughly after C<$after>
256	seconds, and then every C<$repeat> seconds. "Roughly" because the time of	320	seconds, and then every C<$repeat> seconds. The timer does his best not
257	callback processing is not taken into account, so the timer will slowly	321	to drift, but it will not invoke the timer more often then once per event
258	drift. If that isn't acceptable, look at EV::periodic.	322	loop iteration, and might drift in other cases. If that isn't acceptable,
		323	look at EV::periodic, which can provide long-term stable timers.
259		324
260	The timer is based on a monotonic clock, that is if somebody is sitting	325	The timer is based on a monotonic clock, that is, if somebody is sitting
261	in front of the machine while the timer is running and changes the system	326	in front of the machine while the timer is running and changes the system
262	clock, the timer will nevertheless run (roughly) the same time.	327	clock, the timer will nevertheless run (roughly) the same time.
263		328
264	The C<timer_ns> variant doesn't start (activate) the newly created watcher.	329	The C<timer_ns> variant doesn't start (activate) the newly created watcher.
265		330
…		…
270		335
271	=item $w->again	336	=item $w->again
272		337
273	Similar to the C<start> method, but has special semantics for repeating timers:	338	Similar to the C<start> method, but has special semantics for repeating timers:
274		339
		340	If the timer is active and non-repeating, it will be stopped.
		341
275	If the timer is active and repeating, reset the timeout to occur	342	If the timer is active and repeating, reset the timeout to occur
276	C<$repeat> seconds after now.	343	C<$repeat> seconds after now.
277		344
278	If the timer is active and non-repeating, it will be stopped.
279
280	If the timer is in active and repeating, start it.	345	If the timer is inactive and repeating, start it using the repeat value.
281		346
282	Otherwise do nothing.	347	Otherwise do nothing.
283		348
284	This behaviour is useful when you have a timeout for some IO	349	This behaviour is useful when you have a timeout for some IO
285	operation. You create a timer object with the same value for C<$after> and	350	operation. You create a timer object with the same value for C<$after> and
286	C<$repeat>, and then, in the read/write watcher, run the C<again> method	351	C<$repeat>, and then, in the read/write watcher, run the C<again> method
287	on the timeout.	352	on the timeout.
288		353
289		354
290	=item $w = EV::periodic $at, $interval, $callback	355	=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
291		356
292	=item $w = EV::periodic_ns $at, $interval, $callback	357	=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
293		358
294	Similar to EV::timer, but the time is given as an absolute point in time	359	Similar to EV::timer, but is not based on relative timeouts but on
295	(C<$at>), plus an optional C<$interval>.	360	absolute times. Apart from creating "simple" timers that trigger "at" the
		361	specified time, it can also be used for non-drifting absolute timers and
		362	more complex, cron-like, setups that are not adversely affected by time
		363	jumps (i.e. when the system clock is changed by explicit date -s or other
		364	means such as ntpd). It is also the most complex watcher type in EV.
296		365
297	If the C<$interval> is zero, then the callback will be called at the time	366	It has three distinct "modes":
298	C<$at> if that is in the future, or as soon as possible if it is in the
299	past. It will not automatically repeat.
300		367
301	If the C<$interval> is nonzero, then the watcher will always be scheduled	368	=over 4
302	to time out at the next C<$at + N * $interval> time.
303		369
304	This can be used to schedule a callback to run at very regular intervals,	370	=item * absolute timer ($interval = $reschedule_cb = 0)
305	as long as the processing time is less then the interval (otherwise	371
306	obviously events will be skipped).	372	This time simply fires at the wallclock time C<$at> and doesn't repeat. It
		373	will not adjust when a time jump occurs, that is, if it is to be run
		374	at January 1st 2011 then it will run when the system time reaches or
		375	surpasses this time.
		376
		377	=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0)
		378
		379	In this mode the watcher will always be scheduled to time out at the
		380	next C<$at + N * $interval> time (for some integer N) and then repeat,
		381	regardless of any time jumps.
		382
		383	This can be used to create timers that do not drift with respect to system
		384	time:
		385
		386	my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
		387
		388	That doesn't mean there will always be 3600 seconds in between triggers,
		389	but only that the the clalback will be called when the system time shows a
		390	full hour (UTC).
307		391
308	Another way to think about it (for the mathematically inclined) is that	392	Another way to think about it (for the mathematically inclined) is that
309	EV::periodic will try to run the callback at the next possible time where	393	EV::periodic will try to run the callback in this mode at the next
310	C<$time = $at (mod $interval)>, regardless of any time jumps.	394	possible time where C<$time = $at (mod $interval)>, regardless of any time
		395	jumps.
311		396
312	This periodic timer is based on "wallclock time", that is, if the clock	397	=item * manual reschedule mode ($reschedule_cb = coderef)
313	changes (C<ntp>, C<date -s> etc.), then the timer will nevertheless run at	398
314	the specified time. This means it will never drift (it might jitter, but	399	In this mode $interval and $at are both being ignored. Instead, each
315	it will not drift).	400	time the periodic watcher gets scheduled, the reschedule callback
		401	($reschedule_cb) will be called with the watcher as first, and the current
		402	time as second argument.
		403
		404	I<This callback MUST NOT stop or destroy this or any other periodic
		405	watcher, ever>. If you need to stop it, return 1e30 and stop it
		406	afterwards.
		407
		408	It must return the next time to trigger, based on the passed time value
		409	(that is, the lowest time value larger than to the second argument). It
		410	will usually be called just before the callback will be triggered, but
		411	might be called at other times, too.
		412
		413	This can be used to create very complex timers, such as a timer that
		414	triggers on each midnight, local time (actually 24 hours after the last
		415	midnight, to keep the example simple. If you know a way to do it correctly
		416	in about the same space (without requiring elaborate modules), drop me a
		417	note :):
		418
		419	my $daily = EV::periodic 0, 0, sub {
		420	my ($w, $now) = @_;
		421
		422	use Time::Local ();
		423	my (undef, undef, undef, $d, $m, $y) = localtime $now;
		424	86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y
		425	}, sub {
		426	print "it's midnight or likely shortly after, now\n";
		427	};
		428
		429	=back
316		430
317	The C<periodic_ns> variant doesn't start (activate) the newly created watcher.	431	The C<periodic_ns> variant doesn't start (activate) the newly created watcher.
318		432
319	=item $w->set ($at, $interval)	433	=item $w->set ($at, $interval, $reschedule_cb)
320		434
321	Reconfigures the watcher, see the constructor above for details. Can be at	435	Reconfigures the watcher, see the constructor above for details. Can be at
322	any time.	436	any time.
		437
		438	=item $w->again
		439
		440	Simply stops and starts the watcher again.
323		441
324		442
325	=item $w = EV::signal $signal, $callback	443	=item $w = EV::signal $signal, $callback
326		444
327	=item $w = EV::signal_ns $signal, $callback	445	=item $w = EV::signal_ns $signal, $callback
…		…
432	# do nothing unless active	550	# do nothing unless active
433	$dispatcher->{_event_queue_h}	551	$dispatcher->{_event_queue_h}
434	or return;	552	or return;
435		553
436	# make the dispatcher handle any outstanding stuff	554	# make the dispatcher handle any outstanding stuff
		555	... not shown
437		556
438	# create an IO watcher for each and every socket	557	# create an IO watcher for each and every socket
439	@snmp_watcher = (	558	@snmp_watcher = (
440	(map { EV::io $_, EV::READ, sub { } }	559	(map { EV::io $_, EV::READ, sub { } }
441	keys %{ $dispatcher->{_descriptors} }),	560	keys %{ $dispatcher->{_descriptors} }),
		561
		562	EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]
		563	? $event->[Net::SNMP::Dispatcher::_TIME] - EV::now : 0),
		564	0, sub { },
442	);	565	);
443
444	# if there are any timeouts, also create a timer
445	push @snmp_watcher, EV::timer $event->[Net::SNMP::Dispatcher::_TIME] - EV::now, 0, sub { }
446	if $event->[Net::SNMP::Dispatcher::_ACTIVE];
447	};	566	};
448		567
449	The callbacks are irrelevant, the only purpose of those watchers is	568	The callbacks are irrelevant (and are not even being called), the
450	to wake up the process as soon as one of those events occurs (socket	569	only purpose of those watchers is to wake up the process as soon as
451	readable, or timer timed out). The corresponding EV::check watcher will then	570	one of those events occurs (socket readable, or timer timed out). The
452	clean up:	571	corresponding EV::check watcher will then clean up:
453		572
454	our $snmp_check = EV::check sub {	573	our $snmp_check = EV::check sub {
455	# destroy all watchers	574	# destroy all watchers
456	@snmp_watcher = ();	575	@snmp_watcher = ();
457		576
458	# make the dispatcher handle any new stuff	577	# make the dispatcher handle any new stuff
		578	... not shown
459	};	579	};
460		580
461	The callbacks of the created watchers will not be called as the watchers	581	The callbacks of the created watchers will not be called as the watchers
462	are destroyed before this cna happen (remember EV::check gets called	582	are destroyed before this cna happen (remember EV::check gets called
463	first).	583	first).
…		…
466		586
467	=back	587	=back
468		588
469	=head1 THREADS	589	=head1 THREADS
470		590
471	Threads are not supported by this in any way. Perl pseudo-threads is evil	591	Threads are not supported by this module in any way. Perl pseudo-threads
472	stuff and must die.	592	is evil stuff and must die. As soon as Perl gains real threads I will work
		593	on thread support for it.
		594
		595	=head1 FORK
		596
		597	Most of the "improved" event delivering mechanisms of modern operating
		598	systems have quite a few problems with fork(2) (to put it bluntly: it is
		599	not supported and usually destructive). Libev makes it possible to work
		600	around this by having a function that recreates the kernel state after
		601	fork in the child.
		602
		603	On non-win32 platforms, this module requires the pthread_atfork
		604	functionality to do this automatically for you. This function is quite
		605	buggy on most BSDs, though, so YMMV. The overhead for this is quite
		606	negligible, because everything the function currently does is set a flag
		607	that is checked only when the event loop gets used the next time, so when
		608	you do fork but not use EV, the overhead is minimal.
		609
		610	On win32, there is no notion of fork so all this doesn't apply, of course.
473		611
474	=cut	612	=cut
475		613
476	our $DIED = sub {	614	our $DIED = sub {
477	warn "EV: error in callback (ignoring): $@";	615	warn "EV: error in callback (ignoring): $@";
478	};	616	};
479		617
480	init	618	default_loop
481	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?';	619	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?';
482		620
483	push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"];
484
485	1;	621	1;
486		622
487	=head1 SEE ALSO	623	=head1 SEE ALSO
488		624
489	L<EV::DNS>, L<EV::AnyEvent>.	625	L<EV::DNS>.
490		626
491	=head1 AUTHOR	627	=head1 AUTHOR
492		628
493	Marc Lehmann <schmorp@schmorp.de>	629	Marc Lehmann <schmorp@schmorp.de>
494	http://home.schmorp.de/	630	http://home.schmorp.de/

Diff Legend

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

Comparing EV/EV.pm (file contents): Revision 1.27 by root, Sat Nov 3 09:19:58 2007 UTC vs. Revision 1.53 by root, Sat Nov 24 16:57:30 2007 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.27 by root, Sat Nov 3 09:19:58 2007 UTC vs.
Revision 1.53 by root, Sat Nov 24 16:57:30 2007 UTC