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

Comparing EV/EV.pm (file contents):
Revision 1.54 by root, Tue Nov 27 07:27:10 2007 UTC vs.
Revision 1.165 by root, Wed Mar 18 13:21:14 2020 UTC

…		…
2		2
3	EV - perl interface to libev, a high performance full-featured event loop	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
		9	# TIMERS
		10
		11	my $w = EV::timer 2, 0, sub {
		12	warn "is called after 2s";
		13	};
		14
		15	my $w = EV::timer 2, 2, sub {
		16	warn "is called roughly every 2s (repeat = 2)";
		17	};
		18
		19	undef $w; # destroy event watcher again
		20
		21	my $w = EV::periodic 0, 60, 0, sub {
		22	warn "is called every minute, on the minute, exactly";
		23	};
		24
		25	# IO
		26
		27	my $w = EV::io *STDIN, EV::READ, sub {
		28	my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
		29	warn "stdin is readable, you entered: ", <STDIN>;
		30	};
		31
		32	# SIGNALS
		33
		34	my $w = EV::signal 'QUIT', sub {
		35	warn "sigquit received\n";
		36	};
		37
		38	# CHILD/PID STATUS CHANGES
8		39
9	# TIMERS	40	my $w = EV::child 666, 0, sub {
		41	my ($w, $revents) = @_;
		42	my $status = $w->rstatus;
		43	};
10		44
11	my $w = EV::timer 2, 0, sub {
12	warn "is called after 2s";
13	};
14
15	my $w = EV::timer 2, 2, sub {
16	warn "is called roughly every 2s (repeat = 2)";
17	};
18
19	undef $w; # destroy event watcher again
20
21	my $w = EV::periodic 0, 60, 0, sub {
22	warn "is called every minute, on the minute, exactly";
23	};
24
25	# IO
26
27	my $w = EV::io *STDIN, EV::READ, sub {
28	my ($w, $revents) = @_; # all callbacks receive the watcher and event mask
29	warn "stdin is readable, you entered: ", <STDIN>;
30	};
31
32	# SIGNALS
33
34	my $w = EV::signal 'QUIT', sub {
35	warn "sigquit received\n";
36	};
37
38	# CHILD/PID STATUS CHANGES
39
40	my $w = EV::child 666, sub {
41	my ($w, $revents) = @_;
42	my $status = $w->rstatus;
43	};
44
45	# STAT CHANGES	45	# STAT CHANGES
46	my $w = EV::stat "/etc/passwd", 10, sub {	46	my $w = EV::stat "/etc/passwd", 10, sub {
47	my ($w, $revents) = @_;	47	my ($w, $revents) = @_;
48	warn $w->path, " has changed somehow.\n";	48	warn $w->path, " has changed somehow.\n";
49	};	49	};
50		50
51	# MAINLOOP	51	# MAINLOOP
52	EV::loop; # loop until EV::unloop is called or all watchers stop	52	EV::run; # loop until EV::break is called or all watchers stop
53	EV::loop EV::LOOP_ONESHOT; # block until at least one event could be handled	53	EV::run EV::RUN_ONCE; # block until at least one event could be handled
54	EV::loop EV::LOOP_NONBLOCK; # try to handle same events, but do not block	54	EV::run EV::RUN_NOWAIT; # try to handle same events, but do not block
		55
		56	=head1 BEFORE YOU START USING THIS MODULE
		57
		58	If you only need timer, I/O, signal, child and idle watchers and not the
		59	advanced functionality of this module, consider using L<AnyEvent> instead,
		60	specifically the simplified API described in L<AE>.
		61
		62	When used with EV as backend, the L<AE> API is as fast as the native L<EV>
		63	API, but your programs/modules will still run with many other event loops.
55		64
56	=head1 DESCRIPTION	65	=head1 DESCRIPTION
57		66
58	This module provides an interface to libev	67	This module provides an interface to libev
59	(L<http://software.schmorp.de/pkg/libev.html>). While the documentation	68	(L<http://software.schmorp.de/pkg/libev.html>). While the documentation
60	below is comprehensive, one might also consult the documentation of libev	69	below is comprehensive, one might also consult the documentation of
61	itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on	70	libev itself (L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod> or
62	watcher semantics or some discussion on the available backends, or how to	71	F<perldoc EV::libev>) for more subtle details on watcher semantics or some
63	force a specific backend with C<LIBEV_FLAGS>.	72	discussion on the available backends, or how to force a specific backend
		73	with C<LIBEV_FLAGS>, or just about in any case because it has much more
		74	detailed information.
		75
		76	This module is very fast and scalable. It is actually so fast that you
		77	can use it through the L<AnyEvent> module, stay portable to other event
		78	loops (if you don't rely on any watcher types not available through it)
		79	and still be faster than with any other event loop currently supported in
		80	Perl.
		81
		82	=head2 PORTING FROM EV 3.X to 4.X
		83
		84	EV version 4 introduces a number of incompatible changes summarised
		85	here. According to the depreciation strategy used by libev, there is a
		86	compatibility layer in place so programs should continue to run unchanged
		87	(the XS interface lacks this layer, so programs using that one need to be
		88	updated).
		89
		90	This compatibility layer will be switched off in some future release.
		91
		92	All changes relevant to Perl are renames of symbols, functions and
		93	methods:
		94
		95	EV::loop => EV::run
		96	EV::LOOP_NONBLOCK => EV::RUN_NOWAIT
		97	EV::LOOP_ONESHOT => EV::RUN_ONCE
		98
		99	EV::unloop => EV::break
		100	EV::UNLOOP_CANCEL => EV::BREAK_CANCEL
		101	EV::UNLOOP_ONE => EV::BREAK_ONE
		102	EV::UNLOOP_ALL => EV::BREAK_ALL
		103
		104	EV::TIMEOUT => EV::TIMER
		105
		106	EV::loop_count => EV::iteration
		107	EV::loop_depth => EV::depth
		108	EV::loop_verify => EV::verify
		109
		110	The loop object methods corresponding to the functions above have been
		111	similarly renamed.
		112
		113	=head2 MODULE EXPORTS
		114
		115	This module does not export any symbols.
64		116
65	=cut	117	=cut
66		118
67	package EV;	119	package EV;
68		120
69	use strict;	121	use common::sense;
70		122
71	BEGIN {	123	BEGIN {
72	our $VERSION = '1.4';	124	our $VERSION = '4.33';
73	use XSLoader;	125	use XSLoader;
		126	local $^W = 0; # avoid spurious warning
74	XSLoader::load "EV", $VERSION;	127	XSLoader::load "EV", $VERSION;
75	}	128	}
76		129
77	@EV::IO::ISA =	130	@EV::IO::ISA =
78	@EV::Timer::ISA =	131	@EV::Timer::ISA =
79	@EV::Periodic::ISA =	132	@EV::Periodic::ISA =
80	@EV::Signal::ISA =	133	@EV::Signal::ISA =
		134	@EV::Child::ISA =
		135	@EV::Stat::ISA =
81	@EV::Idle::ISA =	136	@EV::Idle::ISA =
82	@EV::Prepare::ISA =	137	@EV::Prepare::ISA =
83	@EV::Check::ISA =	138	@EV::Check::ISA =
84	@EV::Child::ISA =
85	@EV::Embed::ISA =	139	@EV::Embed::ISA =
86	@EV::Stat::ISA = "EV::Watcher";	140	@EV::Fork::ISA =
		141	@EV::Async::ISA =
		142	"EV::Watcher";
		143
		144	@EV::Loop::Default::ISA = "EV::Loop";
		145
		146	=head1 EVENT LOOPS
		147
		148	EV supports multiple event loops: There is a single "default event loop"
		149	that can handle everything including signals and child watchers, and any
		150	number of "dynamic event loops" that can use different backends (with
		151	various limitations), but no child and signal watchers.
		152
		153	You do not have to do anything to create the default event loop: When
		154	the module is loaded a suitable backend is selected on the premise of
		155	selecting a working backend (which for example rules out kqueue on most
		156	BSDs). Modules should, unless they have "special needs" always use the
		157	default loop as this is fastest (perl-wise), best supported by other
		158	modules (e.g. AnyEvent or Coro) and most portable event loop.
		159
		160	For specific programs you can create additional event loops dynamically.
		161
		162	If you want to take advantage of kqueue (which often works properly for
		163	sockets only) even though the default loop doesn't enable it, you can
		164	I<embed> a kqueue loop into the default loop: running the default loop
		165	will then also service the kqueue loop to some extent. See the example in
		166	the section about embed watchers for an example on how to achieve that.
		167
		168	=over 4
		169
		170	=item $loop = new EV::Loop [$flags]
		171
		172	Create a new event loop as per the specified flags. Please refer to
		173	the C<ev_loop_new ()> function description in the libev documentation
		174	(L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>,
		175	or locally-installed as F<EV::libev> manpage) for more info.
		176
		177	The loop will automatically be destroyed when it is no longer referenced
		178	by any watcher and the loop object goes out of scope.
		179
		180	If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK>
		181	is recommended, as only the default event loop is protected by this
		182	module. If you I<are> embedding this loop in the default loop, this is not
		183	necessary, as C<EV::embed> automatically does the right thing on fork.
		184
		185	=item $loop->loop_fork
		186
		187	Must be called after a fork in the child, before entering or continuing
		188	the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
		189	this function automatically, at some performance loss (refer to the libev
		190	documentation).
		191
		192	=item $loop->verify
		193
		194	Calls C<ev_verify> to make internal consistency checks (for debugging
		195	libev) and abort the program if any data structures were found to be
		196	corrupted.
		197
		198	=item $loop = EV::default_loop [$flags]
		199
		200	Return the default loop (which is a singleton object). Since this module
		201	already creates the default loop with default flags, specifying flags here
		202	will not have any effect unless you destroy the default loop first, which
		203	isn't supported. So in short: don't do it, and if you break it, you get to
		204	keep the pieces.
		205
		206	=back
		207
87		208
88	=head1 BASIC INTERFACE	209	=head1 BASIC INTERFACE
89		210
90	=over 4	211	=over 4
91		212
92	=item $EV::DIED	213	=item $EV::DIED
93		214
94	Must contain a reference to a function that is called when a callback	215	Must contain a reference to a function that is called when a callback
95	throws an exception (with $@ containing thr error). The default prints an	216	throws an exception (with $@ containing the error). The default prints an
96	informative message and continues.	217	informative message and continues.
97		218
98	If this callback throws an exception it will be silently ignored.	219	If this callback throws an exception it will be silently ignored.
99		220
		221	=item $flags = EV::supported_backends
		222
		223	=item $flags = EV::recommended_backends
		224
		225	=item $flags = EV::embeddable_backends
		226
		227	Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this
		228	instance of EV, the set of recommended backends (supposed to be good) for
		229	this platform and the set of embeddable backends (see EMBED WATCHERS).
		230
		231	=item EV::sleep $seconds
		232
		233	Block the process for the given number of (fractional) seconds.
		234
100	=item $time = EV::time	235	=item $time = EV::time
101		236
102	Returns the current time in (fractional) seconds since the epoch.	237	Returns the current time in (fractional) seconds since the epoch.
103		238
104	=item $time = EV::now	239	=item $time = EV::now
105		240
		241	=item $time = $loop->now
		242
106	Returns the time the last event loop iteration has been started. This	243	Returns the time the last event loop iteration has been started. This
107	is the time that (relative) timers are based on, and refering to it is	244	is the time that (relative) timers are based on, and referring to it is
108	usually faster then calling EV::time.	245	usually faster then calling EV::time.
109		246
110	=item $method = EV::method	247	=item EV::now_update
111		248
		249	=item $loop->now_update
		250
		251	Establishes the current time by querying the kernel, updating the time
		252	returned by C<EV::now> in the progress. This is a costly operation and
		253	is usually done automatically within C<EV::run>.
		254
		255	This function is rarely useful, but when some event callback runs for a
		256	very long time without entering the event loop, updating libev's idea of
		257	the current time is a good idea.
		258
		259	=item EV::suspend
		260
		261	=item $loop->suspend
		262
		263	=item EV::resume
		264
		265	=item $loop->resume
		266
		267	These two functions suspend and resume a loop, for use when the loop is
		268	not used for a while and timeouts should not be processed.
		269
		270	A typical use case would be an interactive program such as a game: When
		271	the user presses C<^Z> to suspend the game and resumes it an hour later it
		272	would be best to handle timeouts as if no time had actually passed while
		273	the program was suspended. This can be achieved by calling C<suspend>
		274	in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
		275	C<resume> directly afterwards to resume timer processing.
		276
		277	Effectively, all C<timer> watchers will be delayed by the time spend
		278	between C<suspend> and C<resume>, and all C<periodic> watchers
		279	will be rescheduled (that is, they will lose any events that would have
		280	occured while suspended).
		281
		282	After calling C<suspend> you B<must not> call I<any> function on the given
		283	loop other than C<resume>, and you B<must not> call C<resume>
		284	without a previous call to C<suspend>.
		285
		286	Calling C<suspend>/C<resume> has the side effect of updating the event
		287	loop time (see C<now_update>).
		288
		289	=item $backend = EV::backend
		290
		291	=item $backend = $loop->backend
		292
112	Returns an integer describing the backend used by libev (EV::METHOD_SELECT	293	Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
113	or EV::METHOD_EPOLL).	294	or EV::BACKEND_EPOLL).
114		295
115	=item EV::loop [$flags]	296	=item $active = EV::run [$flags]
		297
		298	=item $active = $loop->run ([$flags])
116		299
117	Begin checking for events and calling callbacks. It returns when a	300	Begin checking for events and calling callbacks. It returns when a
118	callback calls EV::unloop.	301	callback calls EV::break or the flags are nonzero (in which case the
		302	return value is true) or when there are no active watchers which reference
		303	the loop (keepalive is true), in which case the return value will be
		304	false. The return value can generally be interpreted as "if true, there is
		305	more work left to do".
119		306
120	The $flags argument can be one of the following:	307	The $flags argument can be one of the following:
121		308
122	0 as above	309	0 as above
123	EV::LOOP_ONESHOT block at most once (wait, but do not loop)	310	EV::RUN_ONCE block at most once (wait, but do not loop)
124	EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait)	311	EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait)
125		312
126	=item EV::unloop [$how]	313	=item EV::break [$how]
127		314
		315	=item $loop->break ([$how])
		316
128	When called with no arguments or an argument of EV::UNLOOP_ONE, makes the	317	When called with no arguments or an argument of EV::BREAK_ONE, makes the
129	innermost call to EV::loop return.	318	innermost call to EV::run return.
130		319
131	When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as	320	When called with an argument of EV::BREAK_ALL, all calls to EV::run will
132	fast as possible.	321	return as fast as possible.
		322
		323	When called with an argument of EV::BREAK_CANCEL, any pending break will
		324	be cancelled.
		325
		326	=item $count = EV::iteration
		327
		328	=item $count = $loop->iteration
		329
		330	Return the number of times the event loop has polled for new
		331	events. Sometimes useful as a generation counter.
133		332
134	=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)	333	=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
		334
		335	=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
135		336
136	This function rolls together an I/O and a timer watcher for a single	337	This function rolls together an I/O and a timer watcher for a single
137	one-shot event without the need for managing a watcher object.	338	one-shot event without the need for managing a watcher object.
138		339
139	If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events>	340	If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events>
…		…
141	\| EV::WRITE>, indicating the type of I/O event you want to wait for. If	342	\| EV::WRITE>, indicating the type of I/O event you want to wait for. If
142	you do not want to wait for some I/O event, specify C<undef> for	343	you do not want to wait for some I/O event, specify C<undef> for
143	C<$fh_or_undef> and C<0> for C<$events>).	344	C<$fh_or_undef> and C<0> for C<$events>).
144		345
145	If timeout is C<undef> or negative, then there will be no	346	If timeout is C<undef> or negative, then there will be no
146	timeout. Otherwise a EV::timer with this value will be started.	347	timeout. Otherwise an C<EV::timer> with this value will be started.
147		348
148	When an error occurs or either the timeout or I/O watcher triggers, then	349	When an error occurs or either the timeout or I/O watcher triggers, then
149	the callback will be called with the received event set (in general	350	the callback will be called with the received event set (in general
150	you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>,	351	you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>,
151	C<EV::WRITE> and C<EV::TIMEOUT>).	352	C<EV::WRITE> and C<EV::TIMER>).
152		353
153	EV::once doesn't return anything: the watchers stay active till either	354	EV::once doesn't return anything: the watchers stay active till either
154	of them triggers, then they will be stopped and freed, and the callback	355	of them triggers, then they will be stopped and freed, and the callback
155	invoked.	356	invoked.
156		357
157	=back	358	=item EV::feed_fd_event $fd, $revents
158		359
		360	=item $loop->feed_fd_event ($fd, $revents)
		361
		362	Feed an event on a file descriptor into EV. EV will react to this call as
		363	if the readyness notifications specified by C<$revents> (a combination of
		364	C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>.
		365
		366	=item EV::feed_signal_event $signal
		367
		368	Feed a signal event into the default loop. EV will react to this call as
		369	if the signal specified by C<$signal> had occured.
		370
		371	=item EV::feed_signal $signal
		372
		373	Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works
		374	regardless of which loop has registered the signal, and is mainly useful
		375	for custom signal implementations.
		376
		377	=item EV::set_io_collect_interval $time
		378
		379	=item $loop->set_io_collect_interval ($time)
		380
		381	=item EV::set_timeout_collect_interval $time
		382
		383	=item $loop->set_timeout_collect_interval ($time)
		384
		385	These advanced functions set the minimum block interval when polling for I/O events and the minimum
		386	wait interval for timer events. See the libev documentation at
		387	L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP>
		388	(locally installed as F<EV::libev>) for a more detailed discussion.
		389
		390	=item $count = EV::pending_count
		391
		392	=item $count = $loop->pending_count
		393
		394	Returns the number of currently pending watchers.
		395
		396	=item EV::invoke_pending
		397
		398	=item $loop->invoke_pending
		399
		400	Invoke all currently pending watchers.
		401
		402	=back
		403
		404
159	=head2 WATCHER OBJECTS	405	=head1 WATCHER OBJECTS
160		406
161	A watcher is an object that gets created to record your interest in some	407	A watcher is an object that gets created to record your interest in some
162	event. For instance, if you want to wait for STDIN to become readable, you	408	event. For instance, if you want to wait for STDIN to become readable, you
163	would create an EV::io watcher for that:	409	would create an EV::io watcher for that:
164		410
165	my $watcher = EV::io *STDIN, EV::READ, sub {	411	my $watcher = EV::io *STDIN, EV::READ, sub {
166	my ($watcher, $revents) = @_;	412	my ($watcher, $revents) = @_;
167	warn "yeah, STDIN should not be readable without blocking!\n"	413	warn "yeah, STDIN should now be readable without blocking!\n"
168	};	414	};
169		415
170	All watchers can be active (waiting for events) or inactive (paused). Only	416	All watchers can be active (waiting for events) or inactive (paused). Only
171	active watchers will have their callbacks invoked. All callbacks will be	417	active watchers will have their callbacks invoked. All callbacks will be
172	called with at least two arguments: the watcher and a bitmask of received	418	called with at least two arguments: the watcher and a bitmask of received
173	events.	419	events.
174		420
175	Each watcher type has its associated bit in revents, so you can use the	421	Each watcher type has its associated bit in revents, so you can use the
176	same callback for multiple watchers. The event mask is named after the	422	same callback for multiple watchers. The event mask is named after the
177	type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,	423	type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
178	EV::periodic sets EV::PERIODIC and so on, with the exception of IO events	424	EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events
179	(which can set both EV::READ and EV::WRITE bits), and EV::timer (which	425	(which can set both EV::READ and EV::WRITE bits).
180	uses EV::TIMEOUT).
181		426
182	In the rare case where one wants to create a watcher but not start it at	427	In the rare case where one wants to create a watcher but not start it at
183	the same time, each constructor has a variant with a trailing C<_ns> in	428	the same time, each constructor has a variant with a trailing C<_ns> in
184	its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.	429	its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.
185		430
…		…
205		450
206	=item $w->stop	451	=item $w->stop
207		452
208	Stop a watcher if it is active. Also clear any pending events (events that	453	Stop a watcher if it is active. Also clear any pending events (events that
209	have been received but that didn't yet result in a callback invocation),	454	have been received but that didn't yet result in a callback invocation),
210	regardless of wether the watcher was active or not.	455	regardless of whether the watcher was active or not.
211		456
212	=item $bool = $w->is_active	457	=item $bool = $w->is_active
213		458
214	Returns true if the watcher is active, false otherwise.	459	Returns true if the watcher is active, false otherwise.
215		460
…		…
245	The default priority of any newly-created watcher is 0.	490	The default priority of any newly-created watcher is 0.
246		491
247	Note that the priority semantics have not yet been fleshed out and are	492	Note that the priority semantics have not yet been fleshed out and are
248	subject to almost certain change.	493	subject to almost certain change.
249		494
250	=item $w->trigger ($revents)	495	=item $w->invoke ($revents)
251		496
252	Call the callback now with the given event mask.	497	Call the callback now with the given event mask.
253		498
		499	=item $w->feed_event ($revents)
		500
		501	Feed some events on this watcher into EV. EV will react to this call as if
		502	the watcher had received the given C<$revents> mask.
		503
		504	=item $revents = $w->clear_pending
		505
		506	If the watcher is pending, this function clears its pending status and
		507	returns its C<$revents> bitset (as if its callback was invoked). If the
		508	watcher isn't pending it does nothing and returns C<0>.
		509
254	=item $previous_state = $w->keepalive ($bool)	510	=item $previous_state = $w->keepalive ($bool)
255		511
256	Normally, C<EV::loop> will return when there are no active watchers	512	Normally, C<EV::run> will return when there are no active watchers
257	(which is a "deadlock" because no progress can be made anymore). This is	513	(which is a "deadlock" because no progress can be made anymore). This is
258	convinient because it allows you to start your watchers (and your jobs),	514	convenient because it allows you to start your watchers (and your jobs),
259	call C<EV::loop> once and when it returns you know that all your jobs are	515	call C<EV::run> once and when it returns you know that all your jobs are
260	finished (or they forgot to register some watchers for their task :).	516	finished (or they forgot to register some watchers for their task :).
261		517
262	Sometimes, however, this gets in your way, for example when you the module	518	Sometimes, however, this gets in your way, for example when the module
263	that calls C<EV::loop> (usually the main program) is not the same module	519	that calls C<EV::run> (usually the main program) is not the same module
264	as a long-living watcher (for example a DNS client module written by	520	as a long-living watcher (for example a DNS client module written by
265	somebody else even). Then you might want any outstanding requests to be	521	somebody else even). Then you might want any outstanding requests to be
266	handled, but you would not want to keep C<EV::loop> from returning just	522	handled, but you would not want to keep C<EV::run> from returning just
267	because you happen to have this long-running UDP port watcher.	523	because you happen to have this long-running UDP port watcher.
268		524
269	In this case you can clear the keepalive status, which means that even	525	In this case you can clear the keepalive status, which means that even
270	though your watcher is active, it won't keep C<EV::loop> from returning.	526	though your watcher is active, it won't keep C<EV::run> from returning.
271		527
272	The initial value for keepalive is true (enabled), and you cna change it	528	The initial value for keepalive is true (enabled), and you can change it
273	any time.	529	any time.
274		530
275	Example: Register an IO watcher for some UDP socket but do not keep the	531	Example: Register an I/O watcher for some UDP socket but do not keep the
276	event loop from running just because of that watcher.	532	event loop from running just because of that watcher.
277		533
278	my $udp_socket = ...	534	my $udp_socket = ...
279	my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };	535	my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
280	$udp_watcher->keepalive (0);	536	$udp_watcher->keepalive (0);
281		537
282	=back	538	=item $loop = $w->loop
283		539
		540	Return the loop that this watcher is attached to.
284		541
		542	=back
		543
		544
285	=head2 WATCHER TYPES	545	=head1 WATCHER TYPES
286		546
287	Each of the following subsections describes a single watcher type.	547	Each of the following subsections describes a single watcher type.
288		548
289	=head3 IO WATCHERS - is this file descriptor readable or writable?	549	=head3 I/O WATCHERS - is this file descriptor readable or writable?
290		550
291	=over 4	551	=over 4
292		552
293	=item $w = EV::io $fileno_or_fh, $eventmask, $callback	553	=item $w = EV::io $fileno_or_fh, $eventmask, $callback
294		554
295	=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback	555	=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
		556
		557	=item $w = $loop->io ($fileno_or_fh, $eventmask, $callback)
		558
		559	=item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback)
296		560
297	As long as the returned watcher object is alive, call the C<$callback>	561	As long as the returned watcher object is alive, call the C<$callback>
298	when at least one of events specified in C<$eventmask> occurs.	562	when at least one of events specified in C<$eventmask> occurs.
299		563
300	The $eventmask can be one or more of these constants ORed together:	564	The $eventmask can be one or more of these constants ORed together:
…		…
330		594
331	=item $w = EV::timer $after, $repeat, $callback	595	=item $w = EV::timer $after, $repeat, $callback
332		596
333	=item $w = EV::timer_ns $after, $repeat, $callback	597	=item $w = EV::timer_ns $after, $repeat, $callback
334		598
		599	=item $w = $loop->timer ($after, $repeat, $callback)
		600
		601	=item $w = $loop->timer_ns ($after, $repeat, $callback)
		602
335	Calls the callback after C<$after> seconds (which may be fractional). If	603	Calls the callback after C<$after> seconds (which may be fractional or
336	C<$repeat> is non-zero, the timer will be restarted (with the $repeat	604	negative). If C<$repeat> is non-zero, the timer will be restarted (with
337	value as $after) after the callback returns.	605	the $repeat value as $after) after the callback returns.
338		606
339	This means that the callback would be called roughly after C<$after>	607	This means that the callback would be called roughly after C<$after>
340	seconds, and then every C<$repeat> seconds. The timer does his best not	608	seconds, and then every C<$repeat> seconds. The timer does his best not
341	to drift, but it will not invoke the timer more often then once per event	609	to drift, but it will not invoke the timer more often then once per event
342	loop iteration, and might drift in other cases. If that isn't acceptable,	610	loop iteration, and might drift in other cases. If that isn't acceptable,
…		…
346	in front of the machine while the timer is running and changes the system	614	in front of the machine while the timer is running and changes the system
347	clock, the timer will nevertheless run (roughly) the same time.	615	clock, the timer will nevertheless run (roughly) the same time.
348		616
349	The C<timer_ns> variant doesn't start (activate) the newly created watcher.	617	The C<timer_ns> variant doesn't start (activate) the newly created watcher.
350		618
351	=item $w->set ($after, $repeat)	619	=item $w->set ($after, $repeat = 0)
352		620
353	Reconfigures the watcher, see the constructor above for details. Can be called at	621	Reconfigures the watcher, see the constructor above for details. Can be called at
354	any time.	622	any time.
355		623
356	=item $w->again	624	=item $w->again
		625
		626	=item $w->again ($repeat)
357		627
358	Similar to the C<start> method, but has special semantics for repeating timers:	628	Similar to the C<start> method, but has special semantics for repeating timers:
359		629
360	If the timer is active and non-repeating, it will be stopped.	630	If the timer is active and non-repeating, it will be stopped.
361		631
…		…
369	This behaviour is useful when you have a timeout for some IO	639	This behaviour is useful when you have a timeout for some IO
370	operation. You create a timer object with the same value for C<$after> and	640	operation. You create a timer object with the same value for C<$after> and
371	C<$repeat>, and then, in the read/write watcher, run the C<again> method	641	C<$repeat>, and then, in the read/write watcher, run the C<again> method
372	on the timeout.	642	on the timeout.
373		643
		644	If called with a C<$repeat> argument, then it uses this a timer repeat
		645	value.
		646
		647	=item $after = $w->remaining
		648
		649	Calculates and returns the remaining time till the timer will fire.
		650
		651	=item $repeat = $w->repeat
		652
		653	=item $old_repeat = $w->repeat ($new_repeat)
		654
		655	Returns the current value of the repeat attribute and optionally sets a
		656	new one. Setting the new one will not restart the watcher - if the watcher
		657	is active, the new repeat value is used whenever it expires next.
		658
374	=back	659	=back
375		660
376		661
377	=head3 PERIODIC WATCHERS - to cron or not to cron?	662	=head3 PERIODIC WATCHERS - to cron or not to cron?
378		663
379	=over 4	664	=over 4
380		665
381	=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback	666	=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
382		667
383	=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback	668	=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
		669
		670	=item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
		671
		672	=item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback)
384		673
385	Similar to EV::timer, but is not based on relative timeouts but on	674	Similar to EV::timer, but is not based on relative timeouts but on
386	absolute times. Apart from creating "simple" timers that trigger "at" the	675	absolute times. Apart from creating "simple" timers that trigger "at" the
387	specified time, it can also be used for non-drifting absolute timers and	676	specified time, it can also be used for non-drifting absolute timers and
388	more complex, cron-like, setups that are not adversely affected by time	677	more complex, cron-like, setups that are not adversely affected by time
…		…
398	This time simply fires at the wallclock time C<$at> and doesn't repeat. It	687	This time simply fires at the wallclock time C<$at> and doesn't repeat. It
399	will not adjust when a time jump occurs, that is, if it is to be run	688	will not adjust when a time jump occurs, that is, if it is to be run
400	at January 1st 2011 then it will run when the system time reaches or	689	at January 1st 2011 then it will run when the system time reaches or
401	surpasses this time.	690	surpasses this time.
402		691
403	=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0)	692	=item * repeating interval timer ($interval > 0, $reschedule_cb = 0)
404		693
405	In this mode the watcher will always be scheduled to time out at the	694	In this mode the watcher will always be scheduled to time out at the
406	next C<$at + N * $interval> time (for some integer N) and then repeat,	695	next C<$at + N * $interval> time (for the lowest integer N) and then repeat,
407	regardless of any time jumps.	696	regardless of any time jumps. Note that, since C<N> can be negative, the
		697	first trigger can happen before C<$at>.
408		698
409	This can be used to create timers that do not drift with respect to system	699	This can be used to create timers that do not drift with respect to system
410	time:	700	time:
411		701
412	my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };	702	my $hourly = EV::periodic 0, 3600, 0, sub { print "once/hour\n" };
413		703
414	That doesn't mean there will always be 3600 seconds in between triggers,	704	That doesn't mean there will always be 3600 seconds in between triggers,
415	but only that the the clalback will be called when the system time shows a	705	but only that the the callback will be called when the system time shows a
416	full hour (UTC).	706	full hour (UTC).
417		707
418	Another way to think about it (for the mathematically inclined) is that	708	Another way to think about it (for the mathematically inclined) is that
419	EV::periodic will try to run the callback in this mode at the next	709	EV::periodic will try to run the callback in this mode at the next
420	possible time where C<$time = $at (mod $interval)>, regardless of any time	710	possible time where C<$time = $at (mod $interval)>, regardless of any time
…		…
426	time the periodic watcher gets scheduled, the reschedule callback	716	time the periodic watcher gets scheduled, the reschedule callback
427	($reschedule_cb) will be called with the watcher as first, and the current	717	($reschedule_cb) will be called with the watcher as first, and the current
428	time as second argument.	718	time as second argument.
429		719
430	I<This callback MUST NOT stop or destroy this or any other periodic	720	I<This callback MUST NOT stop or destroy this or any other periodic
431	watcher, ever>. If you need to stop it, return 1e30 and stop it	721	watcher, ever, and MUST NOT call any event loop functions or methods>. If
432	afterwards.	722	you need to stop it, return 1e30 and stop it afterwards. You may create
		723	and start an C<EV::prepare> watcher for this task.
433		724
434	It must return the next time to trigger, based on the passed time value	725	It must return the next time to trigger, based on the passed time value
435	(that is, the lowest time value larger than to the second argument). It	726	(that is, the lowest time value larger than or equal to to the second
436	will usually be called just before the callback will be triggered, but	727	argument). It will usually be called just before the callback will be
437	might be called at other times, too.	728	triggered, but might be called at other times, too.
438		729
439	This can be used to create very complex timers, such as a timer that	730	This can be used to create very complex timers, such as a timer that
440	triggers on each midnight, local time (actually 24 hours after the last	731	triggers on each midnight, local time (actually one day after the last
441	midnight, to keep the example simple. If you know a way to do it correctly	732	midnight, to keep the example simple):
442	in about the same space (without requiring elaborate modules), drop me a
443	note :):
444		733
445	my $daily = EV::periodic 0, 0, sub {	734	my $daily = EV::periodic 0, 0, sub {
446	my ($w, $now) = @_;	735	my ($w, $now) = @_;
447		736
448	use Time::Local ();	737	use Time::Local ();
449	my (undef, undef, undef, $d, $m, $y) = localtime $now;	738	my (undef, undef, undef, $d, $m, $y) = localtime $now;
450	86400 + Time::Local::timelocal 0, 0, 0, $d, $m, $y	739	Time::Local::timelocal_nocheck 0, 0, 0, $d + 1, $m, $y
451	}, sub {	740	}, sub {
452	print "it's midnight or likely shortly after, now\n";	741	print "it's midnight or likely shortly after, now\n";
453	};	742	};
454		743
455	=back	744	=back
…		…
463		752
464	=item $w->again	753	=item $w->again
465		754
466	Simply stops and starts the watcher again.	755	Simply stops and starts the watcher again.
467		756
		757	=item $time = $w->at
		758
		759	Return the time that the watcher is expected to trigger next.
		760
		761	=item $offset = $w->offset
		762
		763	=item $old_offset = $w->offset ($new_offset)
		764
		765	Returns the current value of the offset attribute and optionally sets a
		766	new one. Setting the new one will not restart the watcher - if the watcher
		767	is active, the new offset value is used whenever it expires next.
		768
		769	=item $interval = $w->interval
		770
		771	=item $old_interval = $w->interval ($new_interval)
		772
		773	See above, for the interval attribute.
		774
		775	=item $reschedule_cb = $w->reschedule_cb
		776
		777	=item $old_reschedule_cb = $w->reschedule_cb ($new_reschedule_cb)
		778
		779	See above, for the reschedule callback.
		780
468	=back	781	=back
469		782
470		783
471	=head3 SIGNAL WATCHERS - signal me when a signal gets signalled!	784	=head3 SIGNAL WATCHERS - signal me when a signal gets signalled!
472		785
473	=over 4	786	=over 4
474		787
475	=item $w = EV::signal $signal, $callback	788	=item $w = EV::signal $signal, $callback
476		789
477	=item $w = EV::signal_ns $signal, $callback	790	=item $w = EV::signal_ns $signal, $callback
		791
		792	=item $w = $loop->signal ($signal, $callback)
		793
		794	=item $w = $loop->signal_ns ($signal, $callback)
478		795
479	Call the callback when $signal is received (the signal can be specified by	796	Call the callback when $signal is received (the signal can be specified by
480	number or by name, just as with C<kill> or C<%SIG>).	797	number or by name, just as with C<kill> or C<%SIG>).
		798
		799	Only one event loop can grab a given signal - attempting to grab the same
		800	signal from two EV loops will crash the program immediately or cause data
		801	corruption.
481		802
482	EV will grab the signal for the process (the kernel only allows one	803	EV will grab the signal for the process (the kernel only allows one
483	component to receive a signal at a time) when you start a signal watcher,	804	component to receive a signal at a time) when you start a signal watcher,
484	and removes it again when you stop it. Perl does the same when you	805	and removes it again when you stop it. Perl does the same when you
485	add/remove callbacks to C<%SIG>, so watch out.	806	add/remove callbacks to C<%SIG>, so watch out.
…		…
505		826
506	=head3 CHILD WATCHERS - watch out for process status changes	827	=head3 CHILD WATCHERS - watch out for process status changes
507		828
508	=over 4	829	=over 4
509		830
510	=item $w = EV::child $pid, $callback	831	=item $w = EV::child $pid, $trace, $callback
511		832
512	=item $w = EV::child_ns $pid, $callback	833	=item $w = EV::child_ns $pid, $trace, $callback
513		834
		835	=item $w = $loop->child ($pid, $trace, $callback)
		836
		837	=item $w = $loop->child_ns ($pid, $trace, $callback)
		838
514	Call the callback when a status change for pid C<$pid> (or any pid if	839	Call the callback when a status change for pid C<$pid> (or any pid
515	C<$pid> is 0) has been received. More precisely: when the process receives	840	if C<$pid> is 0) has been received (a status change happens when the
		841	process terminates or is killed, or, when trace is true, additionally when
		842	it is stopped or continued). More precisely: when the process receives
516	a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all	843	a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all
517	changed/zombie children and call the callback.	844	changed/zombie children and call the callback.
518		845
519	It is valid (and fully supported) to install a child watcher after a child	846	It is valid (and fully supported) to install a child watcher after a child
520	has exited but before the event loop has started its next iteration (for	847	has exited but before the event loop has started its next iteration (for
…		…
527	You can have as many pid watchers per pid as you want, they will all be	854	You can have as many pid watchers per pid as you want, they will all be
528	called.	855	called.
529		856
530	The C<child_ns> variant doesn't start (activate) the newly created watcher.	857	The C<child_ns> variant doesn't start (activate) the newly created watcher.
531		858
532	=item $w->set ($pid)	859	=item $w->set ($pid, $trace)
533		860
534	Reconfigures the watcher, see the constructor above for details. Can be called at	861	Reconfigures the watcher, see the constructor above for details. Can be called at
535	any time.	862	any time.
536		863
537	=item $current_pid = $w->pid	864	=item $current_pid = $w->pid
538		865
539	=item $old_pid = $w->pid ($new_pid)
540
541	Returns the previously set process id and optionally set a new one.	866	Returns the previously set process id and optionally set a new one.
542		867
543	=item $exit_status = $w->rstatus	868	=item $exit_status = $w->rstatus
544		869
545	Return the exit/wait status (as returned by waitpid, see the waitpid entry	870	Return the exit/wait status (as returned by waitpid, see the waitpid entry
…		…
551	watcher for all pids).	876	watcher for all pids).
552		877
553	=back	878	=back
554		879
555		880
		881	=head3 STAT WATCHERS - did the file attributes just change?
		882
		883	=over 4
		884
		885	=item $w = EV::stat $path, $interval, $callback
		886
		887	=item $w = EV::stat_ns $path, $interval, $callback
		888
		889	=item $w = $loop->stat ($path, $interval, $callback)
		890
		891	=item $w = $loop->stat_ns ($path, $interval, $callback)
		892
		893	Call the callback when a file status change has been detected on
		894	C<$path>. The C<$path> does not need to exist, changing from "path exists"
		895	to "path does not exist" is a status change like any other.
		896
		897	The C<$interval> is a recommended polling interval for systems where
		898	OS-supported change notifications don't exist or are not supported. If
		899	you use C<0> then an unspecified default is used (which is highly
		900	recommended!), which is to be expected to be around five seconds usually.
		901
		902	This watcher type is not meant for massive numbers of stat watchers,
		903	as even with OS-supported change notifications, this can be
		904	resource-intensive.
		905
		906	The C<stat_ns> variant doesn't start (activate) the newly created watcher.
		907
		908	=item ... = $w->stat
		909
		910	This call is very similar to the perl C<stat> built-in: It stats (using
		911	C<lstat>) the path specified in the watcher and sets perls stat cache (as
		912	well as EV's idea of the current stat values) to the values found.
		913
		914	In scalar context, a boolean is return indicating success or failure of
		915	the stat. In list context, the same 13-value list as with stat is returned
		916	(except that the blksize and blocks fields are not reliable).
		917
		918	In the case of an error, errno is set to C<ENOENT> (regardless of the
		919	actual error value) and the C<nlink> value is forced to zero (if the stat
		920	was successful then nlink is guaranteed to be non-zero).
		921
		922	See also the next two entries for more info.
		923
		924	=item ... = $w->attr
		925
		926	Just like C<< $w->stat >>, but without the initial stat'ing: this returns
		927	the values most recently detected by EV. See the next entry for more info.
		928
		929	=item ... = $w->prev
		930
		931	Just like C<< $w->stat >>, but without the initial stat'ing: this returns
		932	the previous set of values, before the change.
		933
		934	That is, when the watcher callback is invoked, C<< $w->prev >> will be set
		935	to the values found I<before> a change was detected, while C<< $w->attr >>
		936	returns the values found leading to the change detection. The difference (if any)
		937	between C<prev> and C<attr> is what triggered the callback.
		938
		939	If you did something to the filesystem object and do not want to trigger
		940	yet another change, you can call C<stat> to update EV's idea of what the
		941	current attributes are.
		942
		943	=item $w->set ($path, $interval)
		944
		945	Reconfigures the watcher, see the constructor above for details. Can be
		946	called at any time.
		947
		948	=item $current_path = $w->path
		949
		950	=item $old_path = $w->path ($new_path)
		951
		952	Returns the previously set path and optionally set a new one.
		953
		954	=item $current_interval = $w->interval
		955
		956	=item $old_interval = $w->interval ($new_interval)
		957
		958	Returns the previously set interval and optionally set a new one. Can be
		959	used to query the actual interval used.
		960
		961	=back
		962
		963
556	=head3 IDLE WATCHERS - when you've got nothing better to do...	964	=head3 IDLE WATCHERS - when you've got nothing better to do...
557		965
558	=over 4	966	=over 4
559		967
560	=item $w = EV::idle $callback	968	=item $w = EV::idle $callback
561		969
562	=item $w = EV::idle_ns $callback	970	=item $w = EV::idle_ns $callback
563		971
564	Call the callback when there are no pending io, timer/periodic, signal or	972	=item $w = $loop->idle ($callback)
565	child events, i.e. when the process is idle.	973
		974	=item $w = $loop->idle_ns ($callback)
		975
		976	Call the callback when there are no other pending watchers of the same or
		977	higher priority (excluding check, prepare and other idle watchers of the
		978	same or lower priority, of course). They are called idle watchers because
		979	when the watcher is the highest priority pending event in the process, the
		980	process is considered to be idle at that priority.
		981
		982	If you want a watcher that is only ever called when I<no> other events are
		983	outstanding you have to set the priority to C<EV::MINPRI>.
566		984
567	The process will not block as long as any idle watchers are active, and	985	The process will not block as long as any idle watchers are active, and
568	they will be called repeatedly until stopped.	986	they will be called repeatedly until stopped.
569		987
		988	For example, if you have idle watchers at priority C<0> and C<1>, and
		989	an I/O watcher at priority C<0>, then the idle watcher at priority C<1>
		990	and the I/O watcher will always run when ready. Only when the idle watcher
		991	at priority C<1> is stopped and the I/O watcher at priority C<0> is not
		992	pending with the C<0>-priority idle watcher be invoked.
		993
570	The C<idle_ns> variant doesn't start (activate) the newly created watcher.	994	The C<idle_ns> variant doesn't start (activate) the newly created watcher.
571		995
572	=back	996	=back
573		997
574		998
…		…
577	=over 4	1001	=over 4
578		1002
579	=item $w = EV::prepare $callback	1003	=item $w = EV::prepare $callback
580		1004
581	=item $w = EV::prepare_ns $callback	1005	=item $w = EV::prepare_ns $callback
		1006
		1007	=item $w = $loop->prepare ($callback)
		1008
		1009	=item $w = $loop->prepare_ns ($callback)
582		1010
583	Call the callback just before the process would block. You can still	1011	Call the callback just before the process would block. You can still
584	create/modify any watchers at this point.	1012	create/modify any watchers at this point.
585		1013
586	See the EV::check watcher, below, for explanations and an example.	1014	See the EV::check watcher, below, for explanations and an example.
…		…
596		1024
597	=item $w = EV::check $callback	1025	=item $w = EV::check $callback
598		1026
599	=item $w = EV::check_ns $callback	1027	=item $w = EV::check_ns $callback
600		1028
		1029	=item $w = $loop->check ($callback)
		1030
		1031	=item $w = $loop->check_ns ($callback)
		1032
601	Call the callback just after the process wakes up again (after it has	1033	Call the callback just after the process wakes up again (after it has
602	gathered events), but before any other callbacks have been invoked.	1034	gathered events), but before any other callbacks have been invoked.
603		1035
604	This is used to integrate other event-based software into the EV	1036	This can be used to integrate other event-based software into the EV
605	mainloop: You register a prepare callback and in there, you create io and	1037	mainloop: You register a prepare callback and in there, you create io and
606	timer watchers as required by the other software. Here is a real-world	1038	timer watchers as required by the other software. Here is a real-world
607	example of integrating Net::SNMP (with some details left out):	1039	example of integrating Net::SNMP (with some details left out):
608		1040
609	our @snmp_watcher;	1041	our @snmp_watcher;
…		…
614	or return;	1046	or return;
615		1047
616	# make the dispatcher handle any outstanding stuff	1048	# make the dispatcher handle any outstanding stuff
617	... not shown	1049	... not shown
618		1050
619	# create an IO watcher for each and every socket	1051	# create an I/O watcher for each and every socket
620	@snmp_watcher = (	1052	@snmp_watcher = (
621	(map { EV::io $_, EV::READ, sub { } }	1053	(map { EV::io $_, EV::READ, sub { } }
622	keys %{ $dispatcher->{_descriptors} }),	1054	keys %{ $dispatcher->{_descriptors} }),
623		1055
624	EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]	1056	EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]
…		…
639	# make the dispatcher handle any new stuff	1071	# make the dispatcher handle any new stuff
640	... not shown	1072	... not shown
641	};	1073	};
642		1074
643	The callbacks of the created watchers will not be called as the watchers	1075	The callbacks of the created watchers will not be called as the watchers
644	are destroyed before this cna happen (remember EV::check gets called	1076	are destroyed before this can happen (remember EV::check gets called
645	first).	1077	first).
646		1078
647	The C<check_ns> variant doesn't start (activate) the newly created watcher.	1079	The C<check_ns> variant doesn't start (activate) the newly created watcher.
648		1080
649	=back	1081	=item EV::CHECK constant issues
650		1082
651	=head3 STAT WATCHERS - did the file stats just change?	1083	Like all other watcher types, there is a bitmask constant for use in
		1084	C<$revents> and other places. The C<EV::CHECK> is special as it has
		1085	the same name as the C<CHECK> sub called by Perl. This doesn't cause
		1086	big issues on newer perls (beginning with 5.8.9), but it means thatthe
		1087	constant must be I<inlined>, i.e. runtime calls will not work. That means
		1088	that as long as you always C<use EV> and then C<EV::CHECK> you are on the
		1089	safe side.
652		1090
653	=over 4	1091	=back
654		1092
655	=item $w = EV::stat $path, $interval, $callback
656		1093
657	=item $w = EV::stat_ns $path, $interval, $callback	1094	=head3 FORK WATCHERS - the audacity to resume the event loop after a fork
658		1095
659	Call the callback when a file status change has been detected on	1096	Fork watchers are called when a C<fork ()> was detected. The invocation
660	C<$path>. The C<$path> does not need to exist, changing from "path exists"	1097	is done before the event loop blocks next and before C<check> watchers
661	to "path does not exist" is a status change like any other.	1098	are being called, and only in the child after the fork.
662		1099
663	The C<$interval> is a recommended polling interval for systems where	1100	=over 4
664	OS-supported change notifications don't exist or are not supported. If
665	you use C<0> then an unspecified default is used (which is highly
666	recommended!), which is to be expected to be around five seconds usually.
667		1101
668	This watcher type is not meant for massive numbers of stat watchers,	1102	=item $w = EV::fork $callback
669	as even with OS-supported change notifications, this can be
670	resource-intensive.
671		1103
		1104	=item $w = EV::fork_ns $callback
		1105
		1106	=item $w = $loop->fork ($callback)
		1107
		1108	=item $w = $loop->fork_ns ($callback)
		1109
		1110	Call the callback before the event loop is resumed in the child process
		1111	after a fork.
		1112
672	The C<stat_ns> variant doesn't start (activate) the newly created watcher.	1113	The C<fork_ns> variant doesn't start (activate) the newly created watcher.
673		1114
674	=item $w->set ($path, $interval)
675
676	Reconfigures the watcher, see the constructor above for details. Can be
677	called at any time.
678
679	=item $current_path = $w->path
680
681	=item $old_path = $w->path ($new_path)
682
683	Returns the previously set path and optionally set a new one.
684
685	=item $current_interval = $w->interval
686
687	=item $old_interval = $w->interval ($new_interval)
688
689	Returns the previously set interval and optionally set a new one. Can be
690	used to query the actual interval used.
691
692	=back	1115	=back
693		1116
694		1117
		1118	=head3 EMBED WATCHERS - when one backend isn't enough...
		1119
		1120	This is a rather advanced watcher type that lets you embed one event loop
		1121	into another (currently only IO events are supported in the embedded
		1122	loop, other types of watchers might be handled in a delayed or incorrect
		1123	fashion and must not be used).
		1124
		1125	See the libev documentation at
		1126	L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
		1127	(locally installed as F<EV::libev>) for more details.
		1128
		1129	In short, this watcher is most useful on BSD systems without working
		1130	kqueue to still be able to handle a large number of sockets:
		1131
		1132	my $socket_loop;
		1133
		1134	# check wether we use SELECT or POLL _and_ KQUEUE is supported
		1135	if (
		1136	(EV::backend & (EV::BACKEND_POLL \| EV::BACKEND_SELECT))
		1137	&& (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
		1138	) {
		1139	# use kqueue for sockets
		1140	$socket_loop = new EV::Loop EV::BACKEND_KQUEUE \| EV::FLAG_NOENV;
		1141	}
		1142
		1143	# use the default loop otherwise
		1144	$socket_loop \|\|= EV::default_loop;
		1145
		1146	=over 4
		1147
		1148	=item $w = EV::embed $otherloop[, $callback]
		1149
		1150	=item $w = EV::embed_ns $otherloop[, $callback]
		1151
		1152	=item $w = $loop->embed ($otherloop[, $callback])
		1153
		1154	=item $w = $loop->embed_ns ($otherloop[, $callback])
		1155
		1156	Call the callback when the embedded event loop (C<$otherloop>) has any
		1157	I/O activity. The C<$callback> is optional: if it is missing, then the
		1158	embedded event loop will be managed automatically (which is recommended),
		1159	otherwise you have to invoke C<sweep> yourself.
		1160
		1161	The C<embed_ns> variant doesn't start (activate) the newly created watcher.
		1162
		1163	=back
		1164
		1165	=head3 ASYNC WATCHERS - how to wake up another event loop
		1166
		1167	Async watchers are provided by EV, but have little use in perl directly,
		1168	as perl neither supports threads running in parallel nor direct access to
		1169	signal handlers or other contexts where they could be of value.
		1170
		1171	It is, however, possible to use them from the XS level.
		1172
		1173	Please see the libev documentation for further details.
		1174
		1175	=over 4
		1176
		1177	=item $w = EV::async $callback
		1178
		1179	=item $w = EV::async_ns $callback
		1180
		1181	=item $w = $loop->async ($callback)
		1182
		1183	=item $w = $loop->async_ns ($callback)
		1184
		1185	=item $w->send
		1186
		1187	=item $bool = $w->async_pending
		1188
		1189	=back
		1190
		1191	=head3 CLEANUP WATCHERS - how to clean up when the event loop goes away
		1192
		1193	Cleanup watchers are not supported on the Perl level, they can only be
		1194	used via XS currently.
		1195
		1196
		1197	=head1 PERL SIGNALS
		1198
		1199	While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour
		1200	with EV is as the same as any other C library: Perl-signals will only be
		1201	handled when Perl runs, which means your signal handler might be invoked
		1202	only the next time an event callback is invoked.
		1203
		1204	The solution is to use EV signal watchers (see C<EV::signal>), which will
		1205	ensure proper operations with regards to other event watchers.
		1206
		1207	If you cannot do this for whatever reason, you can also force a watcher
		1208	to be called on every event loop iteration by installing a C<EV::check>
		1209	watcher:
		1210
		1211	my $async_check = EV::check sub { };
		1212
		1213	This ensures that perl gets into control for a short time to handle any
		1214	pending signals, and also ensures (slightly) slower overall operation.
		1215
695	=head1 THREADS	1216	=head1 ITHREADS
696		1217
697	Threads are not supported by this module in any way. Perl pseudo-threads	1218	Ithreads are not supported by this module in any way. Perl pseudo-threads
698	is evil stuff and must die. As soon as Perl gains real threads I will work	1219	is evil stuff and must die. Real threads as provided by Coro are fully
699	on thread support for it.	1220	supported (and enhanced support is available via L<Coro::EV>).
700		1221
701	=head1 FORK	1222	=head1 FORK
702		1223
703	Most of the "improved" event delivering mechanisms of modern operating	1224	Most of the "improved" event delivering mechanisms of modern operating
704	systems have quite a few problems with fork(2) (to put it bluntly: it is	1225	systems have quite a few problems with fork(2) (to put it bluntly: it is
…		…
720	our $DIED = sub {	1241	our $DIED = sub {
721	warn "EV: error in callback (ignoring): $@";	1242	warn "EV: error in callback (ignoring): $@";
722	};	1243	};
723		1244
724	default_loop	1245	default_loop
725	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?';	1246	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?';
726		1247
727	1;	1248	1;
728		1249
729	=head1 SEE ALSO	1250	=head1 SEE ALSO
730		1251
731	L<EV::DNS>.	1252	L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS>
		1253	(asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event
		1254	loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread
		1255	integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
		1256	event-loop agnostic and portable event driven programming.
732		1257
733	=head1 AUTHOR	1258	=head1 AUTHOR
734		1259
735	Marc Lehmann <schmorp@schmorp.de>	1260	Marc Lehmann <schmorp@schmorp.de>
736	http://home.schmorp.de/	1261	http://home.schmorp.de/
737		1262
738	=cut	1263	=cut
739		1264

Diff Legend

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

Comparing EV/EV.pm (file contents): Revision 1.54 by root, Tue Nov 27 07:27:10 2007 UTC vs. Revision 1.165 by root, Wed Mar 18 13:21:14 2020 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.54 by root, Tue Nov 27 07:27:10 2007 UTC vs.
Revision 1.165 by root, Wed Mar 18 13:21:14 2020 UTC