[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.79 by root, Sat Dec 22 16:37:07 2007 UTC

…		…
58	This module provides an interface to libev	58	This module provides an interface to libev
59	(L<http://software.schmorp.de/pkg/libev.html>). While the documentation	59	(L<http://software.schmorp.de/pkg/libev.html>). While the documentation
60	below is comprehensive, one might also consult the documentation of libev	60	below is comprehensive, one might also consult the documentation of libev
61	itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on	61	itself (L<http://cvs.schmorp.de/libev/ev.html>) for more subtle details on
62	watcher semantics or some discussion on the available backends, or how to	62	watcher semantics or some discussion on the available backends, or how to
63	force a specific backend with C<LIBEV_FLAGS>.	63	force a specific backend with C<LIBEV_FLAGS>, or just about in any case
		64	because it has much more detailed information.
64		65
65	=cut	66	=cut
66		67
67	package EV;	68	package EV;
68		69
69	use strict;	70	use strict;
70		71
71	BEGIN {	72	BEGIN {
72	our $VERSION = '1.6';	73	our $VERSION = '2.0';
73	use XSLoader;	74	use XSLoader;
74	XSLoader::load "EV", $VERSION;	75	XSLoader::load "EV", $VERSION;
75	}	76	}
76		77
77	@EV::IO::ISA =	78	@EV::IO::ISA =
…		…
85	@EV::Check::ISA =	86	@EV::Check::ISA =
86	@EV::Embed::ISA =	87	@EV::Embed::ISA =
87	@EV::Fork::ISA =	88	@EV::Fork::ISA =
88	"EV::Watcher";	89	"EV::Watcher";
89		90
		91	@EV::Loop::Default::ISA = "EV::Loop";
		92
		93	=head1 EVENT LOOPS
		94
		95	EV supports multiple event loops: There is a single "default event loop"
		96	that can handle everything including signals and child watchers, and any
		97	number of "dynamic event loops" that can use different backends (with
		98	various limitations), but no child and signal watchers.
		99
		100	You do not have to do anything to create the default event loop: When
		101	the module is loaded a suitable backend is selected on the premise of
		102	selecting a working backend (which for example rules out kqueue on most
		103	BSDs). Modules should, unless they have "special needs" always use the
		104	default loop as this is fastest (perl-wise), best supported by other
		105	modules (e.g. AnyEvent or Coro) and most portable event loop.
		106
		107	For specific programs you can create additional event loops dynamically.
		108
		109	=over 4
		110
		111	=item $loop = new EV::loop [$flags]
		112
		113	Create a new event loop as per the specified flags. Please refer to the
		114	C<ev_loop_new ()> function description in the libev documentation
		115	(L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#GLOBAL_FUNCTIONS>)
		116	for more info.
		117
		118	The loop will automatically be destroyed when it is no longer referenced
		119	by any watcher and the loop object goes out of scope.
		120
		121	Using C<EV::FLAG_FORKCHECK> is recommended, as only the default event loop
		122	is protected by this module.
		123
		124	=item $loop->loop_fork
		125
		126	Must be called after a fork in the child, before entering or continuing
		127	the event loop. An alternative is to use C<EV::FLAG_FORKCHECK> which calls
		128	this fucntion automatically, at some performance loss (refer to the libev
		129	documentation).
		130
		131	=item $loop = EV::default_loop [$flags]
		132
		133	Return the default loop (which is a singleton object).
		134
		135	=back
		136
		137
90	=head1 BASIC INTERFACE	138	=head1 BASIC INTERFACE
91		139
92	=over 4	140	=over 4
93		141
94	=item $EV::DIED	142	=item $EV::DIED
95		143
96	Must contain a reference to a function that is called when a callback	144	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	145	throws an exception (with $@ containing the error). The default prints an
98	informative message and continues.	146	informative message and continues.
99		147
100	If this callback throws an exception it will be silently ignored.	148	If this callback throws an exception it will be silently ignored.
101		149
		150	=item $flags = EV::supported_backends
		151
		152	=item $flags = EV::recommended_backends
		153
		154	=item $flags = EV::embeddable_backends
		155
		156	Returns the set (see C<EV::BACKEND_*> flags) of backends supported by this
		157	instance of EV, the set of recommended backends (supposed to be good) for
		158	this platform and the set of embeddable backends (see EMBED WATCHERS).
		159
102	=item $time = EV::time	160	=item $time = EV::time
103		161
104	Returns the current time in (fractional) seconds since the epoch.	162	Returns the current time in (fractional) seconds since the epoch.
105		163
106	=item $time = EV::now	164	=item $time = EV::now
		165
		166	=item $time = $loop->now
107		167
108	Returns the time the last event loop iteration has been started. This	168	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	169	is the time that (relative) timers are based on, and refering to it is
110	usually faster then calling EV::time.	170	usually faster then calling EV::time.
111		171
112	=item $method = EV::method	172	=item $backend = EV::backend
		173
		174	=item $backend = $loop->backend
113		175
114	Returns an integer describing the backend used by libev (EV::METHOD_SELECT	176	Returns an integer describing the backend used by libev (EV::METHOD_SELECT
115	or EV::METHOD_EPOLL).	177	or EV::METHOD_EPOLL).
116		178
117	=item EV::loop [$flags]	179	=item EV::loop [$flags]
		180
		181	=item $loop->loop ([$flags])
118		182
119	Begin checking for events and calling callbacks. It returns when a	183	Begin checking for events and calling callbacks. It returns when a
120	callback calls EV::unloop.	184	callback calls EV::unloop.
121		185
122	The $flags argument can be one of the following:	186	The $flags argument can be one of the following:
…		…
125	EV::LOOP_ONESHOT block at most once (wait, but do not loop)	189	EV::LOOP_ONESHOT 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)	190	EV::LOOP_NONBLOCK do not block at all (fetch/handle events but do not wait)
127		191
128	=item EV::unloop [$how]	192	=item EV::unloop [$how]
129		193
		194	=item $loop->unloop ([$how])
		195
130	When called with no arguments or an argument of EV::UNLOOP_ONE, makes the	196	When called with no arguments or an argument of EV::UNLOOP_ONE, makes the
131	innermost call to EV::loop return.	197	innermost call to EV::loop return.
132		198
133	When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as	199	When called with an argument of EV::UNLOOP_ALL, all calls to EV::loop will return as
134	fast as possible.	200	fast as possible.
135		201
136	=item $count = EV::loop_count	202	=item $count = EV::loop_count
137		203
		204	=item $count = $loop->loop_count
		205
138	Return the number of times the event loop has polled for new	206	Return the number of times the event loop has polled for new
139	events. Sometiems useful as a generation counter.	207	events. Sometiems useful as a generation counter.
140		208
141	=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)	209	=item EV::once $fh_or_undef, $events, $timeout, $cb->($revents)
		210
		211	=item $loop->once ($fh_or_undef, $events, $timeout, $cb->($revents))
142		212
143	This function rolls together an I/O and a timer watcher for a single	213	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.	214	one-shot event without the need for managing a watcher object.
145		215
146	If C<$fh_or_undef> is a filehandle or file descriptor, then C<$events>	216	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	222	If timeout is C<undef> or negative, then there will be no
153	timeout. Otherwise a EV::timer with this value will be started.	223	timeout. Otherwise a EV::timer with this value will be started.
154		224
155	When an error occurs or either the timeout or I/O watcher triggers, then	225	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	226	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>,	227	you can expect it to be a combination of C<EV::ERROR>, C<EV::READ>,
158	C<EV::WRITE> and C<EV::TIMEOUT>).	228	C<EV::WRITE> and C<EV::TIMEOUT>).
159		229
160	EV::once doesn't return anything: the watchers stay active till either	230	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	231	of them triggers, then they will be stopped and freed, and the callback
162	invoked.	232	invoked.
163		233
164	=back	234	=item EV::feed_fd_event ($fd, $revents)
165		235
		236	=item $loop->feed_fd_event ($fd, $revents)
		237
		238	Feed an event on a file descriptor into EV. EV will react to this call as
		239	if the readyness notifications specified by C<$revents> (a combination of
		240	C<EV::READ> and C<EV::WRITE>) happened on the file descriptor C<$fd>.
		241
		242	=item EV::feed_signal_event ($signal)
		243
		244	Feed a signal event into EV. EV will react to this call as if the signal
		245	specified by C<$signal> had occured.
		246
		247	=item EV::set_io_collect_interval $time
		248
		249	=item $loop->set_io_collect_interval ($time)
		250
		251	=item EV::set_timeout_collect_interval $time
		252
		253	=item $loop->set_timeout_collect_interval ($time)
		254
		255	These advanced functions set the minimum block interval when polling for I/O events and the minimum
		256	wait interval for timer events. See the libev documentation at
		257	L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#FUNCTIONS_CONTROLLING_THE_EVENT_LOOP> for
		258	a more detailed discussion.
		259
		260	=back
		261
		262
166	=head2 WATCHER OBJECTS	263	=head1 WATCHER OBJECTS
167		264
168	A watcher is an object that gets created to record your interest in some	265	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	266	event. For instance, if you want to wait for STDIN to become readable, you
170	would create an EV::io watcher for that:	267	would create an EV::io watcher for that:
171		268
172	my $watcher = EV::io *STDIN, EV::READ, sub {	269	my $watcher = EV::io *STDIN, EV::READ, sub {
173	my ($watcher, $revents) = @_;	270	my ($watcher, $revents) = @_;
174	warn "yeah, STDIN should not be readable without blocking!\n"	271	warn "yeah, STDIN should now be readable without blocking!\n"
175	};	272	};
176		273
177	All watchers can be active (waiting for events) or inactive (paused). Only	274	All watchers can be active (waiting for events) or inactive (paused). Only
178	active watchers will have their callbacks invoked. All callbacks will be	275	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	276	called with at least two arguments: the watcher and a bitmask of received
180	events.	277	events.
181		278
182	Each watcher type has its associated bit in revents, so you can use the	279	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	280	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,	281	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	282	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	283	(which can set both EV::READ and EV::WRITE bits), and EV::timer (which
187	uses EV::TIMEOUT).	284	uses EV::TIMEOUT).
188		285
189	In the rare case where one wants to create a watcher but not start it at	286	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	287	the same time, each constructor has a variant with a trailing C<_ns> in
…		…
212		309
213	=item $w->stop	310	=item $w->stop
214		311
215	Stop a watcher if it is active. Also clear any pending events (events that	312	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),	313	have been received but that didn't yet result in a callback invocation),
217	regardless of wether the watcher was active or not.	314	regardless of whether the watcher was active or not.
218		315
219	=item $bool = $w->is_active	316	=item $bool = $w->is_active
220		317
221	Returns true if the watcher is active, false otherwise.	318	Returns true if the watcher is active, false otherwise.
222		319
…		…
252	The default priority of any newly-created watcher is 0.	349	The default priority of any newly-created watcher is 0.
253		350
254	Note that the priority semantics have not yet been fleshed out and are	351	Note that the priority semantics have not yet been fleshed out and are
255	subject to almost certain change.	352	subject to almost certain change.
256		353
257	=item $w->trigger ($revents)	354	=item $w->invoke ($revents)
258		355
259	Call the callback now with the given event mask.	356	Call the callback now with the given event mask.
		357
		358	=item $w->feed_event ($revents)
		359
		360	Feed some events on this watcher into EV. EV will react to this call as if
		361	the watcher had received the given C<$revents> mask.
		362
		363	=item $revents = $w->clear_pending
		364
		365	If the watcher is pending, this function clears its pending status and
		366	returns its C<$revents> bitset (as if its callback was invoked). If the
		367	watcher isn't pending it does nothing and returns C<0>.
260		368
261	=item $previous_state = $w->keepalive ($bool)	369	=item $previous_state = $w->keepalive ($bool)
262		370
263	Normally, C<EV::loop> will return when there are no active watchers	371	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	372	(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),	373	convinient 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	374	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 :).	375	finished (or they forgot to register some watchers for their task :).
268		376
269	Sometimes, however, this gets in your way, for example when you the module	377	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	378	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	379	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	380	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	381	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.	382	because you happen to have this long-running UDP port watcher.
…		…
277	though your watcher is active, it won't keep C<EV::loop> from returning.	385	though your watcher is active, it won't keep C<EV::loop> from returning.
278		386
279	The initial value for keepalive is true (enabled), and you cna change it	387	The initial value for keepalive is true (enabled), and you cna change it
280	any time.	388	any time.
281		389
282	Example: Register an IO watcher for some UDP socket but do not keep the	390	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.	391	event loop from running just because of that watcher.
284		392
285	my $udp_socket = ...	393	my $udp_socket = ...
286	my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };	394	my $udp_watcher = EV::io $udp_socket, EV::READ, sub { ... };
287	$udp_watcher->keepalive (0);	395	$1000udp_watcher->keepalive (0);
288		396
289	=back	397	=item $loop = $w->loop
290		398
		399	Return the loop that this watcher is attached to.
291		400
		401	=back
		402
		403
292	=head2 WATCHER TYPES	404	=head1 WATCHER TYPES
293		405
294	Each of the following subsections describes a single watcher type.	406	Each of the following subsections describes a single watcher type.
295		407
296	=head3 IO WATCHERS - is this file descriptor readable or writable?	408	=head3 I/O WATCHERS - is this file descriptor readable or writable?
297		409
298	=over 4	410	=over 4
299		411
300	=item $w = EV::io $fileno_or_fh, $eventmask, $callback	412	=item $w = EV::io $fileno_or_fh, $eventmask, $callback
301		413
302	=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback	414	=item $w = EV::io_ns $fileno_or_fh, $eventmask, $callback
		415
		416	=item $w = $loop->io ($fileno_or_fh, $eventmask, $callback)
		417
		418	=item $w = $loop->io_ns ($fileno_or_fh, $eventmask, $callback)
303		419
304	As long as the returned watcher object is alive, call the C<$callback>	420	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.	421	when at least one of events specified in C<$eventmask> occurs.
306		422
307	The $eventmask can be one or more of these constants ORed together:	423	The $eventmask can be one or more of these constants ORed together:
…		…
336	=over 4	452	=over 4
337		453
338	=item $w = EV::timer $after, $repeat, $callback	454	=item $w = EV::timer $after, $repeat, $callback
339		455
340	=item $w = EV::timer_ns $after, $repeat, $callback	456	=item $w = EV::timer_ns $after, $repeat, $callback
		457
		458	=item $w = $loop->timer ($after, $repeat, $callback)
		459
		460	=item $w = $loop->timer_ns ($after, $repeat, $callback)
341		461
342	Calls the callback after C<$after> seconds (which may be fractional). If	462	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	463	C<$repeat> is non-zero, the timer will be restarted (with the $repeat
344	value as $after) after the callback returns.	464	value as $after) after the callback returns.
345		465
…		…
386	=over 4	506	=over 4
387		507
388	=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback	508	=item $w = EV::periodic $at, $interval, $reschedule_cb, $callback
389		509
390	=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback	510	=item $w = EV::periodic_ns $at, $interval, $reschedule_cb, $callback
		511
		512	=item $w = $loop->periodic ($at, $interval, $reschedule_cb, $callback)
		513
		514	=item $w = $loop->periodic_ns ($at, $interval, $reschedule_cb, $callback)
391		515
392	Similar to EV::timer, but is not based on relative timeouts but on	516	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	517	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	518	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	519	more complex, cron-like, setups that are not adversely affected by time
…		…
470		594
471	=item $w->again	595	=item $w->again
472		596
473	Simply stops and starts the watcher again.	597	Simply stops and starts the watcher again.
474		598
		599	=item $time = $w->at
		600
		601	Return the time that the watcher is expected to trigger next.
		602
475	=back	603	=back
476		604
477		605
478	=head3 SIGNAL WATCHERS - signal me when a signal gets signalled!	606	=head3 SIGNAL WATCHERS - signal me when a signal gets signalled!
479		607
…		…
516		644
517	=item $w = EV::child $pid, $callback	645	=item $w = EV::child $pid, $callback
518		646
519	=item $w = EV::child_ns $pid, $callback	647	=item $w = EV::child_ns $pid, $callback
520		648
		649	=item $w = $loop->child ($pid, $callback)
		650
		651	=item $w = $loop->child_ns ($pid, $callback)
		652
521	Call the callback when a status change for pid C<$pid> (or any pid if	653	Call the callback when a status change for pid C<$pid> (or any pid if
522	C<$pid> is 0) has been received. More precisely: when the process receives	654	C<$pid> is 0) has been received. More precisely: when the process receives
523	a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all	655	a C<SIGCHLD>, EV will fetch the outstanding exit/wait status for all
524	changed/zombie children and call the callback.	656	changed/zombie children and call the callback.
525		657
…		…
566		698
567	=item $w = EV::stat $path, $interval, $callback	699	=item $w = EV::stat $path, $interval, $callback
568		700
569	=item $w = EV::stat_ns $path, $interval, $callback	701	=item $w = EV::stat_ns $path, $interval, $callback
570		702
		703	=item $w = $loop->stat ($path, $interval, $callback)
		704
		705	=item $w = $loop->stat_ns ($path, $interval, $callback)
		706
571	Call the callback when a file status change has been detected on	707	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"	708	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.	709	to "path does not exist" is a status change like any other.
574		710
575	The C<$interval> is a recommended polling interval for systems where	711	The C<$interval> is a recommended polling interval for systems where
…		…
645		781
646	=item $w = EV::idle $callback	782	=item $w = EV::idle $callback
647		783
648	=item $w = EV::idle_ns $callback	784	=item $w = EV::idle_ns $callback
649		785
650	Call the callback when there are no pending io, timer/periodic, signal or	786	=item $w = $loop->idle ($callback)
651	child events, i.e. when the process is idle.	787
		788	=item $w = $loop->idle_ns ($callback)
		789
		790	Call the callback when there are no other pending watchers of the same or
		791	higher priority (excluding check, prepare and other idle watchers of the
		792	same or lower priority, of course). They are called idle watchers because
		793	when the watcher is the highest priority pending event in the process, the
		794	process is considered to be idle at that priority.
		795
		796	If you want a watcher that is only ever called when I<no> other events are
		797	outstanding you have to set the priority to C<EV::MINPRI>.
652		798
653	The process will not block as long as any idle watchers are active, and	799	The process will not block as long as any idle watchers are active, and
654	they will be called repeatedly until stopped.	800	they will be called repeatedly until stopped.
655		801
		802	For example, if you have idle watchers at priority C<0> and C<1>, and
		803	an I/O watcher at priority C<0>, then the idle watcher at priority C<1>
		804	and the I/O watcher will always run when ready. Only when the idle watcher
		805	at priority C<1> is stopped and the I/O watcher at priority C<0> is not
		806	pending with the C<0>-priority idle watcher be invoked.
		807
656	The C<idle_ns> variant doesn't start (activate) the newly created watcher.	808	The C<idle_ns> variant doesn't start (activate) the newly created watcher.
657		809
658	=back	810	=back
659		811
660		812
…		…
663	=over 4	815	=over 4
664		816
665	=item $w = EV::prepare $callback	817	=item $w = EV::prepare $callback
666		818
667	=item $w = EV::prepare_ns $callback	819	=item $w = EV::prepare_ns $callback
		820
		821	=item $w = $loop->prepare ($callback)
		822
		823	=item $w = $loop->prepare_ns ($callback)
668		824
669	Call the callback just before the process would block. You can still	825	Call the callback just before the process would block. You can still
670	create/modify any watchers at this point.	826	create/modify any watchers at this point.
671		827
672	See the EV::check watcher, below, for explanations and an example.	828	See the EV::check watcher, below, for explanations and an example.
…		…
681	=over 4	837	=over 4
682		838
683	=item $w = EV::check $callback	839	=item $w = EV::check $callback
684		840
685	=item $w = EV::check_ns $callback	841	=item $w = EV::check_ns $callback
		842
		843	=item $w = $loop->check ($callback)
		844
		845	=item $w = $loop->check_ns ($callback)
686		846
687	Call the callback just after the process wakes up again (after it has	847	Call the callback just after the process wakes up again (after it has
688	gathered events), but before any other callbacks have been invoked.	848	gathered events), but before any other callbacks have been invoked.
689		849
690	This is used to integrate other event-based software into the EV	850	This is used to integrate other event-based software into the EV
…		…
700	or return;	860	or return;
701		861
702	# make the dispatcher handle any outstanding stuff	862	# make the dispatcher handle any outstanding stuff
703	... not shown	863	... not shown
704		864
705	# create an IO watcher for each and every socket	865	# create an I/O watcher for each and every socket
706	@snmp_watcher = (	866	@snmp_watcher = (
707	(map { EV::io $_, EV::READ, sub { } }	867	(map { EV::io $_, EV::READ, sub { } }
708	keys %{ $dispatcher->{_descriptors} }),	868	keys %{ $dispatcher->{_descriptors} }),
709		869
710	EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]	870	EV::timer +($event->[Net::SNMP::Dispatcher::_ACTIVE]
…		…
745		905
746	=item $w = EV::fork $callback	906	=item $w = EV::fork $callback
747		907
748	=item $w = EV::fork_ns $callback	908	=item $w = EV::fork_ns $callback
749		909
		910	=item $w = $loop->fork ($callback)
		911
		912	=item $w = $loop->fork_ns ($callback)
		913
750	Call the callback before the event loop is resumed in the child process	914	Call the callback before the event loop is resumed in the child process
751	after a fork.	915	after a fork.
752		916
753	The C<fork_ns> variant doesn't start (activate) the newly created watcher.	917	The C<fork_ns> variant doesn't start (activate) the newly created watcher.
		918
		919	=back
		920
		921
		922	=head3 EMBED WATCHERS - when one backend isn't enough...
		923
		924	This is a rather advanced watcher type that lets you embed one event loop
		925	into another (currently only IO events are supported in the embedded
		926	loop, other types of watchers might be handled in a delayed or incorrect
		927	fashion and must not be used).
		928
		929	See the libev documentation at
		930	L<http://pod.tst.eu/http://cvs.schmorp.de/libev/ev.pod#code_ev_embed_code_when_one_backend_>
		931	for more details.
		932
		933	In short, this watcher is most useful on BSD systems without working
		934	kqueue to still be able to handle a large number of sockets:
		935
		936	my $socket_loop;
		937
		938	# check wether we use SELECT or POLL _and_ KQUEUE is supported
		939	if (
		940	(EV::backend & (EV::BACKEND_POLL \| EV::BACKEND_SELECT))
		941	&& (EV::supported_backends & EV::embeddable_backends & EV::BACKEND_KQUEUE)
		942	) {
		943	# use kqueue for sockets
		944	$socket_loop = new EV::Loop EV::BACKEND_KQUEUE \| EV::FLAG_NOENV;
		945	}
		946
		947	# use the default loop otherwise
		948	$socket_loop \|\|= EV::default_loop;
		949
		950	=over 4
		951
		952	=item $w = EV::embed $otherloop, $callback
		953
		954	=item $w = EV::embed_ns $otherloop, $callback
		955
		956	=item $w = $loop->embed ($otherloop, $callback)
		957
		958	=item $w = $loop->embed_ns ($otherloop, $callback)
		959
		960	Call the callback when the embedded event loop (C<$otherloop>) has any
		961	I/O activity. The C<$callback> should alwas be specified as C<undef> in
		962	this version of EV, which means the embedded event loop will be managed
		963	automatically.
		964
		965	The C<embed_ns> variant doesn't start (activate) the newly created watcher.
754		966
755	=back	967	=back
756		968
757		969
758	=head1 PERL SIGNALS	970	=head1 PERL SIGNALS
…		…
769	to be called on every event loop iteration by installing a C<EV::check>	981	to be called on every event loop iteration by installing a C<EV::check>
770	watcher:	982	watcher:
771		983
772	my $async_check = EV::check sub { };	984	my $async_check = EV::check sub { };
773		985
774	This ensures that perl shortly gets into control for a short time, and	986	This ensures that perl gets into control for a short time to handle any
775	also ensures slower overall operation.	987	pending signals, and also ensures (slightly) slower overall operation.
776		988
777	=head1 THREADS	989	=head1 THREADS
778		990
779	Threads are not supported by this module in any way. Perl pseudo-threads	991	Threads 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	992	is evil stuff and must die. As soon as Perl gains real threads I will work
…		…
802	our $DIED = sub {	1014	our $DIED = sub {
803	warn "EV: error in callback (ignoring): $@";	1015	warn "EV: error in callback (ignoring): $@";
804	};	1016	};
805		1017
806	default_loop	1018	default_loop
807	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_METHODS}?';	1019	or die 'EV: cannot initialise libev backend. bad $ENV{LIBEV_FLAGS}?';
808		1020
809	1;	1021	1;
810		1022
811	=head1 SEE ALSO	1023	=head1 SEE ALSO
812		1024
813	L<EV::ADNS> (asynchronous dns), L<Glib::EV> (makes Glib/Gtk2 use EV as	1025	L<EV::ADNS> (asynchronous DNS), L<Glib::EV> (makes Glib/Gtk2 use EV as
814	event loop), L<Coro::EV> (efficient coroutines with EV).	1026	event loop), L<EV::Glib> (embed Glib into EV), L<Coro::EV> (efficient
		1027	coroutines with EV), L<Net::SNMP::EV> (asynchronous SNMP).
815		1028
816	=head1 AUTHOR	1029	=head1 AUTHOR
817		1030
818	Marc Lehmann <schmorp@schmorp.de>	1031	Marc Lehmann <schmorp@schmorp.de>
819	http://home.schmorp.de/	1032	http://home.schmorp.de/

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.79 by root, Sat Dec 22 16:37:07 2007 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.79 by root, Sat Dec 22 16:37:07 2007 UTC