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

Comparing EV/EV.pm (file contents):
Revision 1.61 by root, Thu Dec 6 03:13:07 2007 UTC vs.
Revision 1.138 by root, Sun May 6 16:30:27 2012 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::unloop 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.6';	124	our $VERSION = '4.11';
73	use XSLoader;	125	use XSLoader;
74	XSLoader::load "EV", $VERSION;	126	XSLoader::load "EV", $VERSION;
75	}	127	}
76		128
77	@EV::IO::ISA =	129	@EV::IO::ISA =
…		…
83	@EV::Idle::ISA =	135	@EV::Idle::ISA =
84	@EV::Prepare::ISA =	136	@EV::Prepare::ISA =
85	@EV::Check::ISA =	137	@EV::Check::ISA =
86	@EV::Embed::ISA =	138	@EV::Embed::ISA =
87	@EV::Fork::ISA =	139	@EV::Fork::ISA =
		140	@EV::Async::ISA =
88	"EV::Watcher";	141	"EV::Watcher";
89		142
		143	@EV::Loop::Default::ISA = "EV::Loop";
		144
		145	=head1 EVENT LOOPS
		146
		147	EV supports multiple event loops: There is a single "default event loop"
		148	that can handle everything including signals and child watchers, and any
		149	number of "dynamic event loops" that can use different backends (with
		150	various limitations), but no child and signal watchers.
		151
		152	You do not have to do anything to create the default event loop: When
		153	the module is loaded a suitable backend is selected on the premise of
		154	selecting a working backend (which for example rules out kqueue on most
		155	BSDs). Modules should, unless they have "special needs" always use the
		156	default loop as this is fastest (perl-wise), best supported by other
		157	modules (e.g. AnyEvent or Coro) and most portable event loop.
		158
		159	For specific programs you can create additional event loops dynamically.
		160
		161	If you want to take advantage of kqueue (which often works properly for
		162	sockets only) even though the default loop doesn't enable it, you can
		163	I<embed> a kqueue loop into the default loop: running the default loop
		164	will then also service the kqueue loop to some extent. See the example in
		165	the section about embed watchers for an example on how to achieve that.
		166
		167	=over 4
		168
		169	=item $loop = new EV::Loop [$flags]
		170
		171	Create a new event loop as per the specified flags. Please refer to
		172	the C<ev_loop_new ()> function description in the libev documentation
		173	(L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>,
		174	or locally-installed as F<EV::libev> manpage) for more info.
		175
		176	The loop will automatically be destroyed when it is no longer referenced
		177	by any watcher and the loop object goes out of scope.
		178
		179	If you are not embedding the loop, then Using C<EV::FLAG_FORKCHECK>
		180	is recommended, as only the default event loop is protected by this
		181	module. If you I<are> embedding this loop in the default loop, this is not
		182	necessary, as C<EV::embed> automatically does the right thing on fork.
		183
		184	=item $loop->loop_fork
		185
		186	Must be called after a fork in the child, before entering or continuing
		187	the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
		188	this function automatically, at some performance loss (refer to the libev
		189	documentation).
		190
		191	=item $loop->verify
		192
		193	Calls C<ev_verify> to make internal consistency checks (for debugging
		194	libev) and abort the program if any data structures were found to be
		195	corrupted.
		196
		197	=item $loop = EV::default_loop [$flags]
		198
		199	Return the default loop (which is a singleton object). Since this module
		200	already creates the default loop with default flags, specifying flags here
		201	will not have any effect unless you destroy the default loop first, which
		202	isn't supported. So in short: don't do it, and if you break it, you get to
		203	keep the pieces.
		204
		205	=back
		206
		207
90	=head1 BASIC INTERFACE	208	=head1 BASIC INTERFACE
91		209
92	=over 4	210	=over 4
93		211
94	=item $EV::DIED	212	=item $EV::DIED
95		213
96	Must contain a reference to a function that is called when a callback	214	Must contain a reference to a function that is called when a callback
97	throws an exception (with $@ containing thr error). The default prints an	215	throws an exception (with $@ containing the error). The default prints an
98	informative message and continues.	216	informative message and continues.
99		217
100	If this callback throws an exception it will be silently ignored.	218	If this callback throws an exception it will be silently ignored.
101		219
		220	=item $flags = EV::supported_backends
		221
		222	=item $flags = EV::recommended_backends
		223
		224	=item $flags = EV::embeddable_backends
		225
		226	Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this
		227	instance of EV, the set of recommended backends (supposed to be good) for
		228	this platform and the set of embeddable backends (see EMBED WATCHERS).
		229
		230	=item EV::sleep $seconds
		231
		232	Block the process for the given number of (fractional) seconds.
		233
102	=item $time = EV::time	234	=item $time = EV::time
103		235
104	Returns the current time in (fractional) seconds since the epoch.	236	Returns the current time in (fractional) seconds since the epoch.
105		237
106	=item $time = EV::now	238	=item $time = EV::now
107		239
		240	=item $time = $loop->now
		241
108	Returns the time the last event loop iteration has been started. This	242	Returns the time the last event loop iteration has been started. This
109	is the time that (relative) timers are based on, and refering to it is	243	is the time that (relative) timers are based on, and referring to it is
110	usually faster then calling EV::time.	244	usually faster then calling EV::time.
111		245
112	=item $method = EV::method	246	=item EV::now_update
113		247
		248	=item $loop->now_update
		249
		250	Establishes the current time by querying the kernel, updating the time
		251	returned by C<EV::now> in the progress. This is a costly operation and
		252	is usually done automatically within C<EV::loop>.
		253
		254	This function is rarely useful, but when some event callback runs for a
		255	very long time without entering the event loop, updating libev's idea of
		256	the current time is a good idea.
		257
		258	=item EV::suspend
		259
		260	=item $loop->suspend
		261
		262	=item EV::resume
		263
		264	=item $loop->resume
		265
		266	These two functions suspend and resume a loop, for use when the loop is
		267	not used for a while and timeouts should not be processed.
		268
		269	A typical use case would be an interactive program such as a game: When
		270	the user presses C<^Z> to suspend the game and resumes it an hour later it
		271	would be best to handle timeouts as if no time had actually passed while
		272	the program was suspended. This can be achieved by calling C<suspend>
		273	in your C<SIGTSTP> handler, sending yourself a C<SIGSTOP> and calling
		274	C<resume> directly afterwards to resume timer processing.
		275
		276	Effectively, all C<timer> watchers will be delayed by the time spend
		277	between C<suspend> and C<resume>, and all C<periodic> watchers
		278	will be rescheduled (that is, they will lose any events that would have
		279	occured while suspended).
		280
		281	After calling C<suspend> you B<must not> call I<any> function on the given
		282	loop other than C<resume>, and you B<must not> call C<resume>
		283	without a previous call to C<suspend>.
		284
		285	Calling C<suspend>/C<resume> has the side effect of updating the event
		286	loop time (see C<now_update>).
		287
		288	=item $backend = EV::backend
		289
		290	=item $backend = $loop->backend
		291
114	Returns an integer describing the backend used by libev (EV::METHOD_SELECT	292	Returns an integer describing the backend used by libev (EV::BACKEND_SELECT
115	or EV::METHOD_EPOLL).	293	or EV::BACKEND_EPOLL).
116		294
117	=item EV::loop [$flags]	295	=item $active = EV::run [$flags]
		296
		297	=item $active = $loop->run ([$flags])
118		298
119	Begin checking for events and calling callbacks. It returns when a	299	Begin checking for events and calling callbacks. It returns when a
120	callback calls EV::unloop.	300	callback calls EV::unloop or the flasg are nonzero (in which case the
		301	return value is true) or when there are no active watchers which reference
		302	the loop (keepalive is true), in which case the return value will be
		303	false. The returnv alue can generally be interpreted as "if true, there is
		304	more work left to do".
121		305
122	The $flags argument can be one of the following:	306	The $flags argument can be one of the following:
123		307
124	0 as above	308	0 as above
125	EV::LOOP_ONESHOT block at most once (wait, but do not loop)	309	EV::RUN_ONCE block at most once (wait, but do not loop)
126	EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait)	310	EV::RUN_NOWAIT do not block at all (fetch/handle events but do not wait)
127		311
128	=item EV::unloop [$how]	312	=item EV::break [$how]
129		313
		314	=item $loop->break ([$how])
		315
130	When called with no arguments or an argument of EV::UNLOOP_ONE, makes the	316	When called with no arguments or an argument of EV::BREAK_ONE, makes the
131	innermost call to EV::loop return.	317	innermost call to EV::loop return.
132		318
133	When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as	319	When called with an argument of EV::BREAK_ALL, all calls to EV::loop will
134	fast as possible.	320	return as fast as possible.
135		321
136	=item $count = EV::loop_count	322	When called with an argument of EV::BREAK_CANCEL, any pending break will
		323	be cancelled.
		324
		325	=item $count = EV::iteration
		326
		327	=item $count = $loop->iteration
137		328
138	Return the number of times the event loop has polled for new	329	Return the number of times the event loop has polled for new
139	events. Sometiems useful as a generation counter.	330	events. Sometimes useful as a generation counter.
140		331
141	=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)	332	=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
		333
		334	=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
142		335
143	This function rolls together an I/O and a timer watcher for a single	336	This function rolls together an I/O and a timer watcher for a single
144	one-shot event without the need for managing a watcher object.	337	one-shot event without the need for managing a watcher object.
145		338
146	If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events>	339	If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events>
…		…
152	If timeout is C<undef> or negative, then there will be no	345	If timeout is C<undef> or negative, then there will be no
153	timeout. Otherwise a EV::timer with this value will be started.	346	timeout. Otherwise a EV::timer with this value will be started.
154		347
155	When an error occurs or either the timeout or I/O watcher triggers, then	348	When an error occurs or either the timeout or I/O watcher triggers, then
156	the callback will be called with the received event set (in general	349	the callback will be called with the received event set (in general
157	you can expect it to be a combination of C<EV:ERROR>, C<EV::READ>,	350	you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>,
158	C<EV::WRITE> and C<EV::TIMEOUT>).	351	C<EV::WRITE> and C<EV::TIMER>).
159		352
160	EV::once doesn't return anything: the watchers stay active till either	353	EV::once doesn't return anything: the watchers stay active till either
161	of them triggers, then they will be stopped and freed, and the callback	354	of them triggers, then they will be stopped and freed, and the callback
162	invoked.	355	invoked.
163		356
164	=back	357	=item EV::feed_fd_event $fd, $revents
165		358
		359	=item $loop->feed_fd_event ($fd, $revents)
		360
		361	Feed an event on a file descriptor into EV. EV will react to this call as
		362	if the readyness notifications specified by C<$revents> (a combination of
		363	C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>.
		364
		365	=item EV::feed_signal_event $signal
		366
		367	Feed a signal event into the default loop. EV will react to this call as
		368	if the signal specified by C<$signal> had occured.
		369
		370	=item EV::feed_signal $signal
		371
		372	Feed a signal event into EV - unlike C<EV::feed_signal_event>, this works
		373	regardless of which loop has registered the signal, and is mainly useful
		374	fro custom signal implementations.
		375
		376	=item EV::set_io_collect_interval $time
		377
		378	=item $loop->set_io_collect_interval ($time)
		379
		380	=item EV::set_timeout_collect_interval $time
		381
		382	=item $loop->set_timeout_collect_interval ($time)
		383
		384	These advanced functions set the minimum block interval when polling for I/O events and the minimum
		385	wait interval for timer events. See the libev documentation at
		386	L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP>
		387	(locally installed as F<EV::libev>) for a more detailed discussion.
		388
		389	=item $count = EV::pending_count
		390
		391	=item $count = $loop->pending_count
		392
		393	Returns the number of currently pending watchers.
		394
		395	=item EV::invoke_pending
		396
		397	=item $loop->invoke_pending
		398
		399	Invoke all currently pending watchers.
		400
		401	=back
		402
		403
166	=head2 WATCHER OBJECTS	404	=head1 WATCHER OBJECTS
167		405
168	A watcher is an object that gets created to record your interest in some	406	A watcher is an object that gets created to record your interest in some
169	event. For instance, if you want to wait for STDIN to become readable, you	407	event. For instance, if you want to wait for STDIN to become readable, you
170	would create an EV::io watcher for that:	408	would create an EV::io watcher for that:
171		409
172	my $watcher = EV::io *STDIN, EV::READ, sub {	410	my $watcher = EV::io *STDIN, EV::READ, sub {
173	my ($watcher, $revents) = @_;	411	my ($watcher, $revents) = @_;
174	warn "yeah, STDIN should not be readable without blocking!\n"	412	warn "yeah, STDIN should now be readable without blocking!\n"
175	};	413	};
176		414
177	All watchers can be active (waiting for events) or inactive (paused). Only	415	All watchers can be active (waiting for events) or inactive (paused). Only
178	active watchers will have their callbacks invoked. All callbacks will be	416	active watchers will have their callbacks invoked. All callbacks will be
179	called with at least two arguments: the watcher and a bitmask of received	417	called with at least two arguments: the watcher and a bitmask of received
180	events.	418	events.
181		419
182	Each watcher type has its associated bit in revents, so you can use the	420	Each watcher type has its associated bit in revents, so you can use the
183	same callback for multiple watchers. The event mask is named after the	421	same callback for multiple watchers. The event mask is named after the
184	type, i..e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,	422	type, i.e. EV::child sets EV::CHILD, EV::prepare sets EV::PREPARE,
185	EV::periodic sets EV::PERIODIC and so on, with the exception of IO events	423	EV::periodic sets EV::PERIODIC and so on, with the exception of I/O events
186	(which can set both EV::READ and EV::WRITE bits), and EV::timer (which	424	(which can set both EV::READ and EV::WRITE bits).
187	uses EV::TIMEOUT).
188		425
189	In the rare case where one wants to create a watcher but not start it at	426	In the rare case where one wants to create a watcher but not start it at
190	the same time, each constructor has a variant with a trailing C<_ns> in	427	the same time, each constructor has a variant with a trailing C<_ns> in
191	its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.	428	its name, e.g. EV::io has a non-starting variant EV::io_ns and so on.
192		429
…		…
212		449
213	=item $w->stop	450	=item $w->stop
214		451
215	Stop a watcher if it is active. Also clear any pending events (events that	452	Stop a watcher if it is active. Also clear any pending events (events that
216	have been received but that didn't yet result in a callback invocation),	453	have been received but that didn't yet result in a callback invocation),
217	regardless of wether the watcher was active or not.	454	regardless of whether the watcher was active or not.
218		455
219	=item $bool = $w->is_active	456	=item $bool = $w->is_active
220		457
221	Returns true if the watcher is active, false otherwise.	458	Returns true if the watcher is active, false otherwise.
222		459
…		…
252	The default priority of any newly-created watcher is 0.	489	The default priority of any newly-created watcher is 0.
253		490
254	Note that the priority semantics have not yet been fleshed out and are	491	Note that the priority semantics have not yet been fleshed out and are
255	subject to almost certain change.	492	subject to almost certain change.
256		493
257	=item $w->trigger ($revents)	494	=item $w->invoke ($revents)
258		495
259	Call the callback now with the given event mask.	496	Call the callback now with the given event mask.
		497
		498	=item $w->feed_event ($revents)
		499
		500	Feed some events on this watcher into EV. EV will react to this call as if
		501	the watcher had received the given C<$revents> mask.
		502
		503	=item $revents = $w->clear_pending
		504
		505	If the watcher is pending, this function clears its pending status and
		506	returns its C<$revents> bitset (as if its callback was invoked). If the
		507	watcher isn't pending it does nothing and returns C<0>.
260		508
261	=item $previous_state = $w->keepalive ($bool)	509	=item $previous_state = $w->keepalive ($bool)
262		510
263	Normally, C<EV::loop> will return when there are no active watchers	511	Normally, C<EV::loop> will return when there are no active watchers
264	(which is a "deadlock" because no progress can be made anymore). This is	512	(which is a "deadlock" because no progress can be made anymore). This is
265	convinient because it allows you to start your watchers (and your jobs),	513	convenient because it allows you to start your watchers (and your jobs),
266	call C<EV::loop> once and when it returns you know that all your jobs are	514	call C<EV::loop> once and when it returns you know that all your jobs are
267	finished (or they forgot to register some watchers for their task :).	515	finished (or they forgot to register some watchers for their task :).
268		516
269	Sometimes, however, this gets in your way, for example when you the module	517	Sometimes, however, this gets in your way, for example when the module
270	that calls C<EV::loop> (usually the main program) is not the same module	518	that calls C<EV::loop> (usually the main program) is not the same module
271	as a long-living watcher (for example a DNS client module written by	519	as a long-living watcher (for example a DNS client module written by
272	somebody else even). Then you might want any outstanding requests to be	520	somebody else even). Then you might want any outstanding requests to be
273	handled, but you would not want to keep C<EV::loop> from returning just	521	handled, but you would not want to keep C<EV::loop> from returning just
274	because you happen to have this long-running UDP port watcher.	522	because you happen to have this long-running UDP port watcher.
275		523
276	In this case you can clear the keepalive status, which means that even	524	In this case you can clear the keepalive status, which means that even
277	though your watcher is active, it won't keep C<EV::loop> from returning.	525	though your watcher is active, it won't keep C<EV::loop> from returning.
278		526
279	The initial value for keepalive is true (enabled), and you cna change it	527	The initial value for keepalive is true (enabled), and you can change it
280	any time.	528	any time.
281		529
282	Example: Register an IO watcher for some UDP socket but do not keep the	530	Example: Register an I/O watcher for some UDP socket but do not keep the
283	event loop from running just because of that watcher.	531	event loop from running just because of that watcher.
284		532
285	my $udp_socket = ...	533	my $udp_socket = ...
286	my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };	534	my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
287	$udp_watcher->keepalive (0);	535	$udp_watcher->keepalive (0);
288		536
289	=back	537	=item $loop = $w->loop
290		538
		539	Return the loop that this watcher is attached to.
291		540
		541	=back
		542
		543
292	=head2 WATCHER TYPES	544	=head1 WATCHER TYPES
293		545
294	Each of the following subsections describes a single watcher type.	546	Each of the following subsections describes a single watcher type.
295		547
296	=head3 IO WATCHERS - is this file descriptor readable or writable?	548	=head3 I/O WATCHERS - is this file descriptor readable or writable?
297		549
298	=over 4	550	=over 4
299		551
300	=item $w = EV::io $fileno_or_fh, $eventmask, $callback	552	=item $w = EV::io $fileno_or_fh, $eventmask, $callback
301		553
302	=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback	554	=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
		555
		556	=item $w = $loop->io ($fileno_or_fh, $eventmask, $callback)
		557
		558	=item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback)
303		559
304	As long as the returned watcher object is alive, call the C<$callback>	560	As long as the returned watcher object is alive, call the C<$callback>
305	when at least one of events specified in C<$eventmask> occurs.	561	when at least one of events specified in C<$eventmask> occurs.
306		562
307	The $eventmask can be one or more of these constants ORed together:	563	The $eventmask can be one or more of these constants ORed together:
…		…
336	=over 4	592	=over 4
337		593
338	=item $w = EV::timer $after, $repeat, $callback	594	=item $w = EV::timer $after, $repeat, $callback
339		595
340	=item $w = EV::timer_ns $after, $repeat, $callback	596	=item $w = EV::timer_ns $after, $repeat, $callback
		597
		598	=item $w = $loop->timer ($after, $repeat, $callback)
		599
		600	=item $w = $loop->timer_ns ($after, $repeat, $callback)
341		601
342	Calls the callback after C<$after> seconds (which may be fractional). If	602	Calls the callback after C<$after> seconds (which may be fractional). If
343	C<$repeat> is non-zero, the timer will be restarted (with the $repeat	603	C<$repeat> is non-zero, the timer will be restarted (with the $repeat
344	value as $after) after the callback returns.	604	value as $after) after the callback returns.
345		605
…		…
386	=over 4	646	=over 4
387		647
388	=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback	648	=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
389		649
390	=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback	650	=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
		651
		652	=item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
		653
		654	=item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback)
391		655
392	Similar to EV::timer, but is not based on relative timeouts but on	656	Similar to EV::timer, but is not based on relative timeouts but on
393	absolute times. Apart from creating "simple" timers that trigger "at" the	657	absolute times. Apart from creating "simple" timers that trigger "at" the
394	specified time, it can also be used for non-drifting absolute timers and	658	specified time, it can also be used for non-drifting absolute timers and
395	more complex, cron-like, setups that are not adversely affected by time	659	more complex, cron-like, setups that are not adversely affected by time
…		…
405	This time simply fires at the wallclock time C<$at> and doesn't repeat. It	669	This time simply fires at the wallclock time C<$at> and doesn't repeat. It
406	will not adjust when a time jump occurs, that is, if it is to be run	670	will not adjust when a time jump occurs, that is, if it is to be run
407	at January 1st 2011 then it will run when the system time reaches or	671	at January 1st 2011 then it will run when the system time reaches or
408	surpasses this time.	672	surpasses this time.
409		673
410	=item * non-repeating interval timer ($interval > 0, $reschedule_cb = 0)	674	=item * repeating interval timer ($interval > 0, $reschedule_cb = 0)
411		675
412	In this mode the watcher will always be scheduled to time out at the	676	In this mode the watcher will always be scheduled to time out at the
413	next C<$at + N * $interval> time (for some integer N) and then repeat,	677	next C<$at + N * $interval> time (for some integer N) and then repeat,
414	regardless of any time jumps.	678	regardless of any time jumps.
415		679
…		…
433	time the periodic watcher gets scheduled, the reschedule callback	697	time the periodic watcher gets scheduled, the reschedule callback
434	($reschedule_cb) will be called with the watcher as first, and the current	698	($reschedule_cb) will be called with the watcher as first, and the current
435	time as second argument.	699	time as second argument.
436		700
437	I<This callback MUST NOT stop or destroy this or any other periodic	701	I<This callback MUST NOT stop or destroy this or any other periodic
438	watcher, ever>. If you need to stop it, return 1e30 and stop it	702	watcher, ever, and MUST NOT call any event loop functions or methods>. If
439	afterwards.	703	you need to stop it, return 1e30 and stop it afterwards. You may create
		704	and start a C<EV::prepare> watcher for this task.
440		705
441	It must return the next time to trigger, based on the passed time value	706	It must return the next time to trigger, based on the passed time value
442	(that is, the lowest time value larger than to the second argument). It	707	(that is, the lowest time value larger than or equal to to the second
443	will usually be called just before the callback will be triggered, but	708	argument). It will usually be called just before the callback will be
444	might be called at other times, too.	709	triggered, but might be called at other times, too.
445		710
446	This can be used to create very complex timers, such as a timer that	711	This can be used to create very complex timers, such as a timer that
447	triggers on each midnight, local time (actually 24 hours after the last	712	triggers on each midnight, local time (actually 24 hours after the last
448	midnight, to keep the example simple. If you know a way to do it correctly	713	midnight, to keep the example simple. If you know a way to do it correctly
449	in about the same space (without requiring elaborate modules), drop me a	714	in about the same space (without requiring elaborate modules), drop me a
…		…
470		735
471	=item $w->again	736	=item $w->again
472		737
473	Simply stops and starts the watcher again.	738	Simply stops and starts the watcher again.
474		739
		740	=item $time = $w->at
		741
		742	Return the time that the watcher is expected to trigger next.
		743
475	=back	744	=back
476		745
477		746
478	=head3 SIGNAL WATCHERS - signal me when a signal gets signalled!	747	=head3 SIGNAL WATCHERS - signal me when a signal gets signalled!
479		748
480	=over 4	749	=over 4
481		750
482	=item $w = EV::signal $signal, $callback	751	=item $w = EV::signal $signal, $callback
483		752
484	=item $w = EV::signal_ns $signal, $callback	753	=item $w = EV::signal_ns $signal, $callback
		754
		755	=item $w = $loop->signal ($signal, $callback)
		756
		757	=item $w = $loop->signal_ns ($signal, $callback)
485		758
486	Call the callback when $signal is received (the signal can be specified by	759	Call the callback when $signal is received (the signal can be specified by
487	number or by name, just as with C<kill> or C<%SIG>).	760	number or by name, just as with C<kill> or C<%SIG>).
		761
		762	Only one event loop can grab a given signal - attempting to grab the same
		763	signal from two EV loops will crash the program immediately or cause data
		764	corruption.
488		765
489	EV will grab the signal for the process (the kernel only allows one	766	EV will grab the signal for the process (the kernel only allows one
490	component to receive a signal at a time) when you start a signal watcher,	767	component to receive a signal at a time) when you start a signal watcher,
491	and removes it again when you stop it. Perl does the same when you	768	and removes it again when you stop it. Perl does the same when you
492	add/remove callbacks to C<%SIG>, so watch out.	769	add/remove callbacks to C<%SIG>, so watch out.
…		…
512		789
513	=head3 CHILD WATCHERS - watch out for process status changes	790	=head3 CHILD WATCHERS - watch out for process status changes
514		791
515	=over 4	792	=over 4
516		793
517	=item $w = EV::child $pid, $callback	794	=item $w = EV::child $pid, $trace, $callback
518		795
519	=item $w = EV::child_ns $pid, $callback	796	=item $w = EV::child_ns $pid, $trace, $callback
520		797
		798	=item $w = $loop->child ($pid, $trace, $callback)
		799
		800	=item $w = $loop->child_ns ($pid, $trace, $callback)
		801
521	Call the callback when a status change for pid C<$pid> (or any pid if	802	Call the callback when a status change for pid C<$pid> (or any pid
522	C<$pid> is 0) has been received. More precisely: when the process receives	803	if C<$pid> is 0) has been received (a status change happens when the
		804	process terminates or is killed, or, when trace is true, additionally when
		805	it is stopped or continued). More precisely: when the process receives
523	a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all	806	a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all
524	changed/zombie children and call the callback.	807	changed/zombie children and call the callback.
525		808
526	It is valid (and fully supported) to install a child watcher after a child	809	It is valid (and fully supported) to install a child watcher after a child
527	has exited but before the event loop has started its next iteration (for	810	has exited but before the event loop has started its next iteration (for
…		…
534	You can have as many pid watchers per pid as you want, they will all be	817	You can have as many pid watchers per pid as you want, they will all be
535	called.	818	called.
536		819
537	The C<child_ns> variant doesn't start (activate) the newly created watcher.	820	The C<child_ns> variant doesn't start (activate) the newly created watcher.
538		821
539	=item $w->set ($pid)	822	=item $w->set ($pid, $trace)
540		823
541	Reconfigures the watcher, see the constructor above for details. Can be called at	824	Reconfigures the watcher, see the constructor above for details. Can be called at
542	any time.	825	any time.
543		826
544	=item $current_pid = $w->pid	827	=item $current_pid = $w->pid
545		828
546	=item $old_pid = $w->pid ($new_pid)
547
548	Returns the previously set process id and optionally set a new one.	829	Returns the previously set process id and optionally set a new one.
549		830
550	=item $exit_status = $w->rstatus	831	=item $exit_status = $w->rstatus
551		832
552	Return the exit/wait status (as returned by waitpid, see the waitpid entry	833	Return the exit/wait status (as returned by waitpid, see the waitpid entry
…		…
565	=over 4	846	=over 4
566		847
567	=item $w = EV::stat $path, $interval, $callback	848	=item $w = EV::stat $path, $interval, $callback
568		849
569	=item $w = EV::stat_ns $path, $interval, $callback	850	=item $w = EV::stat_ns $path, $interval, $callback
		851
		852	=item $w = $loop->stat ($path, $interval, $callback)
		853
		854	=item $w = $loop->stat_ns ($path, $interval, $callback)
570		855
571	Call the callback when a file status change has been detected on	856	Call the callback when a file status change has been detected on
572	C<$path>. The C<$path> does not need to exist, changing from "path exists"	857	C<$path>. The C<$path> does not need to exist, changing from "path exists"
573	to "path does not exist" is a status change like any other.	858	to "path does not exist" is a status change like any other.
574		859
…		…
645		930
646	=item $w = EV::idle $callback	931	=item $w = EV::idle $callback
647		932
648	=item $w = EV::idle_ns $callback	933	=item $w = EV::idle_ns $callback
649		934
650	Call the callback when there are no pending io, timer/periodic, signal or	935	=item $w = $loop->idle ($callback)
651	child events, i.e. when the process is idle.	936
		937	=item $w = $loop->idle_ns ($callback)
		938
		939	Call the callback when there are no other pending watchers of the same or
		940	higher priority (excluding check, prepare and other idle watchers of the
		941	same or lower priority, of course). They are called idle watchers because
		942	when the watcher is the highest priority pending event in the process, the
		943	process is considered to be idle at that priority.
		944
		945	If you want a watcher that is only ever called when I<no> other events are
		946	outstanding you have to set the priority to C<EV::MINPRI>.
652		947
653	The process will not block as long as any idle watchers are active, and	948	The process will not block as long as any idle watchers are active, and
654	they will be called repeatedly until stopped.	949	they will be called repeatedly until stopped.
655		950
		951	For example, if you have idle watchers at priority C<0> and C<1>, and
		952	an I/O watcher at priority C<0>, then the idle watcher at priority C<1>
		953	and the I/O watcher will always run when ready. Only when the idle watcher
		954	at priority C<1> is stopped and the I/O watcher at priority C<0> is not
		955	pending with the C<0>-priority idle watcher be invoked.
		956
656	The C<idle_ns> variant doesn't start (activate) the newly created watcher.	957	The C<idle_ns> variant doesn't start (activate) the newly created watcher.
657		958
658	=back	959	=back
659		960
660		961
…		…
663	=over 4	964	=over 4
664		965
665	=item $w = EV::prepare $callback	966	=item $w = EV::prepare $callback
666		967
667	=item $w = EV::prepare_ns $callback	968	=item $w = EV::prepare_ns $callback
		969
		970	=item $w = $loop->prepare ($callback)
		971
		972	=item $w = $loop->prepare_ns ($callback)
668		973
669	Call the callback just before the process would block. You can still	974	Call the callback just before the process would block. You can still
670	create/modify any watchers at this point.	975	create/modify any watchers at this point.
671		976
672	See the EV::check watcher, below, for explanations and an example.	977	See the EV::check watcher, below, for explanations and an example.
…		…
682		987
683	=item $w = EV::check $callback	988	=item $w = EV::check $callback
684		989
685	=item $w = EV::check_ns $callback	990	=item $w = EV::check_ns $callback
686		991
		992	=item $w = $loop->check ($callback)
		993
		994	=item $w = $loop->check_ns ($callback)
		995
687	Call the callback just after the process wakes up again (after it has	996	Call the callback just after the process wakes up again (after it has
688	gathered events), but before any other callbacks have been invoked.	997	gathered events), but before any other callbacks have been invoked.
689		998
690	This is used to integrate other event-based software into the EV	999	This can be used to integrate other event-based software into the EV
691	mainloop: You register a prepare callback and in there, you create io and	1000	mainloop: You register a prepare callback and in there, you create io and
692	timer watchers as required by the other software. Here is a real-world	1001	timer watchers as required by the other software. Here is a real-world
693	example of integrating Net::SNMP (with some details left out):	1002	example of integrating Net::SNMP (with some details left out):
694		1003
695	our @snmp_watcher;	1004	our @snmp_watcher;
…		…
700	or return;	1009	or return;
701		1010
702	# make the dispatcher handle any outstanding stuff	1011	# make the dispatcher handle any outstanding stuff
703	... not shown	1012	... not shown
704		1013
705	# create an IO watcher for each and every socket	1014	# create an I/O watcher for each and every socket
706	@snmp_watcher = (	1015	@snmp_watcher = (
707	(map { EV::io $_, EV::READ, sub { } }	1016	(map { EV::io $_, EV::READ, sub { } }
708	keys %{ $dispatcher->{_descriptors} }),	1017	keys %{ $dispatcher->{_descriptors} }),
709		1018
710	EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]	1019	EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]
…		…
725	# make the dispatcher handle any new stuff	1034	# make the dispatcher handle any new stuff
726	... not shown	1035	... not shown
727	};	1036	};
728		1037
729	The callbacks of the created watchers will not be called as the watchers	1038	The callbacks of the created watchers will not be called as the watchers
730	are destroyed before this cna happen (remember EV::check gets called	1039	are destroyed before this can happen (remember EV::check gets called
731	first).	1040	first).
732		1041
733	The C<check_ns> variant doesn't start (activate) the newly created watcher.	1042	The C<check_ns> variant doesn't start (activate) the newly created watcher.
		1043
		1044	=item EV::CHECK constant issues
		1045
		1046	Like all other watcher types, there is a bitmask constant for use in
		1047	C<$revents> and other places. The C<EV::CHECK> is special as it has
		1048	the same name as the C<CHECK> sub called by Perl. This doesn't cause
		1049	big issues on newer perls (beginning with 5.8.9), but it means thatthe
		1050	constant must be I<inlined>, i.e. runtime calls will not work. That means
		1051	that as long as you always C<use EV> and then C<EV::CHECK> you are on the
		1052	safe side.
734		1053
735	=back	1054	=back
736		1055
737		1056
738	=head3 FORK WATCHERS - the audacity to resume the event loop after a fork	1057	=head3 FORK WATCHERS - the audacity to resume the event loop after a fork
…		…
745		1064
746	=item $w = EV::fork $callback	1065	=item $w = EV::fork $callback
747		1066
748	=item $w = EV::fork_ns $callback	1067	=item $w = EV::fork_ns $callback
749		1068
		1069	=item $w = $loop->fork ($callback)
		1070
		1071	=item $w = $loop->fork_ns ($callback)
		1072
750	Call the callback before the event loop is resumed in the child process	1073	Call the callback before the event loop is resumed in the child process
751	after a fork.	1074	after a fork.
752		1075
753	The C<fork_ns> variant doesn't start (activate) the newly created watcher.	1076	The C<fork_ns> variant doesn't start (activate) the newly created watcher.
754		1077
755	=back	1078	=back
		1079
		1080
		1081	=head3 EMBED WATCHERS - when one backend isn't enough...
		1082
		1083	This is a rather advanced watcher type that lets you embed one event loop
		1084	into another (currently only IO events are supported in the embedded
		1085	loop, other types of watchers might be handled in a delayed or incorrect
		1086	fashion and must not be used).
		1087
		1088	See the libev documentation at
		1089	L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
		1090	(locally installed as F<EV::libev>) for more details.
		1091
		1092	In short, this watcher is most useful on BSD systems without working
		1093	kqueue to still be able to handle a large number of sockets:
		1094
		1095	my $socket_loop;
		1096
		1097	# check wether we use SELECT or POLL _and_ KQUEUE is supported
		1098	if (
		1099	(EV::backend & (EV::BACKEND_POLL \| EV::BACKEND_SELECT))
		1100	&& (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
		1101	) {
		1102	# use kqueue for sockets
		1103	$socket_loop = new EV::Loop EV::BACKEND_KQUEUE \| EV::FLAG_NOENV;
		1104	}
		1105
		1106	# use the default loop otherwise
		1107	$socket_loop \|\|= EV::default_loop;
		1108
		1109	=over 4
		1110
		1111	=item $w = EV::embed $otherloop[, $callback]
		1112
		1113	=item $w = EV::embed_ns $otherloop[, $callback]
		1114
		1115	=item $w = $loop->embed ($otherloop[, $callback])
		1116
		1117	=item $w = $loop->embed_ns ($otherloop[, $callback])
		1118
		1119	Call the callback when the embedded event loop (C<$otherloop>) has any
		1120	I/O activity. The C<$callback> is optional: if it is missing, then the
		1121	embedded event loop will be managed automatically (which is recommended),
		1122	otherwise you have to invoke C<sweep> yourself.
		1123
		1124	The C<embed_ns> variant doesn't start (activate) the newly created watcher.
		1125
		1126	=back
		1127
		1128	=head3 ASYNC WATCHERS - how to wake up another event loop
		1129
		1130	Async watchers are provided by EV, but have little use in perl directly,
		1131	as perl neither supports threads running in parallel nor direct access to
		1132	signal handlers or other contexts where they could be of value.
		1133
		1134	It is, however, possible to use them from the XS level.
		1135
		1136	Please see the libev documentation for further details.
		1137
		1138	=over 4
		1139
		1140	=item $w = EV::async $callback
		1141
		1142	=item $w = EV::async_ns $callback
		1143
		1144	=item $w = $loop->async ($callback)
		1145
		1146	=item $w = $loop->async_ns ($callback)
		1147
		1148	=item $w->send
		1149
		1150	=item $bool = $w->async_pending
		1151
		1152	=back
		1153
		1154	=head3 CLEANUP WATCHERS - how to clean up when the event loop goes away
		1155
		1156	Cleanup watchers are not supported on the Perl level, they can only be
		1157	used via XS currently.
756		1158
757		1159
758	=head1 PERL SIGNALS	1160	=head1 PERL SIGNALS
759		1161
760	While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour	1162	While Perl signal handling (C<%SIG>) is not affected by EV, the behaviour
…		…
769	to be called on every event loop iteration by installing a C<EV::check>	1171	to be called on every event loop iteration by installing a C<EV::check>
770	watcher:	1172	watcher:
771		1173
772	my $async_check = EV::check sub { };	1174	my $async_check = EV::check sub { };
773		1175
774	This ensures that perl shortly gets into control for a short time, and	1176	This ensures that perl gets into control for a short time to handle any
775	also ensures slower overall operation.	1177	pending signals, and also ensures (slightly) slower overall operation.
776		1178
777	=head1 THREADS	1179	=head1 ITHREADS
778		1180
779	Threads are not supported by this module in any way. Perl pseudo-threads	1181	Ithreads are not supported by this module in any way. Perl pseudo-threads
780	is evil stuff and must die. As soon as Perl gains real threads I will work	1182	is evil stuff and must die. Real threads as provided by Coro are fully
781	on thread support for it.	1183	supported (and enhanced support is available via L<Coro::EV>).
782		1184
783	=head1 FORK	1185	=head1 FORK
784		1186
785	Most of the "improved" event delivering mechanisms of modern operating	1187	Most of the "improved" event delivering mechanisms of modern operating
786	systems have quite a few problems with fork(2) (to put it bluntly: it is	1188	systems have quite a few problems with fork(2) (to put it bluntly: it is
…		…
802	our $DIED = sub {	1204	our $DIED = sub {
803	warn "EV: error in callback (ignoring): $@";	1205	warn "EV: error in callback (ignoring): $@";
804	};	1206	};
805		1207
806	default_loop	1208	default_loop
807	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?';	1209	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?';
808		1210
809	1;	1211	1;
810		1212
811	=head1 SEE ALSO	1213	=head1 SEE ALSO
812		1214
		1215	L<EV::MakeMaker> - MakeMaker interface to XS API, L<EV::ADNS>
813	L<EV::ADNS> (asynchronous dns), L<Glib::EV> (makes Glib/Gtk2 use EV as	1216	(asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as event
814	event loop), L<Coro::EV> (efficient coroutines with EV).	1217	loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient thread
		1218	integration), L<Net::SNMP::EV> (asynchronous SNMP), L<AnyEvent> for
		1219	event-loop agnostic and portable event driven programming.
815		1220
816	=head1 AUTHOR	1221	=head1 AUTHOR
817		1222
818	Marc Lehmann <schmorp@schmorp.de>	1223	Marc Lehmann <schmorp@schmorp.de>
819	http://home.schmorp.de/	1224	http://home.schmorp.de/
820		1225
821	=cut	1226	=cut
822		1227

Diff Legend

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

Comparing EV/EV.pm (file contents): Revision 1.61 by root, Thu Dec 6 03:13:07 2007 UTC vs. Revision 1.138 by root, Sun May 6 16:30:27 2012 UTC

Diff Legend

Comparing EV/EV.pm (file contents):
Revision 1.61 by root, Thu Dec 6 03:13:07 2007 UTC vs.
Revision 1.138 by root, Sun May 6 16:30:27 2012 UTC