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

Comparing EV/EV.pm (file contents):
Revision 1.28 by root, Sun Nov 4 16:52:52 2007 UTC vs.
Revision 1.47 by root, Fri Nov 23 13:08:55 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
…		…
62	package EV;	57	package EV;
63		58
64	use strict;	59	use strict;
65		60
66	BEGIN {	61	BEGIN {
67	our $VERSION = '0.5';	62	our $VERSION = '1.2';
68	use XSLoader;	63	use XSLoader;
69	XSLoader::load "EV", $VERSION;	64	XSLoader::load "EV", $VERSION;
70	}	65	}
71		66
72	@EV::Io::ISA =	67	@EV::Io::ISA =
…		…
98		93
99	Returns the time the last event loop iteration has been started. This	94	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	95	is the time that (relative) timers are based on, and refering to it is
101	usually faster then calling EV::time.	96	usually faster then calling EV::time.
102		97
103	=item $method = EV::ev_method	98	=item $method = EV::method
104		99
105	Returns an integer describing the backend used by libev (EV::METHOD_SELECT	100	Returns an integer describing the backend used by libev (EV::METHOD_SELECT
106	or EV::METHOD_EPOLL).	101	or EV::METHOD_EPOLL).
107		102
108	=item EV::loop [$flags]	103	=item EV::loop [$flags]
109		104
110	Begin checking for events and calling callbacks. It returns when a	105	Begin checking for events and calling callbacks. It returns when a
111	callback calls EV::loop_done.	106	callback calls EV::unloop.
112		107
113	The $flags argument can be one of the following:	108	The $flags argument can be one of the following:
114		109
115	0 as above	110	0 as above
116	EV::LOOP_ONESHOT block at most once (wait, but do not loop)	111	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)	112	EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait)
118		113
119	=item EV::loop_done [$how]	114	=item EV::unloop [$how]
120		115
121	When called with no arguments or an argument of 1, makes the innermost	116	When called with no arguments or an argument of EV::UNLOOP_ONE, makes the
122	call to EV::loop return.	117	innermost call to EV::loop return.
123		118
124	When called with an agrument of 2, 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
125	fast as possible.	120	fast as possible.
		121
		122	=item EV::once $fh_or_undef, $events, $timeout, $cb->($events)
		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.
126		144
127	=back	145	=back
128		146
129	=head2 WATCHER	147	=head2 WATCHER
130		148
…		…
186		204
187	=item $bool = $w->is_active	205	=item $bool = $w->is_active
188		206
189	Returns true if the watcher is active, false otherwise.	207	Returns true if the watcher is active, false otherwise.
190		208
		209	=item $current_data = $w->data
		210
		211	=item $old_data = $w->data ($new_data)
		212
		213	Queries a freely usable data scalar on the watcher and optionally changes
		214	it. This is a way to associate custom data with a watcher:
		215
		216	my $w = EV::timer 60, 0, sub {
		217	warn $_[0]->data;
		218	};
		219	$w->data ("print me!");
		220
191	=item $current_cb = $w->cb	221	=item $current_cb = $w->cb
192		222
193	=item $old_cb = $w->cb ($new_cb)	223	=item $old_cb = $w->cb ($new_cb)
194		224
195	Queries the callback on the watcher and optionally changes it. You can do	225	Queries the callback on the watcher and optionally changes it. You can do
…		…
251	Calls the callback after C<$after> seconds. If C<$repeat> is non-zero,	281	Calls the callback after C<$after> seconds. If C<$repeat> is non-zero,
252	the timer will be restarted (with the $repeat value as $after) after the	282	the timer will be restarted (with the $repeat value as $after) after the
253	callback returns.	283	callback returns.
254		284
255	This means that the callback would be called roughly after C<$after>	285	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	286	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	287	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.	288	loop iteration, and might drift in other cases. If that isn't acceptable,
		289	look at EV::periodic, which can provide long-term stable timers.
259		290
260	The timer is based on a monotonic clock, that is if somebody is sitting	291	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	292	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.	293	clock, the timer will nevertheless run (roughly) the same time.
263		294
264	The C<timer_ns> variant doesn't start (activate) the newly created watcher.	295	The C<timer_ns> variant doesn't start (activate) the newly created watcher.
265		296
…		…
270		301
271	=item $w->again	302	=item $w->again
272		303
273	Similar to the C<start> method, but has special semantics for repeating timers:	304	Similar to the C<start> method, but has special semantics for repeating timers:
274		305
		306	If the timer is active and non-repeating, it will be stopped.
		307
275	If the timer is active and repeating, reset the timeout to occur	308	If the timer is active and repeating, reset the timeout to occur
276	C<$repeat> seconds after now.	309	C<$repeat> seconds after now.
277		310
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.	311	If the timer is inactive and repeating, start it using the repeat value.
281		312
282	Otherwise do nothing.	313	Otherwise do nothing.
283		314
284	This behaviour is useful when you have a timeout for some IO	315	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	316	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	317	C<$repeat>, and then, in the read/write watcher, run the C<again> method
287	on the timeout.	318	on the timeout.
288		319
289		320
290	=item $w = EV::periodic $at, $interval, $callback	321	=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
291		322
292	=item $w = EV::periodic_ns $at, $interval, $callback	323	=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
293		324
294	Similar to EV::timer, but the time is given as an absolute point in time	325	Similar to EV::timer, but is not based on relative timeouts but on
295	(C<$at>), plus an optional C<$interval>.	326	absolute times. Apart from creating "simple" timers that trigger "at" the
		327	specified time, it can also be used for non-drifting absolute timers and
		328	more complex, cron-like, setups that are not adversely affected by time
		329	jumps (i.e. when the system clock is changed by explicit date -s or other
		330	means such as ntpd). It is also the most complex watcher type in EV.
296		331
297	If the C<$interval> is zero, then the callback will be called at the time	332	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		333
301	If the C<$interval> is nonzero, then the watcher will always be scheduled	334	=over 4
302	to time out at the next C<$at + N * $interval> time.
303		335
304	This can be used to schedule a callback to run at very regular intervals,	336	=item * absolute timer ($interval = $reschedule_cb = 0)
305	as long as the processing time is less then the interval (otherwise	337
306	obviously events will be skipped).	338	This time simply fires at the wallclock time C<$at> and doesn't repeat. It
		339	will not adjust when a time jump occurs, that is, if it is to be run
		340	at January 1st 2011 then it will run when the system time reaches or
		341	surpasses this time.
		342
		343	=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0)
		344
		345	In this mode the watcher will always be scheduled to time out at the
		346	next C<$at + N * $interval> time (for some integer N) and then repeat,
		347	regardless of any time jumps.
		348
		349	This can be used to create timers that do not drift with respect to system
		350	time:
		351
		352	my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
		353
		354	That doesn't mean there will always be 3600 seconds in between triggers,
		355	but only that the the clalback will be called when the system time shows a
		356	full hour (UTC).
307		357
308	Another way to think about it (for the mathematically inclined) is that	358	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	359	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.	360	possible time where C<$time = $at (mod $interval)>, regardless of any time
		361	jumps.
311		362
312	This periodic timer is based on "wallclock time", that is, if the clock	363	=item * manual reschedule mode ($reschedule_cb = coderef)
313	changes (C<ntp>, C<date -s> etc.), then the timer will nevertheless run at	364
314	the specified time. This means it will never drift (it might jitter, but	365	In this mode $interval and $at are both being ignored. Instead, each
315	it will not drift).	366	time the periodic watcher gets scheduled, the reschedule callback
		367	($reschedule_cb) will be called with the watcher as first, and the current
		368	time as second argument.
		369
		370	I<This callback MUST NOT stop or destroy this or any other periodic
		371	watcher, ever>. If you need to stop it, return 1e30 and stop it
		372	afterwards.
		373
		374	It must return the next time to trigger, based on the passed time value
		375	(that is, the lowest time value larger than to the second argument). It
		376	will usually be called just before the callback will be triggered, but
		377	might be called at other times, too.
		378
		379	This can be used to create very complex timers, such as a timer that
		380	triggers on each midnight, local time (actually 24 hours after the last
		381	midnight, to keep the example simple. If you know a way to do it correctly
		382	in about the same space (without requiring elaborate modules), drop me a
		383	note :):
		384
		385	my $daily = EV::periodic 0, 0, sub {
		386	my ($w, $now) = @_;
		387
		388	use Time::Local ();
		389	my (undef, undef, undef, $d, $m, $y) = localtime $now;
		390	86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y
		391	}, sub {
		392	print "it's midnight or likely shortly after, now\n";
		393	};
		394
		395	=back
316		396
317	The C<periodic_ns> variant doesn't start (activate) the newly created watcher.	397	The C<periodic_ns> variant doesn't start (activate) the newly created watcher.
318		398
319	=item $w->set ($at, $interval)	399	=item $w->set ($at, $interval, $reschedule_cb)
320		400
321	Reconfigures the watcher, see the constructor above for details. Can be at	401	Reconfigures the watcher, see the constructor above for details. Can be at
322	any time.	402	any time.
		403
		404	=item $w->again
		405
		406	Simply stops and starts the watcher again.
323		407
324		408
325	=item $w = EV::signal $signal, $callback	409	=item $w = EV::signal $signal, $callback
326		410
327	=item $w = EV::signal_ns $signal, $callback	411	=item $w = EV::signal_ns $signal, $callback
…		…
432	# do nothing unless active	516	# do nothing unless active
433	$dispatcher->{_event_queue_h}	517	$dispatcher->{_event_queue_h}
434	or return;	518	or return;
435		519
436	# make the dispatcher handle any outstanding stuff	520	# make the dispatcher handle any outstanding stuff
		521	... not shown
437		522
438	# create an IO watcher for each and every socket	523	# create an IO watcher for each and every socket
439	@snmp_watcher = (	524	@snmp_watcher = (
440	(map { EV::io $_, EV::READ, sub { } }	525	(map { EV::io $_, EV::READ, sub { } }
441	keys %{ $dispatcher->{_descriptors} }),	526	keys %{ $dispatcher->{_descriptors} }),
		527
		528	EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]
		529	? $event->[Net::SNMP::Dispatcher::_TIME] - EV::now : 0),
		530	0, sub { },
442	);	531	);
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	};	532	};
448		533
449	The callbacks are irrelevant, the only purpose of those watchers is	534	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	535	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	536	one of those events occurs (socket readable, or timer timed out). The
452	clean up:	537	corresponding EV::check watcher will then clean up:
453		538
454	our $snmp_check = EV::check sub {	539	our $snmp_check = EV::check sub {
455	# destroy all watchers	540	# destroy all watchers
456	@snmp_watcher = ();	541	@snmp_watcher = ();
457		542
458	# make the dispatcher handle any new stuff	543	# make the dispatcher handle any new stuff
		544	... not shown
459	};	545	};
460		546
461	The callbacks of the created watchers will not be called as the watchers	547	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	548	are destroyed before this cna happen (remember EV::check gets called
463	first).	549	first).
…		…
466		552
467	=back	553	=back
468		554
469	=head1 THREADS	555	=head1 THREADS
470		556
471	Threads are not supported by this in any way. Perl pseudo-threads is evil	557	Threads are not supported by this module in any way. Perl pseudo-threads
472	stuff and must die.	558	is evil stuff and must die. As soon as Perl gains real threads I will work
		559	on thread support for it.
		560
		561	=head1 FORK
		562
		563	Most of the "improved" event delivering mechanisms of modern operating
		564	systems have quite a few problems with fork(2) (to put it bluntly: it is
		565	not supported and usually destructive). Libev makes it possible to work
		566	around this by having a function that recreates the kernel state after
		567	fork in the child.
		568
		569	On non-win32 platforms, this module requires the pthread_atfork
		570	functionality to do this automatically for you. This function is quite
		571	buggy on most BSDs, though, so YMMV. The overhead for this is quite
		572	negligible, because everything the function currently does is set a flag
		573	that is checked only when the event loop gets used the next time, so when
		574	you do fork but not use EV, the overhead is minimal.
		575
		576	On win32, there is no notion of fork so all this doesn't apply, of course.
473		577
474	=cut	578	=cut
475		579
476	our $DIED = sub {	580	our $DIED = sub {
477	warn "EV: error in callback (ignoring): $@";	581	warn "EV: error in callback (ignoring): $@";
478	};	582	};
479		583
480	default_loop	584	default_loop
481	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?';	585	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?';
482		586
483	push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"];
484
485	1;	587	1;
486		588
487	=head1 SEE ALSO	589	=head1 SEE ALSO
488		590
489	L<EV::DNS>, L<EV::AnyEvent>.	591	L<EV::DNS>.
490		592
491	=head1 AUTHOR	593	=head1 AUTHOR
492		594
493	Marc Lehmann <schmorp@schmorp.de>	595	Marc Lehmann <schmorp@schmorp.de>
494	http://home.schmorp.de/	596	http://home.schmorp.de/

Diff Legend

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

Comparing EV/EV.pm (file contents): Revision 1.28 by root, Sun Nov 4 16:52:52 2007 UTC vs. Revision 1.47 by root, Fri Nov 23 13:08:55 2007 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.28 by root, Sun Nov 4 16:52:52 2007 UTC vs.
Revision 1.47 by root, Fri Nov 23 13:08:55 2007 UTC