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

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.228 by root, Wed Jul 8 01:11:12 2009 UTC vs.
Revision 1.236 by root, Fri Jul 10 22:35:27 2009 UTC

…		…
176	=head2 I/O WATCHERS	176	=head2 I/O WATCHERS
177		177
178	You can create an I/O watcher by calling the C<< AnyEvent->io >> method	178	You can create an I/O watcher by calling the C<< AnyEvent->io >> method
179	with the following mandatory key-value pairs as arguments:	179	with the following mandatory key-value pairs as arguments:
180		180
181	C<fh> is the Perl I<file handle> (I<not> file descriptor, see below) to	181	C<fh> is the Perl I<file handle> (or a naked file descriptor) to watch
182	watch for events (AnyEvent might or might not keep a reference to this	182	for events (AnyEvent might or might not keep a reference to this file
183	file handle). Note that only file handles pointing to things for which	183	handle). Note that only file handles pointing to things for which
184	non-blocking operation makes sense are allowed. This includes sockets,	184	non-blocking operation makes sense are allowed. This includes sockets,
185	most character devices, pipes, fifos and so on, but not for example files	185	most character devices, pipes, fifos and so on, but not for example files
186	or block devices.	186	or block devices.
187		187
188	C<poll> must be a string that is either C<r> or C<w>, which creates a	188	C<poll> must be a string that is either C<r> or C<w>, which creates a
…		…
208	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {	208	my $w; $w = AnyEvent->io (fh => \*STDIN, poll => 'r', cb => sub {
209	chomp (my $input = <STDIN>);	209	chomp (my $input = <STDIN>);
210	warn "read: $input\n";	210	warn "read: $input\n";
211	undef $w;	211	undef $w;
212	});	212	});
213
214	=head3 GETTING A FILE HANDLE FROM A FILE DESCRIPTOR
215
216	It is not uncommon to only have a file descriptor, while AnyEvent requires
217	a Perl file handle.
218
219	There are basically two methods to convert a file descriptor into a file handle. If you own
220	the file descriptor, you can open it with C<&=>, as in:
221
222	open my $fh, "<&=$fileno" or die "xxx: §!";
223
224	This will "own" the file descriptor, meaning that when C<$fh> is
225	destroyed, it will automatically close the C<$fileno>. Also, note that
226	the open mode (read, write, read/write) must correspond with how the
227	underlying file descriptor was opened.
228
229	In many cases, taking over the file descriptor is now what you want, in
230	which case the only alternative is to dup the file descriptor:
231
232	open my $fh, "<&$fileno" or die "xxx: $!";
233
234	This has the advantage of not closing the file descriptor and the
235	disadvantage of making a slow copy.
236		213
237	=head2 TIME WATCHERS	214	=head2 TIME WATCHERS
238		215
239	You can create a time watcher by calling the C<< AnyEvent->timer >>	216	You can create a time watcher by calling the C<< AnyEvent->timer >>
240	method with the following mandatory arguments:	217	method with the following mandatory arguments:
…		…
763	variable itself. Calling C<recv> inside the callback or at any later time	740	variable itself. Calling C<recv> inside the callback or at any later time
764	is guaranteed not to block.	741	is guaranteed not to block.
765		742
766	=back	743	=back
767		744
		745	=head1 SUPPORTED EVENT LOOPS/BACKENDS
		746
		747	The available backend classes are (every class has its own manpage):
		748
		749	=over 4
		750
		751	=item Backends that are autoprobed when no other event loop can be found.
		752
		753	EV is the preferred backend when no other event loop seems to be in
		754	use. If EV is not installed, then AnyEvent will try Event, and, failing
		755	that, will fall back to its own pure-perl implementation, which is
		756	available everywhere as it comes with AnyEvent itself.
		757
		758	AnyEvent::Impl::EV based on EV (interface to libev, best choice).
		759	AnyEvent::Impl::Event based on Event, very stable, few glitches.
		760	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
		761
		762	=item Backends that are transparently being picked up when they are used.
		763
		764	These will be used when they are currently loaded when the first watcher
		765	is created, in which case it is assumed that the application is using
		766	them. This means that AnyEvent will automatically pick the right backend
		767	when the main program loads an event module before anything starts to
		768	create watchers. Nothing special needs to be done by the main program.
		769
		770	AnyEvent::Impl::Glib based on Glib, slow but very stable.
		771	AnyEvent::Impl::Tk based on Tk, very broken.
		772	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
		773	AnyEvent::Impl::POE based on POE, very slow, some limitations.
		774
		775	=item Backends with special needs.
		776
		777	Qt requires the Qt::Application to be instantiated first, but will
		778	otherwise be picked up automatically. As long as the main program
		779	instantiates the application before any AnyEvent watchers are created,
		780	everything should just work.
		781
		782	AnyEvent::Impl::Qt based on Qt.
		783
		784	Support for IO::Async can only be partial, as it is too broken and
		785	architecturally limited to even support the AnyEvent API. It also
		786	is the only event loop that needs the loop to be set explicitly, so
		787	it can only be used by a main program knowing about AnyEvent. See
		788	L<AnyEvent::Impl::Async> for the gory details.
		789
		790	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed.
		791
		792	=item Event loops that are indirectly supported via other backends.
		793
		794	Some event loops can be supported via other modules:
		795
		796	There is no direct support for WxWidgets (L<Wx>) or L<Prima>.
		797
		798	B<WxWidgets> has no support for watching file handles. However, you can
		799	use WxWidgets through the POE adaptor, as POE has a Wx backend that simply
		800	polls 20 times per second, which was considered to be too horrible to even
		801	consider for AnyEvent.
		802
		803	B<Prima> is not supported as nobody seems to be using it, but it has a POE
		804	backend, so it can be supported through POE.
		805
		806	AnyEvent knows about both L<Prima> and L<Wx>, however, and will try to
		807	load L<POE> when detecting them, in the hope that POE will pick them up,
		808	in which case everything will be automatic.
		809
		810	=back
		811
768	=head1 GLOBAL VARIABLES AND FUNCTIONS	812	=head1 GLOBAL VARIABLES AND FUNCTIONS
769		813
		814	These are not normally required to use AnyEvent, but can be useful to
		815	write AnyEvent extension modules.
		816
770	=over 4	817	=over 4
771		818
772	=item $AnyEvent::MODEL	819	=item $AnyEvent::MODEL
773		820
774	Contains C<undef> until the first watcher is being created. Then it	821	Contains C<undef> until the first watcher is being created, before the
		822	backend has been autodetected.
		823
775	contains the event model that is being used, which is the name of the	824	Afterwards it contains the event model that is being used, which is the
776	Perl class implementing the model. This class is usually one of the	825	name of the Perl class implementing the model. This class is usually one
777	C<AnyEvent::Impl:xxx> modules, but can be any other class in the case	826	of the C<AnyEvent::Impl:xxx> modules, but can be any other class in the
778	AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode>).	827	case AnyEvent has been extended at runtime (e.g. in I<rxvt-unicode> it
779		828	will be C<urxvt::anyevent>).
780	The known classes so far are:
781
782	AnyEvent::Impl::EV based on EV (an interface to libev, best choice).
783	AnyEvent::Impl::Event based on Event, second best choice.
784	AnyEvent::Impl::Perl pure-perl implementation, fast and portable.
785	AnyEvent::Impl::Glib based on Glib, third-best choice.
786	AnyEvent::Impl::Tk based on Tk, very bad choice.
787	AnyEvent::Impl::Qt based on Qt, cannot be autoprobed (see its docs).
788	AnyEvent::Impl::EventLib based on Event::Lib, leaks memory and worse.
789	AnyEvent::Impl::POE based on POE, not generic enough for full support.
790
791	# warning, support for IO::Async is only partial, as it is too broken
792	# and limited toe ven support the AnyEvent API. See AnyEvent::Impl::Async.
793	AnyEvent::Impl::IOAsync based on IO::Async, cannot be autoprobed (see its docs).
794
795	There is no support for WxWidgets, as WxWidgets has no support for
796	watching file handles. However, you can use WxWidgets through the
797	POE Adaptor, as POE has a Wx backend that simply polls 20 times per
798	second, which was considered to be too horrible to even consider for
799	AnyEvent. Likewise, other POE backends can be used by AnyEvent by using
800	it's adaptor.
801
802	AnyEvent knows about L<Prima> and L<Wx> and will try to use L<POE> when
803	autodetecting them.
804		829
805	=item AnyEvent::detect	830	=item AnyEvent::detect
806		831
807	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model	832	Returns C<$AnyEvent::MODEL>, forcing autodetection of the event model
808	if necessary. You should only call this function right before you would	833	if necessary. You should only call this function right before you would
809	have created an AnyEvent watcher anyway, that is, as late as possible at	834	have created an AnyEvent watcher anyway, that is, as late as possible at
810	runtime.	835	runtime, and not e.g. while initialising of your module.
		836
		837	If you need to do some initialisation before AnyEvent watchers are
		838	created, use C<post_detect>.
811		839
812	=item $guard = AnyEvent::post_detect { BLOCK }	840	=item $guard = AnyEvent::post_detect { BLOCK }
813		841
814	Arranges for the code block to be executed as soon as the event model is	842	Arranges for the code block to be executed as soon as the event model is
815	autodetected (or immediately if this has already happened).	843	autodetected (or immediately if this has already happened).
		844
		845	The block will be executed I<after> the actual backend has been detected
		846	(C<$AnyEvent::MODEL> is set), but I<before> any watchers have been
		847	created, so it is possible to e.g. patch C<@AnyEvent::ISA> or do
		848	other initialisations - see the sources of L<AnyEvent::Strict> or
		849	L<AnyEvent::AIO> to see how this is used.
		850
		851	The most common usage is to create some global watchers, without forcing
		852	event module detection too early, for example, L<AnyEvent::AIO> creates
		853	and installs the global L<IO::AIO> watcher in a C<post_detect> block to
		854	avoid autodetecting the event module at load time.
816		855
817	If called in scalar or list context, then it creates and returns an object	856	If called in scalar or list context, then it creates and returns an object
818	that automatically removes the callback again when it is destroyed. See	857	that automatically removes the callback again when it is destroyed. See
819	L<Coro::BDB> for a case where this is useful.	858	L<Coro::BDB> for a case where this is useful.
820		859
…		…
823	If there are any code references in this array (you can C<push> to it	862	If there are any code references in this array (you can C<push> to it
824	before or after loading AnyEvent), then they will called directly after	863	before or after loading AnyEvent), then they will called directly after
825	the event loop has been chosen.	864	the event loop has been chosen.
826		865
827	You should check C<$AnyEvent::MODEL> before adding to this array, though:	866	You should check C<$AnyEvent::MODEL> before adding to this array, though:
828	if it contains a true value then the event loop has already been detected,	867	if it is defined then the event loop has already been detected, and the
829	and the array will be ignored.	868	array will be ignored.
830		869
831	Best use C<AnyEvent::post_detect { BLOCK }> instead.	870	Best use C<AnyEvent::post_detect { BLOCK }> when your application allows
		871	it,as it takes care of these details.
		872
		873	This variable is mainly useful for modules that can do something useful
		874	when AnyEvent is used and thus want to know when it is initialised, but do
		875	not need to even load it by default. This array provides the means to hook
		876	into AnyEvent passively, without loading it.
832		877
833	=back	878	=back
834		879
835	=head1 WHAT TO DO IN A MODULE	880	=head1 WHAT TO DO IN A MODULE
836		881
…		…
891		936
892		937
893	=head1 OTHER MODULES	938	=head1 OTHER MODULES
894		939
895	The following is a non-exhaustive list of additional modules that use	940	The following is a non-exhaustive list of additional modules that use
896	AnyEvent and can therefore be mixed easily with other AnyEvent modules	941	AnyEvent as a client and can therefore be mixed easily with other AnyEvent
897	in the same program. Some of the modules come with AnyEvent, some are	942	modules and other event loops in the same program. Some of the modules
898	available via CPAN.	943	come with AnyEvent, most are available via CPAN.
899		944
900	=over 4	945	=over 4
901		946
902	=item L<AnyEvent::Util>	947	=item L<AnyEvent::Util>
903		948
…		…
912		957
913	=item L<AnyEvent::Handle>	958	=item L<AnyEvent::Handle>
914		959
915	Provide read and write buffers, manages watchers for reads and writes,	960	Provide read and write buffers, manages watchers for reads and writes,
916	supports raw and formatted I/O, I/O queued and fully transparent and	961	supports raw and formatted I/O, I/O queued and fully transparent and
917	non-blocking SSL/TLS.	962	non-blocking SSL/TLS (via L<AnyEvent::TLS>.
918		963
919	=item L<AnyEvent::DNS>	964	=item L<AnyEvent::DNS>
920		965
921	Provides rich asynchronous DNS resolver capabilities.	966	Provides rich asynchronous DNS resolver capabilities.
922		967
…		…
950		995
951	=item L<AnyEvent::GPSD>	996	=item L<AnyEvent::GPSD>
952		997
953	A non-blocking interface to gpsd, a daemon delivering GPS information.	998	A non-blocking interface to gpsd, a daemon delivering GPS information.
954		999
		1000	=item L<AnyEvent::IRC>
		1001
		1002	AnyEvent based IRC client module family (replacing the older Net::IRC3).
		1003
		1004	=item L<AnyEvent::XMPP>
		1005
		1006	AnyEvent based XMPP (Jabber protocol) module family (replacing the older
		1007	Net::XMPP2>.
		1008
955	=item L<AnyEvent::IGS>	1009	=item L<AnyEvent::IGS>
956		1010
957	A non-blocking interface to the Internet Go Server protocol (used by	1011	A non-blocking interface to the Internet Go Server protocol (used by
958	L<App::IGS>).	1012	L<App::IGS>).
959		1013
960	=item L<AnyEvent::IRC>
961
962	AnyEvent based IRC client module family (replacing the older Net::IRC3).
963
964	=item L<Net::XMPP2>
965
966	AnyEvent based XMPP (Jabber protocol) module family.
967
968	=item L<Net::FCP>	1014	=item L<Net::FCP>
969		1015
970	AnyEvent-based implementation of the Freenet Client Protocol, birthplace	1016	AnyEvent-based implementation of the Freenet Client Protocol, birthplace
971	of AnyEvent.	1017	of AnyEvent.
972		1018
…		…
976		1022
977	=item L<Coro>	1023	=item L<Coro>
978		1024
979	Has special support for AnyEvent via L<Coro::AnyEvent>.	1025	Has special support for AnyEvent via L<Coro::AnyEvent>.
980		1026
981	=item L<IO::Lambda>
982
983	The lambda approach to I/O - don't ask, look there. Can use AnyEvent.
984
985	=back	1027	=back
986		1028
987	=cut	1029	=cut
988		1030
989	package AnyEvent;	1031	package AnyEvent;
…		…
991	no warnings;	1033	no warnings;
992	use strict qw(vars subs);	1034	use strict qw(vars subs);
993		1035
994	use Carp;	1036	use Carp;
995		1037
996	our $VERSION = 4.8;	1038	our $VERSION = 4.82;
997	our $MODEL;	1039	our $MODEL;
998		1040
999	our $AUTOLOAD;	1041	our $AUTOLOAD;
1000	our @ISA;	1042	our @ISA;
1001		1043
…		…
1027	[Event:: => AnyEvent::Impl::Event::],	1069	[Event:: => AnyEvent::Impl::Event::],
1028	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],	1070	[AnyEvent::Impl::Perl:: => AnyEvent::Impl::Perl::],
1029	# everything below here will not be autoprobed	1071	# everything below here will not be autoprobed
1030	# as the pureperl backend should work everywhere	1072	# as the pureperl backend should work everywhere
1031	# and is usually faster	1073	# and is usually faster
1032	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
1033	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers	1074	[Glib:: => AnyEvent::Impl::Glib::], # becomes extremely slow with many watchers
1034	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy	1075	[Event::Lib:: => AnyEvent::Impl::EventLib::], # too buggy
		1076	[Tk:: => AnyEvent::Impl::Tk::], # crashes with many handles
		1077	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1035	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program	1078	[Qt:: => AnyEvent::Impl::Qt::], # requires special main program
1036	[POE::Kernel:: => AnyEvent::Impl::POE::], # lasciate ogni speranza
1037	[Wx:: => AnyEvent::Impl::POE::],	1079	[Wx:: => AnyEvent::Impl::POE::],
1038	[Prima:: => AnyEvent::Impl::POE::],	1080	[Prima:: => AnyEvent::Impl::POE::],
1039	# IO::Async is just too broken - we would need workaorunds for its	1081	# IO::Async is just too broken - we would need workarounds for its
1040	# byzantine signal and broken child handling, among others.	1082	# byzantine signal and broken child handling, among others.
1041	# IO::Async is rather hard to detect, as it doesn't have any	1083	# IO::Async is rather hard to detect, as it doesn't have any
1042	# obvious default class.	1084	# obvious default class.
1043	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program	1085	# [IO::Async:: => AnyEvent::Impl::IOAsync::], # requires special main program
1044	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program	1086	# [IO::Async::Loop:: => AnyEvent::Impl::IOAsync::], # requires special main program
…		…
1146	# allow only one watcher per fd, so we dup it to get a different one).	1188	# allow only one watcher per fd, so we dup it to get a different one).
1147	sub _dupfh($$;$$) {	1189	sub _dupfh($$;$$) {
1148	my ($poll, $fh, $r, $w) = @_;	1190	my ($poll, $fh, $r, $w) = @_;
1149		1191
1150	# cygwin requires the fh mode to be matching, unix doesn't	1192	# cygwin requires the fh mode to be matching, unix doesn't
1151	my ($rw, $mode) = $poll eq "r" ? ($r, "<")	1193	my ($rw, $mode) = $poll eq "r" ? ($r, "<") : ($w, ">");
1152	: $poll eq "w" ? ($w, ">")
1153	: Carp::croak "AnyEvent->io requires poll set to either 'r' or 'w'";
1154		1194
1155	open my $fh2, "$mode&" . fileno $fh	1195	open my $fh2, "$mode&", $fh
1156	or die "cannot dup() filehandle: $!,";	1196	or die "AnyEvent->io: cannot dup() filehandle in mode '$poll': $!,";
1157		1197
1158	# we assume CLOEXEC is already set by perl in all important cases	1198	# we assume CLOEXEC is already set by perl in all important cases
1159		1199
1160	($fh2, $rw)	1200	($fh2, $rw)
1161	}	1201	}
…		…
2060		2100
2061	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher	2101	A handler for C<SIGCHLD> is installed by AnyEvent's child watcher
2062	emulation for event loops that do not support them natively. Also, some	2102	emulation for event loops that do not support them natively. Also, some
2063	event loops install a similar handler.	2103	event loops install a similar handler.
2064		2104
2065	If, when AnyEvent is loaded, SIGCHLD is set to IGNORE, then AnyEvent will	2105	Additionally, when AnyEvent is loaded and SIGCHLD is set to IGNORE, then
2066	reset it to default, to avoid losing child exit statuses.	2106	AnyEvent will reset it to default, to avoid losing child exit statuses.
2067		2107
2068	=item SIGPIPE	2108	=item SIGPIPE
2069		2109
2070	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>	2110	A no-op handler is installed for C<SIGPIPE> when C<$SIG{PIPE}> is C<undef>
2071	when AnyEvent gets loaded.	2111	when AnyEvent gets loaded.
…		…
2144	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.	2184	L<Glib>, L<Tk>, L<Event::Lib>, L<Qt>, L<POE>.
2145		2185
2146	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,	2186	Implementations: L<AnyEvent::Impl::EV>, L<AnyEvent::Impl::Event>,
2147	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,	2187	L<AnyEvent::Impl::Glib>, L<AnyEvent::Impl::Tk>, L<AnyEvent::Impl::Perl>,
2148	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,	2188	L<AnyEvent::Impl::EventLib>, L<AnyEvent::Impl::Qt>,
2149	L<AnyEvent::Impl::POE>.	2189	L<AnyEvent::Impl::POE>, L<AnyEvent::Impl::IOAsync>.
2150		2190
2151	Non-blocking file handles, sockets, TCP clients and	2191	Non-blocking file handles, sockets, TCP clients and
2152	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>.	2192	servers: L<AnyEvent::Handle>, L<AnyEvent::Socket>, L<AnyEvent::TLS>.
2153		2193
2154	Asynchronous DNS: L<AnyEvent::DNS>.	2194	Asynchronous DNS: L<AnyEvent::DNS>.
2155		2195
2156	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>,	2196	Coroutine support: L<Coro>, L<Coro::AnyEvent>, L<Coro::EV>,
		2197	L<Coro::Event>,
2157		2198
2158	Nontrivial usage examples: L<Net::FCP>, L<Net::XMPP2>, L<AnyEvent::DNS>.	2199	Nontrivial usage examples: L<AnyEvent::GPSD>, L<AnyEvent::XMPP>,
		2200	L<AnyEvent::HTTP>.
2159		2201
2160		2202
2161	=head1 AUTHOR	2203	=head1 AUTHOR
2162		2204
2163	Marc Lehmann <schmorp@schmorp.de>	2205	Marc Lehmann <schmorp@schmorp.de>

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent.pm (file contents): Revision 1.228 by root, Wed Jul 8 01:11:12 2009 UTC vs. Revision 1.236 by root, Fri Jul 10 22:35:27 2009 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent.pm (file contents):
Revision 1.228 by root, Wed Jul 8 01:11:12 2009 UTC vs.
Revision 1.236 by root, Fri Jul 10 22:35:27 2009 UTC