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

Comparing EV/EV.pm (file contents):
Revision 1.49 by root, Sat Nov 24 08:28:10 2007 UTC vs.
Revision 1.87 by root, Tue Apr 15 04:41:57 2008 UTC

…		…
35	warn "sigquit received\n";	35	warn "sigquit received\n";
36	};	36	};
37		37
38	# CHILD/PID STATUS CHANGES	38	# CHILD/PID STATUS CHANGES
39		39
40	my $w = EV::child 666, sub {	40	my $w = EV::child 666, 0, sub {
41	my ($w, $revents) = @_;	41	my ($w, $revents) = @_;
42	my $status = $w->rstatus;	42	my $status = $w->rstatus;
		43	};
		44
		45	# STAT CHANGES
		46	my $w = EV::stat "/etc/passwd", 10, sub {
		47	my ($w, $revents) = @_;
		48	warn $w->path, " has changed somehow.\n";
43	};	49	};
44		50
45	# MAINLOOP	51	# MAINLOOP
46	EV::loop; # loop until EV::unloop is called or all watchers stop	52	EV::loop; # loop until EV::unloop is called or all watchers stop
47	EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled	53	EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled
48	EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block	54	EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block
49		55
50	=head1 DESCRIPTION	56	=head1 DESCRIPTION
51		57
52	This module provides an interface to libev	58	This module provides an interface to libev
53	(L<http://software.schmorp.de/pkg/libev.html>).	59	(L<http://software.schmorp.de/pkg/libev.html>). While the documentation
		60	below is comprehensive, one might also consult the documentation of libev
		61	itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on
		62	watcher semantics or some discussion on the available backends, or how to
		63	force a specific backend with C<LIBEV_FLAGS>, or just about in any case
		64	because it has much more detailed information.
54		65
55	=cut	66	=cut
56		67
57	package EV;	68	package EV;
58		69
59	use strict;	70	use strict;
60		71
61	BEGIN {	72	BEGIN {
62	our $VERSION = '1.2';	73	our $VERSION = '3.2';
63	use XSLoader;	74	use XSLoader;
64	XSLoader::load "EV", $VERSION;	75	XSLoader::load "EV", $VERSION;
65	}	76	}
66		77
67	@EV::IO::ISA =	78	@EV::IO::ISA =
68	@EV::Timer::ISA =	79	@EV::Timer::ISA =
69	@EV::Periodic::ISA =	80	@EV::Periodic::ISA =
70	@EV::Signal::ISA =	81	@EV::Signal::ISA =
		82	@EV::Child::ISA =
		83	@EV::Stat::ISA =
71	@EV::Idle::ISA =	84	@EV::Idle::ISA =
72	@EV::Prepare::ISA =	85	@EV::Prepare::ISA =
73	@EV::Check::ISA =	86	@EV::Check::ISA =
74	@EV::Child::ISA = "EV::Watcher";	87	@EV::Embed::ISA =
		88	@EV::Fork::ISA =
		89	@EV::Async::ISA =
		90	"EV::Watcher";
		91
		92	@EV::Loop::Default::ISA = "EV::Loop";
		93
		94	=head1 EVENT LOOPS
		95
		96	EV supports multiple event loops: There is a single "default event loop"
		97	that can handle everything including signals and child watchers, and any
		98	number of "dynamic event loops" that can use different backends (with
		99	various limitations), but no child and signal watchers.
		100
		101	You do not have to do anything to create the default event loop: When
		102	the module is loaded a suitable backend is selected on the premise of
		103	selecting a working backend (which for example rules out kqueue on most
		104	BSDs). Modules should, unless they have "special needs" always use the
		105	default loop as this is fastest (perl-wise), best supported by other
		106	modules (e.g. AnyEvent or Coro) and most portable event loop.
		107
		108	For specific programs you can create additional event loops dynamically.
		109
		110	=over 4
		111
		112	=item $loop = new EV::loop [$flags]
		113
		114	Create a new event loop as per the specified flags. Please refer to the
		115	C<ev_loop_new ()> function description in the libev documentation
		116	(L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>)
		117	for more info.
		118
		119	The loop will automatically be destroyed when it is no longer referenced
		120	by any watcher and the loop object goes out of scope.
		121
		122	Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop
		123	is protected by this module.
		124
		125	=item $loop->loop_fork
		126
		127	Must be called after a fork in the child, before entering or continuing
		128	the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
		129	this fucntion automatically, at some performance loss (refer to the libev
		130	documentation).
		131
		132	=item $loop = EV::default_loop [$flags]
		133
		134	Return the default loop (which is a singleton object).
		135
		136	=back
		137
75		138
76	=head1 BASIC INTERFACE	139	=head1 BASIC INTERFACE
77		140
78	=over 4	141	=over 4
79		142
80	=item $EV::DIED	143	=item $EV::DIED
81		144
82	Must contain a reference to a function that is called when a callback	145	Must contain a reference to a function that is called when a callback
83	throws an exception (with $@ containing thr error). The default prints an	146	throws an exception (with $@ containing the error). The default prints an
84	informative message and continues.	147	informative message and continues.
85		148
86	If this callback throws an exception it will be silently ignored.	149	If this callback throws an exception it will be silently ignored.
87		150
		151	=item $flags = EV::supported_backends
		152
		153	=item $flags = EV::recommended_backends
		154
		155	=item $flags = EV::embeddable_backends
		156
		157	Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this
		158	instance of EV, the set of recommended backends (supposed to be good) for
		159	this platform and the set of embeddable backends (see EMBED WATCHERS).
		160
		161	=item EV::sleep $seconds
		162
		163	Block the process for the given number of (fractional) seconds.
		164
88	=item $time = EV::time	165	=item $time = EV::time
89		166
90	Returns the current time in (fractional) seconds since the epoch.	167	Returns the current time in (fractional) seconds since the epoch.
91		168
92	=item $time = EV::now	169	=item $time = EV::now
		170
		171	=item $time = $loop->now
93		172
94	Returns the time the last event loop iteration has been started. This	173	Returns the time the last event loop iteration has been started. This
95	is the time that (relative) timers are based on, and refering to it is	174	is the time that (relative) timers are based on, and refering to it is
96	usually faster then calling EV::time.	175	usually faster then calling EV::time.
97		176
98	=item $method = EV::method	177	=item $backend = EV::backend
		178
		179	=item $backend = $loop->backend
99		180
100	Returns an integer describing the backend used by libev (EV::METHOD_SELECT	181	Returns an integer describing the backend used by libev (EV::METHOD_SELECT
101	or EV::METHOD_EPOLL).	182	or EV::METHOD_EPOLL).
102		183
103	=item EV::loop [$flags]	184	=item EV::loop [$flags]
		185
		186	=item $loop->loop ([$flags])
104		187
105	Begin checking for events and calling callbacks. It returns when a	188	Begin checking for events and calling callbacks. It returns when a
106	callback calls EV::unloop.	189	callback calls EV::unloop.
107		190
108	The $flags argument can be one of the following:	191	The $flags argument can be one of the following:
…		…
111	EV::LOOP_ONESHOT block at most once (wait, but do not loop)	194	EV::LOOP_ONESHOT block at most once (wait, but do not loop)
112	EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait)	195	EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait)
113		196
114	=item EV::unloop [$how]	197	=item EV::unloop [$how]
115		198
		199	=item $loop->unloop ([$how])
		200
116	When called with no arguments or an argument of EV::UNLOOP_ONE, makes the	201	When called with no arguments or an argument of EV::UNLOOP_ONE, makes the
117	innermost call to EV::loop return.	202	innermost call to EV::loop return.
118		203
119	When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as	204	When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as
120	fast as possible.	205	fast as possible.
121		206
		207	=item $count = EV::loop_count
		208
		209	=item $count = $loop->loop_count
		210
		211	Return the number of times the event loop has polled for new
		212	events. Sometiems useful as a generation counter.
		213
122	=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)	214	=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
		215
		216	=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
123		217
124	This function rolls together an I/O and a timer watcher for a single	218	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.	219	one-shot event without the need for managing a watcher object.
126		220
127	If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events>	221	If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events>
…		…
133	If timeout is C<undef> or negative, then there will be no	227	If timeout is C<undef> or negative, then there will be no
134	timeout. Otherwise a EV::timer with this value will be started.	228	timeout. Otherwise a EV::timer with this value will be started.
135		229
136	When an error occurs or either the timeout or I/O watcher triggers, then	230	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	231	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>,	232	you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>,
139	C<EV::WRITE> and C<EV::TIMEOUT>).	233	C<EV::WRITE> and C<EV::TIMEOUT>).
140		234
141	EV::once doesn't return anything: the watchers stay active till either	235	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	236	of them triggers, then they will be stopped and freed, and the callback
143	invoked.	237	invoked.
144		238
145	=back	239	=item EV::feed_fd_event ($fd, $revents)
146		240
147	=head2 WATCHER	241	=item $loop->feed_fd_event ($fd, $revents)
		242
		243	Feed an event on a file descriptor into EV. EV will react to this call as
		244	if the readyness notifications specified by C<$revents> (a combination of
		245	C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>.
		246
		247	=item EV::feed_signal_event ($signal)
		248
		249	Feed a signal event into EV. EV will react to this call as if the signal
		250	specified by C<$signal> had occured.
		251
		252	=item EV::set_io_collect_interval $time
		253
		254	=item $loop->set_io_collect_interval ($time)
		255
		256	=item EV::set_timeout_collect_interval $time
		257
		258	=item $loop->set_timeout_collect_interval ($time)
		259
		260	These advanced functions set the minimum block interval when polling for I/O events and the minimum
		261	wait interval for timer events. See the libev documentation at
		262	L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for
		263	a more detailed discussion.
		264
		265	=back
		266
		267
		268	=head1 WATCHER OBJECTS
148		269
149	A watcher is an object that gets created to record your interest in some	270	A watcher is an object that gets created to record your interest in some
150	event. For instance, if you want to wait for STDIN to become readable, you	271	event. For instance, if you want to wait for STDIN to become readable, you
151	would create an EV::io watcher for that:	272	would create an EV::io watcher for that:
152		273
153	my $watcher = EV::io *STDIN, EV::READ, sub {	274	my $watcher = EV::io *STDIN, EV::READ, sub {
154	my ($watcher, $revents) = @_;	275	my ($watcher, $revents) = @_;
155	warn "yeah, STDIN should not be readable without blocking!\n"	276	warn "yeah, STDIN should now be readable without blocking!\n"
156	};	277	};
157		278
158	All watchers can be active (waiting for events) or inactive (paused). Only	279	All watchers can be active (waiting for events) or inactive (paused). Only
159	active watchers will have their callbacks invoked. All callbacks will be	280	active watchers will have their callbacks invoked. All callbacks will be
160	called with at least two arguments: the watcher and a bitmask of received	281	called with at least two arguments: the watcher and a bitmask of received
161	events.	282	events.
162		283
163	Each watcher type has its associated bit in revents, so you can use the	284	Each watcher type has its associated bit in revents, so you can use the
164	same callback for multiple watchers. The event mask is named after the	285	same callback for multiple watchers. The event mask is named after the
165	type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,	286	type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
166	EV::periodic sets EV::PERIODIC and so on, with the exception of IO events	287	EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events
167	(which can set both EV::READ and EV::WRITE bits), and EV::timer (which	288	(which can set both EV::READ and EV::WRITE bits), and EV::timer (which
168	uses EV::TIMEOUT).	289	uses EV::TIMEOUT).
169		290
170	In the rare case where one wants to create a watcher but not start it at	291	In the rare case where one wants to create a watcher but not start it at
171	the same time, each constructor has a variant with a trailing C<_ns> in	292	the same time, each constructor has a variant with a trailing C<_ns> in
…		…
177		298
178	Also, all methods changing some aspect of a watcher (->set, ->priority,	299	Also, all methods changing some aspect of a watcher (->set, ->priority,
179	->fh and so on) automatically stop and start it again if it is active,	300	->fh and so on) automatically stop and start it again if it is active,
180	which means pending events get lost.	301	which means pending events get lost.
181		302
182	=head2 WATCHER TYPES	303	=head2 COMMON WATCHER METHODS
183		304
184	Now lets move to the existing watcher types and asociated methods.	305	This section lists methods common to all watchers.
185
186	The following methods are available for all watchers. Then followes a
187	description of each watcher constructor (EV::io, EV::timer, EV::periodic,
188	EV::signal, EV::child, EV::idle, EV::prepare and EV::check), followed by
189	any type-specific methods (if any).
190		306
191	=over 4	307	=over 4
192		308
193	=item $w->start	309	=item $w->start
194		310
…		…
198		314
199	=item $w->stop	315	=item $w->stop
200		316
201	Stop a watcher if it is active. Also clear any pending events (events that	317	Stop a watcher if it is active. Also clear any pending events (events that
202	have been received but that didn't yet result in a callback invocation),	318	have been received but that didn't yet result in a callback invocation),
203	regardless of wether the watcher was active or not.	319	regardless of whether the watcher was active or not.
204		320
205	=item $bool = $w->is_active	321	=item $bool = $w->is_active
206		322
207	Returns true if the watcher is active, false otherwise.	323	Returns true if the watcher is active, false otherwise.
208		324
…		…
233	watchers with higher priority will be invoked first. The valid range of	349	watchers with higher priority will be invoked first. The valid range of
234	priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default	350	priorities lies between EV::MAXPRI (default 2) and EV::MINPRI (default
235	-2). If the priority is outside this range it will automatically be	351	-2). If the priority is outside this range it will automatically be
236	normalised to the nearest valid priority.	352	normalised to the nearest valid priority.
237		353
238	The default priority of any newly-created weatcher is 0.	354	The default priority of any newly-created watcher is 0.
239		355
		356	Note that the priority semantics have not yet been fleshed out and are
		357	subject to almost certain change.
		358
240	=item $w->trigger ($revents)	359	=item $w->invoke ($revents)
241		360
242	Call the callback now with the given event mask.	361	Call the callback now with the given event mask.
243		362
		363	=item $w->feed_event ($revents)
		364
		365	Feed some events on this watcher into EV. EV will react to this call as if
		366	the watcher had received the given C<$revents> mask.
		367
		368	=item $revents = $w->clear_pending
		369
		370	If the watcher is pending, this function clears its pending status and
		371	returns its C<$revents> bitset (as if its callback was invoked). If the
		372	watcher isn't pending it does nothing and returns C<0>.
		373
		374	=item $previous_state = $w->keepalive ($bool)
		375
		376	Normally, C<EV::loop> will return when there are no active watchers
		377	(which is a "deadlock" because no progress can be made anymore). This is
		378	convinient because it allows you to start your watchers (and your jobs),
		379	call C<EV::loop> once and when it returns you know that all your jobs are
		380	finished (or they forgot to register some watchers for their task :).
		381
		382	Sometimes, however, this gets in your way, for example when the module
		383	that calls C<EV::loop> (usually the main program) is not the same module
		384	as a long-living watcher (for example a DNS client module written by
		385	somebody else even). Then you might want any outstanding requests to be
		386	handled, but you would not want to keep C<EV::loop> from returning just
		387	because you happen to have this long-running UDP port watcher.
		388
		389	In this case you can clear the keepalive status, which means that even
		390	though your watcher is active, it won't keep C<EV::loop> from returning.
		391
		392	The initial value for keepalive is true (enabled), and you cna change it
		393	any time.
		394
		395	Example: Register an I/O watcher for some UDP socket but do not keep the
		396	event loop from running just because of that watcher.
		397
		398	my $udp_socket = ...
		399	my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
		400	$1000udp_watcher->keepalive (0);
		401
		402	=item $loop = $w->loop
		403
		404	Return the loop that this watcher is attached to.
		405
		406	=back
		407
		408
		409	=head1 WATCHER TYPES
		410
		411	Each of the following subsections describes a single watcher type.
		412
		413	=head3 I/O WATCHERS - is this file descriptor readable or writable?
		414
		415	=over 4
244		416
245	=item $w = EV::io $fileno_or_fh, $eventmask, $callback	417	=item $w = EV::io $fileno_or_fh, $eventmask, $callback
246		418
247	=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback	419	=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
248		420
		421	=item $w = $loop->io ($fileno_or_fh, $eventmask, $callback)
		422
		423	=item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback)
		424
249	As long as the returned watcher object is alive, call the C<$callback>	425	As long as the returned watcher object is alive, call the C<$callback>
250	when the events specified in C<$eventmask>.	426	when at least one of events specified in C<$eventmask> occurs.
251		427
252	The $eventmask can be one or more of these constants ORed together:	428	The $eventmask can be one or more of these constants ORed together:
253		429
254	EV::READ wait until read() wouldn't block anymore	430	EV::READ wait until read() wouldn't block anymore
255	EV::WRITE wait until write() wouldn't block anymore	431	EV::WRITE wait until write() wouldn't block anymore
…		…
271		447
272	=item $old_eventmask = $w->events ($new_eventmask)	448	=item $old_eventmask = $w->events ($new_eventmask)
273		449
274	Returns the previously set event mask and optionally set a new one.	450	Returns the previously set event mask and optionally set a new one.
275		451
		452	=back
		453
		454
		455	=head3 TIMER WATCHERS - relative and optionally repeating timeouts
		456
		457	=over 4
276		458
277	=item $w = EV::timer $after, $repeat, $callback	459	=item $w = EV::timer $after, $repeat, $callback
278		460
279	=item $w = EV::timer_ns $after, $repeat, $callback	461	=item $w = EV::timer_ns $after, $repeat, $callback
280		462
281	Calls the callback after C<$after> seconds. If C<$repeat> is non-zero,	463	=item $w = $loop->timer ($after, $repeat, $callback)
282	the timer will be restarted (with the $repeat value as $after) after the	464
283	callback returns.	465	=item $w = $loop->timer_ns ($after, $repeat, $callback)
		466
		467	Calls the callback after C<$after> seconds (which may be fractional). If
		468	C<$repeat> is non-zero, the timer will be restarted (with the $repeat
		469	value as $after) after the callback returns.
284		470
285	This means that the callback would be called roughly after C<$after>	471	This means that the callback would be called roughly after C<$after>
286	seconds, and then every C<$repeat> seconds. The timer does his best not	472	seconds, and then every C<$repeat> seconds. The timer does his best not
287	to drift, but it will not invoke the timer more often then once per event	473	to drift, but it will not invoke the timer more often then once per event
288	loop iteration, and might drift in other cases. If that isn't acceptable,	474	loop iteration, and might drift in other cases. If that isn't acceptable,
…		…
294		480
295	The C<timer_ns> variant doesn't start (activate) the newly created watcher.	481	The C<timer_ns> variant doesn't start (activate) the newly created watcher.
296		482
297	=item $w->set ($after, $repeat)	483	=item $w->set ($after, $repeat)
298		484
299	Reconfigures the watcher, see the constructor above for details. Can be at	485	Reconfigures the watcher, see the constructor above for details. Can be called at
300	any time.	486	any time.
301		487
302	=item $w->again	488	=item $w->again
303		489
304	Similar to the C<start> method, but has special semantics for repeating timers:	490	Similar to the C<start> method, but has special semantics for repeating timers:
…		…
315	This behaviour is useful when you have a timeout for some IO	501	This behaviour is useful when you have a timeout for some IO
316	operation. You create a timer object with the same value for C<$after> and	502	operation. You create a timer object with the same value for C<$after> and
317	C<$repeat>, and then, in the read/write watcher, run the C<again> method	503	C<$repeat>, and then, in the read/write watcher, run the C<again> method
318	on the timeout.	504	on the timeout.
319		505
		506	=back
		507
		508
		509	=head3 PERIODIC WATCHERS - to cron or not to cron?
		510
		511	=over 4
320		512
321	=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback	513	=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
322		514
323	=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback	515	=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
		516
		517	=item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
		518
		519	=item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback)
324		520
325	Similar to EV::timer, but is not based on relative timeouts but on	521	Similar to EV::timer, but is not based on relative timeouts but on
326	absolute times. Apart from creating "simple" timers that trigger "at" the	522	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	523	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	524	more complex, cron-like, setups that are not adversely affected by time
…		…
338	This time simply fires at the wallclock time C<$at> and doesn't repeat. It	534	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	535	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	536	at January 1st 2011 then it will run when the system time reaches or
341	surpasses this time.	537	surpasses this time.
342		538
343	=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0)	539	=item * repeating interval timer ($interval > 0, $reschedule_cb = 0)
344		540
345	In this mode the watcher will always be scheduled to time out at the	541	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,	542	next C<$at + N * $interval> time (for some integer N) and then repeat,
347	regardless of any time jumps.	543	regardless of any time jumps.
348		544
…		…
396		592
397	The C<periodic_ns> variant doesn't start (activate) the newly created watcher.	593	The C<periodic_ns> variant doesn't start (activate) the newly created watcher.
398		594
399	=item $w->set ($at, $interval, $reschedule_cb)	595	=item $w->set ($at, $interval, $reschedule_cb)
400		596
401	Reconfigures the watcher, see the constructor above for details. Can be at	597	Reconfigures the watcher, see the constructor above for details. Can be called at
402	any time.	598	any time.
403		599
404	=item $w->again	600	=item $w->again
405		601
406	Simply stops and starts the watcher again.	602	Simply stops and starts the watcher again.
407		603
		604	=item $time = $w->at
		605
		606	Return the time that the watcher is expected to trigger next.
		607
		608	=back
		609
		610
		611	=head3 SIGNAL WATCHERS - signal me when a signal gets signalled!
		612
		613	=over 4
408		614
409	=item $w = EV::signal $signal, $callback	615	=item $w = EV::signal $signal, $callback
410		616
411	=item $w = EV::signal_ns $signal, $callback	617	=item $w = EV::signal_ns $signal, $callback
412		618
413	Call the callback when $signal is received (the signal can be specified	619	Call the callback when $signal is received (the signal can be specified by
414	by number or by name, just as with kill or %SIG).	620	number or by name, just as with C<kill> or C<%SIG>).
415		621
416	EV will grab the signal for the process (the kernel only allows one	622	EV will grab the signal for the process (the kernel only allows one
417	component to receive a signal at a time) when you start a signal watcher,	623	component to receive a signal at a time) when you start a signal watcher,
418	and removes it again when you stop it. Perl does the same when you	624	and removes it again when you stop it. Perl does the same when you
419	add/remove callbacks to %SIG, so watch out.	625	add/remove callbacks to C<%SIG>, so watch out.
420		626
421	You can have as many signal watchers per signal as you want.	627	You can have as many signal watchers per signal as you want.
422		628
423	The C<signal_ns> variant doesn't start (activate) the newly created watcher.	629	The C<signal_ns> variant doesn't start (activate) the newly created watcher.
424		630
425	=item $w->set ($signal)	631	=item $w->set ($signal)
426		632
427	Reconfigures the watcher, see the constructor above for details. Can be at	633	Reconfigures the watcher, see the constructor above for details. Can be
428	any time.	634	called at any time.
429		635
430	=item $current_signum = $w->signal	636	=item $current_signum = $w->signal
431		637
432	=item $old_signum = $w->signal ($new_signal)	638	=item $old_signum = $w->signal ($new_signal)
433		639
434	Returns the previously set signal (always as a number not name) and	640	Returns the previously set signal (always as a number not name) and
435	optionally set a new one.	641	optionally set a new one.
436		642
		643	=back
437		644
		645
		646	=head3 CHILD WATCHERS - watch out for process status changes
		647
		648	=over 4
		649
438	=item $w = EV::child $pid, $callback	650	=item $w = EV::child $pid, $trace, $callback
439		651
440	=item $w = EV::child_ns $pid, $callback	652	=item $w = EV::child_ns $pid, $trace, $callback
		653
		654	=item $w = $loop->child ($pid, $trace, $callback)
		655
		656	=item $w = $loop->child_ns ($pid, $trace, $callback)
441		657
442	Call the callback when a status change for pid C<$pid> (or any pid	658	Call the callback when a status change for pid C<$pid> (or any pid
443	if C<$pid> is 0) has been received. More precisely: when the process	659	if C<$pid> is 0) has been received (a status change happens when the
		660	process terminates or is killed, or, when trace is true, additionally when
		661	it is stopped or continued). More precisely: when the process receives
444	receives a SIGCHLD, EV will fetch the outstanding exit/wait status for all	662	a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all
445	changed/zombie children and call the callback.	663	changed/zombie children and call the callback.
446		664
447	You can access both status and pid by using the C<rstatus> and C<rpid>	665	It is valid (and fully supported) to install a child watcher after a child
448	methods on the watcher object.	666	has exited but before the event loop has started its next iteration (for
		667	example, first you C<fork>, then the new child process might exit, and
		668	only then do you install a child watcher in the parent for the new pid).
449		669
		670	You can access both exit (or tracing) status and pid by using the
		671	C<rstatus> and C<rpid> methods on the watcher object.
		672
450	You can have as many pid watchers per pid as you want.	673	You can have as many pid watchers per pid as you want, they will all be
		674	called.
451		675
452	The C<child_ns> variant doesn't start (activate) the newly created watcher.	676	The C<child_ns> variant doesn't start (activate) the newly created watcher.
453		677
454	=item $w->set ($pid)	678	=item $w->set ($pid, $trace)
455		679
456	Reconfigures the watcher, see the constructor above for details. Can be at	680	Reconfigures the watcher, see the constructor above for details. Can be called at
457	any time.	681	any time.
458		682
459	=item $current_pid = $w->pid	683	=item $current_pid = $w->pid
460
461	=item $old_pid = $w->pid ($new_pid)
462		684
463	Returns the previously set process id and optionally set a new one.	685	Returns the previously set process id and optionally set a new one.
464		686
465	=item $exit_status = $w->rstatus	687	=item $exit_status = $w->rstatus
466		688
…		…
470	=item $pid = $w->rpid	692	=item $pid = $w->rpid
471		693
472	Return the pid of the awaited child (useful when you have installed a	694	Return the pid of the awaited child (useful when you have installed a
473	watcher for all pids).	695	watcher for all pids).
474		696
		697	=back
		698
		699
		700	=head3 STAT WATCHERS - did the file attributes just change?
		701
		702	=over 4
		703
		704	=item $w = EV::stat $path, $interval, $callback
		705
		706	=item $w = EV::stat_ns $path, $interval, $callback
		707
		708	=item $w = $loop->stat ($path, $interval, $callback)
		709
		710	=item $w = $loop->stat_ns ($path, $interval, $callback)
		711
		712	Call the callback when a file status change has been detected on
		713	C<$path>. The C<$path> does not need to exist, changing from "path exists"
		714	to "path does not exist" is a status change like any other.
		715
		716	The C<$interval> is a recommended polling interval for systems where
		717	OS-supported change notifications don't exist or are not supported. If
		718	you use C<0> then an unspecified default is used (which is highly
		719	recommended!), which is to be expected to be around five seconds usually.
		720
		721	This watcher type is not meant for massive numbers of stat watchers,
		722	as even with OS-supported change notifications, this can be
		723	resource-intensive.
		724
		725	The C<stat_ns> variant doesn't start (activate) the newly created watcher.
		726
		727	=item ... = $w->stat
		728
		729	This call is very similar to the perl C<stat> built-in: It stats (using
		730	C<lstat>) the path specified in the watcher and sets perls stat cache (as
		731	well as EV's idea of the current stat values) to the values found.
		732
		733	In scalar context, a boolean is return indicating success or failure of
		734	the stat. In list context, the same 13-value list as with stat is returned
		735	(except that the blksize and blocks fields are not reliable).
		736
		737	In the case of an error, errno is set to C<ENOENT> (regardless of the
		738	actual error value) and the C<nlink> value is forced to zero (if the stat
		739	was successful then nlink is guaranteed to be non-zero).
		740
		741	See also the next two entries for more info.
		742
		743	=item ... = $w->attr
		744
		745	Just like C<< $w->stat >>, but without the initial stat'ing: this returns
		746	the values most recently detected by EV. See the next entry for more info.
		747
		748	=item ... = $w->prev
		749
		750	Just like C<< $w->stat >>, but without the initial stat'ing: this returns
		751	the previous set of values, before the change.
		752
		753	That is, when the watcher callback is invoked, C<< $w->prev >> will be set
		754	to the values found I<before> a change was detected, while C<< $w->attr >>
		755	returns the values found leading to the change detection. The difference (if any)
		756	between C<prev> and C<attr> is what triggered the callback.
		757
		758	If you did something to the filesystem object and do not want to trigger
		759	yet another change, you can call C<stat> to update EV's idea of what the
		760	current attributes are.
		761
		762	=item $w->set ($path, $interval)
		763
		764	Reconfigures the watcher, see the constructor above for details. Can be
		765	called at any time.
		766
		767	=item $current_path = $w->path
		768
		769	=item $old_path = $w->path ($new_path)
		770
		771	Returns the previously set path and optionally set a new one.
		772
		773	=item $current_interval = $w->interval
		774
		775	=item $old_interval = $w->interval ($new_interval)
		776
		777	Returns the previously set interval and optionally set a new one. Can be
		778	used to query the actual interval used.
		779
		780	=back
		781
		782
		783	=head3 IDLE WATCHERS - when you've got nothing better to do...
		784
		785	=over 4
475		786
476	=item $w = EV::idle $callback	787	=item $w = EV::idle $callback
477		788
478	=item $w = EV::idle_ns $callback	789	=item $w = EV::idle_ns $callback
479		790
480	Call the callback when there are no pending io, timer/periodic, signal or	791	=item $w = $loop->idle ($callback)
481	child events, i.e. when the process is idle.	792
		793	=item $w = $loop->idle_ns ($callback)
		794
		795	Call the callback when there are no other pending watchers of the same or
		796	higher priority (excluding check, prepare and other idle watchers of the
		797	same or lower priority, of course). They are called idle watchers because
		798	when the watcher is the highest priority pending event in the process, the
		799	process is considered to be idle at that priority.
		800
		801	If you want a watcher that is only ever called when I<no> other events are
		802	outstanding you have to set the priority to C<EV::MINPRI>.
482		803
483	The process will not block as long as any idle watchers are active, and	804	The process will not block as long as any idle watchers are active, and
484	they will be called repeatedly until stopped.	805	they will be called repeatedly until stopped.
485		806
		807	For example, if you have idle watchers at priority C<0> and C<1>, and
		808	an I/O watcher at priority C<0>, then the idle watcher at priority C<1>
		809	and the I/O watcher will always run when ready. Only when the idle watcher
		810	at priority C<1> is stopped and the I/O watcher at priority C<0> is not
		811	pending with the C<0>-priority idle watcher be invoked.
		812
486	The C<idle_ns> variant doesn't start (activate) the newly created watcher.	813	The C<idle_ns> variant doesn't start (activate) the newly created watcher.
487		814
		815	=back
		816
		817
		818	=head3 PREPARE WATCHERS - customise your event loop!
		819
		820	=over 4
488		821
489	=item $w = EV::prepare $callback	822	=item $w = EV::prepare $callback
490		823
491	=item $w = EV::prepare_ns $callback	824	=item $w = EV::prepare_ns $callback
		825
		826	=item $w = $loop->prepare ($callback)
		827
		828	=item $w = $loop->prepare_ns ($callback)
492		829
493	Call the callback just before the process would block. You can still	830	Call the callback just before the process would block. You can still
494	create/modify any watchers at this point.	831	create/modify any watchers at this point.
495		832
496	See the EV::check watcher, below, for explanations and an example.	833	See the EV::check watcher, below, for explanations and an example.
497		834
498	The C<prepare_ns> variant doesn't start (activate) the newly created watcher.	835	The C<prepare_ns> variant doesn't start (activate) the newly created watcher.
499		836
		837	=back
		838
		839
		840	=head3 CHECK WATCHERS - customise your event loop even more!
		841
		842	=over 4
500		843
501	=item $w = EV::check $callback	844	=item $w = EV::check $callback
502		845
503	=item $w = EV::check_ns $callback	846	=item $w = EV::check_ns $callback
		847
		848	=item $w = $loop->check ($callback)
		849
		850	=item $w = $loop->check_ns ($callback)
504		851
505	Call the callback just after the process wakes up again (after it has	852	Call the callback just after the process wakes up again (after it has
506	gathered events), but before any other callbacks have been invoked.	853	gathered events), but before any other callbacks have been invoked.
507		854
508	This is used to integrate other event-based software into the EV	855	This is used to integrate other event-based software into the EV
…		…
518	or return;	865	or return;
519		866
520	# make the dispatcher handle any outstanding stuff	867	# make the dispatcher handle any outstanding stuff
521	... not shown	868	... not shown
522		869
523	# create an IO watcher for each and every socket	870	# create an I/O watcher for each and every socket
524	@snmp_watcher = (	871	@snmp_watcher = (
525	(map { EV::io $_, EV::READ, sub { } }	872	(map { EV::io $_, EV::READ, sub { } }
526	keys %{ $dispatcher->{_descriptors} }),	873	keys %{ $dispatcher->{_descriptors} }),
527		874
528	EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]	875	EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]
…		…
549	first).	896	first).
550		897
551	The C<check_ns> variant doesn't start (activate) the newly created watcher.	898	The C<check_ns> variant doesn't start (activate) the newly created watcher.
552		899
553	=back	900	=back
		901
		902
		903	=head3 FORK WATCHERS - the audacity to resume the event loop after a fork
		904
		905	Fork watchers are called when a C<fork ()> was detected. The invocation
		906	is done before the event loop blocks next and before C<check> watchers
		907	are being called, and only in the child after the fork.
		908
		909	=over 4
		910
		911	=item $w = EV::fork $callback
		912
		913	=item $w = EV::fork_ns $callback
		914
		915	=item $w = $loop->fork ($callback)
		916
		917	=item $w = $loop->fork_ns ($callback)
		918
		919	Call the callback before the event loop is resumed in the child process
		920	after a fork.
		921
		922	The C<fork_ns> variant doesn't start (activate) the newly created watcher.
		923
		924	=back
		925
		926
		927	=head3 EMBED WATCHERS - when one backend isn't enough...
		928
		929	This is a rather advanced watcher type that lets you embed one event loop
		930	into another (currently only IO events are supported in the embedded
		931	loop, other types of watchers might be handled in a delayed or incorrect
		932	fashion and must not be used).
		933
		934	See the libev documentation at
		935	L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
		936	for more details.
		937
		938	In short, this watcher is most useful on BSD systems without working
		939	kqueue to still be able to handle a large number of sockets:
		940
		941	my $socket_loop;
		942
		943	# check wether we use SELECT or POLL _and_ KQUEUE is supported
		944	if (
		945	(EV::backend & (EV::BACKEND_POLL \| EV::BACKEND_SELECT))
		946	&& (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
		947	) {
		948	# use kqueue for sockets
		949	$socket_loop = new EV::Loop EV::BACKEND_KQUEUE \| EV::FLAG_NOENV;
		950	}
		951
		952	# use the default loop otherwise
		953	$socket_loop \|\|= EV::default_loop;
		954
		955	=over 4
		956
		957	=item $w = EV::embed $otherloop, $callback
		958
		959	=item $w = EV::embed_ns $otherloop, $callback
		960
		961	=item $w = $loop->embed ($otherloop, $callback)
		962
		963	=item $w = $loop->embed_ns ($otherloop, $callback)
		964
		965	Call the callback when the embedded event loop (C<$otherloop>) has any
		966	I/O activity. The C<$callback> should alwas be specified as C<undef> in
		967	this version of EV, which means the embedded event loop will be managed
		968	automatically.
		969
		970	The C<embed_ns> variant doesn't start (activate) the newly created watcher.
		971
		972	=back
		973
		974	=head3 ASYNC WATCHERS - how to wake up another event loop
		975
		976	Async watchers are provided by EV, but have little use in perl directly, as perl
		977	neither supports threads nor direct access to signal handlers or other
		978	contexts where they could be of value.
		979
		980	It is, however, possible to use them from the XS level.
		981
		982	Please see the libev documentation for further details.
		983
		984	=over 4
		985
		986	=item $w = EV::async $callback
		987
		988	=item $w = EV::async_ns $callback
		989
		990	=item $w->send
		991
		992	=item $bool = $w->async_pending
		993
		994	=back
		995
		996
		997	=head1 PERL SIGNALS
		998
		999	While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour
		1000	with EV is as the same as any other C library: Perl-signals will only be
		1001	handled when Perl runs, which means your signal handler might be invoked
		1002	only the next time an event callback is invoked.
		1003
		1004	The solution is to use EV signal watchers (see C<EV::signal>), which will
		1005	ensure proper operations with regards to other event watchers.
		1006
		1007	If you cannot do this for whatever reason, you can also force a watcher
		1008	to be called on every event loop iteration by installing a C<EV::check>
		1009	watcher:
		1010
		1011	my $async_check = EV::check sub { };
		1012
		1013	This ensures that perl gets into control for a short time to handle any
		1014	pending signals, and also ensures (slightly) slower overall operation.
554		1015
555	=head1 THREADS	1016	=head1 THREADS
556		1017
557	Threads are not supported by this module in any way. Perl pseudo-threads	1018	Threads are not supported by this module in any way. Perl pseudo-threads
558	is evil stuff and must die. As soon as Perl gains real threads I will work	1019	is evil stuff and must die. As soon as Perl gains real threads I will work
…		…
580	our $DIED = sub {	1041	our $DIED = sub {
581	warn "EV: error in callback (ignoring): $@";	1042	warn "EV: error in callback (ignoring): $@";
582	};	1043	};
583		1044
584	default_loop	1045	default_loop
585	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?';	1046	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?';
586		1047
587	1;	1048	1;
588		1049
589	=head1 SEE ALSO	1050	=head1 SEE ALSO
590		1051
591	L<EV::DNS>.	1052	L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as
		1053	event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient
		1054	coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP).
592		1055
593	=head1 AUTHOR	1056	=head1 AUTHOR
594		1057
595	Marc Lehmann <schmorp@schmorp.de>	1058	Marc Lehmann <schmorp@schmorp.de>
596	http://home.schmorp.de/	1059	http://home.schmorp.de/

Diff Legend

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

Comparing EV/EV.pm (file contents): Revision 1.49 by root, Sat Nov 24 08:28:10 2007 UTC vs. Revision 1.87 by root, Tue Apr 15 04:41:57 2008 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.49 by root, Sat Nov 24 08:28:10 2007 UTC vs.
Revision 1.87 by root, Tue Apr 15 04:41:57 2008 UTC