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

Comparing EV/EV.pm (file contents):
Revision 1.25 by root, Fri Nov 2 22:18:49 2007 UTC vs.
Revision 1.49 by root, Sat Nov 24 08:28:10 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, $status) = @_;	41	my ($w, $revents) = @_;
		42	my $status = $w->rstatus;
46	};	43	};
47		44
48	# MAINLOOP	45	# MAINLOOP
49	EV::loop; # loop until EV::loop_done is called	46	EV::loop; # loop until EV::unloop is called or all watchers stop
50	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
51	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
52		49
53	=head1 DESCRIPTION	50	=head1 DESCRIPTION
54		51
…		…
60	package EV;	57	package EV;
61		58
62	use strict;	59	use strict;
63		60
64	BEGIN {	61	BEGIN {
65	our $VERSION = '0.5';	62	our $VERSION = '1.2';
66	use XSLoader;	63	use XSLoader;
67	XSLoader::load "EV", $VERSION;	64	XSLoader::load "EV", $VERSION;
68	}	65	}
69		66
70	@EV::Io::ISA =	67	@EV::IO::ISA =
71	@EV::Timer::ISA =	68	@EV::Timer::ISA =
72	@EV::Periodic::ISA =	69	@EV::Periodic::ISA =
73	@EV::Signal::ISA =	70	@EV::Signal::ISA =
74	@EV::Idle::ISA =	71	@EV::Idle::ISA =
75	@EV::Prepare::ISA =	72	@EV::Prepare::ISA =
…		…
96		93
97	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
98	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
99	usually faster then calling EV::time.	96	usually faster then calling EV::time.
100		97
101	=item $method = EV::ev_method	98	=item $method = EV::method
102		99
103	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
104	or EV::METHOD_EPOLL).	101	or EV::METHOD_EPOLL).
105		102
106	=item EV::loop [$flags]	103	=item EV::loop [$flags]
107		104
108	Begin checking for events and calling callbacks. It returns when a	105	Begin checking for events and calling callbacks. It returns when a
109	callback calls EV::loop_done.	106	callback calls EV::unloop.
110		107
111	The $flags argument can be one of the following:	108	The $flags argument can be one of the following:
112		109
113	0 as above	110	0 as above
114	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)
115	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)
116		113
117	=item EV::loop_done [$how]	114	=item EV::unloop [$how]
118		115
119	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
120	call to EV::loop return.	117	innermost call to EV::loop return.
121		118
122	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
123	fast as possible.	120	fast as possible.
		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.
124		144
125	=back	145	=back
126		146
127	=head2 WATCHER	147	=head2 WATCHER
128		148
…		…
184		204
185	=item $bool = $w->is_active	205	=item $bool = $w->is_active
186		206
187	Returns true if the watcher is active, false otherwise.	207	Returns true if the watcher is active, false otherwise.
188		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
189	=item $current_cb = $w->cb	221	=item $current_cb = $w->cb
190		222
191	=item $old_cb = $w->cb ($new_cb)	223	=item $old_cb = $w->cb ($new_cb)
192		224
193	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
…		…
249	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,
250	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
251	callback returns.	283	callback returns.
252		284
253	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>
254	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
255	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
256	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.
257		290
258	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
259	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
260	clock, the timer will nevertheless run (roughly) the same time.	293	clock, the timer will nevertheless run (roughly) the same time.
261		294
262	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.
263		296
…		…
268		301
269	=item $w->again	302	=item $w->again
270		303
271	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:
272		305
		306	If the timer is active and non-repeating, it will be stopped.
		307
273	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
274	C<$repeat> seconds after now.	309	C<$repeat> seconds after now.
275		310
276	If the timer is active and non-repeating, it will be stopped.
277
278	If the timer is in active and repeating, start it.	311	If the timer is inactive and repeating, start it using the repeat value.
279		312
280	Otherwise do nothing.	313	Otherwise do nothing.
281		314
282	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
283	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
284	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
285	on the timeout.	318	on the timeout.
286		319
287		320
288	=item $w = EV::periodic $at, $interval, $callback	321	=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
289		322
290	=item $w = EV::periodic_ns $at, $interval, $callback	323	=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
291		324
292	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
293	(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.
294		331
295	If the C<$interval> is zero, then the callback will be called at the time	332	It has three distinct "modes":
296	C<$at> if that is in the future, or as soon as possible if it is in the
297	past. It will not automatically repeat.
298		333
299	If the C<$interval> is nonzero, then the watcher will always be scheduled	334	=over 4
300	to time out at the next C<$at + N * $interval> time.
301		335
302	This can be used to schedule a callback to run at very regular intervals,	336	=item * absolute timer ($interval = $reschedule_cb = 0)
303	as long as the processing time is less then the interval (otherwise	337
304	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).
305		357
306	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
307	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
308	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.
309		362
310	This periodic timer is based on "wallclock time", that is, if the clock	363	=item * manual reschedule mode ($reschedule_cb = coderef)
311	changes (C<ntp>, C<date -s> etc.), then the timer will nevertheless run at	364
312	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
313	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
314		396
315	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.
316		398
317	=item $w->set ($at, $interval)	399	=item $w->set ($at, $interval, $reschedule_cb)
318		400
319	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
320	any time.	402	any time.
		403
		404	=item $w->again
		405
		406	Simply stops and starts the watcher again.
321		407
322		408
323	=item $w = EV::signal $signal, $callback	409	=item $w = EV::signal $signal, $callback
324		410
325	=item $w = EV::signal_ns $signal, $callback	411	=item $w = EV::signal_ns $signal, $callback
…		…
356	Call the callback when a status change for pid C<$pid> (or any pid	442	Call the callback when a status change for pid C<$pid> (or any pid
357	if C<$pid> is 0) has been received. More precisely: when the process	443	if C<$pid> is 0) has been received. More precisely: when the process
358	receives a SIGCHLD, EV will fetch the outstanding exit/wait status for all	444	receives a SIGCHLD, EV will fetch the outstanding exit/wait status for all
359	changed/zombie children and call the callback.	445	changed/zombie children and call the callback.
360		446
361	Unlike all other callbacks, this callback will be called with an	447	You can access both status and pid by using the C<rstatus> and C<rpid>
362	additional third argument which is the exit status. See the C<waitpid>	448	methods on the watcher object.
363	function for details.
364		449
365	You can have as many pid watchers per pid as you want.	450	You can have as many pid watchers per pid as you want.
366		451
367	The C<child_ns> variant doesn't start (activate) the newly created watcher.	452	The C<child_ns> variant doesn't start (activate) the newly created watcher.
368		453
…		…
374	=item $current_pid = $w->pid	459	=item $current_pid = $w->pid
375		460
376	=item $old_pid = $w->pid ($new_pid)	461	=item $old_pid = $w->pid ($new_pid)
377		462
378	Returns the previously set process id and optionally set a new one.	463	Returns the previously set process id and optionally set a new one.
		464
		465	=item $exit_status = $w->rstatus
		466
		467	Return the exit/wait status (as returned by waitpid, see the waitpid entry
		468	in perlfunc).
		469
		470	=item $pid = $w->rpid
		471
		472	Return the pid of the awaited child (useful when you have installed a
		473	watcher for all pids).
379		474
380		475
381	=item $w = EV::idle $callback	476	=item $w = EV::idle $callback
382		477
383	=item $w = EV::idle_ns $callback	478	=item $w = EV::idle_ns $callback
…		…
421	# do nothing unless active	516	# do nothing unless active
422	$dispatcher->{_event_queue_h}	517	$dispatcher->{_event_queue_h}
423	or return;	518	or return;
424		519
425	# make the dispatcher handle any outstanding stuff	520	# make the dispatcher handle any outstanding stuff
		521	... not shown
426		522
427	# create an IO watcher for each and every socket	523	# create an IO watcher for each and every socket
428	@snmp_watcher = (	524	@snmp_watcher = (
429	(map { EV::io $_, EV::READ, sub { } }	525	(map { EV::io $_, EV::READ, sub { } }
430	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 { },
431	);	531	);
432
433	# if there are any timeouts, also create a timer
434	push @snmp_watcher, EV::timer $event->[Net::SNMP::Dispatcher::_TIME] - EV::now, 0, sub { }
435	if $event->[Net::SNMP::Dispatcher::_ACTIVE];
436	};	532	};
437		533
438	The callbacks are irrelevant, the only purpose of those watchers is	534	The callbacks are irrelevant (and are not even being called), the
439	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
440	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
441	clean up:	537	corresponding EV::check watcher will then clean up:
442		538
443	our $snmp_check = EV::check sub {	539	our $snmp_check = EV::check sub {
444	# destroy all watchers	540	# destroy all watchers
445	@snmp_watcher = ();	541	@snmp_watcher = ();
446		542
447	# make the dispatcher handle any new stuff	543	# make the dispatcher handle any new stuff
		544	... not shown
448	};	545	};
449		546
450	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
451	are destroyed before this cna happen (remember EV::check gets called	548	are destroyed before this cna happen (remember EV::check gets called
452	first).	549	first).
…		…
455		552
456	=back	553	=back
457		554
458	=head1 THREADS	555	=head1 THREADS
459		556
460	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
461	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.
462		577
463	=cut	578	=cut
464		579
465	our $DIED = sub {	580	our $DIED = sub {
466	warn "EV: error in callback (ignoring): $@";	581	warn "EV: error in callback (ignoring): $@";
467	};	582	};
468		583
469	init;	584	default_loop
470		585	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?';
471	push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"];
472		586
473	1;	587	1;
474		588
475	=head1 SEE ALSO	589	=head1 SEE ALSO
476		590
477	L<EV::DNS>, L<EV::AnyEvent>.	591	L<EV::DNS>.
478		592
479	=head1 AUTHOR	593	=head1 AUTHOR
480		594
481	Marc Lehmann <schmorp@schmorp.de>	595	Marc Lehmann <schmorp@schmorp.de>
482	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.25 by root, Fri Nov 2 22:18:49 2007 UTC vs. Revision 1.49 by root, Sat Nov 24 08:28:10 2007 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.25 by root, Fri Nov 2 22:18:49 2007 UTC vs.
Revision 1.49 by root, Sat Nov 24 08:28:10 2007 UTC