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

Comparing EV/EV.pm (file contents):
Revision 1.21 by root, Thu Nov 1 17:20:25 2007 UTC vs.
Revision 1.46 by root, Fri Nov 23 05:00:44 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.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 =
…		…
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.
124		121
125	=back	122	=back
126		123
127	=head2 WATCHER	124	=head2 WATCHER
…		…
150	In the rare case where one wants to create a watcher but not start it at	147	In the rare case where one wants to create a watcher but not start it at
151	the same time, each constructor has a variant with a trailing C<_ns> in	148	the same time, each constructor has a variant with a trailing C<_ns> in
152	its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.	149	its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.
153		150
154	Please note that a watcher will automatically be stopped when the watcher	151	Please note that a watcher will automatically be stopped when the watcher
155	object is returned, so you I<need> to keep the watcher objects returned by	152	object is destroyed, so you I<need> to keep the watcher objects returned by
156	the constructors.	153	the constructors.
		154
		155	Also, all methods changing some aspect of a watcher (->set, ->priority,
		156	->fh and so on) automatically stop and start it again if it is active,
		157	which means pending events get lost.
157		158
158	=head2 WATCHER TYPES	159	=head2 WATCHER TYPES
159		160
160	Now lets move to the existing watcher types and asociated methods.	161	Now lets move to the existing watcher types and asociated methods.
161		162
…		…
180		181
181	=item $bool = $w->is_active	182	=item $bool = $w->is_active
182		183
183	Returns true if the watcher is active, false otherwise.	184	Returns true if the watcher is active, false otherwise.
184		185
		186	=item $current_data = $w->data
		187
		188	=item $old_data = $w->data ($new_data)
		189
		190	Queries a freely usable data scalar on the watcher and optionally changes
		191	it. This is a way to associate custom data with a watcher:
		192
		193	my $w = EV::timer 60, 0, sub {
		194	warn $_[0]->data;
		195	};
		196	$w->data ("print me!");
		197
185	=item $current_cb = $w->cb	198	=item $current_cb = $w->cb
186		199
187	=item $old_cb = $w->cb ($new_cb)	200	=item $old_cb = $w->cb ($new_cb)
188		201
189	Queries the callback on the watcher and optionally changes it. You cna do	202	Queries the callback on the watcher and optionally changes it. You can do
190	this at any time.	203	this at any time without the watcher restarting.
		204
		205	=item $current_priority = $w->priority
		206
		207	=item $old_priority = $w->priority ($new_priority)
		208
		209	Queries the priority on the watcher and optionally changes it. Pending
		210	watchers with higher priority will be invoked first. The valid range of
		211	priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default
		212	-2). If the priority is outside this range it will automatically be
		213	normalised to the nearest valid priority.
		214
		215	The default priority of any newly-created weatcher is 0.
191		216
192	=item $w->trigger ($revents)	217	=item $w->trigger ($revents)
193		218
194	Call the callback now with the given event mask.	219	Call the callback now with the given event mask.
195		220
…		…
233	Calls the callback after C<$after> seconds. If C<$repeat> is non-zero,	258	Calls the callback after C<$after> seconds. If C<$repeat> is non-zero,
234	the timer will be restarted (with the $repeat value as $after) after the	259	the timer will be restarted (with the $repeat value as $after) after the
235	callback returns.	260	callback returns.
236		261
237	This means that the callback would be called roughly after C<$after>	262	This means that the callback would be called roughly after C<$after>
238	seconds, and then every C<$repeat> seconds. "Roughly" because the time of	263	seconds, and then every C<$repeat> seconds. The timer does his best not
239	callback processing is not taken into account, so the timer will slowly	264	to drift, but it will not invoke the timer more often then once per event
240	drift. If that isn't acceptable, look at EV::periodic.	265	loop iteration, and might drift in other cases. If that isn't acceptable,
		266	look at EV::periodic, which can provide long-term stable timers.
241		267
242	The timer is based on a monotonic clock, that is if somebody is sitting	268	The timer is based on a monotonic clock, that is, if somebody is sitting
243	in front of the machine while the timer is running and changes the system	269	in front of the machine while the timer is running and changes the system
244	clock, the timer will nevertheless run (roughly) the same time.	270	clock, the timer will nevertheless run (roughly) the same time.
245		271
246	The C<timer_ns> variant doesn't start (activate) the newly created watcher.	272	The C<timer_ns> variant doesn't start (activate) the newly created watcher.
247		273
…		…
252		278
253	=item $w->again	279	=item $w->again
254		280
255	Similar to the C<start> method, but has special semantics for repeating timers:	281	Similar to the C<start> method, but has special semantics for repeating timers:
256		282
		283	If the timer is active and non-repeating, it will be stopped.
		284
257	If the timer is active and repeating, reset the timeout to occur	285	If the timer is active and repeating, reset the timeout to occur
258	C<$repeat> seconds after now.	286	C<$repeat> seconds after now.
259		287
260	If the timer is active and non-repeating, it will be stopped.
261
262	If the timer is in active and repeating, start it.	288	If the timer is inactive and repeating, start it using the repeat value.
263		289
264	Otherwise do nothing.	290	Otherwise do nothing.
265		291
266	This behaviour is useful when you have a timeout for some IO	292	This behaviour is useful when you have a timeout for some IO
267	operation. You create a timer object with the same value for C<$after> and	293	operation. You create a timer object with the same value for C<$after> and
268	C<$repeat>, and then, in the read/write watcher, run the C<again> method	294	C<$repeat>, and then, in the read/write watcher, run the C<again> method
269	on the timeout.	295	on the timeout.
270		296
271		297
272	=item $w = EV::periodic $at, $interval, $callback	298	=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
273		299
274	=item $w = EV::periodic_ns $at, $interval, $callback	300	=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
275		301
276	Similar to EV::timer, but the time is given as an absolute point in time	302	Similar to EV::timer, but is not based on relative timeouts but on
277	(C<$at>), plus an optional C<$interval>.	303	absolute times. Apart from creating "simple" timers that trigger "at" the
		304	specified time, it can also be used for non-drifting absolute timers and
		305	more complex, cron-like, setups that are not adversely affected by time
		306	jumps (i.e. when the system clock is changed by explicit date -s or other
		307	means such as ntpd). It is also the most complex watcher type in EV.
278		308
279	If the C<$interval> is zero, then the callback will be called at the time	309	It has three distinct "modes":
280	C<$at> if that is in the future, or as soon as possible if it is in the
281	past. It will not automatically repeat.
282		310
283	If the C<$interval> is nonzero, then the watcher will always be scheduled	311	=over 4
284	to time out at the next C<$at + N * $interval> time.
285		312
286	This can be used to schedule a callback to run at very regular intervals,	313	=item * absolute timer ($interval = $reschedule_cb = 0)
287	as long as the processing time is less then the interval (otherwise	314
288	obviously events will be skipped).	315	This time simply fires at the wallclock time C<$at> and doesn't repeat. It
		316	will not adjust when a time jump occurs, that is, if it is to be run
		317	at January 1st 2011 then it will run when the system time reaches or
		318	surpasses this time.
		319
		320	=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0)
		321
		322	In this mode the watcher will always be scheduled to time out at the
		323	next C<$at + N * $interval> time (for some integer N) and then repeat,
		324	regardless of any time jumps.
		325
		326	This can be used to create timers that do not drift with respect to system
		327	time:
		328
		329	my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
		330
		331	That doesn't mean there will always be 3600 seconds in between triggers,
		332	but only that the the clalback will be called when the system time shows a
		333	full hour (UTC).
289		334
290	Another way to think about it (for the mathematically inclined) is that	335	Another way to think about it (for the mathematically inclined) is that
291	EV::periodic will try to run the callback at the next possible time where	336	EV::periodic will try to run the callback in this mode at the next
292	C<$time = $at (mod $interval)>, regardless of any time jumps.	337	possible time where C<$time = $at (mod $interval)>, regardless of any time
		338	jumps.
293		339
294	This periodic timer is based on "wallclock time", that is, if the clock	340	=item * manual reschedule mode ($reschedule_cb = coderef)
295	changes (C<ntp>, C<date -s> etc.), then the timer will nevertheless run at	341
296	the specified time. This means it will never drift (it might jitter, but	342	In this mode $interval and $at are both being ignored. Instead, each
297	it will not drift).	343	time the periodic watcher gets scheduled, the reschedule callback
		344	($reschedule_cb) will be called with the watcher as first, and the current
		345	time as second argument.
		346
		347	I<This callback MUST NOT stop or destroy this or any other periodic
		348	watcher, ever>. If you need to stop it, return 1e30 and stop it
		349	afterwards.
		350
		351	It must return the next time to trigger, based on the passed time value
		352	(that is, the lowest time value larger than to the second argument). It
		353	will usually be called just before the callback will be triggered, but
		354	might be called at other times, too.
		355
		356	This can be used to create very complex timers, such as a timer that
		357	triggers on each midnight, local time (actually 24 hours after the last
		358	midnight, to keep the example simple. If you know a way to do it correctly
		359	in about the same space (without requiring elaborate modules), drop me a
		360	note :):
		361
		362	my $daily = EV::periodic 0, 0, sub {
		363	my ($w, $now) = @_;
		364
		365	use Time::Local ();
		366	my (undef, undef, undef, $d, $m, $y) = localtime $now;
		367	86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y
		368	}, sub {
		369	print "it's midnight or likely shortly after, now\n";
		370	};
		371
		372	=back
298		373
299	The C<periodic_ns> variant doesn't start (activate) the newly created watcher.	374	The C<periodic_ns> variant doesn't start (activate) the newly created watcher.
300		375
301	=item $w->set ($at, $interval)	376	=item $w->set ($at, $interval, $reschedule_cb)
302		377
303	Reconfigures the watcher, see the constructor above for details. Can be at	378	Reconfigures the watcher, see the constructor above for details. Can be at
304	any time.	379	any time.
		380
		381	=item $w->again
		382
		383	Simply stops and starts the watcher again.
305		384
306		385
307	=item $w = EV::signal $signal, $callback	386	=item $w = EV::signal $signal, $callback
308		387
309	=item $w = EV::signal_ns $signal, $callback	388	=item $w = EV::signal_ns $signal, $callback
…		…
323	=item $w->set ($signal)	402	=item $w->set ($signal)
324		403
325	Reconfigures the watcher, see the constructor above for details. Can be at	404	Reconfigures the watcher, see the constructor above for details. Can be at
326	any time.	405	any time.
327		406
		407	=item $current_signum = $w->signal
		408
		409	=item $old_signum = $w->signal ($new_signal)
		410
		411	Returns the previously set signal (always as a number not name) and
		412	optionally set a new one.
		413
328		414
329	=item $w = EV::child $pid, $callback	415	=item $w = EV::child $pid, $callback
330		416
331	=item $w = EV::child_ns $pid, $callback	417	=item $w = EV::child_ns $pid, $callback
332		418
333	Call the callback when a status change for pid C<$pid> (or any pid	419	Call the callback when a status change for pid C<$pid> (or any pid
334	if C<$pid> is 0) has been received. More precisely: when the process	420	if C<$pid> is 0) has been received. More precisely: when the process
335	receives a SIGCHLD, EV will fetch the outstanding exit/wait status for all	421	receives a SIGCHLD, EV will fetch the outstanding exit/wait status for all
336	changed/zombie children and call the callback.	422	changed/zombie children and call the callback.
337		423
338	Unlike all other callbacks, this callback will be called with an	424	You can access both status and pid by using the C<rstatus> and C<rpid>
339	additional third argument which is the exit status. See the C<waitpid>	425	methods on the watcher object.
340	function for details.
341		426
342	You can have as many pid watchers per pid as you want.	427	You can have as many pid watchers per pid as you want.
343		428
344	The C<child_ns> variant doesn't start (activate) the newly created watcher.	429	The C<child_ns> variant doesn't start (activate) the newly created watcher.
345		430
346	=item $w->set ($pid)	431	=item $w->set ($pid)
347		432
348	Reconfigures the watcher, see the constructor above for details. Can be at	433	Reconfigures the watcher, see the constructor above for details. Can be at
349	any time.	434	any time.
		435
		436	=item $current_pid = $w->pid
		437
		438	=item $old_pid = $w->pid ($new_pid)
		439
		440	Returns the previously set process id and optionally set a new one.
		441
		442	=item $exit_status = $w->rstatus
		443
		444	Return the exit/wait status (as returned by waitpid, see the waitpid entry
		445	in perlfunc).
		446
		447	=item $pid = $w->rpid
		448
		449	Return the pid of the awaited child (useful when you have installed a
		450	watcher for all pids).
350		451
351		452
352	=item $w = EV::idle $callback	453	=item $w = EV::idle $callback
353		454
354	=item $w = EV::idle_ns $callback	455	=item $w = EV::idle_ns $callback
…		…
392	# do nothing unless active	493	# do nothing unless active
393	$dispatcher->{_event_queue_h}	494	$dispatcher->{_event_queue_h}
394	or return;	495	or return;
395		496
396	# make the dispatcher handle any outstanding stuff	497	# make the dispatcher handle any outstanding stuff
		498	... not shown
397		499
398	# create an IO watcher for each and every socket	500	# create an IO watcher for each and every socket
399	@snmp_watcher = (	501	@snmp_watcher = (
400	(map { EV::io $_, EV::READ, sub { } }	502	(map { EV::io $_, EV::READ, sub { } }
401	keys %{ $dispatcher->{_descriptors} }),	503	keys %{ $dispatcher->{_descriptors} }),
		504
		505	EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]
		506	? $event->[Net::SNMP::Dispatcher::_TIME] - EV::now : 0),
		507	0, sub { },
402	);	508	);
403
404	# if there are any timeouts, also create a timer
405	push @snmp_watcher, EV::timer $event->[Net::SNMP::Dispatcher::_TIME] - EV::now, 0, sub { }
406	if $event->[Net::SNMP::Dispatcher::_ACTIVE];
407	};	509	};
408		510
409	The callbacks are irrelevant, the only purpose of those watchers is	511	The callbacks are irrelevant (and are not even being called), the
410	to wake up the process as soon as one of those events occurs (socket	512	only purpose of those watchers is to wake up the process as soon as
411	readable, or timer timed out). The corresponding EV::check watcher will then	513	one of those events occurs (socket readable, or timer timed out). The
412	clean up:	514	corresponding EV::check watcher will then clean up:
413		515
414	our $snmp_check = EV::check sub {	516	our $snmp_check = EV::check sub {
415	# destroy all watchers	517	# destroy all watchers
416	@snmp_watcher = ();	518	@snmp_watcher = ();
417		519
418	# make the dispatcher handle any new stuff	520	# make the dispatcher handle any new stuff
		521	... not shown
419	};	522	};
420		523
421	The callbacks of the created watchers will not be called as the watchers	524	The callbacks of the created watchers will not be called as the watchers
422	are destroyed before this cna happen (remember EV::check gets called	525	are destroyed before this cna happen (remember EV::check gets called
423	first).	526	first).
…		…
426		529
427	=back	530	=back
428		531
429	=head1 THREADS	532	=head1 THREADS
430		533
431	Threads are not supported by this in any way. Perl pseudo-threads is evil	534	Threads are not supported by this module in any way. Perl pseudo-threads
432	stuff and must die.	535	is evil stuff and must die. As soon as Perl gains real threads I will work
		536	on thread support for it.
		537
		538	=head1 FORK
		539
		540	Most of the "improved" event delivering mechanisms of modern operating
		541	systems have quite a few problems with fork(2) (to put it bluntly: it is
		542	not supported and usually destructive). Libev makes it possible to work
		543	around this by having a function that recreates the kernel state after
		544	fork in the child.
		545
		546	On non-win32 platforms, this module requires the pthread_atfork
		547	functionality to do this automatically for you. This function is quite
		548	buggy on most BSDs, though, so YMMV. The overhead for this is quite
		549	negligible, because everything the function currently does is set a flag
		550	that is checked only when the event loop gets used the next time, so when
		551	you do fork but not use EV, the overhead is minimal.
		552
		553	On win32, there is no notion of fork so all this doesn't apply, of course.
433		554
434	=cut	555	=cut
435		556
436	our $DIED = sub {	557	our $DIED = sub {
437	warn "EV: error in callback (ignoring): $@";	558	warn "EV: error in callback (ignoring): $@";
438	};	559	};
439		560
440	init;	561	default_loop
441		562	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?';
442	push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"];
443		563
444	1;	564	1;
445		565
446	=head1 SEE ALSO	566	=head1 SEE ALSO
447		567
448	L<EV::DNS>, L<EV::AnyEvent>.	568	L<EV::DNS>.
449		569
450	=head1 AUTHOR	570	=head1 AUTHOR
451		571
452	Marc Lehmann <schmorp@schmorp.de>	572	Marc Lehmann <schmorp@schmorp.de>
453	http://home.schmorp.de/	573	http://home.schmorp.de/

Diff Legend

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

Comparing EV/EV.pm (file contents): Revision 1.21 by root, Thu Nov 1 17:20:25 2007 UTC vs. Revision 1.46 by root, Fri Nov 23 05:00:44 2007 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.21 by root, Thu Nov 1 17:20:25 2007 UTC vs.
Revision 1.46 by root, Fri Nov 23 05:00:44 2007 UTC