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

Comparing EV/EV.pm (file contents):
Revision 1.16 by root, Wed Oct 31 20:10:17 2007 UTC vs.
Revision 1.30 by root, Thu Nov 8 02:19:36 2007 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	EV - perl interface to libevent, monkey.org/~provos/libevent/	3	EV - perl interface to libev, a high performance full-featured event loop
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use EV;	7	use EV;
8		8
9	# TIMER	9	# TIMERS
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
16	warn "is called roughly every 2s (repeat = 1)";	16	warn "is called roughly every 2s (repeat = 1)";
17	};	17	};
18		18
19	undef $w; # destroy event watcher again	19	undef $w; # destroy event watcher again
20		20
21	my $w = EV::timer_abs 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 \| EV::PERSIST, 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 get the watcher object and event mask
29	if ($revents & EV::TIMEOUT) {
30	warn "nothing received on stdin for 10 seconds, retrying";
31	} else {
32	warn "stdin is readable, you entered: ", <STDIN>;	29	warn "stdin is readable, you entered: ", <STDIN>;
33	}
34	};
35	$w->timeout (10);
36
37	my $w = EV::timed_io \*STDIN, EV::READ, 30, sub {
38	my ($w, $revents) = @_;
39	if ($revents & EV::TIMEOUT) {
40	warn "nothing entered within 30 seconds, bye bye.\n";
41	$w->stop;
42	} else {
43	my $line = <STDIN>;
44	warn "you entered something, you again have 30 seconds.\n";
45	}
46	};	30	};
47		31
48	# SIGNALS	32	# SIGNALS
49		33
50	my $w = EV::signal 'QUIT', sub {	34	my $w = EV::signal 'QUIT', sub {
…		…
56	};	40	};
57		41
58	# CHILD/PID STATUS CHANGES	42	# CHILD/PID STATUS CHANGES
59		43
60	my $w = EV::child 666, sub {	44	my $w = EV::child 666, sub {
61	my ($w, $revents, $status) = @_;	45	my ($w, $revents) = @_;
		46	# my $pid = $w->rpid;
		47	my $status = $w->rstatus;
62	};	48	};
63		49
64	# MAINLOOP	50	# MAINLOOP
65	EV::dispatch; # loop as long as watchers are active	51	EV::loop; # loop until EV::loop_done is called
66	EV::loop; # the same thing
67	EV::loop EV::LOOP_ONESHOT; # block until some events could be handles	52	EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled
68	EV::loop EV::LOOP_NONBLOCK; # check and handle some events, but do not wait	53	EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block
69		54
70	=head1 DESCRIPTION	55	=head1 DESCRIPTION
71		56
72	This module provides an interface to libev	57	This module provides an interface to libev
73	(L<http://software.schmorp.de/pkg/libev.html>). You probably should	58	(L<http://software.schmorp.de/pkg/libev.html>).
74	acquaint yourself with its documentation and source code to be able to use
75	this module fully.
76		59
77	=cut	60	=cut
78		61
79	package EV;	62	package EV;
80		63
81	use strict;	64	use strict;
82		65
83	BEGIN {	66	BEGIN {
84	our $VERSION = '0.03';	67	our $VERSION = '0.51';
85	use XSLoader;	68	use XSLoader;
86	XSLoader::load "EV", $VERSION;	69	XSLoader::load "EV", $VERSION;
87	}	70	}
88		71
89	@EV::Io::ISA = "EV::Watcher";	72	@EV::Io::ISA =
90	@EV::Time::ISA = "EV::Watcher";
91	@EV::Timer::ISA = "EV::Time";	73	@EV::Timer::ISA =
92	@EV::Periodic::ISA = "EV::Time";	74	@EV::Periodic::ISA =
93	@EV::Signal::ISA = "EV::Watcher";	75	@EV::Signal::ISA =
94	@EV::Idle::ISA = "EV::Watcher";	76	@EV::Idle::ISA =
95	@EV::Prepare::ISA = "EV::Watcher";	77	@EV::Prepare::ISA =
		78	@EV::Check::ISA =
96	@EV::Check::ISA = "EV::Watcher";	79	@EV::Child::ISA = "EV::Watcher";
97		80
98	=head1 BASIC INTERFACE	81	=head1 BASIC INTERFACE
99		82
100	=over 4	83	=over 4
101
102	=item $EV::NPRI
103
104	How many priority levels are available.
105		84
106	=item $EV::DIED	85	=item $EV::DIED
107		86
108	Must contain a reference to a function that is called when a callback	87	Must contain a reference to a function that is called when a callback
109	throws an exception (with $@ containing thr error). The default prints an	88	throws an exception (with $@ containing thr error). The default prints an
110	informative message and continues.	89	informative message and continues.
111		90
112	If this callback throws an exception it will be silently ignored.	91	If this callback throws an exception it will be silently ignored.
113		92
		93	=item $time = EV::time
		94
		95	Returns the current time in (fractional) seconds since the epoch.
		96
114	=item $time = EV::now	97	=item $time = EV::now
115		98
116	Returns the time in (fractional) seconds since the epoch.	99	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
		101	usually faster then calling EV::time.
117		102
118	=item $version = EV::version
119
120	=item $method = EV::method	103	=item $method = EV::ev_method
121		104
122	Return version string and event polling method used.	105	Returns an integer describing the backend used by libev (EV::METHOD_SELECT
		106	or EV::METHOD_EPOLL).
123		107
124	=item EV::loop $flags # EV::LOOP_ONCE, EV::LOOP_ONESHOT	108	=item EV::loop [$flags]
125		109
126	=item EV::loopexit $after	110	Begin checking for events and calling callbacks. It returns when a
		111	callback calls EV::loop_done.
127		112
128	Exit any active loop or dispatch after C<$after> seconds or immediately if	113	The $flags argument can be one of the following:
129	C<$after> is missing or zero.
130		114
131	=item EV::dispatch	115	0 as above
		116	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)
132		118
133	Same as C<EV::loop 0>.	119	=item EV::loop_done [$how]
134		120
135	=item EV::event $callback	121	When called with no arguments or an argument of 1, makes the innermost
		122	call to EV::loop return.
136		123
137	Creates a new event watcher waiting for nothing, calling the given callback.	124	When called with an agrument of 2, all calls to EV::loop will return as
		125	fast as possible.
138		126
		127	=back
		128
		129	=head2 WATCHER
		130
		131	A watcher is an object that gets created to record your interest in some
		132	event. For instance, if you want to wait for STDIN to become readable, you
		133	would create an EV::io watcher for that:
		134
		135	my $watcher = EV::io *STDIN, EV::READ, sub {
		136	my ($watcher, $revents) = @_;
		137	warn "yeah, STDIN should not be readable without blocking!\n"
		138	};
		139
		140	All watchers can be active (waiting for events) or inactive (paused). Only
		141	active watchers will have their callbacks invoked. All callbacks will be
		142	called with at least two arguments: the watcher and a bitmask of received
		143	events.
		144
		145	Each watcher type has its associated bit in revents, so you can use the
		146	same callback for multiple watchers. The event mask is named after the
		147	type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
		148	EV::periodic sets EV::PERIODIC and so on, with the exception of IO events
		149	(which can set both EV::READ and EV::WRITE bits), and EV::timer (which
		150	uses EV::TIMEOUT).
		151
		152	In the rare case where one wants to create a watcher but not start it at
		153	the same time, each constructor has a variant with a trailing C<_ns> in
		154	its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.
		155
		156	Please note that a watcher will automatically be stopped when the watcher
		157	object is destroyed, so you I<need> to keep the watcher objects returned by
		158	the constructors.
		159
		160	Also, all methods changing some aspect of a watcher (->set, ->priority,
		161	->fh and so on) automatically stop and start it again if it is active,
		162	which means pending events get lost.
		163
		164	=head2 WATCHER TYPES
		165
		166	Now lets move to the existing watcher types and asociated methods.
		167
		168	The following methods are available for all watchers. Then followes a
		169	description of each watcher constructor (EV::io, EV::timer, EV::periodic,
		170	EV::signal, EV::child, EV::idle, EV::prepare and EV::check), followed by
		171	any type-specific methods (if any).
		172
		173	=over 4
		174
		175	=item $w->start
		176
		177	Starts a watcher if it isn't active already. Does nothing to an already
		178	active watcher. By default, all watchers start out in the active state
		179	(see the description of the C<_ns> variants if you need stopped watchers).
		180
		181	=item $w->stop
		182
		183	Stop a watcher if it is active. Also clear any pending events (events that
		184	have been received but that didn't yet result in a callback invocation),
		185	regardless of wether the watcher was active or not.
		186
		187	=item $bool = $w->is_active
		188
		189	Returns true if the watcher is active, false otherwise.
		190
		191	=item $current_data = $w->data
		192
		193	=item $old_data = $w->data ($new_data)
		194
		195	Queries a freely usable data scalar on the watcher and optionally changes
		196	it. This is a way to associate custom data with a watcher:
		197
		198	my $w = EV::timer 60, 0, sub {
		199	warn $_[0]->data;
		200	};
		201	$w->data ("print me!");
		202
		203	=item $current_cb = $w->cb
		204
		205	=item $old_cb = $w->cb ($new_cb)
		206
		207	Queries the callback on the watcher and optionally changes it. You can do
		208	this at any time without the watcher restarting.
		209
		210	=item $current_priority = $w->priority
		211
		212	=item $old_priority = $w->priority ($new_priority)
		213
		214	Queries the priority on the watcher and optionally changes it. Pending
		215	watchers with higher priority will be invoked first. The valid range of
		216	priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default
		217	-2). If the priority is outside this range it will automatically be
		218	normalised to the nearest valid priority.
		219
		220	The default priority of any newly-created weatcher is 0.
		221
		222	=item $w->trigger ($revents)
		223
		224	Call the callback now with the given event mask.
		225
		226
139	=item my $w = EV::io $fileno_or_fh, $eventmask, $callback	227	=item $w = EV::io $fileno_or_fh, $eventmask, $callback
140		228
141	=item my $w = EV::io_ns $fileno_or_fh, $eventmask, $callback	229	=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
142		230
143	As long as the returned watcher object is alive, call the C<$callback>	231	As long as the returned watcher object is alive, call the C<$callback>
144	when the events specified in C<$eventmask> happen. Initially, the timeout	232	when the events specified in C<$eventmask>.
145	is disabled.
146		233
147	You can additionall set a timeout to occur on the watcher, but note that
148	this timeout will not be reset when you get an I/O event in the EV::PERSIST
149	case, and reaching a timeout will always stop the watcher even in the
150	EV::PERSIST case.
151
152	If you want a timeout to occur only after a specific time of inactivity, set
153	a repeating timeout and do NOT use EV::PERSIST.
154
155	Eventmask can be one or more of these constants ORed together:	234	The $eventmask can be one or more of these constants ORed together:
156		235
157	EV::READ wait until read() wouldn't block anymore	236	EV::READ wait until read() wouldn't block anymore
158	EV::WRITE wait until write() wouldn't block anymore	237	EV::WRITE wait until write() wouldn't block anymore
159	EV::PERSIST stay active after a (non-timeout) event occured
160		238
161	The C<io_ns> variant doesn't add/start the newly created watcher.	239	The C<io_ns> variant doesn't start (activate) the newly created watcher.
162		240
163	=item my $w = EV::timed_io $fileno_or_fh, $eventmask, $timeout, $callback	241	=item $w->set ($fileno_or_fh, $eventmask)
164		242
165	=item my $w = EV::timed_io_ns $fileno_or_fh, $eventmask, $timeout, $callback	243	Reconfigures the watcher, see the constructor above for details. Can be
		244	called at any time.
166		245
167	Same as C<io> and C<io_ns>, but also specifies a timeout (as if there was	246	=item $current_fh = $w->fh
168	a call to C<< $w->timeout ($timout, 1) >>. The persist flag is not allowed
169	and will automatically be cleared. The watcher will be restarted after each event.
170		247
171	If the timeout is zero or undef, no timeout will be set, and a normal	248	=item $old_fh = $w->fh ($new_fh)
172	watcher (with the persist flag set!) will be created.
173		249
174	This has the effect of timing out after the specified period of inactivity	250	Returns the previously set filehandle and optionally set a new one.
175	has happened.
176		251
177	Due to the design of libevent, this is also relatively inefficient, having	252	=item $current_eventmask = $w->events
178	one or two io watchers and a separate timeout watcher that you reset on
179	activity (by calling its C<start> method) is usually more efficient.
180		253
		254	=item $old_eventmask = $w->events ($new_eventmask)
		255
		256	Returns the previously set event mask and optionally set a new one.
		257
		258
181	=item my $w = EV::timer $after, $repeat, $callback	259	=item $w = EV::timer $after, $repeat, $callback
182		260
183	=item my $w = EV::timer_ns $after, $repeat, $callback	261	=item $w = EV::timer_ns $after, $repeat, $callback
184		262
185	Calls the callback after C<$after> seconds. If C<$repeat> is true, the	263	Calls the callback after C<$after> seconds. If C<$repeat> is non-zero,
186	timer will be restarted after the callback returns. This means that the	264	the timer will be restarted (with the $repeat value as $after) after the
187	callback would be called roughly every C<$after> seconds, prolonged by the	265	callback returns.
188	time the callback takes.
189		266
		267	This means that the callback would be called roughly after C<$after>
		268	seconds, and then every C<$repeat> seconds. "Roughly" because the time of
		269	callback processing is not taken into account, so the timer will slowly
		270	drift. If that isn't acceptable, look at EV::periodic.
		271
		272	The timer is based on a monotonic clock, that is if somebody is sitting
		273	in front of the machine while the timer is running and changes the system
		274	clock, the timer will nevertheless run (roughly) the same time.
		275
190	The C<timer_ns> variant doesn't add/start the newly created watcher.	276	The C<timer_ns> variant doesn't start (activate) the newly created watcher.
191		277
192	=item my $w = EV::timer_abs $at, $interval, $callback	278	=item $w->set ($after, $repeat)
193		279
194	=item my $w = EV::timer_abs_ns $at, $interval, $callback	280	Reconfigures the watcher, see the constructor above for details. Can be at
		281	any time.
195		282
196	Similar to EV::timer, but the time is given as an absolute point in time	283	=item $w->again
197	(C<$at>), plus an optional C<$interval>.
198		284
199	If the C<$interval> is zero, then the callback will be called at the time	285	Similar to the C<start> method, but has special semantics for repeating timers:
200	C<$at> if that is in the future, or as soon as possible if its in the
201	past. It will not automatically repeat.
202		286
203	If the C<$interval> is nonzero, then the watcher will always be scheduled	287	If the timer is active and repeating, reset the timeout to occur
204	to time out at the next C<$at + integer * $interval> time.	288	C<$repeat> seconds after now.
205		289
206	This can be used to schedule a callback to run at very regular intervals,	290	If the timer is active and non-repeating, it will be stopped.
207	as long as the processing time is less then the interval (otherwise	291
208	obviously events will be skipped).	292	If the timer is in active and repeating, start it.
		293
		294	Otherwise do nothing.
		295
		296	This behaviour is useful when you have a timeout for some IO
		297	operation. You create a timer object with the same value for C<$after> and
		298	C<$repeat>, and then, in the read/write watcher, run the C<again> method
		299	on the timeout.
		300
		301
		302	=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
		303
		304	=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
		305
		306	Similar to EV::timer, but is not based on relative timeouts but on
		307	absolute times. Apart from creating "simple" timers that trigger "at" the
		308	specified time, it can also be used for non-drifting absolute timers and
		309	more complex, cron-like, setups that are not adversely affected by time
		310	jumps (i.e. when the system clock is changed by explicit date -s or other
		311	means such as ntpd). It is also the most complex watcher type in EV.
		312
		313	It has three distinct "modes":
		314
		315	=over 4
		316
		317	=item * absolute timer ($interval = $reschedule_cb = 0)
		318
		319	This time simply fires at the wallclock time C<$at> and doesn't repeat. It
		320	will not adjust when a time jump occurs, that is, if it is to be run
		321	at January 1st 2011 then it will run when the system time reaches or
		322	surpasses this time.
		323
		324	=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0)
		325
		326	In this mode the watcher will always be scheduled to time out at the
		327	next C<$at + N * $interval> time (for some integer N) and then repeat,
		328	regardless of any time jumps.
		329
		330	This can be used to create timers that do not drift with respect to system
		331	time:
		332
		333	my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
		334
		335	That doesn't mean there will always be 3600 seconds in between triggers,
		336	but only that the the clalback will be called when the system time shows a
		337	full hour (UTC).
209		338
210	Another way to think about it (for the mathematically inclined) is that	339	Another way to think about it (for the mathematically inclined) is that
211	C<timer_abs> will try to tun the callback at the next possible time where	340	EV::periodic will try to run the callback in this mode at the next
212	C<$time = $at (mod $interval)>, regardless of any time jumps.	341	possible time where C<$time = $at (mod $interval)>, regardless of any time
		342	jumps.
213		343
		344	=item * manual reschedule mode ($reschedule_cb = coderef)
		345
		346	In this mode $interval and $at are both being ignored. Instead, each time
		347	the periodic watcher gets scheduled, the first callback ($reschedule_cb)
		348	will be called with the watcher as first, and the current time as second
		349	argument.
		350
		351	I<This callback MUST NOT stop or destroy the event watcher, ever.>
		352
		353	It must return the next time to trigger, based on the passed time value
		354	(that is, the lowest time value larger than to the second argument). It
		355	will usually be called just before the callback will be triggered, but
		356	might be called at other times, too.
		357
		358	This can be used to create very complex timers, such as a timer that
		359	triggers on each midnight, local time (actually 24 hours after the last
		360	midnight, to keep the example simple. If you know a way to do it correctly
		361	in about the same space (without requiring elaborate modules), drop me a
		362	note :):
		363
		364	my $daily = EV::periodic 0, 0, sub {
		365	my ($w, $now) = @_;
		366
		367	use Time::Local ();
		368	my (undef, undef, undef, $d, $m, $y) = localtime $now;
		369	86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y
		370	}, sub {
		371	print "it's midnight or likely shortly after, now\n";
		372	};
		373
		374	=back
		375
214	The C<timer_abs_ns> variant doesn't add/start the newly created watcher.	376	The C<periodic_ns> variant doesn't start (activate) the newly created watcher.
215		377
		378	=item $w->set ($at, $interval, $reschedule_cb)
		379
		380	Reconfigures the watcher, see the constructor above for details. Can be at
		381	any time.
		382
		383	=item $w->again
		384
		385	Simply stops and starts the watcher again.
		386
		387
216	=item my $w = EV::signal $signal, $callback	388	=item $w = EV::signal $signal, $callback
217		389
218	=item my $w = EV::signal_ns $signal, $callback	390	=item $w = EV::signal_ns $signal, $callback
219		391
220	Call the callback when $signal is received (the signal can be specified	392	Call the callback when $signal is received (the signal can be specified
221	by number or by name, just as with kill or %SIG). Signal watchers are	393	by number or by name, just as with kill or %SIG).
222	persistent no natter what.
223		394
224	EV will grab the signal for the process (the kernel only allows one	395	EV will grab the signal for the process (the kernel only allows one
225	component to receive signals) when you start a signal watcher, and	396	component to receive a signal at a time) when you start a signal watcher,
226	removes it again when you stop it. Pelr does the same when you add/remove	397	and removes it again when you stop it. Perl does the same when you
227	callbacks to %SIG, so watch out.	398	add/remove callbacks to %SIG, so watch out.
228		399
229	Unfortunately, only one handler can be registered per signal. Screw	400	You can have as many signal watchers per signal as you want.
230	libevent.
231		401
232	The C<signal_ns> variant doesn't add/start the newly created watcher.	402	The C<signal_ns> variant doesn't start (activate) the newly created watcher.
		403
		404	=item $w->set ($signal)
		405
		406	Reconfigures the watcher, see the constructor above for details. Can be at
		407	any time.
		408
		409	=item $current_signum = $w->signal
		410
		411	=item $old_signum = $w->signal ($new_signal)
		412
		413	Returns the previously set signal (always as a number not name) and
		414	optionally set a new one.
		415
		416
		417	=item $w = EV::child $pid, $callback
		418
		419	=item $w = EV::child_ns $pid, $callback
		420
		421	Call the callback when a status change for pid C<$pid> (or any pid
		422	if C<$pid> is 0) has been received. More precisely: when the process
		423	receives a SIGCHLD, EV will fetch the outstanding exit/wait status for all
		424	changed/zombie children and call the callback.
		425
		426	You can access both status and pid by using the C<rstatus> and C<rpid>
		427	methods on the watcher object.
		428
		429	You can have as many pid watchers per pid as you want.
		430
		431	The C<child_ns> variant doesn't start (activate) the newly created watcher.
		432
		433	=item $w->set ($pid)
		434
		435	Reconfigures the watcher, see the constructor above for details. Can be at
		436	any time.
		437
		438	=item $current_pid = $w->pid
		439
		440	=item $old_pid = $w->pid ($new_pid)
		441
		442	Returns the previously set process id and optionally set a new one.
		443
		444	=item $exit_status = $w->rstatus
		445
		446	Return the exit/wait status (as returned by waitpid, see the waitpid entry
		447	in perlfunc).
		448
		449	=item $pid = $w->rpid
		450
		451	Return the pid of the awaited child (useful when you have installed a
		452	watcher for all pids).
		453
		454
		455	=item $w = EV::idle $callback
		456
		457	=item $w = EV::idle_ns $callback
		458
		459	Call the callback when there are no pending io, timer/periodic, signal or
		460	child events, i.e. when the process is idle.
		461
		462	The process will not block as long as any idle watchers are active, and
		463	they will be called repeatedly until stopped.
		464
		465	The C<idle_ns> variant doesn't start (activate) the newly created watcher.
		466
		467
		468	=item $w = EV::prepare $callback
		469
		470	=item $w = EV::prepare_ns $callback
		471
		472	Call the callback just before the process would block. You can still
		473	create/modify any watchers at this point.
		474
		475	See the EV::check watcher, below, for explanations and an example.
		476
		477	The C<prepare_ns> variant doesn't start (activate) the newly created watcher.
		478
		479
		480	=item $w = EV::check $callback
		481
		482	=item $w = EV::check_ns $callback
		483
		484	Call the callback just after the process wakes up again (after it has
		485	gathered events), but before any other callbacks have been invoked.
		486
		487	This is used to integrate other event-based software into the EV
		488	mainloop: You register a prepare callback and in there, you create io and
		489	timer watchers as required by the other software. Here is a real-world
		490	example of integrating Net::SNMP (with some details left out):
		491
		492	our @snmp_watcher;
		493
		494	our $snmp_prepare = EV::prepare sub {
		495	# do nothing unless active
		496	$dispatcher->{_event_queue_h}
		497	or return;
		498
		499	# make the dispatcher handle any outstanding stuff
		500
		501	# create an IO watcher for each and every socket
		502	@snmp_watcher = (
		503	(map { EV::io $_, EV::READ, sub { } }
		504	keys %{ $dispatcher->{_descriptors} }),
		505	);
		506
		507	# if there are any timeouts, also create a timer
		508	push @snmp_watcher, EV::timer $event->[Net::SNMP::Dispatcher::_TIME] - EV::now, 0, sub { }
		509	if $event->[Net::SNMP::Dispatcher::_ACTIVE];
		510	};
		511
		512	The callbacks are irrelevant, the only purpose of those watchers is
		513	to wake up the process as soon as one of those events occurs (socket
		514	readable, or timer timed out). The corresponding EV::check watcher will then
		515	clean up:
		516
		517	our $snmp_check = EV::check sub {
		518	# destroy all watchers
		519	@snmp_watcher = ();
		520
		521	# make the dispatcher handle any new stuff
		522	};
		523
		524	The callbacks of the created watchers will not be called as the watchers
		525	are destroyed before this cna happen (remember EV::check gets called
		526	first).
		527
		528	The C<check_ns> variant doesn't start (activate) the newly created watcher.
233		529
234	=back	530	=back
235		531
236	=head1 THE EV::Event CLASS
237
238	All EV functions creating an event watcher (designated by C<my $w =>
239	above) support the following methods on the returned watcher object:
240
241	=over 4
242
243	=item $w->add ($timeout)
244
245	Stops and (re-)starts the event watcher, setting the optional timeout to
246	the given value, or clearing the timeout if none is given.
247
248	=item $w->start
249
250	Stops and (re-)starts the event watcher without touching the timeout.
251
252	=item $w->del
253
254	=item $w->stop
255
256	Stop the event watcher if it was started.
257
258	=item $current_callback = $w->cb
259
260	=item $old_callback = $w->cb ($new_callback)
261
262	Return the previously set callback and optionally set a new one.
263
264	=item $current_fh = $w->fh
265
266	=item $old_fh = $w->fh ($new_fh)
267
268	Returns the previously set filehandle and optionally set a new one (also
269	clears the EV::SIGNAL flag when setting a filehandle).
270
271	=item $current_signal = $w->signal
272
273	=item $old_signal = $w->signal ($new_signal)
274
275	Returns the previously set signal number and optionally set a new one (also sets
276	the EV::SIGNAL flag when setting a signal).
277
278	=item $current_eventmask = $w->events
279
280	=item $old_eventmask = $w->events ($new_eventmask)
281
282	Returns the previously set event mask and optionally set a new one.
283
284	=item $w->timeout ($after, $repeat)
285
286	Resets the timeout (see C<EV::timer> for details).
287
288	=item $w->timeout_abs ($at, $interval)
289
290	Resets the timeout (see C<EV::timer_abs> for details).
291
292	=item $w->priority_set ($priority)
293
294	Set the priority of the watcher to C<$priority> (0 <= $priority < $EV::NPRI).
295
296	=back
297
298	=head1 THREADS	532	=head1 THREADS
299		533
300	Threads are not supported by this in any way. Perl pseudo-threads is evil	534	Threads are not supported by this in any way. Perl pseudo-threads is evil
301	and must die.	535	stuff and must die.
302
303	=head1 BUGS
304
305	Lots. Libevent itself isn't well tested and rather buggy, and this module
306	is quite new at the moment.
307
308	Please note that the epoll method is not, in general, reliable in programs
309	that use fork (even if no libveent calls are being made in the forked
310	process). If your program behaves erratically, try setting the environment
311	variable C<EVENT_NOEPOLL> first when running the program.
312
313	In general, if you fork, then you can only use the EV module in one of the
314	children.
315		536
316	=cut	537	=cut
317		538
318	our $DIED = sub {	539	our $DIED = sub {
319	warn "EV: error in callback (ignoring): $@";	540	warn "EV: error in callback (ignoring): $@";
320	};	541	};
321		542
322	init;	543	default_loop
		544	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?';
323		545
324	push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"];	546	push @AnyEvent::REGISTRY, [EV => "EV::AnyEvent"];
325		547
326	1;	548	1;
327		549
328	=head1 SEE ALSO	550	=head1 SEE ALSO
329		551
330	L<EV::DNS>, L<event(3)>, L<event.h>, L<evdns.h>.
331	L<EV::AnyEvent>.	552	L<EV::DNS>, L<EV::AnyEvent>.
332		553
333	=head1 AUTHOR	554	=head1 AUTHOR
334		555
335	Marc Lehmann <schmorp@schmorp.de>	556	Marc Lehmann <schmorp@schmorp.de>
336	http://home.schmorp.de/	557	http://home.schmorp.de/

Diff Legend

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

Comparing EV/EV.pm (file contents): Revision 1.16 by root, Wed Oct 31 20:10:17 2007 UTC vs. Revision 1.30 by root, Thu Nov 8 02:19:36 2007 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.16 by root, Wed Oct 31 20:10:17 2007 UTC vs.
Revision 1.30 by root, Thu Nov 8 02:19:36 2007 UTC