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

Comparing EV/EV.pm (file contents):
Revision 1.24 by root, Fri Nov 2 22:03:00 2007 UTC vs.
Revision 1.50 by root, Sat Nov 24 08:42:38 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	# CHILD/PID STATUS CHANGES
		39
38	my $w = EV::signal 3, sub {	40	my $w = EV::child 666, sub {
39	warn "sigquit received (this is GNU/Linux, right?)\n";	41	my ($w, $revents) = @_;
		42	my $status = $w->rstatus;
40	};	43	};
41
42	# CHILD/PID STATUS CHANGES
43
44	my $w = EV::child 666, sub {
45	my ($w, $revents, $status) = @_;
46	};
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.1';	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
…		…
201	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
202	priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default	234	priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default
203	-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
204	normalised to the nearest valid priority.	236	normalised to the nearest valid priority.
205		237
206	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.
207		242
208	=item $w->trigger ($revents)	243	=item $w->trigger ($revents)
209		244
210	Call the callback now with the given event mask.	245	Call the callback now with the given event mask.
211		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);
212		274
213	=item $w = EV::io $fileno_or_fh, $eventmask, $callback	275	=item $w = EV::io $fileno_or_fh, $eventmask, $callback
214		276
215	=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback	277	=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
216		278
…		…
249	Calls the callback after C<$after> seconds. If C<$repeat> is non-zero,	311	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	312	the timer will be restarted (with the $repeat value as $after) after the
251	callback returns.	313	callback returns.
252		314
253	This means that the callback would be called roughly after C<$after>	315	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	316	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	317	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.	318	loop iteration, and might drift in other cases. If that isn't acceptable,
		319	look at EV::periodic, which can provide long-term stable timers.
257		320
258	The timer is based on a monotonic clock, that is if somebody is sitting	321	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	322	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.	323	clock, the timer will nevertheless run (roughly) the same time.
261		324
262	The C<timer_ns> variant doesn't start (activate) the newly created watcher.	325	The C<timer_ns> variant doesn't start (activate) the newly created watcher.
263		326
…		…
268		331
269	=item $w->again	332	=item $w->again
270		333
271	Similar to the C<start> method, but has special semantics for repeating timers:	334	Similar to the C<start> method, but has special semantics for repeating timers:
272		335
		336	If the timer is active and non-repeating, it will be stopped.
		337
273	If the timer is active and repeating, reset the timeout to occur	338	If the timer is active and repeating, reset the timeout to occur
274	C<$repeat> seconds after now.	339	C<$repeat> seconds after now.
275		340
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.	341	If the timer is inactive and repeating, start it using the repeat value.
279		342
280	Otherwise do nothing.	343	Otherwise do nothing.
281		344
282	This behaviour is useful when you have a timeout for some IO	345	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	346	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	347	C<$repeat>, and then, in the read/write watcher, run the C<again> method
285	on the timeout.	348	on the timeout.
286		349
287		350
288	=item $w = EV::periodic $at, $interval, $callback	351	=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
289		352
290	=item $w = EV::periodic_ns $at, $interval, $callback	353	=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
291		354
292	Similar to EV::timer, but the time is given as an absolute point in time	355	Similar to EV::timer, but is not based on relative timeouts but on
293	(C<$at>), plus an optional C<$interval>.	356	absolute times. Apart from creating "simple" timers that trigger "at" the
		357	specified time, it can also be used for non-drifting absolute timers and
		358	more complex, cron-like, setups that are not adversely affected by time
		359	jumps (i.e. when the system clock is changed by explicit date -s or other
		360	means such as ntpd). It is also the most complex watcher type in EV.
294		361
295	If the C<$interval> is zero, then the callback will be called at the time	362	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		363
299	If the C<$interval> is nonzero, then the watcher will always be scheduled	364	=over 4
300	to time out at the next C<$at + N * $interval> time.
301		365
302	This can be used to schedule a callback to run at very regular intervals,	366	=item * absolute timer ($interval = $reschedule_cb = 0)
303	as long as the processing time is less then the interval (otherwise	367
304	obviously events will be skipped).	368	This time simply fires at the wallclock time C<$at> and doesn't repeat. It
		369	will not adjust when a time jump occurs, that is, if it is to be run
		370	at January 1st 2011 then it will run when the system time reaches or
		371	surpasses this time.
		372
		373	=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0)
		374
		375	In this mode the watcher will always be scheduled to time out at the
		376	next C<$at + N * $interval> time (for some integer N) and then repeat,
		377	regardless of any time jumps.
		378
		379	This can be used to create timers that do not drift with respect to system
		380	time:
		381
		382	my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
		383
		384	That doesn't mean there will always be 3600 seconds in between triggers,
		385	but only that the the clalback will be called when the system time shows a
		386	full hour (UTC).
305		387
306	Another way to think about it (for the mathematically inclined) is that	388	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	389	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.	390	possible time where C<$time = $at (mod $interval)>, regardless of any time
		391	jumps.
309		392
310	This periodic timer is based on "wallclock time", that is, if the clock	393	=item * manual reschedule mode ($reschedule_cb = coderef)
311	changes (C<ntp>, C<date -s> etc.), then the timer will nevertheless run at	394
312	the specified time. This means it will never drift (it might jitter, but	395	In this mode $interval and $at are both being ignored. Instead, each
313	it will not drift).	396	time the periodic watcher gets scheduled, the reschedule callback
		397	($reschedule_cb) will be called with the watcher as first, and the current
		398	time as second argument.
		399
		400	I<This callback MUST NOT stop or destroy this or any other periodic
		401	watcher, ever>. If you need to stop it, return 1e30 and stop it
		402	afterwards.
		403
		404	It must return the next time to trigger, based on the passed time value
		405	(that is, the lowest time value larger than to the second argument). It
		406	will usually be called just before the callback will be triggered, but
		407	might be called at other times, too.
		408
		409	This can be used to create very complex timers, such as a timer that
		410	triggers on each midnight, local time (actually 24 hours after the last
		411	midnight, to keep the example simple. If you know a way to do it correctly
		412	in about the same space (without requiring elaborate modules), drop me a
		413	note :):
		414
		415	my $daily = EV::periodic 0, 0, sub {
		416	my ($w, $now) = @_;
		417
		418	use Time::Local ();
		419	my (undef, undef, undef, $d, $m, $y) = localtime $now;
		420	86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y
		421	}, sub {
		422	print "it's midnight or likely shortly after, now\n";
		423	};
		424
		425	=back
314		426
315	The C<periodic_ns> variant doesn't start (activate) the newly created watcher.	427	The C<periodic_ns> variant doesn't start (activate) the newly created watcher.
316		428
317	=item $w->set ($at, $interval)	429	=item $w->set ($at, $interval, $reschedule_cb)
318		430
319	Reconfigures the watcher, see the constructor above for details. Can be at	431	Reconfigures the watcher, see the constructor above for details. Can be at
320	any time.	432	any time.
		433
		434	=item $w->again
		435
		436	Simply stops and starts the watcher again.
321		437
322		438
323	=item $w = EV::signal $signal, $callback	439	=item $w = EV::signal $signal, $callback
324		440
325	=item $w = EV::signal_ns $signal, $callback	441	=item $w = EV::signal_ns $signal, $callback
…		…
356	Call the callback when a status change for pid C<$pid> (or any pid	472	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	473	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	474	receives a SIGCHLD, EV will fetch the outstanding exit/wait status for all
359	changed/zombie children and call the callback.	475	changed/zombie children and call the callback.
360		476
361	Unlike all other callbacks, this callback will be called with an	477	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>	478	methods on the watcher object.
363	function for details.
364		479
365	You can have as many pid watchers per pid as you want.	480	You can have as many pid watchers per pid as you want.
366		481
367	The C<child_ns> variant doesn't start (activate) the newly created watcher.	482	The C<child_ns> variant doesn't start (activate) the newly created watcher.
368		483
…		…
374	=item $current_pid = $w->pid	489	=item $current_pid = $w->pid
375		490
376	=item $old_pid = $w->pid ($new_pid)	491	=item $old_pid = $w->pid ($new_pid)
377		492
378	Returns the previously set process id and optionally set a new one.	493	Returns the previously set process id and optionally set a new one.
		494
		495	=item $exit_status = $w->rstatus
		496
		497	Return the exit/wait status (as returned by waitpid, see the waitpid entry
		498	in perlfunc).
		499
		500	=item $pid = $w->rpid
		501
		502	Return the pid of the awaited child (useful when you have installed a
		503	watcher for all pids).
379		504
380		505
381	=item $w = EV::idle $callback	506	=item $w = EV::idle $callback
382		507
383	=item $w = EV::idle_ns $callback	508	=item $w = EV::idle_ns $callback
…		…
421	# do nothing unless active	546	# do nothing unless active
422	$dispatcher->{_event_queue_h}	547	$dispatcher->{_event_queue_h}
423	or return;	548	or return;
424		549
425	# make the dispatcher handle any outstanding stuff	550	# make the dispatcher handle any outstanding stuff
		551	... not shown
426		552
427	# create an IO watcher for each and every socket	553	# create an IO watcher for each and every socket
428	@snmp_watcher = (	554	@snmp_watcher = (
429	(map { EV::io $_, EV::READ, sub { } }	555	(map { EV::io $_, EV::READ, sub { } }
430	keys %{ $dispatcher->{_descriptors} }),	556	keys %{ $dispatcher->{_descriptors} }),
		557
		558	EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]
		559	? $event->[Net::SNMP::Dispatcher::_TIME] - EV::now : 0),
		560	0, sub { },
431	);	561	);
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	};	562	};
437		563
438	The callbacks are irrelevant, the only purpose of those watchers is	564	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	565	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	566	one of those events occurs (socket readable, or timer timed out). The
441	clean up:	567	corresponding EV::check watcher will then clean up:
442		568
443	our $snmp_check = EV::check sub {	569	our $snmp_check = EV::check sub {
444	# destroy all watchers	570	# destroy all watchers
445	@snmp_watcher = ();	571	@snmp_watcher = ();
446		572
447	# make the dispatcher handle any new stuff	573	# make the dispatcher handle any new stuff
		574	... not shown
448	};	575	};
449		576
450	The callbacks of the created watchers will not be called as the watchers	577	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	578	are destroyed before this cna happen (remember EV::check gets called
452	first).	579	first).
…		…
455		582
456	=back	583	=back
457		584
458	=head1 THREADS	585	=head1 THREADS
459		586
460	Threads are not supported by this in any way. Perl pseudo-threads is evil	587	Threads are not supported by this module in any way. Perl pseudo-threads
461	stuff and must die.	588	is evil stuff and must die. As soon as Perl gains real threads I will work
		589	on thread support for it.
		590
		591	=head1 FORK
		592
		593	Most of the "improved" event delivering mechanisms of modern operating
		594	systems have quite a few problems with fork(2) (to put it bluntly: it is
		595	not supported and usually destructive). Libev makes it possible to work
		596	around this by having a function that recreates the kernel state after
		597	fork in the child.
		598
		599	On non-win32 platforms, this module requires the pthread_atfork
		600	functionality to do this automatically for you. This function is quite
		601	buggy on most BSDs, though, so YMMV. The overhead for this is quite
		602	negligible, because everything the function currently does is set a flag
		603	that is checked only when the event loop gets used the next time, so when
		604	you do fork but not use EV, the overhead is minimal.
		605
		606	On win32, there is no notion of fork so all this doesn't apply, of course.
462		607
463	=cut	608	=cut
464		609
465	our $DIED = sub {	610	our $DIED = sub {
466	warn "EV: error in callback (ignoring): $@";	611	warn "EV: error in callback (ignoring): $@";
467	};	612	};
468		613
469	init;	614	default_loop
470		615	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?';
471	push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"];
472		616
473	1;	617	1;
474		618
475	=head1 SEE ALSO	619	=head1 SEE ALSO
476		620
477	L<EV::DNS>, L<EV::AnyEvent>.	621	L<EV::DNS>.
478		622
479	=head1 AUTHOR	623	=head1 AUTHOR
480		624
481	Marc Lehmann <schmorp@schmorp.de>	625	Marc Lehmann <schmorp@schmorp.de>
482	http://home.schmorp.de/	626	http://home.schmorp.de/

Diff Legend

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

Comparing EV/EV.pm (file contents): Revision 1.24 by root, Fri Nov 2 22:03:00 2007 UTC vs. Revision 1.50 by root, Sat Nov 24 08:42:38 2007 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.24 by root, Fri Nov 2 22:03:00 2007 UTC vs.
Revision 1.50 by root, Sat Nov 24 08:42:38 2007 UTC