[ViewVC] Diff of: cvs/AnyEvent/lib/AnyEvent.pm

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.15 by root, Mon Oct 30 20:55:05 2006 UTC vs.
Revision 1.57 by root, Thu Apr 24 03:19:28 2008 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent - provide framework for multiple event loops	3	AnyEvent - provide framework for multiple event loops
4		4
5	Event, Coro, Glib, Tk, Perl - various supported event loops	5	EV, Event, Coro::EV, Coro::Event, Glib, Tk, Perl, Event::Lib, Qt - various supported event loops
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	use AnyEvent;	9	use AnyEvent;
10		10
14		14
15	my $w = AnyEvent->timer (after => $seconds, cb => sub {	15	my $w = AnyEvent->timer (after => $seconds, cb => sub {
16	...	16	...
17	});	17	});
18		18
19	my $w = AnyEvent->condvar; # stores wether a condition was flagged	19	my $w = AnyEvent->condvar; # stores whether a condition was flagged
20	$w->wait; # enters "main loop" till $condvar gets ->broadcast	20	$w->wait; # enters "main loop" till $condvar gets ->broadcast
21	$w->broadcast; # wake up current and all future wait's	21	$w->broadcast; # wake up current and all future wait's
		22
		23	=head1 WHY YOU SHOULD USE THIS MODULE (OR NOT)
		24
		25	Glib, POE, IO::Async, Event... CPAN offers event models by the dozen
		26	nowadays. So what is different about AnyEvent?
		27
		28	Executive Summary: AnyEvent is I<compatible>, AnyEvent is I<free of
		29	policy> and AnyEvent is I<small and efficient>.
		30
		31	First and foremost, I<AnyEvent is not an event model> itself, it only
		32	interfaces to whatever event model the main program happens to use in a
		33	pragmatic way. For event models and certain classes of immortals alike,
		34	the statement "there can only be one" is a bitter reality: In general,
		35	only one event loop can be active at the same time in a process. AnyEvent
		36	helps hiding the differences between those event loops.
		37
		38	The goal of AnyEvent is to offer module authors the ability to do event
		39	programming (waiting for I/O or timer events) without subscribing to a
		40	religion, a way of living, and most importantly: without forcing your
		41	module users into the same thing by forcing them to use the same event
		42	model you use.
		43
		44	For modules like POE or IO::Async (which is a total misnomer as it is
		45	actually doing all I/O I<synchronously>...), using them in your module is
		46	like joining a cult: After you joined, you are dependent on them and you
		47	cannot use anything else, as it is simply incompatible to everything that
		48	isn't itself. What's worse, all the potential users of your module are
		49	I<also> forced to use the same event loop you use.
		50
		51	AnyEvent is different: AnyEvent + POE works fine. AnyEvent + Glib works
		52	fine. AnyEvent + Tk works fine etc. etc. but none of these work together
		53	with the rest: POE + IO::Async? no go. Tk + Event? no go. Again: if
		54	your module uses one of those, every user of your module has to use it,
		55	too. But if your module uses AnyEvent, it works transparently with all
		56	event models it supports (including stuff like POE and IO::Async, as long
		57	as those use one of the supported event loops. It is trivial to add new
		58	event loops to AnyEvent, too, so it is future-proof).
		59
		60	In addition to being free of having to use I<the one and only true event
		61	model>, AnyEvent also is free of bloat and policy: with POE or similar
		62	modules, you get an enourmous amount of code and strict rules you have to
		63	follow. AnyEvent, on the other hand, is lean and up to the point, by only
		64	offering the functionality that is necessary, in as thin as a wrapper as
		65	technically possible.
		66
		67	Of course, if you want lots of policy (this can arguably be somewhat
		68	useful) and you want to force your users to use the one and only event
		69	model, you should I<not> use this module.
		70
22		71
23	=head1 DESCRIPTION	72	=head1 DESCRIPTION
24		73
25	L<AnyEvent> provides an identical interface to multiple event loops. This	74	L<AnyEvent> provides an identical interface to multiple event loops. This
26	allows module authors to utilise an event loop without forcing module	75	allows module authors to utilise an event loop without forcing module
27	users to use the same event loop (as only a single event loop can coexist	76	users to use the same event loop (as only a single event loop can coexist
28	peacefully at any one time).	77	peacefully at any one time).
29		78
30	The interface itself is vaguely similar but not identical to the Event	79	The interface itself is vaguely similar, but not identical to the L<Event>
31	module.	80	module.
32		81
33	On the first call of any method, the module tries to detect the currently	82	During the first call of any watcher-creation method, the module tries
34	loaded event loop by probing wether any of the following modules is	83	to detect the currently loaded event loop by probing whether one of
35	loaded: L<Coro::Event>, L<Event>, L<Glib>, L<Tk>. The first one found is	84	the following modules is already loaded: L<Coro::EV>, L<Coro::Event>,
		85	L<EV>, L<Event>, L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>. The first one
36	used. If none is found, the module tries to load these modules in the	86	found is used. If none are found, the module tries to load these modules
37	order given. The first one that could be successfully loaded will be	87	(excluding Event::Lib and Qt) in the order given. The first one that can
38	used. If still none could be found, AnyEvent will fall back to a pure-perl	88	be successfully loaded will be used. If, after this, still none could be
39	event loop, which is also not very efficient.	89	found, AnyEvent will fall back to a pure-perl event loop, which is not
		90	very efficient, but should work everywhere.
40		91
41	Because AnyEvent first checks for modules that are already loaded, loading	92	Because AnyEvent first checks for modules that are already loaded, loading
42	an Event model explicitly before first using AnyEvent will likely make	93	an event model explicitly before first using AnyEvent will likely make
43	that model the default. For example:	94	that model the default. For example:
44		95
45	use Tk;	96	use Tk;
46	use AnyEvent;	97	use AnyEvent;
47		98
48	# .. AnyEvent will likely default to Tk	99	# .. AnyEvent will likely default to Tk
		100
		101	The I<likely> means that, if any module loads another event model and
		102	starts using it, all bets are off. Maybe you should tell their authors to
		103	use AnyEvent so their modules work together with others seamlessly...
49		104
50	The pure-perl implementation of AnyEvent is called	105	The pure-perl implementation of AnyEvent is called
51	C<AnyEvent::Impl::Perl>. Like other event modules you can load it	106	C<AnyEvent::Impl::Perl>. Like other event modules you can load it
52	explicitly.	107	explicitly.
53		108
…		…
56	AnyEvent has the central concept of a I<watcher>, which is an object that	111	AnyEvent has the central concept of a I<watcher>, which is an object that
57	stores relevant data for each kind of event you are waiting for, such as	112	stores relevant data for each kind of event you are waiting for, such as
58	the callback to call, the filehandle to watch, etc.	113	the callback to call, the filehandle to watch, etc.
59		114
60	These watchers are normal Perl objects with normal Perl lifetime. After	115	These watchers are normal Perl objects with normal Perl lifetime. After
61	creating a watcher it will immediately "watch" for events and invoke	116	creating a watcher it will immediately "watch" for events and invoke the
		117	callback when the event occurs (of course, only when the event model
		118	is in control).
		119
62	the callback. To disable the watcher you have to destroy it (e.g. by	120	To disable the watcher you have to destroy it (e.g. by setting the
63	setting the variable that stores it to C<undef> or otherwise deleting all	121	variable you store it in to C<undef> or otherwise deleting all references
64	references to it).	122	to it).
65		123
66	All watchers are created by calling a method on the C<AnyEvent> class.	124	All watchers are created by calling a method on the C<AnyEvent> class.
67		125
		126	Many watchers either are used with "recursion" (repeating timers for
		127	example), or need to refer to their watcher object in other ways.
		128
		129	An any way to achieve that is this pattern:
		130
		131	my $w; $w = AnyEvent->type (arg => value ..., cb => sub {
		132	# you can use $w here, for example to undef it
		133	undef $w;
		134	});
		135
		136	Note that C<my $w; $w => combination. This is necessary because in Perl,
		137	my variables are only visible after the statement in which they are
		138	declared.
		139
68	=head2 IO WATCHERS	140	=head2 IO WATCHERS
69		141
70	You can create I/O watcher by calling the C<< AnyEvent->io >> method with	142	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
71	the following mandatory arguments:	143	with the following mandatory key-value pairs as arguments:
72		144
73	C<fh> the Perl I<filehandle> (not filedescriptor) to watch for	145	C<fh> the Perl I<file handle> (I<not> file descriptor) to watch for
74	events. C<poll> must be a string that is either C<r> or C<w>, that creates	146	events. C<poll> must be a string that is either C<r> or C<w>, which
75	a watcher waiting for "r"eadable or "w"ritable events. C<cb> teh callback	147	creates a watcher waiting for "r"eadable or "w"ritable events,
76	to invoke everytime the filehandle becomes ready.	148	respectively. C<cb> is the callback to invoke each time the file handle
		149	becomes ready.
77		150
78	Only one io watcher per C<fh> and C<poll> combination is allowed (i.e. on	151	As long as the I/O watcher exists it will keep the file descriptor or a
79	a socket you can have one r + one w, not any more (limitation comes from	152	copy of it alive/open.
80	Tk - if you are sure you are not using Tk this limitation is gone).
81		153
82	Filehandles will be kept alive, so as long as the watcher exists, the	154	It is not allowed to close a file handle as long as any watcher is active
83	filehandle exists, too.	155	on the underlying file descriptor.
		156
		157	Some event loops issue spurious readyness notifications, so you should
		158	always use non-blocking calls when reading/writing from/to your file
		159	handles.
84		160
85	Example:	161	Example:
86		162
87	# wait for readability of STDIN, then read a line and disable the watcher	163	# wait for readability of STDIN, then read a line and disable the watcher
88	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	164	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
89	chomp (my $input = <STDIN>);	165	chomp (my $input = <STDIN>);
90	warn "read: $input\n";	166	warn "read: $input\n";
91	undef $w;	167	undef $w;
92	});	168	});
93		169
94	=head2 TIMER WATCHERS	170	=head2 TIME WATCHERS
95		171
96	You can create a timer watcher by calling the C<< AnyEvent->timer >>	172	You can create a time watcher by calling the C<< AnyEvent->timer >>
97	method with the following mandatory arguments:	173	method with the following mandatory arguments:
98		174
99	C<after> after how many seconds (fractions are supported) should the timer	175	C<after> specifies after how many seconds (fractional values are
100	activate. C<cb> the callback to invoke.	176	supported) should the timer activate. C<cb> the callback to invoke in that
		177	case.
101		178
102	The timer callback will be invoked at most once: if you want a repeating	179	The timer callback will be invoked at most once: if you want a repeating
103	timer you have to create a new watcher (this is a limitation by both Tk	180	timer you have to create a new watcher (this is a limitation by both Tk
104	and Glib).	181	and Glib).
105		182
…		…
109	my $w = AnyEvent->timer (after => 7.7, cb => sub {	186	my $w = AnyEvent->timer (after => 7.7, cb => sub {
110	warn "timeout\n";	187	warn "timeout\n";
111	});	188	});
112		189
113	# to cancel the timer:	190	# to cancel the timer:
114	undef $w	191	undef $w;
115		192
		193	Example 2:
		194
		195	# fire an event after 0.5 seconds, then roughly every second
		196	my $w;
		197
		198	my $cb = sub {
		199	# cancel the old timer while creating a new one
		200	$w = AnyEvent->timer (after => 1, cb => $cb);
		201	};
		202
		203	# start the "loop" by creating the first watcher
		204	$w = AnyEvent->timer (after => 0.5, cb => $cb);
		205
		206	=head3 TIMING ISSUES
		207
		208	There are two ways to handle timers: based on real time (relative, "fire
		209	in 10 seconds") and based on wallclock time (absolute, "fire at 12
		210	o'clock").
		211
		212	While most event loops expect timers to specified in a relative way, they use
		213	absolute time internally. This makes a difference when your clock "jumps",
		214	for example, when ntp decides to set your clock backwards from the wrong 2014-01-01 to
		215	2008-01-01, a watcher that you created to fire "after" a second might actually take
		216	six years to finally fire.
		217
		218	AnyEvent cannot compensate for this. The only event loop that is conscious
		219	about these issues is L<EV>, which offers both relative (ev_timer) and
		220	absolute (ev_periodic) timers.
		221
		222	AnyEvent always prefers relative timers, if available, matching the
		223	AnyEvent API.
		224
		225	=head2 SIGNAL WATCHERS
		226
		227	You can watch for signals using a signal watcher, C<signal> is the signal
		228	I<name> without any C<SIG> prefix, C<cb> is the Perl callback to
		229	be invoked whenever a signal occurs.
		230
		231	Multiple signals occurances can be clumped together into one callback
		232	invocation, and callback invocation will be synchronous. synchronous means
		233	that it might take a while until the signal gets handled by the process,
		234	but it is guarenteed not to interrupt any other callbacks.
		235
		236	The main advantage of using these watchers is that you can share a signal
		237	between multiple watchers.
		238
		239	This watcher might use C<%SIG>, so programs overwriting those signals
		240	directly will likely not work correctly.
		241
		242	Example: exit on SIGINT
		243
		244	my $w = AnyEvent->signal (signal => "INT", cb => sub { exit 1 });
		245
		246	=head2 CHILD PROCESS WATCHERS
		247
		248	You can also watch on a child process exit and catch its exit status.
		249
		250	The child process is specified by the C<pid> argument (if set to C<0>, it
		251	watches for any child process exit). The watcher will trigger as often
		252	as status change for the child are received. This works by installing a
		253	signal handler for C<SIGCHLD>. The callback will be called with the pid
		254	and exit status (as returned by waitpid).
		255
		256	Example: wait for pid 1333
		257
		258	my $w = AnyEvent->child (
		259	pid => 1333,
		260	cb => sub {
		261	my ($pid, $status) = @_;
		262	warn "pid $pid exited with status $status";
		263	},
		264	);
		265
116	=head2 CONDITION WATCHERS	266	=head2 CONDITION VARIABLES
117		267
118	Condition watchers can be created by calling the C<< AnyEvent->condvar >>	268	Condition variables can be created by calling the C<< AnyEvent->condvar >>
119	method without any arguments.	269	method without any arguments.
120		270
121	A condition watcher watches for a condition - precisely that the C<<	271	A condition variable waits for a condition - precisely that the C<<
122	->broadcast >> method has been called.	272	->broadcast >> method has been called.
123		273
124	The watcher has only two methods:	274	They are very useful to signal that a condition has been fulfilled, for
		275	example, if you write a module that does asynchronous http requests,
		276	then a condition variable would be the ideal candidate to signal the
		277	availability of results.
		278
		279	You can also use condition variables to block your main program until
		280	an event occurs - for example, you could C<< ->wait >> in your main
		281	program until the user clicks the Quit button in your app, which would C<<
		282	->broadcast >> the "quit" event.
		283
		284	Note that condition variables recurse into the event loop - if you have
		285	two pirces of code that call C<< ->wait >> in a round-robbin fashion, you
		286	lose. Therefore, condition variables are good to export to your caller, but
		287	you should avoid making a blocking wait yourself, at least in callbacks,
		288	as this asks for trouble.
		289
		290	This object has two methods:
125		291
126	=over 4	292	=over 4
127		293
128	=item $cv->wait	294	=item $cv->wait
129		295
130	Wait (blocking if necessary) until the C<< ->broadcast >> method has been	296	Wait (blocking if necessary) until the C<< ->broadcast >> method has been
131	called on c<$cv>, while servicing other watchers normally.	297	called on c<$cv>, while servicing other watchers normally.
132		298
133	Not all event models support a blocking wait - some die in that case, so
134	if you are using this from a module, never require a blocking wait, but
135	let the caller decide wether the call will block or not (for example,
136	by coupling condition variables with some kind of request results and
137	supporting callbacks so the caller knows that getting the result will not
138	block, while still suppporting blockign waits if the caller so desires).
139
140	You can only wait once on a condition - additional calls will return	299	You can only wait once on a condition - additional calls will return
141	immediately.	300	immediately.
142		301
		302	Not all event models support a blocking wait - some die in that case
		303	(programs might want to do that to stay interactive), so I<if you are
		304	using this from a module, never require a blocking wait>, but let the
		305	caller decide whether the call will block or not (for example, by coupling
		306	condition variables with some kind of request results and supporting
		307	callbacks so the caller knows that getting the result will not block,
		308	while still suppporting blocking waits if the caller so desires).
		309
		310	Another reason I<never> to C<< ->wait >> in a module is that you cannot
		311	sensibly have two C<< ->wait >>'s in parallel, as that would require
		312	multiple interpreters or coroutines/threads, none of which C<AnyEvent>
		313	can supply (the coroutine-aware backends L<AnyEvent::Impl::CoroEV> and
		314	L<AnyEvent::Impl::CoroEvent> explicitly support concurrent C<< ->wait >>'s
		315	from different coroutines, however).
		316
143	=item $cv->broadcast	317	=item $cv->broadcast
144		318
145	Flag the condition as ready - a running C<< ->wait >> and all further	319	Flag the condition as ready - a running C<< ->wait >> and all further
146	calls to C<wait> will return after this method has been called. If nobody	320	calls to C<wait> will (eventually) return after this method has been
147	is waiting the broadcast will be remembered..	321	called. If nobody is waiting the broadcast will be remembered..
		322
		323	=back
148		324
149	Example:	325	Example:
150		326
151	# wait till the result is ready	327	# wait till the result is ready
152	my $result_ready = AnyEvent->condvar;	328	my $result_ready = AnyEvent->condvar;
153		329
154	# do something such as adding a timer	330	# do something such as adding a timer
155	# or socket watcher the calls $result_ready->broadcast	331	# or socket watcher the calls $result_ready->broadcast
156	# when the "result" is ready.	332	# when the "result" is ready.
		333	# in this case, we simply use a timer:
		334	my $w = AnyEvent->timer (
		335	after => 1,
		336	cb => sub { $result_ready->broadcast },
		337	);
157		338
		339	# this "blocks" (while handling events) till the watcher
		340	# calls broadcast
158	$result_ready->wait;	341	$result_ready->wait;
159		342
		343	=head1 GLOBAL VARIABLES AND FUNCTIONS
		344
		345	=over 4
		346
		347	=item $AnyEvent::MODEL
		348
		349	Contains C<undef> until the first watcher is being created. Then it
		350	contains the event model that is being used, which is the name of the
		351	Perl class implementing the model. This class is usually one of the
		352	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case
		353	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).
		354
		355	The known classes so far are:
		356
		357	AnyEvent::Impl::CoroEV based on Coro::EV, best choice.
		358	AnyEvent::Impl::CoroEvent based on Coro::Event, second best choice.
		359	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
		360	AnyEvent::Impl::Event based on Event, second best choice.
		361	AnyEvent::Impl::Glib based on Glib, third-best choice.
		362	AnyEvent::Impl::Tk based on Tk, very bad choice.
		363	AnyEvent::Impl::Perl pure-perl implementation, inefficient but portable.
		364	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
		365	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		366
		367	=item AnyEvent::detect
		368
		369	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
		370	if necessary. You should only call this function right before you would
		371	have created an AnyEvent watcher anyway, that is, as late as possible at
		372	runtime.
		373
160	=back	374	=back
161		375
162	=head1 WHAT TO DO IN A MODULE	376	=head1 WHAT TO DO IN A MODULE
163		377
164	As a module author, you should "use AnyEvent" and call AnyEvent methods	378	As a module author, you should C<use AnyEvent> and call AnyEvent methods
165	freely, but you should not load a specific event module or rely on it.	379	freely, but you should not load a specific event module or rely on it.
166		380
167	Be careful when you create watchers in the module body - Anyevent will	381	Be careful when you create watchers in the module body - AnyEvent will
168	decide which event module to use as soon as the first method is called, so	382	decide which event module to use as soon as the first method is called, so
169	by calling AnyEvent in your module body you force the user of your module	383	by calling AnyEvent in your module body you force the user of your module
170	to load the event module first.	384	to load the event module first.
171		385
		386	Never call C<< ->wait >> on a condition variable unless you I<know> that
		387	the C<< ->broadcast >> method has been called on it already. This is
		388	because it will stall the whole program, and the whole point of using
		389	events is to stay interactive.
		390
		391	It is fine, however, to call C<< ->wait >> when the user of your module
		392	requests it (i.e. if you create a http request object ad have a method
		393	called C<results> that returns the results, it should call C<< ->wait >>
		394	freely, as the user of your module knows what she is doing. always).
		395
172	=head1 WHAT TO DO IN THE MAIN PROGRAM	396	=head1 WHAT TO DO IN THE MAIN PROGRAM
173		397
174	There will always be a single main program - the only place that should	398	There will always be a single main program - the only place that should
175	dictate which event model to use.	399	dictate which event model to use.
176		400
177	If it doesn't care, it can just "use AnyEvent" and use it itself, or not	401	If it doesn't care, it can just "use AnyEvent" and use it itself, or not
178	do anything special and let AnyEvent decide which implementation to chose.	402	do anything special (it does not need to be event-based) and let AnyEvent
		403	decide which implementation to chose if some module relies on it.
179		404
180	If the main program relies on a specific event model (for example, in Gtk2	405	If the main program relies on a specific event model. For example, in
181	programs you have to rely on either Glib or Glib::Event), you should load	406	Gtk2 programs you have to rely on the Glib module. You should load the
182	it before loading AnyEvent or any module that uses it, generally, as early	407	event module before loading AnyEvent or any module that uses it: generally
183	as possible. The reason is that modules might create watchers when they	408	speaking, you should load it as early as possible. The reason is that
184	are loaded, and AnyEvent will decide on the event model to use as soon as	409	modules might create watchers when they are loaded, and AnyEvent will
185	it creates watchers, and it might chose the wrong one unless you load the	410	decide on the event model to use as soon as it creates watchers, and it
186	correct one yourself.	411	might chose the wrong one unless you load the correct one yourself.
187		412
188	You can chose to use a rather inefficient pure-perl implementation by	413	You can chose to use a rather inefficient pure-perl implementation by
189	loading the C<AnyEvent::Impl::Perl> module, but letting AnyEvent chose is	414	loading the C<AnyEvent::Impl::Perl> module, which gives you similar
190	generally better.	415	behaviour everywhere, but letting AnyEvent chose is generally better.
191		416
192	=cut	417	=cut
193		418
194	package AnyEvent;	419	package AnyEvent;
195		420
196	no warnings;	421	no warnings;
197	use strict 'vars';	422	use strict;
		423
198	use Carp;	424	use Carp;
199		425
200	our $VERSION = '2.0';	426	our $VERSION = '3.12';
201	our $MODEL;	427	our $MODEL;
202		428
203	our $AUTOLOAD;	429	our $AUTOLOAD;
204	our @ISA;	430	our @ISA;
205		431
206	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;	432	our $verbose = $ENV{PERL_ANYEVENT_VERBOSE}*1;
207		433
208	our @REGISTRY;	434	our @REGISTRY;
209		435
210	my @models = (	436	my @models = (
		437	[Coro::EV:: => AnyEvent::Impl::CoroEV::],
211	[Coro::Event:: => AnyEvent::Impl::Coro::],	438	[Coro::Event:: => AnyEvent::Impl::CoroEvent::],
		439	[EV:: => AnyEvent::Impl::EV::],
212	[Event:: => AnyEvent::Impl::Event::],	440	[Event:: => AnyEvent::Impl::Event::],
213	[Glib:: => AnyEvent::Impl::Glib::],	441	[Glib:: => AnyEvent::Impl::Glib::],
214	[Tk:: => AnyEvent::Impl::Tk::],	442	[Tk:: => AnyEvent::Impl::Tk::],
215	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	443	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
216	);	444	);
		445	my @models_detect = (
		446	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
		447	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		448	);
217		449
218	our %method = map +($_ => 1), qw(io timer condvar broadcast wait DESTROY);	450	our %method = map +($_ => 1), qw(io timer signal child condvar broadcast wait one_event DESTROY);
219		451
220	sub AUTOLOAD {	452	sub detect() {
221	$AUTOLOAD =~ s/.*://;
222
223	$method{$AUTOLOAD}
224	or croak "$AUTOLOAD: not a valid method for AnyEvent objects";
225
226	unless ($MODEL) {	453	unless ($MODEL) {
		454	no strict 'refs';
		455
		456	if ($ENV{PERL_ANYEVENT_MODEL} =~ /^([a-zA-Z]+)$/) {
		457	my $model = "AnyEvent::Impl::$1";
		458	if (eval "require $model") {
		459	$MODEL = $model;
		460	warn "AnyEvent: loaded model '$model' (forced by \$PERL_ANYEVENT_MODEL), using it.\n" if $verbose > 1;
		461	}
		462	}
		463
227	# check for already loaded models	464	# check for already loaded models
		465	unless ($MODEL) {
228	for (@REGISTRY, @models) {	466	for (@REGISTRY, @models, @models_detect) {
229	my ($package, $model) = @$_;	467	my ($package, $model) = @$_;
230	if (${"$package\::VERSION"} > 0) {	468	if (${"$package\::VERSION"} > 0) {
231	if (eval "require $model") {	469	if (eval "require $model") {
232	$MODEL = $model;	470	$MODEL = $model;
233	warn "AnyEvent: found model '$model', using it.\n" if $verbose > 1;	471	warn "AnyEvent: autodetected model '$model', using it.\n" if $verbose > 1;
234	last;	472	last;
		473	}
235	}	474	}
236	}	475	}
		476
		477	unless ($MODEL) {
		478	# try to load a model
		479
		480	for (@REGISTRY, @models) {
		481	my ($package, $model) = @$_;
		482	if (eval "require $package"
		483	and ${"$package\::VERSION"} > 0
		484	and eval "require $model") {
		485	$MODEL = $model;
		486	warn "AnyEvent: autoprobed model '$model', using it.\n" if $verbose > 1;
		487	last;
		488	}
		489	}
		490
		491	$MODEL
		492	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: EV (or Coro+EV), Event (or Coro+Event) or Glib.";
		493	}
237	}	494	}
238		495
239	unless ($MODEL) {	496	unshift @ISA, $MODEL;
240	# try to load a model	497	push @{"$MODEL\::ISA"}, "AnyEvent::Base";
241
242	for (@REGISTRY, @models) {
243	my ($package, $model) = @$_;
244	if (eval "require $model") {
245	$MODEL = $model;
246	warn "AnyEvent: autoprobed and loaded model '$model', using it.\n" if $verbose > 1;
247	last;
248	}
249	}
250
251	$MODEL
252	or die "No event module selected for AnyEvent and autodetect failed. Install any one of these modules: Coro, Event, Glib or Tk.";
253	}
254	}	498	}
255		499
256	@ISA = $MODEL;	500	$MODEL
		501	}
		502
		503	sub AUTOLOAD {
		504	(my $func = $AUTOLOAD) =~ s/.*://;
		505
		506	$method{$func}
		507	or croak "$func: not a valid method for AnyEvent objects";
		508
		509	detect unless $MODEL;
257		510
258	my $class = shift;	511	my $class = shift;
259	$class->$AUTOLOAD (@_);	512	$class->$func (@_);
		513	}
		514
		515	package AnyEvent::Base;
		516
		517	# default implementation for ->condvar, ->wait, ->broadcast
		518
		519	sub condvar {
		520	bless \my $flag, "AnyEvent::Base::CondVar"
		521	}
		522
		523	sub AnyEvent::Base::CondVar::broadcast {
		524	${$_[0]}++;
		525	}
		526
		527	sub AnyEvent::Base::CondVar::wait {
		528	AnyEvent->one_event while !${$_[0]};
		529	}
		530
		531	# default implementation for ->signal
		532
		533	our %SIG_CB;
		534
		535	sub signal {
		536	my (undef, %arg) = @_;
		537
		538	my $signal = uc $arg{signal}
		539	or Carp::croak "required option 'signal' is missing";
		540
		541	$SIG_CB{$signal}{$arg{cb}} = $arg{cb};
		542	$SIG{$signal} \|\|= sub {
		543	$_->() for values %{ $SIG_CB{$signal} \|\| {} };
		544	};
		545
		546	bless [$signal, $arg{cb}], "AnyEvent::Base::Signal"
		547	}
		548
		549	sub AnyEvent::Base::Signal::DESTROY {
		550	my ($signal, $cb) = @{$_[0]};
		551
		552	delete $SIG_CB{$signal}{$cb};
		553
		554	$SIG{$signal} = 'DEFAULT' unless keys %{ $SIG_CB{$signal} };
		555	}
		556
		557	# default implementation for ->child
		558
		559	our %PID_CB;
		560	our $CHLD_W;
		561	our $CHLD_DELAY_W;
		562	our $PID_IDLE;
		563	our $WNOHANG;
		564
		565	sub _child_wait {
		566	while (0 < (my $pid = waitpid -1, $WNOHANG)) {
		567	$_->($pid, $?) for (values %{ $PID_CB{$pid} \|\| {} }),
		568	(values %{ $PID_CB{0} \|\| {} });
		569	}
		570
		571	undef $PID_IDLE;
		572	}
		573
		574	sub _sigchld {
		575	# make sure we deliver these changes "synchronous" with the event loop.
		576	$CHLD_DELAY_W \|\|= AnyEvent->timer (after => 0, cb => sub {
		577	undef $CHLD_DELAY_W;
		578	&_child_wait;
		579	});
		580	}
		581
		582	sub child {
		583	my (undef, %arg) = @_;
		584
		585	defined (my $pid = $arg{pid} + 0)
		586	or Carp::croak "required option 'pid' is missing";
		587
		588	$PID_CB{$pid}{$arg{cb}} = $arg{cb};
		589
		590	unless ($WNOHANG) {
		591	$WNOHANG = eval { require POSIX; &POSIX::WNOHANG } \|\| 1;
		592	}
		593
		594	unless ($CHLD_W) {
		595	$CHLD_W = AnyEvent->signal (signal => 'CHLD', cb => \&_sigchld);
		596	# child could be a zombie already, so make at least one round
		597	&_sigchld;
		598	}
		599
		600	bless [$pid, $arg{cb}], "AnyEvent::Base::Child"
		601	}
		602
		603	sub AnyEvent::Base::Child::DESTROY {
		604	my ($pid, $cb) = @{$_[0]};
		605
		606	delete $PID_CB{$pid}{$cb};
		607	delete $PID_CB{$pid} unless keys %{ $PID_CB{$pid} };
		608
		609	undef $CHLD_W unless keys %PID_CB;
260	}	610	}
261		611
262	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE	612	=head1 SUPPLYING YOUR OWN EVENT MODEL INTERFACE
		613
		614	This is an advanced topic that you do not normally need to use AnyEvent in
		615	a module. This section is only of use to event loop authors who want to
		616	provide AnyEvent compatibility.
263		617
264	If you need to support another event library which isn't directly	618	If you need to support another event library which isn't directly
265	supported by AnyEvent, you can supply your own interface to it by	619	supported by AnyEvent, you can supply your own interface to it by
266	pushing, before the first watcher gets created, the package name of	620	pushing, before the first watcher gets created, the package name of
267	the event module and the package name of the interface to use onto	621	the event module and the package name of the interface to use onto
268	C<@AnyEvent::REGISTRY>. You can do that before and even without loading	622	C<@AnyEvent::REGISTRY>. You can do that before and even without loading
269	AnyEvent.	623	AnyEvent, so it is reasonably cheap.
270		624
271	Example:	625	Example:
272		626
273	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	627	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
274		628
275	This tells AnyEvent to (literally) use the C<urxvt::anyevent::>	629	This tells AnyEvent to (literally) use the C<urxvt::anyevent::>
276	package/class when it finds the C<urxvt> package/module is loaded. When	630	package/class when it finds the C<urxvt> package/module is already loaded.
		631
277	AnyEvent is loaded and asked to find a suitable event model, it will	632	When AnyEvent is loaded and asked to find a suitable event model, it
278	first check for the presence of urxvt.	633	will first check for the presence of urxvt by trying to C<use> the
		634	C<urxvt::anyevent> module.
279		635
280	The class should prove implementations for all watcher types (see	636	The class should provide implementations for all watcher types. See
281	L<AnyEvent::Impl::Event> (source code), L<AnyEvent::Impl::Glib>	637	L<AnyEvent::Impl::EV> (source code), L<AnyEvent::Impl::Glib> (Source code)
282	(Source code) and so on for actual examples, use C<perldoc -m	638	and so on for actual examples. Use C<perldoc -m AnyEvent::Impl::Glib> to
283	AnyEvent::Impl::Glib> to see the sources).	639	see the sources.
284		640
		641	If you don't provide C<signal> and C<child> watchers than AnyEvent will
		642	provide suitable (hopefully) replacements.
		643
285	The above isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt)	644	The above example isn't fictitious, the I<rxvt-unicode> (a.k.a. urxvt)
286	uses the above line as-is. An interface isn't included in AnyEvent	645	terminal emulator uses the above line as-is. An interface isn't included
287	because it doesn't make sense outside the embedded interpreter inside	646	in AnyEvent because it doesn't make sense outside the embedded interpreter
288	I<rxvt-unicode>, and it is updated and maintained as part of the	647	inside I<rxvt-unicode>, and it is updated and maintained as part of the
289	I<rxvt-unicode> distribution.	648	I<rxvt-unicode> distribution.
290		649
291	I<rxvt-unicode> also cheats a bit by not providing blocking access to	650	I<rxvt-unicode> also cheats a bit by not providing blocking access to
292	condition variables: code blocking while waiting for a condition will	651	condition variables: code blocking while waiting for a condition will
293	C<die>. This still works with most modules/usages, and blocking calls must	652	C<die>. This still works with most modules/usages, and blocking calls must
294	not be in an interactive appliation, so it makes sense.	653	not be done in an interactive application, so it makes sense.
295		654
296	=head1 ENVIRONMENT VARIABLES	655	=head1 ENVIRONMENT VARIABLES
297		656
298	The following environment variables are used by this module:	657	The following environment variables are used by this module:
299		658
300	C<PERL_ANYEVENT_VERBOSE> when set to C<2> or higher, reports which event	659	=over 4
301	model gets used.
302		660
		661	=item C<PERL_ANYEVENT_VERBOSE>
		662
		663	When set to C<2> or higher, cause AnyEvent to report to STDERR which event
		664	model it chooses.
		665
		666	=item C<PERL_ANYEVENT_MODEL>
		667
		668	This can be used to specify the event model to be used by AnyEvent, before
		669	autodetection and -probing kicks in. It must be a string consisting
		670	entirely of ASCII letters. The string C<AnyEvent::Impl::> gets prepended
		671	and the resulting module name is loaded and if the load was successful,
		672	used as event model. If it fails to load AnyEvent will proceed with
		673	autodetection and -probing.
		674
		675	This functionality might change in future versions.
		676
		677	For example, to force the pure perl model (L<AnyEvent::Impl::Perl>) you
		678	could start your program like this:
		679
		680	PERL_ANYEVENT_MODEL=Perl perl ...
		681
		682	=back
		683
303	=head1 EXAMPLE	684	=head1 EXAMPLE PROGRAM
304		685
305	The following program uses an io watcher to read data from stdin, a timer	686	The following program uses an IO watcher to read data from STDIN, a timer
306	to display a message once per second, and a condvar to exit the program	687	to display a message once per second, and a condition variable to quit the
307	when the user enters quit:	688	program when the user enters quit:
308		689
309	use AnyEvent;	690	use AnyEvent;
310		691
311	my $cv = AnyEvent->condvar;	692	my $cv = AnyEvent->condvar;
312		693
313	my $io_watcher = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	694	my $io_watcher = AnyEvent->io (
		695	fh => \*STDIN,
		696	poll => 'r',
		697	cb => sub {
314	warn "io event <$_[0]>\n"; # will always output <r>	698	warn "io event <$_[0]>\n"; # will always output <r>
315	chomp (my $input = <STDIN>); # read a line	699	chomp (my $input = <STDIN>); # read a line
316	warn "read: $input\n"; # output what has been read	700	warn "read: $input\n"; # output what has been read
317	$cv->broadcast if $input =~ /^q/i; # quit program if /^q/i	701	$cv->broadcast if $input =~ /^q/i; # quit program if /^q/i
		702	},
318	});	703	);
319		704
320	my $time_watcher; # can only be used once	705	my $time_watcher; # can only be used once
321		706
322	sub new_timer {	707	sub new_timer {
323	$timer = AnyEvent->timer (after => 1, cb => sub {	708	$timer = AnyEvent->timer (after => 1, cb => sub {
…		…
405	$txn->{finished}->wait;	790	$txn->{finished}->wait;
406	return $txn->{result};	791	return $txn->{result};
407		792
408	The actual code goes further and collects all errors (C<die>s, exceptions)	793	The actual code goes further and collects all errors (C<die>s, exceptions)
409	that occured during request processing. The C<result> method detects	794	that occured during request processing. The C<result> method detects
410	wether an exception as thrown (it is stored inside the $txn object)	795	whether an exception as thrown (it is stored inside the $txn object)
411	and just throws the exception, which means connection errors and other	796	and just throws the exception, which means connection errors and other
412	problems get reported tot he code that tries to use the result, not in a	797	problems get reported tot he code that tries to use the result, not in a
413	random callback.	798	random callback.
414		799
415	All of this enables the following usage styles:	800	All of this enables the following usage styles:
416		801
417	1. Blocking:	802	1. Blocking:
418		803
419	my $data = $fcp->client_get ($url);	804	my $data = $fcp->client_get ($url);
420		805
421	2. Blocking, but parallelizing:	806	2. Blocking, but running in parallel:
422		807
423	my @datas = map $_->result,	808	my @datas = map $_->result,
424	map $fcp->txn_client_get ($_),	809	map $fcp->txn_client_get ($_),
425	@urls;	810	@urls;
426		811
427	Both blocking examples work without the module user having to know	812	Both blocking examples work without the module user having to know
428	anything about events.	813	anything about events.
429		814
430	3a. Event-based in a main program, using any support Event module:	815	3a. Event-based in a main program, using any supported event module:
431		816
432	use Event;	817	use EV;
433		818
434	$fcp->txn_client_get ($url)->cb (sub {	819	$fcp->txn_client_get ($url)->cb (sub {
435	my $txn = shift;	820	my $txn = shift;
436	my $data = $txn->result;	821	my $data = $txn->result;
437	...	822	...
438	});	823	});
439		824
440	Event::loop;	825	EV::loop;
441		826
442	3b. The module user could use AnyEvent, too:	827	3b. The module user could use AnyEvent, too:
443		828
444	use AnyEvent;	829	use AnyEvent;
445		830
…		…
450	$quit->broadcast;	835	$quit->broadcast;
451	});	836	});
452		837
453	$quit->wait;	838	$quit->wait;
454		839
		840	=head1 FORK
		841
		842	Most event libraries are not fork-safe. The ones who are usually are
		843	because they are so inefficient. Only L<EV> is fully fork-aware.
		844
		845	If you have to fork, you must either do so I<before> creating your first
		846	watcher OR you must not use AnyEvent at all in the child.
		847
		848	=head1 SECURITY CONSIDERATIONS
		849
		850	AnyEvent can be forced to load any event model via
		851	$ENV{PERL_ANYEVENT_MODEL}. While this cannot (to my knowledge) be used to
		852	execute arbitrary code or directly gain access, it can easily be used to
		853	make the program hang or malfunction in subtle ways, as AnyEvent watchers
		854	will not be active when the program uses a different event model than
		855	specified in the variable.
		856
		857	You can make AnyEvent completely ignore this variable by deleting it
		858	before the first watcher gets created, e.g. with a C<BEGIN> block:
		859
		860	BEGIN { delete $ENV{PERL_ANYEVENT_MODEL} }
		861
		862	use AnyEvent;
		863
455	=head1 SEE ALSO	864	=head1 SEE ALSO
456		865
457	Event modules: L<Coro::Event>, L<Coro>, L<Event>, L<Glib::Event>, L<Glib>.	866	Event modules: L<Coro::EV>, L<EV>, L<EV::Glib>, L<Glib::EV>,
		867	L<Coro::Event>, L<Event>, L<Glib::Event>, L<Glib>, L<Coro>, L<Tk>,
		868	L<Event::Lib>, L<Qt>.
458		869
		870	Implementations: L<AnyEvent::Impl::CoroEV>, L<AnyEvent::Impl::EV>,
459	Implementations: L<AnyEvent::Impl::Coro>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>.	871	L<AnyEvent::Impl::CoroEvent>, L<AnyEvent::Impl::Event>, L<AnyEvent::Impl::Glib>,
		872	L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>, L<AnyEvent::Impl::EventLib>,
		873	L<AnyEvent::Impl::Qt>.
460		874
461	Nontrivial usage example: L<Net::FCP>.	875	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>.
462		876
463	=head1	877	=head1 AUTHOR
		878
		879	Marc Lehmann <schmorp@schmorp.de>
		880	http://home.schmorp.de/
464		881
465	=cut	882	=cut
466		883
467	1	884	1
468		885

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.15 by root, Mon Oct 30 20:55:05 2006 UTC vs. Revision 1.57 by root, Thu Apr 24 03:19:28 2008 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.15 by root, Mon Oct 30 20:55:05 2006 UTC vs.
Revision 1.57 by root, Thu Apr 24 03:19:28 2008 UTC