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

Comparing AnyEvent/lib/AnyEvent/Socket.pm (file contents):
Revision 1.34 by root, Wed May 28 21:07:07 2008 UTC vs.
Revision 1.138 by root, Thu Aug 25 02:11:12 2011 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	AnyEvent::Socket - useful IPv4 and IPv6 stuff.	3	AnyEvent::Socket - useful IPv4 and IPv6 stuff. also unix domain sockets. and stuff.
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use AnyEvent::Socket;	7	use AnyEvent::Socket;
8		8
9	tcp_connect "gameserver.deliantra.net", 13327, sub {	9	tcp_connect "gameserver.deliantra.net", 13327, sub {
10	my ($fh) = @_	10	my ($fh) = @_
11	or die "gameserver.deliantra.net connect failed: $!";	11	or die "gameserver.deliantra.net connect failed: $!";
12		12
13	# enjoy your filehandle	13	# enjoy your filehandle
14	};	14	};
15		15
16	# a simple tcp server	16	# a simple tcp server
17	tcp_server undef, 8888, sub {	17	tcp_server undef, 8888, sub {
18	my ($fh, $host, $port) = @_;	18	my ($fh, $host, $port) = @_;
19		19
20	syswrite $fh, "The internet is full, $host:$port. Go away!\015\012";	20	syswrite $fh, "The internet is full, $host:$port. Go away!\015\012";
21	};	21	};
22		22
23	=head1 DESCRIPTION	23	=head1 DESCRIPTION
24		24
25	This module implements various utility functions for handling internet	25	This module implements various utility functions for handling internet
26	protocol addresses and sockets, in an as transparent and simple way as	26	protocol addresses and sockets, in an as transparent and simple way as
33		33
34	=cut	34	=cut
35		35
36	package AnyEvent::Socket;	36	package AnyEvent::Socket;
37		37
38	no warnings;
39	use strict;
40
41	use Carp ();	38	use Carp ();
42	use Errno ();	39	use Errno ();
43	use Socket qw(AF_INET AF_UNIX SOCK_STREAM SOCK_DGRAM SOL_SOCKET SO_REUSEADDR);	40	use Socket qw(AF_INET AF_UNIX SOCK_STREAM SOCK_DGRAM SOL_SOCKET SO_REUSEADDR);
44		41
45	use AnyEvent ();	42	use AnyEvent (); BEGIN { AnyEvent::common_sense }
46	use AnyEvent::Util qw(guard fh_nonblocking AF_INET6);	43	use AnyEvent::Util qw(guard fh_nonblocking AF_INET6);
47	use AnyEvent::DNS ();	44	use AnyEvent::DNS ();
48		45
49	use base 'Exporter';	46	use base 'Exporter';
50		47
51	our @EXPORT = qw(	48	our @EXPORT = qw(
		49	getprotobyname
		50	parse_hostport format_hostport
52	parse_ipv4 parse_ipv6	51	parse_ipv4 parse_ipv6
53	parse_ip parse_address	52	parse_ip parse_address
		53	format_ipv4 format_ipv6
54	format_ip format_address	54	format_ip format_address
55	address_family	55	address_family
56	inet_aton	56	inet_aton
57	tcp_server	57	tcp_server
58	tcp_connect	58	tcp_connect
59	);	59	);
60		60
61	our $VERSION = '1.0';	61	our $VERSION = $AnyEvent::VERSION;
62		62
63	=item $ipn = parse_ipv4 $dotted_quad	63	=item $ipn = parse_ipv4 $dotted_quad
64		64
65	Tries to parse the given dotted quad IPv4 address and return it in	65	Tries to parse the given dotted quad IPv4 address and return it in
66	octet form (or undef when it isn't in a parsable format). Supports all	66	octet form (or undef when it isn't in a parsable format). Supports all
…		…
78		78
79	# check leading parts against range	79	# check leading parts against range
80	return undef if grep $_ >= 256, @_[0 .. @_ - 2];	80	return undef if grep $_ >= 256, @_[0 .. @_ - 2];
81		81
82	# check trailing part against range	82	# check trailing part against range
83	return undef if $_[-1] >= 1 << (8 * (4 - $#_));	83	return undef if $_[-1] >= 2 ** (8 * (4 - $#_));
84		84
85	pack "N", (pop)	85	pack "N", (pop)
86	+ ($_[0] << 24)	86	+ ($_[0] << 24)
87	+ ($_[1] << 16)	87	+ ($_[1] << 16)
88	+ ($_[2] << 8);	88	+ ($_[2] << 8);
…		…
97	forms supported by parse_ipv4). Note that scope-id's are not supported	97	forms supported by parse_ipv4). Note that scope-id's are not supported
98	(and will not parse).	98	(and will not parse).
99		99
100	This function works similarly to C<inet_pton AF_INET6, ...>.	100	This function works similarly to C<inet_pton AF_INET6, ...>.
101		101
		102	Example:
		103
		104	print unpack "H*", parse_ipv6 "2002:5345::10.0.0.1";
		105	# => 2002534500000000000000000a000001
		106
102	=cut	107	=cut
103		108
104	sub parse_ipv6($) {	109	sub parse_ipv6($) {
105	# quick test to avoid longer processing	110	# quick test to avoid longer processing
106	my $n = $_[0] =~ y/://;	111	my $n = $_[0] =~ y/://;
…		…
136		141
137	# and done	142	# and done
138	pack "n*", map hex, @h, @t	143	pack "n*", map hex, @h, @t
139	}	144	}
140		145
		146	=item $token = parse_unix $hostname
		147
		148	This fucntion exists mainly for symmetry to the other C<parse_protocol>
		149	functions - it takes a hostname and, if it is C<unix/>, it returns a
		150	special address token, otherwise C<undef>.
		151
		152	The only use for this function is probably to detect whether a hostname
		153	matches whatever AnyEvent uses for unix domain sockets.
		154
		155	=cut
		156
141	sub parse_unix($) {	157	sub parse_unix($) {
142	$_[0] eq "unix/"	158	$_[0] eq "unix/"
143	? pack "S", AF_UNIX	159	? pack "S", AF_UNIX
144	: undef	160	: undef
145		161
146	}	162	}
147		163
148	=item $ipn = parse_address $text	164	=item $ipn = parse_address $ip
149		165
150	Combines C<parse_ipv4> and C<parse_ipv6> in one function. The address	166	Combines C<parse_ipv4> and C<parse_ipv6> in one function. The address
151	here refers to the host address (not socket address) in network form	167	here refers to the host address (not socket address) in network form
152	(binary).	168	(binary).
153		169
154	If the C<$text> is C<unix/>, then this function returns a special token	170	If the C<$text> is C<unix/>, then this function returns a special token
155	recognised by the other functions in this module to mean "UNIX domain	171	recognised by the other functions in this module to mean "UNIX domain
156	socket".	172	socket".
157		173
		174	If the C<$text> to parse is a mapped IPv4 in IPv6 address (:ffff::<ipv4>),
		175	then it will be treated as an IPv4 address. If you don't want that, you
		176	have to call C<parse_ipv4> and/or C<parse_ipv6> manually.
		177
		178	Example:
		179
		180	print unpack "H*", parse_address "10.1.2.3";
		181	# => 0a010203
		182
		183	=item $ipn = AnyEvent::Socket::aton $ip
		184
		185	Same as C<parse_address>, but not exported (think C<Socket::inet_aton> but
		186	I<without> name resolution).
		187
158	=cut	188	=cut
159		189
160	sub parse_address($) {	190	sub parse_address($) {
161	&parse_ipv4 \|\| &parse_ipv6 \|\| &parse_unix	191	for (&parse_ipv6) {
		192	if ($_) {
		193	s/^\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff\xff//;
		194	return $_;
		195	} else {
		196	return &parse_ipv4 \|\| &parse_unix
		197	}
		198	}
162	}	199	}
163		200
164	*parse_ip =\&parse_address; #d#	201	*aton = \&parse_address;
		202
		203	=item ($name, $aliases, $proto) = getprotobyname $name
		204
		205	Works like the builtin function of the same name, except it tries hard to
		206	work even on broken platforms (well, that's windows), where getprotobyname
		207	is traditionally very unreliable.
		208
		209	Example: get the protocol number for TCP (usually 6)
		210
		211	my $proto = getprotobyname "tcp";
		212
		213	=cut
		214
		215	# microsoft can't even get getprotobyname working (the etc/protocols file
		216	# gets lost fairly often on windows), so we have to hardcode some common
		217	# protocol numbers ourselves.
		218	our %PROTO_BYNAME;
		219
		220	$PROTO_BYNAME{tcp} = Socket::IPPROTO_TCP () if defined &Socket::IPPROTO_TCP;
		221	$PROTO_BYNAME{udp} = Socket::IPPROTO_UDP () if defined &Socket::IPPROTO_UDP;
		222	$PROTO_BYNAME{icmp} = Socket::IPPROTO_ICMP() if defined &Socket::IPPROTO_ICMP;
		223
		224	sub getprotobyname($) {
		225	my $name = lc shift;
		226
		227	defined (my $proton = $PROTO_BYNAME{$name} \|\| (getprotobyname $name)[2])
		228	or return;
		229
		230	($name, uc $name, $proton)
		231	}
		232
		233	=item ($host, $service) = parse_hostport $string[, $default_service]
		234
		235	Splitting a string of the form C<hostname:port> is a common
		236	problem. Unfortunately, just splitting on the colon makes it hard to
		237	specify IPv6 addresses and doesn't support the less common but well
		238	standardised C<[ip literal]> syntax.
		239
		240	This function tries to do this job in a better way, it supports the
		241	following formats, where C<port> can be a numerical port number of a
		242	service name, or a C<name=port> string, and the C< port> and C<:port>
		243	parts are optional. Also, everywhere where an IP address is supported
		244	a hostname or unix domain socket address is also supported (see
		245	C<parse_unix>), and strings starting with C</> will also be interpreted as
		246	unix domain sockets.
		247
		248	hostname:port e.g. "www.linux.org", "www.x.de:443", "www.x.de:https=443",
		249	ipv4:port e.g. "198.182.196.56", "127.1:22"
		250	ipv6 e.g. "::1", "affe::1"
		251	[ipv4or6]:port e.g. "[::1]", "[10.0.1]:80"
		252	[ipv4or6] port e.g. "[127.0.0.1]", "[www.x.org] 17"
		253	ipv4or6 port e.g. "::1 443", "10.0.0.1 smtp"
		254	unix/:path e.g. "unix/:/path/to/socket"
		255	/path e.g. "/path/to/socket"
		256
		257	It also supports defaulting the service name in a simple way by using
		258	C<$default_service> if no service was detected. If neither a service was
		259	detected nor a default was specified, then this function returns the
		260	empty list. The same happens when a parse error was detected, such as a
		261	hostname with a colon in it (the function is rather conservative, though).
		262
		263	Example:
		264
		265	print join ",", parse_hostport "localhost:443";
		266	# => "localhost,443"
		267
		268	print join ",", parse_hostport "localhost", "https";
		269	# => "localhost,https"
		270
		271	print join ",", parse_hostport "[::1]";
		272	# => "," (empty list)
		273
		274	print join ",", parse_host_port "/tmp/debug.sock";
		275	# => "unix/", "/tmp/debug.sock"
		276
		277	=cut
		278
		279	sub parse_hostport($;$) {
		280	my ($host, $port);
		281
		282	for ("$_[0]") { # work on a copy, just in case, and also reset pos
		283
		284	# shortcut for /path
		285	return ("unix/", $_)
		286	if m%^/%;
		287
		288	# parse host, special cases: "ipv6" or "ipv6 port"
		289	unless (
		290	($host) = /^\s* ([0-9a-fA-F:]:[0-9a-fA-F:]:[0-9a-fA-F\.:]*)/xgc
		291	and parse_ipv6 $host
		292	) {
		293	/^\s*/xgc;
		294
		295	if (/^ \[ ([^\[\]]+) \]/xgc) {
		296	$host = $1;
		297	} elsif (/^ ([^\[\]:\ ]+) /xgc) {
		298	$host = $1;
		299	} else {
		300	return;
		301	}
		302	}
		303
		304	# parse port
		305	if (/\G (?:\s+\|:) ([^:[:space:]]+) \s*$/xgc) {
		306	$port = $1;
		307	} elsif (/\G\s*$/gc && length $_[1]) {
		308	$port = $_[1];
		309	} else {
		310	return;
		311	}
		312
		313	}
		314
		315	# hostnames must not contain :'s
		316	return if $host =~ /:/ && !parse_ipv6 $host;
		317
		318	($host, $port)
		319	}
		320
		321	=item $string = format_hostport $host, $port
		322
		323	Takes a host (in textual form) and a port and formats in unambigiously in
		324	a way that C<parse_hostport> can parse it again. C<$port> can be C<undef>.
		325
		326	=cut
		327
		328	sub format_hostport($;$) {
		329	my ($host, $port) = @_;
		330
		331	$port = ":$port" if length $port;
		332	$host = "[$host]" if $host =~ /:/;
		333
		334	"$host$port"
		335	}
165		336
166	=item $sa_family = address_family $ipn	337	=item $sa_family = address_family $ipn
167		338
168	Returns the address family/protocol-family (AF_xxx/PF_xxx, in one value :)	339	Returns the address family/protocol-family (AF_xxx/PF_xxx, in one value :)
169	of the given host address in network format.	340	of the given host address in network format.
…		…
176	: 16 == length $_[0]	347	: 16 == length $_[0]
177	? AF_INET6	348	? AF_INET6
178	: unpack "S", $_[0]	349	: unpack "S", $_[0]
179	}	350	}
180		351
		352	=item $text = format_ipv4 $ipn
		353
		354	Expects a four octet string representing a binary IPv4 address and returns
		355	its textual format. Rarely used, see C<format_address> for a nicer
		356	interface.
		357
		358	=item $text = format_ipv6 $ipn
		359
		360	Expects a sixteen octet string representing a binary IPv6 address and
		361	returns its textual format. Rarely used, see C<format_address> for a
		362	nicer interface.
		363
181	=item $text = format_address $ipn	364	=item $text = format_address $ipn
182		365
183	Covnvert a host address in network format (e.g. 4 octets for IPv4 or 16	366	Covnvert a host address in network format (e.g. 4 octets for IPv4 or 16
184	octets for IPv6) and convert it into textual form.	367	octets for IPv6) and convert it into textual form.
185		368
…		…
188	This function works similarly to C<inet_ntop AF_INET \|\| AF_INET6, ...>,	371	This function works similarly to C<inet_ntop AF_INET \|\| AF_INET6, ...>,
189	except it automatically detects the address type.	372	except it automatically detects the address type.
190		373
191	Returns C<undef> if it cannot detect the type.	374	Returns C<undef> if it cannot detect the type.
192		375
193	=cut	376	If the C<$ipn> is a mapped IPv4 in IPv6 address (:ffff::<ipv4>), then just
		377	the contained IPv4 address will be returned. If you do not want that, you
		378	have to call C<format_ipv6> manually.
194		379
195	sub format_address;	380	Example:
196	sub format_address($) {	381
197	my $af = address_family $_[0];	382	print format_address "\x01\x02\x03\x05";
198	if ($af == AF_INET) {	383	=> 1.2.3.5
		384
		385	=item $text = AnyEvent::Socket::ntoa $ipn
		386
		387	Same as format_address, but not exported (think C<inet_ntoa>).
		388
		389	=cut
		390
		391	sub format_ipv4($) {
199	return join ".", unpack "C4", $_[0]	392	join ".", unpack "C4", $_[0]
200	} elsif ($af == AF_INET6) {	393	}
		394
		395	sub format_ipv6($) {
		396	if ($_[0] =~ /^\x00\x00\x00\x00\x00\x00\x00\x00/) {
		397	if (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0 eq $_[0]) {
		398	return "::";
		399	} elsif (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.1 eq $_[0]) {
		400	return "::1";
201	if (v0.0.0.0.0.0.0.0.0.0.0.0 eq substr $_[0], 0, 12) {	401	} elsif (v0.0.0.0.0.0.0.0.0.0.0.0 eq substr $_[0], 0, 12) {
202	# v4compatible	402	# v4compatible
203	return "::" . format_address substr $_[0], 12;	403	return "::" . format_ipv4 substr $_[0], 12;
204	} elsif (v0.0.0.0.0.0.0.0.0.0.255.255 eq substr $_[0], 0, 12) {	404	} elsif (v0.0.0.0.0.0.0.0.0.0.255.255 eq substr $_[0], 0, 12) {
205	# v4mapped	405	# v4mapped
206	return "::ffff:" . format_address substr $_[0], 12;	406	return "::ffff:" . format_ipv4 substr $_[0], 12;
207	} elsif (v0.0.0.0.0.0.0.0.255.255.0.0 eq substr $_[0], 0, 12) {	407	} elsif (v0.0.0.0.0.0.0.0.255.255.0.0 eq substr $_[0], 0, 12) {
208	# v4translated	408	# v4translated
209	return "::ffff:0:" . format_address substr $_[0], 12;	409	return "::ffff:0:" . format_ipv4 substr $_[0], 12;
210	} else {
211	my $ip = sprintf "%x:%x:%x:%x:%x:%x:%x:%x", unpack "n8", $_[0];
212
213	$ip =~ s/^0:(?:0:)*(0$)?/::/
214	or $ip =~ s/(:0)+$/::/
215	or $ip =~ s/(:0)+/:/;
216	return $ip
217	}	410	}
218	} elsif ($af == AF_UNIX) {	411	}
		412
		413	my $ip = sprintf "%x:%x:%x:%x:%x:%x:%x:%x", unpack "n8", $_[0];
		414
		415	# this is admittedly rather sucky
		416	$ip =~ s/(?:^\|:) 0:0:0:0:0:0:0 (?:$\|:)/::/x
		417	or $ip =~ s/(?:^\|:) 0:0:0:0:0:0 (?:$\|:)/::/x
		418	or $ip =~ s/(?:^\|:) 0:0:0:0:0 (?:$\|:)/::/x
		419	or $ip =~ s/(?:^\|:) 0:0:0:0 (?:$\|:)/::/x
		420	or $ip =~ s/(?:^\|:) 0:0:0 (?:$\|:)/::/x
		421	or $ip =~ s/(?:^\|:) 0:0 (?:$\|:)/::/x
		422	or $ip =~ s/(?:^\|:) 0 (?:$\|:)/::/x;
		423
		424	$ip
		425	}
		426
		427	sub format_address($) {
		428	if (4 == length $_[0]) {
		429	return &format_ipv4;
		430	} elsif (16 == length $_[0]) {
		431	return $_[0] =~ /^\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff\xff(....)$/s
		432	? format_ipv4 $1
		433	: &format_ipv6;
		434	} elsif (AF_UNIX == address_family $_[0]) {
219	return "unix/"	435	return "unix/"
220	} else {	436	} else {
221	return undef	437	return undef
222	}	438	}
223	}	439	}
224		440
225	*format_ip = \&format_address;	441	*ntoa = \&format_address;
226		442
227	=item inet_aton $name_or_address, $cb->(@addresses)	443	=item inet_aton $name_or_address, $cb->(@addresses)
228		444
229	Works similarly to its Socket counterpart, except that it uses a	445	Works similarly to its Socket counterpart, except that it uses a
230	callback. Also, if a host has only an IPv6 address, this might be passed	446	callback. Use the length to distinguish between ipv4 and ipv6 (4 octets
231	to the callback instead (use the length to detect this - 4 for IPv4, 16	447	for IPv4, 16 for IPv6), or use C<format_address> to convert it to a more
232	for IPv6).	448	readable format.
233		449
234	Unlike the L<Socket> function of the same name, you can get multiple IPv4	450	Note that C<resolve_sockaddr>, while initially a more complex interface,
235	and IPv6 addresses as result (and maybe even other adrdess types).	451	resolves host addresses, IDNs, service names and SRV records and gives you
		452	an ordered list of socket addresses to try and should be preferred over
		453	C<inet_aton>.
		454
		455	Example.
		456
		457	inet_aton "www.google.com", my $cv = AE::cv;
		458	say unpack "H*", $_
		459	for $cv->recv;
		460	# => d155e363
		461	# => d155e367 etc.
		462
		463	inet_aton "ipv6.google.com", my $cv = AE::cv;
		464	say unpack "H*", $_
		465	for $cv->recv;
		466	# => 20014860a00300000000000000000068
236		467
237	=cut	468	=cut
238		469
239	sub inet_aton {	470	sub inet_aton {
240	my ($name, $cb) = @_;	471	my ($name, $cb) = @_;
…		…
246	} elsif ($name eq "localhost") { # rfc2606 et al.	477	} elsif ($name eq "localhost") { # rfc2606 et al.
247	$cb->(v127.0.0.1, v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.1);	478	$cb->(v127.0.0.1, v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.1);
248	} else {	479	} else {
249	require AnyEvent::DNS;	480	require AnyEvent::DNS;
250		481
251	# simple, bad suboptimal algorithm	482	my $ipv4 = $AnyEvent::PROTOCOL{ipv4};
		483	my $ipv6 = $AnyEvent::PROTOCOL{ipv6};
		484
		485	my @res;
		486
		487	my $cv = AE::cv {
		488	$cb->(map @$_, reverse @res);
		489	};
		490
		491	$cv->begin;
		492
		493	if ($ipv4) {
		494	$cv->begin;
252	AnyEvent::DNS::a ($name, sub {	495	AnyEvent::DNS::a ($name, sub {
253	if (@_) {	496	$res[$ipv4] = [map &parse_ipv4, @_];
254	$cb->(map +(parse_ipv4 $_), @_);
255	} else {
256	$cb->();	497	$cv->end;
257	#AnyEvent::DNS::aaaa ($name, $cb); need inet_pton
258	}	498	});
259	});	499	};
260	}
261	}
262		500
		501	if ($ipv6) {
		502	$cv->begin;
		503	AnyEvent::DNS::aaaa ($name, sub {
		504	$res[$ipv6] = [map &parse_ipv6, @_];
		505	$cv->end;
		506	});
		507	};
		508
		509	$cv->end;
		510	}
		511	}
		512
		513	BEGIN {
		514	*sockaddr_family = $Socket::VERSION >= 1.75
		515	? \&Socket::sockaddr_family
		516	: # for 5.6.x, we need to do something much more horrible
		517	(Socket::pack_sockaddr_in 0x5555, "\x55\x55\x55\x55"
		518	\| eval { Socket::pack_sockaddr_un "U" }) =~ /^\x00/
		519	? sub { unpack "xC", $_[0] }
		520	: sub { unpack "S" , $_[0] };
		521	}
		522
263	# check for broken platforms with extra field in sockaddr structure	523	# check for broken platforms with an extra field in sockaddr structure
264	# kind of a rfc vs. bsd issue, as usual (ok, normally it's a	524	# kind of a rfc vs. bsd issue, as usual (ok, normally it's a
265	# unix vs. bsd issue, a iso C vs. bsd issue or simply a	525	# unix vs. bsd issue, a iso C vs. bsd issue or simply a
266	# correctness vs. bsd issue.	526	# correctness vs. bsd issue.)
267	my $pack_family = 0x55 == Socket::sockaddr_family "\x55\x55"	527	my $pack_family = 0x55 == sockaddr_family ("\x55\x55")
268	? "xC" : "S";	528	? "xC" : "S";
269		529
270	=item $sa = AnyEvent::Socket::pack_sockaddr $service, $host	530	=item $sa = AnyEvent::Socket::pack_sockaddr $service, $host
271		531
272	Pack the given port/host combination into a binary sockaddr	532	Pack the given port/host combination into a binary sockaddr
273	structure. Handles both IPv4 and IPv6 host addresses, as well as UNIX	533	structure. Handles both IPv4 and IPv6 host addresses, as well as UNIX
274	domain sockets (C<$host> == C<unix/> and C<$service> == absolute	534	domain sockets (C<$host> == C<unix/> and C<$service> == absolute
275	pathname).	535	pathname).
		536
		537	Example:
		538
		539	my $bind = AnyEvent::Socket::pack_sockaddr 43, v195.234.53.120;
		540	bind $socket, $bind
		541	or die "bind: $!";
276		542
277	=cut	543	=cut
278		544
279	sub pack_sockaddr($$) {	545	sub pack_sockaddr($$) {
280	my $af = address_family $_[1];	546	my $af = address_family $_[1];
…		…
307	is a special token that is understood by the other functions in this	573	is a special token that is understood by the other functions in this
308	module (C<format_address> converts it to C<unix/>).	574	module (C<format_address> converts it to C<unix/>).
309		575
310	=cut	576	=cut
311		577
		578	# perl contains a bug (imho) where it requires that the kernel always returns
		579	# sockaddr_un structures of maximum length (which is not, AFAICS, required
		580	# by any standard). try to 0-pad structures for the benefit of those platforms.
		581
		582	my $sa_un_zero = eval { Socket::pack_sockaddr_un "" }; $sa_un_zero ^= $sa_un_zero;
		583
312	sub unpack_sockaddr($) {	584	sub unpack_sockaddr($) {
313	my $af = Socket::sockaddr_family $_[0];	585	my $af = sockaddr_family $_[0];
314		586
315	if ($af == AF_INET) {	587	if ($af == AF_INET) {
316	Socket::unpack_sockaddr_in $_[0]	588	Socket::unpack_sockaddr_in $_[0]
317	} elsif ($af == AF_INET6) {	589	} elsif ($af == AF_INET6) {
318	unpack "x2 n x4 a16", $_[0]	590	unpack "x2 n x4 a16", $_[0]
319	} elsif ($af == AF_UNIX) {	591	} elsif ($af == AF_UNIX) {
320	((Socket::unpack_sockaddr_un $_[0]), "unix/")	592	((Socket::unpack_sockaddr_un $_[0] ^ $sa_un_zero), pack "S", AF_UNIX)
321	} else {	593	} else {
322	Carp::croak "unpack_sockaddr: unsupported protocol family $af";	594	Carp::croak "unpack_sockaddr: unsupported protocol family $af";
323	}	595	}
324	}
325
326	sub _tcp_port($) {
327	$_[0] =~ /^(\d)$/ and return $11;
328
329	(getservbyname $_[0], "tcp")[2]
330	or Carp::croak "$_[0]: service unknown"
331	}	596	}
332		597
333	=item resolve_sockaddr $node, $service, $proto, $family, $type, $cb->([$family, $type, $proto, $sockaddr], ...)	598	=item resolve_sockaddr $node, $service, $proto, $family, $type, $cb->([$family, $type, $proto, $sockaddr], ...)
334		599
335	Tries to resolve the given nodename and service name into protocol families	600	Tries to resolve the given nodename and service name into protocol families
336	and sockaddr structures usable to connect to this node and service in a	601	and sockaddr structures usable to connect to this node and service in a
337	protocol-independent way. It works remotely similar to the getaddrinfo	602	protocol-independent way. It works remotely similar to the getaddrinfo
338	posix function.	603	posix function.
339		604
340	For internet addresses, C<$node> is either an IPv4 or IPv6 address or an	605	For internet addresses, C<$node> is either an IPv4 or IPv6 address, an
341	internet hostname, and C<$service> is either a service name (port name	606	internet hostname (DNS domain name or IDN), and C<$service> is either
342	from F</etc/services>) or a numerical port number. If both C<$node> and	607	a service name (port name from F</etc/services>) or a numerical port
343	C<$service> are names, then SRV records will be consulted to find the real	608	number. If both C<$node> and C<$service> are names, then SRV records
344	service, otherwise they will be used as-is. If you know that the service	609	will be consulted to find the real service, otherwise they will be
345	name is not in your services database, then you can specify the service in	610	used as-is. If you know that the service name is not in your services
346	the format C<name=port> (e.g. C<http=80>).	611	database, then you can specify the service in the format C<name=port>
		612	(e.g. C<http=80>).
		613
		614	If a host cannot be found via DNS, then it will be looked up in
		615	F</etc/hosts> (or the file specified via C<< $ENV{PERL_ANYEVENT_HOSTS}
		616	>>). If they are found, the addresses there will be used. The effect is as
		617	if entries from F</etc/hosts> would yield C<A> and C<AAAA> records for the
		618	host name unless DNS already had records for them.
347		619
348	For UNIX domain sockets, C<$node> must be the string C<unix/> and	620	For UNIX domain sockets, C<$node> must be the string C<unix/> and
349	C<$service> must be the absolute pathname of the socket. In this case,	621	C<$service> must be the absolute pathname of the socket. In this case,
350	C<$proto> will be ignored.	622	C<$proto> will be ignored.
351		623
…		…
353	C<sctp>. The default is currently C<tcp>, but in the future, this function	625	C<sctp>. The default is currently C<tcp>, but in the future, this function
354	might try to use other protocols such as C<sctp>, depending on the socket	626	might try to use other protocols such as C<sctp>, depending on the socket
355	type and any SRV records it might find.	627	type and any SRV records it might find.
356		628
357	C<$family> must be either C<0> (meaning any protocol is OK), C<4> (use	629	C<$family> must be either C<0> (meaning any protocol is OK), C<4> (use
358	only IPv4) or C<6> (use only IPv6). This setting might be influenced by	630	only IPv4) or C<6> (use only IPv6). The default is influenced by
359	C<$ENV{PERL_ANYEVENT_PROTOCOLS}>.	631	C<$ENV{PERL_ANYEVENT_PROTOCOLS}>.
360		632
361	C<$type> must be C<SOCK_STREAM>, C<SOCK_DGRAM> or C<SOCK_SEQPACKET> (or	633	C<$type> must be C<SOCK_STREAM>, C<SOCK_DGRAM> or C<SOCK_SEQPACKET> (or
362	C<undef> in which case it gets automatically chosen).	634	C<undef> in which case it gets automatically chosen to be C<SOCK_STREAM>
		635	unless C<$proto> is C<udp>).
363		636
364	The callback will receive zero or more array references that contain	637	The callback will receive zero or more array references that contain
365	C<$family, $type, $proto> for use in C<socket> and a binary	638	C<$family, $type, $proto> for use in C<socket> and a binary
366	C<$sockaddr> for use in C<connect> (or C<bind>).	639	C<$sockaddr> for use in C<connect> (or C<bind>).
367		640
…		…
371		644
372	resolve_sockaddr "google.com", "http", 0, undef, undef, sub { ... };	645	resolve_sockaddr "google.com", "http", 0, undef, undef, sub { ... };
373		646
374	=cut	647	=cut
375		648
		649	our %HOSTS;
		650	our $HOSTS;
		651
		652	if (
		653	open my $fh, "<",
		654	length $ENV{PERL_ANYEVENT_HOSTS} ? $ENV{PERL_ANYEVENT_HOSTS}
		655	: AnyEvent::WIN32 ? "$ENV{SystemRoot}/system32/drivers/etc/hosts"
		656	: "/etc/hosts"
		657	) {
		658	local $/;
		659	binmode $fh;
		660	$HOSTS = <$fh>;
		661	} else {
		662	$HOSTS = "";
		663	}
		664
		665	sub _parse_hosts() {
		666	#%HOSTS = ();
		667
		668	for (split /\n/, $HOSTS) {
		669	s/#.*$//;
		670	s/^[ \t]+//;
		671	y/A-Z/a-z/;
		672
		673	my ($addr, @aliases) = split /[ \t]+/;
		674	next unless @aliases;
		675
		676	if (my $ip = parse_ipv4 $addr) {
		677	push @{ $HOSTS{$_}[0] }, $ip
		678	for @aliases;
		679	} elsif (my $ip = parse_ipv6 $addr) {
		680	push @{ $HOSTS{$_}[1] }, $ip
		681	for @aliases;
		682	}
		683	}
		684
		685	undef $HOSTS;
		686	}
		687
376	sub resolve_sockaddr($$$$$$) {	688	sub resolve_sockaddr($$$$$$) {
377	my ($node, $service, $proto, $family, $type, $cb) = @_;	689	my ($node, $service, $proto, $family, $type, $cb) = @_;
378		690
379	if ($node eq "unix/") {	691	if ($node eq "unix/") {
380	return $cb->() if $family \|\| !/^\//; # no can do	692	return $cb->() if $family \|\| $service !~ /^\//; # no can do
381		693
382	return $cb->([AF_UNIX, $type, 0, Socket::pack_sockaddr_un $service]);	694	return $cb->([AF_UNIX, defined $type ? $type : SOCK_STREAM, 0, Socket::pack_sockaddr_un $service]);
383	}	695	}
384		696
385	unless (AF_INET6) {	697	unless (AF_INET6) {
386	$family != 6	698	$family != 6
387	or return $cb->();	699	or return $cb->();
…		…
396	$family \|\|= 6 unless $AnyEvent::PROTOCOL{ipv4};	708	$family \|\|= 6 unless $AnyEvent::PROTOCOL{ipv4};
397		709
398	$proto \|\|= "tcp";	710	$proto \|\|= "tcp";
399	$type \|\|= $proto eq "udp" ? SOCK_DGRAM : SOCK_STREAM;	711	$type \|\|= $proto eq "udp" ? SOCK_DGRAM : SOCK_STREAM;
400		712
401	my $proton = (getprotobyname $proto)[2]	713	my $proton = AnyEvent::Socket::getprotobyname $proto
402	or Carp::croak "$proto: protocol unknown";	714	or Carp::croak "$proto: protocol unknown";
403		715
404	my $port;	716	my $port;
405		717
406	if ($service =~ /^(\S+)=(\d+)$/) {	718	if ($service =~ /^(\S+)=(\d+)$/) {
407	($service, $port) = ($1, $2);	719	($service, $port) = ($1, $2);
408	} elsif ($service =~ /^\d+$/) {	720	} elsif ($service =~ /^\d+$/) {
409	($service, $port) = (undef, $service);	721	($service, $port) = (undef, $service);
410	} else {	722	} else {
411	$port = (getservbyname $service, $proto)[2]	723	$port = (getservbyname $service, $proto)[2]
412	or Carp::croak "$service/$proto: service unknown";	724	or Carp::croak "$service/$proto: service unknown";
413	}	725	}
414
415	my @target = [$node, $port];
416		726
417	# resolve a records / provide sockaddr structures	727	# resolve a records / provide sockaddr structures
418	my $resolve = sub {	728	my $resolve = sub {
		729	my @target = @_;
		730
419	my @res;	731	my @res;
420	my $cv = AnyEvent->condvar (cb => sub {	732	my $cv = AE::cv {
421	$cb->(	733	$cb->(
422	map $_->[2],	734	map $_->[2],
423	sort {	735	sort {
424	$AnyEvent::PROTOCOL{$b->[1]} <=> $AnyEvent::PROTOCOL{$a->[1]}	736	$AnyEvent::PROTOCOL{$b->[1]} <=> $AnyEvent::PROTOCOL{$a->[1]}
425	or $a->[0] <=> $b->[0]	737	or $a->[0] <=> $b->[0]
426	}	738	}
427	@res	739	@res
428	)	740	)
429	});	741	};
430		742
431	$cv->begin;	743	$cv->begin;
432	for my $idx (0 .. $#target) {	744	for my $idx (0 .. $#target) {
433	my ($node, $port) = @{ $target[$idx] };	745	my ($node, $port) = @{ $target[$idx] };
434		746
435	if (my $noden = parse_address $node) {	747	if (my $noden = parse_address $node) {
		748	my $af = address_family $noden;
		749
436	if (4 == length $noden && $family != 6) {	750	if ($af == AF_INET && $family != 6) {
437	push @res, [$idx, "ipv4", [AF_INET, $type, $proton,	751	push @res, [$idx, "ipv4", [AF_INET, $type, $proton,
438	pack_sockaddr $port, $noden]]	752	pack_sockaddr $port, $noden]]
439	}	753	}
440		754
441	if (16 == length $noden && $family != 4) {	755	if ($af == AF_INET6 && $family != 4) {
442	push @res, [$idx, "ipv6", [AF_INET6, $type, $proton,	756	push @res, [$idx, "ipv6", [AF_INET6, $type, $proton,
443	pack_sockaddr $port, $noden]]	757	pack_sockaddr $port, $noden]]
444	}	758	}
445	} else {	759	} else {
446	# ipv4	760	$node =~ y/A-Z/a-z/;
		761
		762	my $hosts = $HOSTS{$node};
		763
		764	# a records
447	if ($family != 6) {	765	if ($family != 6) {
448	$cv->begin;	766	$cv->begin;
449	a $node, sub {	767	AnyEvent::DNS::a $node, sub {
450	push @res, [$idx, "ipv4", [AF_INET, $type, $proton,	768	push @res, [$idx, "ipv4", [AF_INET , $type, $proton, pack_sockaddr $port, parse_ipv4 $_]]
451	pack_sockaddr $port, parse_ipv4 $_]]
452	for @_;	769	for @_;
		770
		771	# dns takes precedence over hosts
		772	push @res,
		773	map [$idx, "ipv4", [AF_INET , $type, $proton, pack_sockaddr $port, $_]],
		774	@{ $hosts->[0] }
		775	unless @_;
		776
453	$cv->end;	777	$cv->end;
454	};	778	};
455	}	779	}
456		780
457	# ipv6	781	# aaaa records
458	if ($family != 4) {	782	if ($family != 4) {
459	$cv->begin;	783	$cv->begin;
460	aaaa $node, sub {	784	AnyEvent::DNS::aaaa $node, sub {
461	push @res, [$idx, "ipv6", [AF_INET6, $type, $proton,	785	push @res, [$idx, "ipv6", [AF_INET6, $type, $proton, pack_sockaddr $port, parse_ipv6 $_]]
462	pack_sockaddr $port, parse_ipv6 $_]]
463	for @_;	786	for @_;
		787
		788	push @res,
		789	map [$idx + 0.5, "ipv6", [AF_INET6, $type, $proton, pack_sockaddr $port, $_]],
		790	@{ $hosts->[1] }
		791	unless @_;
		792
464	$cv->end;	793	$cv->end;
465	};	794	};
466	}	795	}
467	}	796	}
468	}	797	}
469	$cv->end;	798	$cv->end;
470	};	799	};
471		800
		801	$node = AnyEvent::Util::idn_to_ascii $node
		802	if $node =~ /[^\x00-\x7f]/;
		803
		804	# parse hosts
		805	if (defined $HOSTS) {
		806	_parse_hosts;
		807	undef &_parse_hosts;
		808	}
		809
472	# try srv records, if applicable	810	# try srv records, if applicable
473	if ($node eq "localhost") {	811	if ($node eq "localhost") {
474	@target = (["127.0.0.1", $port], ["::1", $port]);	812	$resolve->(["127.0.0.1", $port], ["::1", $port]);
475	&$resolve;
476	} elsif (defined $service && !parse_address $node) {	813	} elsif (defined $service && !parse_address $node) {
477	srv $service, $proto, $node, sub {	814	AnyEvent::DNS::srv $service, $proto, $node, sub {
478	my (@srv) = @_;	815	my (@srv) = @_;
479		816
		817	if (@srv) {
		818	# the only srv record has "." ("" here) => abort
		819	$srv[0][2] ne "" \|\| $#srv
		820	or return $cb->();
		821
		822	# use srv records then
		823	$resolve->(
		824	map ["$_->[3].", $_->[2]],
		825	grep $_->[3] ne ".",
		826	@srv
		827	);
		828	} else {
480	# no srv records, continue traditionally	829	# no srv records, continue traditionally
		830	$resolve->([$node, $port]);
481	@srv	831	}
482	or return &$resolve;
483
484	# only srv record has "." => abort
485	$srv[0][2] ne "." \|\| $#srv
486	or return $cb->();
487
488	# use srv records then
489	@target = map ["$_->[3].", $_->[2]],
490	grep $_->[3] ne ".",
491	@srv;
492
493	&$resolve;
494	};	832	};
495	} else {	833	} else {
496	&$resolve;	834	# most common case
		835	$resolve->([$node, $port]);
497	}	836	}
498	}	837	}
499		838
500	=item $guard = tcp_connect $host, $service, $connect_cb[, $prepare_cb]	839	=item $guard = tcp_connect $host, $service, $connect_cb[, $prepare_cb]
501		840
502	This is a convenience function that creates a TCP socket and makes a 100%	841	This is a convenience function that creates a TCP socket and makes a
503	non-blocking connect to the given C<$host> (which can be a hostname or	842	100% non-blocking connect to the given C<$host> (which can be a DNS/IDN
504	a textual IP address, or the string C<unix/> for UNIX domain sockets)	843	hostname or a textual IP address, or the string C<unix/> for UNIX domain
505	and C<$service> (which can be a numeric port number or a service name,	844	sockets) and C<$service> (which can be a numeric port number or a service
506	or a C<servicename=portnumber> string, or the pathname to a UNIX domain	845	name, or a C<servicename=portnumber> string, or the pathname to a UNIX
507	socket).	846	domain socket).
508		847
509	If both C<$host> and C<$port> are names, then this function will use SRV	848	If both C<$host> and C<$port> are names, then this function will use SRV
510	records to locate the real target(s).	849	records to locate the real target(s).
511		850
512	In either case, it will create a list of target hosts (e.g. for multihomed	851	In either case, it will create a list of target hosts (e.g. for multihomed
513	hosts or hosts with both IPv4 and IPv6 addresses) and try to connect to	852	hosts or hosts with both IPv4 and IPv6 addresses) and try to connect to
514	each in turn.	853	each in turn.
515		854
516	If the connect is successful, then the C<$connect_cb> will be invoked with	855	After the connection is established, then the C<$connect_cb> will be
517	the socket file handle (in non-blocking mode) as first and the peer host	856	invoked with the socket file handle (in non-blocking mode) as first, and
518	(as a textual IP address) and peer port as second and third arguments,	857	the peer host (as a textual IP address) and peer port as second and third
519	respectively. The fourth argument is a code reference that you can call	858	arguments, respectively. The fourth argument is a code reference that you
520	if, for some reason, you don't like this connection, which will cause	859	can call if, for some reason, you don't like this connection, which will
521	C<tcp_connect> to try the next one (or call your callback without any	860	cause C<tcp_connect> to try the next one (or call your callback without
522	arguments if there are no more connections). In most cases, you can simply	861	any arguments if there are no more connections). In most cases, you can
523	ignore this argument.	862	simply ignore this argument.
524		863
525	$cb->($filehandle, $host, $port, $retry)	864	$cb->($filehandle, $host, $port, $retry)
526		865
527	If the connect is unsuccessful, then the C<$connect_cb> will be invoked	866	If the connect is unsuccessful, then the C<$connect_cb> will be invoked
528	without any arguments and C<$!> will be set appropriately (with C<ENXIO>	867	without any arguments and C<$!> will be set appropriately (with C<ENXIO>
529	indicating a DNS resolution failure).	868	indicating a DNS resolution failure).
530		869
		870	The callback will I<never> be invoked before C<tcp_connect> returns, even
		871	if C<tcp_connect> was able to connect immediately (e.g. on unix domain
		872	sockets).
		873
531	The file handle is perfect for being plugged into L<AnyEvent::Handle>, but	874	The file handle is perfect for being plugged into L<AnyEvent::Handle>, but
532	can be used as a normal perl file handle as well.	875	can be used as a normal perl file handle as well.
533		876
534	Unless called in void context, C<tcp_connect> returns a guard object that	877	Unless called in void context, C<tcp_connect> returns a guard object that
535	will automatically abort connecting when it gets destroyed (it does not do	878	will automatically cancel the connection attempt when it gets destroyed
		879	- in which case the callback will not be invoked. Destroying it does not
536	anything to the socket after the connect was successful).	880	do anything to the socket after the connect was successful - you cannot
		881	"uncall" a callback that has been invoked already.
537		882
538	Sometimes you need to "prepare" the socket before connecting, for example,	883	Sometimes you need to "prepare" the socket before connecting, for example,
539	to C<bind> it to some port, or you want a specific connect timeout that	884	to C<bind> it to some port, or you want a specific connect timeout that
540	is lower than your kernel's default timeout. In this case you can specify	885	is lower than your kernel's default timeout. In this case you can specify
541	a second callback, C<$prepare_cb>. It will be called with the file handle	886	a second callback, C<$prepare_cb>. It will be called with the file handle
…		…
555	lessen the impact of this windows bug, a default timeout of 30 seconds	900	lessen the impact of this windows bug, a default timeout of 30 seconds
556	will be imposed on windows. Cygwin is not affected.	901	will be imposed on windows. Cygwin is not affected.
557		902
558	Simple Example: connect to localhost on port 22.	903	Simple Example: connect to localhost on port 22.
559		904
560	tcp_connect localhost => 22, sub {	905	tcp_connect localhost => 22, sub {
561	my $fh = shift	906	my $fh = shift
562	or die "unable to connect: $!";	907	or die "unable to connect: $!";
563	# do something	908	# do something
564	};	909	};
565		910
566	Complex Example: connect to www.google.com on port 80 and make a simple	911	Complex Example: connect to www.google.com on port 80 and make a simple
567	GET request without much error handling. Also limit the connection timeout	912	GET request without much error handling. Also limit the connection timeout
568	to 15 seconds.	913	to 15 seconds.
569		914
…		…
573	or die "unable to connect: $!";	918	or die "unable to connect: $!";
574		919
575	my $handle; # avoid direct assignment so on_eof has it in scope.	920	my $handle; # avoid direct assignment so on_eof has it in scope.
576	$handle = new AnyEvent::Handle	921	$handle = new AnyEvent::Handle
577	fh => $fh,	922	fh => $fh,
		923	on_error => sub {
		924	warn "error $_[2]\n";
		925	$_[0]->destroy;
		926	},
578	on_eof => sub {	927	on_eof => sub {
579	undef $handle; # keep it alive till eof	928	$handle->destroy; # destroy handle
580	warn "done.\n";	929	warn "done.\n";
581	};	930	};
582		931
583	$handle->push_write ("GET / HTTP/1.0\015\012\015\012");	932	$handle->push_write ("GET / HTTP/1.0\015\012\015\012");
584		933
585	$handle->push_read_line ("\015\012\015\012", sub {	934	$handle->push_read (line => "\015\012\015\012", sub {
586	my ($handle, $line) = @_;	935	my ($handle, $line) = @_;
587		936
588	# print response header	937	# print response header
589	print "HEADER\n$line\n\nBODY\n";	938	print "HEADER\n$line\n\nBODY\n";
590		939
…		…
610	=cut	959	=cut
611		960
612	sub tcp_connect($$$;$) {	961	sub tcp_connect($$$;$) {
613	my ($host, $port, $connect, $prepare) = @_;	962	my ($host, $port, $connect, $prepare) = @_;
614		963
615	# see http://cr.yp.to/docs/connect.html for some background	964	# see http://cr.yp.to/docs/connect.html for some tricky aspects
616	# also http://advogato.org/article/672.html	965	# also http://advogato.org/article/672.html
617		966
618	my %state = ( fh => undef );	967	my %state = ( fh => undef );
619		968
620	# name/service to type/sockaddr resolution	969	# name/service to type/sockaddr resolution
621	resolve_sockaddr $host, $port, 0, 0, 0, sub {	970	resolve_sockaddr $host, $port, 0, 0, undef, sub {
622	my @target = @_;	971	my @target = @_;
623		972
624	$state{next} = sub {	973	$state{next} = sub {
625	return unless exists $state{fh};	974	return unless exists $state{fh};
626		975
627	my $target = shift @target	976	my $target = shift @target
628	or do {	977	or return AE::postpone {
		978	return unless exists $state{fh};
629	%state = ();	979	%state = ();
630	return $connect->();	980	$connect->();
631	};	981	};
632		982
633	my ($domain, $type, $proto, $sockaddr) = @$target;	983	my ($domain, $type, $proto, $sockaddr) = @$target;
634		984
635	# socket creation	985	# socket creation
…		…
640		990
641	my $timeout = $prepare && $prepare->($state{fh});	991	my $timeout = $prepare && $prepare->($state{fh});
642		992
643	$timeout \|\|= 30 if AnyEvent::WIN32;	993	$timeout \|\|= 30 if AnyEvent::WIN32;
644		994
645	$state{to} = AnyEvent->timer (after => $timeout, cb => sub {	995	$state{to} = AE::timer $timeout, 0, sub {
646	$! = &Errno::ETIMEDOUT;	996	$! = Errno::ETIMEDOUT;
647	$state{next}();	997	$state{next}();
648	}) if $timeout;	998	} if $timeout;
649		999
650	# called when the connect was successful, which,	1000	# now connect
651	# in theory, could be the case immediately (but never is in practise)	1001	if (
652	my $connected = sub {	1002	(connect $state{fh}, $sockaddr)
653	delete $state{ww};	1003	\|\| ($! == Errno::EINPROGRESS # POSIX
654	delete $state{to};	1004	\|\| $! == Errno::EWOULDBLOCK
655		1005	# WSAEINPROGRESS intentionally not checked - it means something else entirely
		1006	\|\| $! == AnyEvent::Util::WSAEINVAL # not convinced, but doesn't hurt
		1007	\|\| $! == AnyEvent::Util::WSAEWOULDBLOCK)
		1008	) {
		1009	$state{ww} = AE::io $state{fh}, 1, sub {
656	# we are connected, or maybe there was an error	1010	# we are connected, or maybe there was an error
657	if (my $sin = getpeername $state{fh}) {	1011	if (my $sin = getpeername $state{fh}) {
658	my ($port, $host) = unpack_sockaddr $sin;	1012	my ($port, $host) = unpack_sockaddr $sin;
659		1013
		1014	delete $state{ww}; delete $state{to};
		1015
660	my $guard = guard {	1016	my $guard = guard { %state = () };
661	%state = ();
662	};
663		1017
664	$connect->($state{fh}, format_address $host, $port, sub {	1018	$connect->(delete $state{fh}, format_address $host, $port, sub {
665	$guard->cancel;	1019	$guard->cancel;
		1020	$state{next}();
		1021	});
		1022	} else {
		1023	if ($! == Errno::ENOTCONN) {
		1024	# dummy read to fetch real error code if !cygwin
		1025	sysread $state{fh}, my $buf, 1;
		1026
		1027	# cygwin 1.5 continously reports "ready' but never delivers
		1028	# an error with getpeername or sysread.
		1029	# cygwin 1.7 only reports readyness once, but is otherwise
		1030	# the same, which is actually more broken.
		1031	# Work around both by using unportable SO_ERROR for cygwin.
		1032	$! = (unpack "l", getsockopt $state{fh}, Socket::SOL_SOCKET(), Socket::SO_ERROR()) \|\| Errno::EAGAIN
		1033	if AnyEvent::CYGWIN && $! == Errno::EAGAIN;
		1034	}
		1035
		1036	return if $! == Errno::EAGAIN; # skip spurious wake-ups
		1037
		1038	delete $state{ww}; delete $state{to};
		1039
666	$state{next}();	1040	$state{next}();
667	});	1041	}
668	} else {
669	# dummy read to fetch real error code
670	sysread $state{fh}, my $buf, 1 if $! == &Errno::ENOTCONN;
671	$state{next}();
672	}	1042	};
673	};
674
675	# now connect
676	if (connect $state{fh}, $sockaddr) {
677	$connected->();
678	} elsif ($! == &Errno::EINPROGRESS # POSIX
679	\|\| $! == &Errno::EWOULDBLOCK
680	# WSAEINPROGRESS intentionally not checked - it means something else entirely
681	\|\| $! == AnyEvent::Util::WSAEINVAL # not convinced, but doesn't hurt
682	\|\| $! == AnyEvent::Util::WSAEWOULDBLOCK) {
683	$state{ww} = AnyEvent->io (fh => $state{fh}, poll => 'w', cb => $connected);
684	} else {	1043	} else {
685	$state{next}();	1044	$state{next}();
686	}	1045	}
687	};	1046	};
688		1047
689	$! = &Errno::ENXIO;	1048	$! = Errno::ENXIO;
690	$state{next}();	1049	$state{next}();
691	};	1050	};
692		1051
693	defined wantarray && guard { %state = () }	1052	defined wantarray && guard { %state = () }
694	}	1053	}
695		1054
696	=item $guard = tcp_server $host, $port, $accept_cb[, $prepare_cb]	1055	=item $guard = tcp_server $host, $service, $accept_cb[, $prepare_cb]
697		1056
698	Create and bind a TCP socket to the given host, and port, set the	1057	Create and bind a stream socket to the given host, and port, set the
699	SO_REUSEADDR flag and call C<listen>.	1058	SO_REUSEADDR flag (if applicable) and call C<listen>. Unlike the name
		1059	implies, this function can also bind on UNIX domain sockets.
700		1060
701	C<$host> must be an IPv4 or IPv6 address (or C<undef>, in which case it	1061	For internet sockets, C<$host> must be an IPv4 or IPv6 address (or
702	binds either to C<0> or to C<::>, depending on whether IPv4 or IPv6 is the	1062	C<undef>, in which case it binds either to C<0> or to C<::>, depending
703	preferred protocol).	1063	on whether IPv4 or IPv6 is the preferred protocol, and maybe to both in
		1064	future versions, as applicable).
704		1065
705	To bind to the IPv4 wildcard address, use C<0>, to bind to the IPv6	1066	To bind to the IPv4 wildcard address, use C<0>, to bind to the IPv6
706	wildcard address, use C<::>.	1067	wildcard address, use C<::>.
707		1068
708	The port is specified by C<$port>, which must be either a service name or	1069	The port is specified by C<$service>, which must be either a service name or
709	a numeric port number (or C<0> or C<undef>, in which case an ephemeral	1070	a numeric port number (or C<0> or C<undef>, in which case an ephemeral
710	port will be used).	1071	port will be used).
711		1072
		1073	For UNIX domain sockets, C<$host> must be C<unix/> and C<$service> must be
		1074	the absolute pathname of the socket. This function will try to C<unlink>
		1075	the socket before it tries to bind to it, and will try to unlink it after
		1076	it stops using it. See SECURITY CONSIDERATIONS, below.
		1077
712	For each new connection that could be C<accept>ed, call the C<<	1078	For each new connection that could be C<accept>ed, call the C<<
713	$accept_cb->($fh, $host, $port) >> with the file handle (in non-blocking	1079	$accept_cb->($fh, $host, $port) >> with the file handle (in non-blocking
714	mode) as first and the peer host and port as second and third arguments	1080	mode) as first, and the peer host and port as second and third arguments
715	(see C<tcp_connect> for details).	1081	(see C<tcp_connect> for details).
716		1082
717	Croaks on any errors it can detect before the listen.	1083	Croaks on any errors it can detect before the listen.
718		1084
719	If called in non-void context, then this function returns a guard object	1085	If called in non-void context, then this function returns a guard object
720	whose lifetime it tied to the TCP server: If the object gets destroyed,	1086	whose lifetime it tied to the TCP server: If the object gets destroyed,
721	the server will be stopped (but existing accepted connections will	1087	the server will be stopped (but existing accepted connections will
722	continue).	1088	not be affected).
723		1089
724	If you need more control over the listening socket, you can provide a	1090	If you need more control over the listening socket, you can provide a
725	C<< $prepare_cb->($fh, $host, $port) >>, which is called just before the	1091	C<< $prepare_cb->($fh, $host, $port) >>, which is called just before the
726	C<listen ()> call, with the listen file handle as first argument, and IP	1092	C<listen ()> call, with the listen file handle as first argument, and IP
727	address and port number of the local socket endpoint as second and third	1093	address and port number of the local socket endpoint as second and third
728	arguments.	1094	arguments.
729		1095
730	It should return the length of the listen queue (or C<0> for the default).	1096	It should return the length of the listen queue (or C<0> for the default).
731		1097
		1098	Note to IPv6 users: RFC-compliant behaviour for IPv6 sockets listening on
		1099	C<::> is to bind to both IPv6 and IPv4 addresses by default on dual-stack
		1100	hosts. Unfortunately, only GNU/Linux seems to implement this properly, so
		1101	if you want both IPv4 and IPv6 listening sockets you should create the
		1102	IPv6 socket first and then attempt to bind on the IPv4 socket, but ignore
		1103	any C<EADDRINUSE> errors.
		1104
732	Example: bind on some TCP port on the local machine and tell each client	1105	Example: bind on some TCP port on the local machine and tell each client
733	to go away.	1106	to go away.
734		1107
735	tcp_server undef, undef, sub {	1108	tcp_server undef, undef, sub {
736	my ($fh, $host, $port) = @_;	1109	my ($fh, $host, $port) = @_;
…		…
739	}, sub {	1112	}, sub {
740	my ($fh, $thishost, $thisport) = @_;	1113	my ($fh, $thishost, $thisport) = @_;
741	warn "bound to $thishost, port $thisport\n";	1114	warn "bound to $thishost, port $thisport\n";
742	};	1115	};
743		1116
		1117	Example: bind a server on a unix domain socket.
		1118
		1119	tcp_server "unix/", "/tmp/mydir/mysocket", sub {
		1120	my ($fh) = @_;
		1121	};
		1122
744	=cut	1123	=cut
745		1124
746	sub tcp_server($$$;$) {	1125	sub tcp_server($$$;$) {
747	my ($host, $port, $accept, $prepare) = @_;	1126	my ($host, $service, $accept, $prepare) = @_;
748		1127
749	$host = $AnyEvent::PROTOCOL{ipv4} < $AnyEvent::PROTOCOL{ipv6} && AF_INET6	1128	$host = $AnyEvent::PROTOCOL{ipv4} < $AnyEvent::PROTOCOL{ipv6} && AF_INET6
750	? "::" : "0"	1129	? "::" : "0"
751	unless defined $host;	1130	unless defined $host;
752		1131
753	my $ipn = parse_address $host	1132	my $ipn = parse_address $host
754	or Carp::croak "AnyEvent::Socket::tcp_server: cannot parse '$host' as host address";	1133	or Carp::croak "AnyEvent::Socket::tcp_server: cannot parse '$host' as host address";
755		1134
756	my $domain = 4 == length $ipn ? AF_INET : AF_INET6;	1135	my $af = address_family $ipn;
757		1136
758	my %state;	1137	my %state;
759		1138
		1139	# win32 perl is too stupid to get this right :/
		1140	Carp::croak "tcp_server/socket: address family not supported"
		1141	if AnyEvent::WIN32 && $af == AF_UNIX;
		1142
760	socket $state{fh}, $domain, SOCK_STREAM, 0	1143	socket $state{fh}, $af, SOCK_STREAM, 0
761	or Carp::croak "socket: $!";	1144	or Carp::croak "tcp_server/socket: $!";
762		1145
		1146	if ($af == AF_INET \|\| $af == AF_INET6) {
763	setsockopt $state{fh}, SOL_SOCKET, SO_REUSEADDR, 1	1147	setsockopt $state{fh}, SOL_SOCKET, SO_REUSEADDR, 1
764	or Carp::croak "so_reuseaddr: $!";	1148	or Carp::croak "tcp_server/so_reuseaddr: $!"
		1149	unless AnyEvent::WIN32; # work around windows bug
765		1150
		1151	unless ($service =~ /^\d*$/) {
		1152	$service = (getservbyname $service, "tcp")[2]
		1153	or Carp::croak "$service: service unknown"
		1154	}
		1155	} elsif ($af == AF_UNIX) {
		1156	unlink $service;
		1157	}
		1158
766	bind $state{fh}, pack_sockaddr _tcp_port $port, $ipn	1159	bind $state{fh}, pack_sockaddr $service, $ipn
767	or Carp::croak "bind: $!";	1160	or Carp::croak "bind: $!";
768		1161
		1162	if ($af == AF_UNIX) {
		1163	my $fh = $state{fh};
		1164	my $ino = (stat $fh)[1];
		1165	$state{unlink} = guard {
		1166	# this is racy, but is not designed to be foolproof, just best-effort
		1167	unlink $service
		1168	if $ino == (stat $fh)[1];
		1169	};
		1170	}
		1171
769	fh_nonblocking $state{fh}, 1;	1172	fh_nonblocking $state{fh}, 1;
770		1173
771	my $len;	1174	my $len;
772		1175
773	if ($prepare) {	1176	if ($prepare) {
774	my ($port, $host) = unpack_sockaddr getsockname $state{fh};	1177	my ($service, $host) = unpack_sockaddr getsockname $state{fh};
775	$len = $prepare && $prepare->($state{fh}, format_address $host, $port);	1178	$len = $prepare && $prepare->($state{fh}, format_address $host, $service);
776	}	1179	}
777		1180
778	$len \|\|= 128;	1181	$len \|\|= 128;
779		1182
780	listen $state{fh}, $len	1183	listen $state{fh}, $len
781	or Carp::croak "listen: $!";	1184	or Carp::croak "listen: $!";
782		1185
783	$state{aw} = AnyEvent->io (fh => $state{fh}, poll => 'r', cb => sub {	1186	$state{aw} = AE::io $state{fh}, 0, sub {
784	# this closure keeps $state alive	1187	# this closure keeps $state alive
785	while (my $peer = accept my $fh, $state{fh}) {	1188	while ($state{fh} && (my $peer = accept my $fh, $state{fh})) {
786	fh_nonblocking $fh, 1; # POSIX requires inheritance, the outside world does not	1189	fh_nonblocking $fh, 1; # POSIX requires inheritance, the outside world does not
		1190
787	my ($port, $host) = unpack_sockaddr $peer;	1191	my ($service, $host) = unpack_sockaddr $peer;
788	$accept->($fh, format_address $host, $port);	1192	$accept->($fh, format_address $host, $service);
789	}	1193	}
790	});	1194	};
791		1195
792	defined wantarray	1196	defined wantarray
793	? guard { %state = () } # clear fh and watcher, which breaks the circular dependency	1197	? guard { %state = () } # clear fh and watcher, which breaks the circular dependency
794	: ()	1198	: ()
795	}	1199	}
796		1200
		1201	=item tcp_nodelay $fh, $enable
		1202
		1203	Enables (or disables) the C<TCP_NODELAY> socket option (also known as
		1204	Nagle's algorithm). Returns false on error, true otherwise.
		1205
		1206	=cut
		1207
		1208	sub tcp_nodelay($$) {
		1209	my $onoff = int ! ! $_[1];
		1210
		1211	setsockopt $_[0], Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), $onoff
		1212	}
		1213
		1214	=item tcp_congestion $fh, $algorithm
		1215
		1216	Sets the tcp congestion avoidance algorithm (via the C<TCP_CONGESTION>
		1217	socket option). The default is OS-specific, but is usually
		1218	C<reno>. Typical other available choices include C<cubic>, C<lp>, C<bic>,
		1219	C<highspeed>, C<htcp>, C<hybla>, C<illinois>, C<scalable>, C<vegas>,
		1220	C<veno>, C<westwood> and C<yeah>.
		1221
		1222	=cut
		1223
		1224	sub tcp_congestion($$) {
		1225	defined TCP_CONGESTION
		1226	? setsockopt $_[0], Socket::IPPROTO_TCP (), TCP_CONGESTION, "$_[1]"
		1227	: undef
		1228	}
		1229
797	1;	1230	1;
798		1231
799	=back	1232	=back
		1233
		1234	=head1 SECURITY CONSIDERATIONS
		1235
		1236	This module is quite powerful, with with power comes the ability to abuse
		1237	as well: If you accept "hostnames" and ports from untrusted sources,
		1238	then note that this can be abused to delete files (host=C<unix/>). This
		1239	is not really a problem with this module, however, as blindly accepting
		1240	any address and protocol and trying to bind a server or connect to it is
		1241	harmful in general.
800		1242
801	=head1 AUTHOR	1243	=head1 AUTHOR
802		1244
803	Marc Lehmann <schmorp@schmorp.de>	1245	Marc Lehmann <schmorp@schmorp.de>
804	http://home.schmorp.de/	1246	http://home.schmorp.de/

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Socket.pm (file contents): Revision 1.34 by root, Wed May 28 21:07:07 2008 UTC vs. Revision 1.138 by root, Thu Aug 25 02:11:12 2011 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Socket.pm (file contents):
Revision 1.34 by root, Wed May 28 21:07:07 2008 UTC vs.
Revision 1.138 by root, Thu Aug 25 02:11:12 2011 UTC