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

Comparing AnyEvent/lib/AnyEvent/Socket.pm (file contents):
Revision 1.91 by root, Thu Jul 16 04:20:24 2009 UTC vs.
Revision 1.157 by root, Wed Oct 31 15:42:06 2012 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
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(
52	parse_hostport	49	getprotobyname
		50	parse_hostport format_hostport
53	parse_ipv4 parse_ipv6	51	parse_ipv4 parse_ipv6
54	parse_ip parse_address	52	parse_ip parse_address
55	format_ipv4 format_ipv6	53	format_ipv4 format_ipv6
56	format_ip format_address	54	format_ip format_address
57	address_family	55	address_family
58	inet_aton	56	inet_aton
59	tcp_server	57	tcp_server
60	tcp_connect	58	tcp_connect
61	);	59	);
62		60
63	our $VERSION = 4.82;	61	our $VERSION = $AnyEvent::VERSION;
64		62
65	=item $ipn = parse_ipv4 $dotted_quad	63	=item $ipn = parse_ipv4 $dotted_quad
66		64
67	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
68	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
…		…
99	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
100	(and will not parse).	98	(and will not parse).
101		99
102	This function works similarly to C<inet_pton AF_INET6, ...>.	100	This function works similarly to C<inet_pton AF_INET6, ...>.
103		101
		102	Example:
		103
		104	print unpack "H*", parse_ipv6 "2002:5345::10.0.0.1";
		105	# => 2002534500000000000000000a000001
		106
104	=cut	107	=cut
105		108
106	sub parse_ipv6($) {	109	sub parse_ipv6($) {
107	# quick test to avoid longer processing	110	# quick test to avoid longer processing
108	my $n = $_[0] =~ y/://;	111	my $n = $_[0] =~ y/://;
…		…
138		141
139	# and done	142	# and done
140	pack "n*", map hex, @h, @t	143	pack "n*", map hex, @h, @t
141	}	144	}
142		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
143	sub parse_unix($) {	157	sub parse_unix($) {
144	$_[0] eq "unix/"	158	$_[0] eq "unix/"
145	? pack "S", AF_UNIX	159	? pack "S", AF_UNIX
146	: undef	160	: undef
147		161
…		…
158	socket".	172	socket".
159		173
160	If the C<$text> to parse is a mapped IPv4 in IPv6 address (:ffff::<ipv4>),	174	If the C<$text> to parse is a mapped IPv4 in IPv6 address (:ffff::<ipv4>),
161	then it will be treated as an IPv4 address. If you don't want that, you	175	then it will be treated as an IPv4 address. If you don't want that, you
162	have to call C<parse_ipv4> and/or C<parse_ipv6> manually.	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
163		182
164	=item $ipn = AnyEvent::Socket::aton $ip	183	=item $ipn = AnyEvent::Socket::aton $ip
165		184
166	Same as C<parse_address>, but not exported (think C<Socket::inet_aton> but	185	Same as C<parse_address>, but not exported (think C<Socket::inet_aton> but
167	I<without> name resolution).	186	I<without> name resolution).
…		…
179	}	198	}
180	}	199	}
181		200
182	*aton = \&parse_address;	201	*aton = \&parse_address;
183		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
184	=item ($host, $service) = parse_hostport $string[, $default_service]	233	=item ($host, $service) = parse_hostport $string[, $default_service]
185		234
186	Splitting a string of the form C<hostname:port> is a common	235	Splitting a string of the form C<hostname:port> is a common
187	problem. Unfortunately, just splitting on the colon makes it hard to	236	problem. Unfortunately, just splitting on the colon makes it hard to
188	specify IPv6 addresses and doesn't support the less common but well	237	specify IPv6 addresses and doesn't support the less common but well
189	standardised C<[ip literal]> syntax.	238	standardised C<[ip literal]> syntax.
190		239
191	This function tries to do this job in a better way, it supports the	240	This function tries to do this job in a better way, it supports (at
192	following formats, where C<port> can be a numerical port number of a	241	least) the following formats, where C<port> can be a numerical port
193	service name, or a C<name=port> string, and the C< port> and C<:port>	242	number of a service name, or a C<name=port> string, and the C< port> and
194	parts are optional. Also, everywhere where an IP address is supported	243	C<:port> parts are optional. Also, everywhere where an IP address is
195	a hostname or unix domain socket address is also supported (see	244	supported a hostname or unix domain socket address is also supported (see
196	C<parse_unix>).	245	C<parse_unix>), and strings starting with C</> will also be interpreted as
		246	unix domain sockets.
197		247
198	hostname:port e.g. "www.linux.org", "www.x.de:443", "www.x.de:https=443"	248	hostname:port e.g. "www.linux.org", "www.x.de:443", "www.x.de:https=443",
199	ipv4:port e.g. "198.182.196.56", "127.1:22"	249	ipv4:port e.g. "198.182.196.56", "127.1:22"
200	ipv6 e.g. "::1", "affe::1"	250	ipv6 e.g. "::1", "affe::1"
201	[ipv4or6]:port e.g. "[::1]", "[10.0.1]:80"	251	[ipv4or6]:port e.g. "[::1]", "[10.0.1]:80"
202	[ipv4or6] port e.g. "[127.0.0.1]", "[www.x.org] 17"	252	[ipv4or6] port e.g. "[127.0.0.1]", "[www.x.org] 17"
203	ipv4or6 port e.g. "::1 443", "10.0.0.1 smtp"	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"
204		256
205	It also supports defaulting the service name in a simple way by using	257	It also supports defaulting the service name in a simple way by using
206	C<$default_service> if no service was detected. If neither a service was	258	C<$default_service> if no service was detected. If neither a service was
207	detected nor a default was specified, then this function returns the	259	detected nor a default was specified, then this function returns the
208	empty list. The same happens when a parse error weas detected, such as a	260	empty list. The same happens when a parse error was detected, such as a
209	hostname with a colon in it (the function is rather conservative, though).	261	hostname with a colon in it (the function is rather conservative, though).
210		262
211	Example:	263	Example:
212		264
213	print join ",", parse_hostport "localhost:443";	265	print join ",", parse_hostport "localhost:443";
…		…
217	# => "localhost,https"	269	# => "localhost,https"
218		270
219	print join ",", parse_hostport "[::1]";	271	print join ",", parse_hostport "[::1]";
220	# => "," (empty list)	272	# => "," (empty list)
221		273
		274	print join ",", parse_host_port "/tmp/debug.sock";
		275	# => "unix/", "/tmp/debug.sock"
		276
222	=cut	277	=cut
223		278
224	sub parse_hostport($;$) {	279	sub parse_hostport($;$) {
225	my ($host, $port);	280	my ($host, $port);
226		281
227	for ("$_[0]") { # work on a copy, just in case, and also reset pos	282	for ("$_[0]") { # work on a copy, just in case, and also reset pos
228		283
		284	# shortcut for /path
		285	return ("unix/", $_)
		286	if m%^/%;
		287
229	# parse host, special cases: "ipv6" or "ipv6 port"	288	# parse host, special cases: "ipv6" or "ipv6[#p ]port"
230	unless (	289	unless (
231	($host) = /^\s* ([0-9a-fA-F:]:[0-9a-fA-F:]:[0-9a-fA-F\.:]*)/xgc	290	($host) = /^\s* ([0-9a-fA-F:]:[0-9a-fA-F:]:[0-9a-fA-F\.:]*)/xgc
232	and parse_ipv6 $host	291	and parse_ipv6 $host
233	) {	292	) {
234	/^\s*/xgc;	293	/^\s*/xgc;
…		…
241	return;	300	return;
242	}	301	}
243	}	302	}
244		303
245	# parse port	304	# parse port
246	if (/\G (?:\s+\|:) ([^:[:space:]]+) \s*$/xgc) {	305	if (/\G (?:\s+\|:\|\#) ([^:[:space:]]+) \s*$/xgc) {
247	$port = $1;	306	$port = $1;
248	} elsif (/\G\s*$/gc && length $_[1]) {	307	} elsif (/\G\s*$/gc && length $_[1]) {
249	$port = $_[1];	308	$port = $_[1];
250	} else {	309	} else {
251	return;	310	return;
252	}	311	}
		312
253	}	313	}
254		314
255	# hostnames must not contain :'s	315	# hostnames must not contain :'s
256	return if $host =~ /:/ && !parse_ipv6 $host;	316	return if $host =~ /:/ && !parse_ipv6 $host;
257		317
258	($host, $port)	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"
259	}	335	}
260		336
261	=item $sa_family = address_family $ipn	337	=item $sa_family = address_family $ipn
262		338
263	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 :)
…		…
299		375
300	If the C<$ipn> is a mapped IPv4 in IPv6 address (:ffff::<ipv4>), then just	376	If the C<$ipn> is a mapped IPv4 in IPv6 address (:ffff::<ipv4>), then just
301	the contained IPv4 address will be returned. If you do not want that, you	377	the contained IPv4 address will be returned. If you do not want that, you
302	have to call C<format_ipv6> manually.	378	have to call C<format_ipv6> manually.
303		379
		380	Example:
		381
		382	print format_address "\x01\x02\x03\x05";
		383	=> 1.2.3.5
		384
304	=item $text = AnyEvent::Socket::ntoa $ipn	385	=item $text = AnyEvent::Socket::ntoa $ipn
305		386
306	Same as format_address, but not exported (think C<inet_ntoa>).	387	Same as format_address, but not exported (think C<inet_ntoa>).
307		388
308	=cut	389	=cut
…		…
310	sub format_ipv4($) {	391	sub format_ipv4($) {
311	join ".", unpack "C4", $_[0]	392	join ".", unpack "C4", $_[0]
312	}	393	}
313		394
314	sub format_ipv6($) {	395	sub format_ipv6($) {
		396	if ($_[0] =~ /^\x00\x00\x00\x00\x00\x00\x00\x00/) {
315	if (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0 eq $_[0]) {	397	if (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0 eq $_[0]) {
316	return "::";	398	return "::";
317	} elsif (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.1 eq $_[0]) {	399	} elsif (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.1 eq $_[0]) {
318	return "::1";	400	return "::1";
319	} elsif (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) {
320	# v4compatible	402	# v4compatible
321	return "::" . format_ipv4 substr $_[0], 12;	403	return "::" . format_ipv4 substr $_[0], 12;
322	} 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) {
323	# v4mapped	405	# v4mapped
324	return "::ffff:" . format_ipv4 substr $_[0], 12;	406	return "::ffff:" . format_ipv4 substr $_[0], 12;
325	} 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) {
326	# v4translated	408	# v4translated
327	return "::ffff:0:" . format_ipv4 substr $_[0], 12;	409	return "::ffff:0:" . format_ipv4 substr $_[0], 12;
328	} else {	410	}
		411	}
		412
329	my $ip = sprintf "%x:%x:%x:%x:%x:%x:%x:%x", unpack "n8", $_[0];	413	my $ip = sprintf "%x:%x:%x:%x:%x:%x:%x:%x", unpack "n8", $_[0];
330		414
331	# this is rather sucky, I admit	415	# this is admittedly rather sucky
332	$ip =~ s/^0:(?:0:)*(0$)?/::/	416	$ip =~ s/(?:^\|:) 0:0:0:0:0:0:0 (?:$\|:)/::/x
333	or $ip =~ s/(:0){7}$/::/ or $ip =~ s/(:0){7}/:/	417	or $ip =~ s/(?:^\|:) 0:0:0:0:0:0 (?:$\|:)/::/x
334	or $ip =~ s/(:0){6}$/::/ or $ip =~ s/(:0){6}/:/	418	or $ip =~ s/(?:^\|:) 0:0:0:0:0 (?:$\|:)/::/x
335	or $ip =~ s/(:0){5}$/::/ or $ip =~ s/(:0){5}/:/	419	or $ip =~ s/(?:^\|:) 0:0:0:0 (?:$\|:)/::/x
336	or $ip =~ s/(:0){4}$/::/ or $ip =~ s/(:0){4}/:/	420	or $ip =~ s/(?:^\|:) 0:0:0 (?:$\|:)/::/x
337	or $ip =~ s/(:0){3}$/::/ or $ip =~ s/(:0){3}/:/	421	or $ip =~ s/(?:^\|:) 0:0 (?:$\|:)/::/x
338	or $ip =~ s/(:0){2}$/::/ or $ip =~ s/(:0){2}/:/	422	or $ip =~ s/(?:^\|:) 0 (?:$\|:)/::/x;
339	or $ip =~ s/(:0){1}$/::/ or $ip =~ s/(:0){1}/:/;	423
340	return $ip	424	$ip
341	}
342	}	425	}
343		426
344	sub format_address($) {	427	sub format_address($) {
345	my $af = address_family $_[0];	428	if (4 == length $_[0]) {
346	if ($af == AF_INET) {
347	return &format_ipv4;	429	return &format_ipv4;
348	} elsif ($af == AF_INET6) {	430	} elsif (16 == length $_[0]) {
349	return (v0.0.0.0.0.0.0.0.0.0.255.255 eq substr $_[0], 0, 12)	431	return $_[0] =~ /^\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff\xff(....)$/s
350	? format_ipv4 substr $_[0], 12	432	? format_ipv4 $1
351	: &format_ipv6;	433	: &format_ipv6;
352	} elsif ($af == AF_UNIX) {	434	} elsif (AF_UNIX == address_family $_[0]) {
353	return "unix/"	435	return "unix/"
354	} else {	436	} else {
355	return undef	437	return undef
356	}	438	}
357	}	439	}
…		…
359	*ntoa = \&format_address;	441	*ntoa = \&format_address;
360		442
361	=item inet_aton $name_or_address, $cb->(@addresses)	443	=item inet_aton $name_or_address, $cb->(@addresses)
362		444
363	Works similarly to its Socket counterpart, except that it uses a	445	Works similarly to its Socket counterpart, except that it uses a
364	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
365	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
366	for IPv6).	448	readable format.
367		449
368	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,
369	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
370		467
371	=cut	468	=cut
372		469
373	sub inet_aton {	470	sub inet_aton {
374	my ($name, $cb) = @_;	471	my ($name, $cb) = @_;
…		…
378	} elsif (my $ipn = &parse_ipv6) {	475	} elsif (my $ipn = &parse_ipv6) {
379	$cb->($ipn);	476	$cb->($ipn);
380	} elsif ($name eq "localhost") { # rfc2606 et al.	477	} elsif ($name eq "localhost") { # rfc2606 et al.
381	$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);
382	} else {	479	} else {
383	require AnyEvent::DNS;	480	require AnyEvent::DNS unless $AnyEvent::DNS::VERSION;
384		481
385	# 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;
386	AnyEvent::DNS::a ($name, sub {	495	AnyEvent::DNS::a ($name, sub {
387	if (@_) {	496	$res[$ipv4] = [map { parse_ipv4 $_ } @_];
388	$cb->(map +(parse_ipv4 $_), @_);
389	} else {
390	$cb->();	497	$cv->end;
391	#AnyEvent::DNS::aaaa ($name, $cb); need inet_pton
392	}	498	});
393	});	499	};
394	}
395	}
396		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
397	# check for broken platforms with extra field in sockaddr structure	523	# check for broken platforms with an extra field in sockaddr structure
398	# 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
399	# 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
400	# correctness vs. bsd issue.	526	# correctness vs. bsd issue.)
401	my $pack_family = (0x55 == Socket::sockaddr_family "\x55\x55")	527	my $pack_family = 0x55 == sockaddr_family ("\x55\x55")
402	? "xC" : "S";	528	? "xC" : "S";
403		529
404	=item $sa = AnyEvent::Socket::pack_sockaddr $service, $host	530	=item $sa = AnyEvent::Socket::pack_sockaddr $service, $host
405		531
406	Pack the given port/host combination into a binary sockaddr	532	Pack the given port/host combination into a binary sockaddr
407	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
408	domain sockets (C<$host> == C<unix/> and C<$service> == absolute	534	domain sockets (C<$host> == C<unix/> and C<$service> == absolute
409	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: $!";
410		542
411	=cut	543	=cut
412		544
413	sub pack_sockaddr($$) {	545	sub pack_sockaddr($$) {
414	my $af = address_family $_[1];	546	my $af = address_family $_[1];
…		…
441	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
442	module (C<format_address> converts it to C<unix/>).	574	module (C<format_address> converts it to C<unix/>).
443		575
444	=cut	576	=cut
445		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
446	sub unpack_sockaddr($) {	584	sub unpack_sockaddr($) {
447	my $af = Socket::sockaddr_family $_[0];	585	my $af = sockaddr_family $_[0];
448		586
449	if ($af == AF_INET) {	587	if ($af == AF_INET) {
450	Socket::unpack_sockaddr_in $_[0]	588	Socket::unpack_sockaddr_in $_[0]
451	} elsif ($af == AF_INET6) {	589	} elsif ($af == AF_INET6) {
452	unpack "x2 n x4 a16", $_[0]	590	unpack "x2 n x4 a16", $_[0]
453	} elsif ($af == AF_UNIX) {	591	} elsif ($af == AF_UNIX) {
454	((Socket::unpack_sockaddr_un $_[0]), pack "S", AF_UNIX)	592	((Socket::unpack_sockaddr_un $_[0] ^ $sa_un_zero), pack "S", AF_UNIX)
455	} else {	593	} else {
456	Carp::croak "unpack_sockaddr: unsupported protocol family $af";	594	Carp::croak "unpack_sockaddr: unsupported protocol family $af";
457	}	595	}
458	}	596	}
459		597
…		…
462	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
463	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
464	protocol-independent way. It works remotely similar to the getaddrinfo	602	protocol-independent way. It works remotely similar to the getaddrinfo
465	posix function.	603	posix function.
466		604
467	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
468	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
469	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
470	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
471	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
472	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
473	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.
474		619
475	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
476	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,
477	C<$proto> will be ignored.	622	C<$proto> will be ignored.
478		623
…		…
499		644
500	resolve_sockaddr "google.com", "http", 0, undef, undef, sub { ... };	645	resolve_sockaddr "google.com", "http", 0, undef, undef, sub { ... };
501		646
502	=cut	647	=cut
503		648
504	# microsoft can't even get getprotobyname working (the etc/protocols file	649	our %HOSTS; # $HOSTS{$nodename}[$ipv6] = [@aliases...]
505	# gets lost fairly often on windows), so we have to hardcode some common	650	our @HOSTS_CHECKING; # callbacks to call when hosts have been loaded
506	# protocol numbers ourselves.	651	our $HOSTS_MTIME;
507	our %PROTO_BYNAME;
508		652
509	$PROTO_BYNAME{tcp} = &Socket::IPPROTO_TCP if defined &Socket::IPPROTO_TCP;	653	sub _parse_hosts($) {
510	$PROTO_BYNAME{udp} = &Socket::IPPROTO_UDP if defined &Socket::IPPROTO_UDP;	654	%HOSTS = ();
511	$PROTO_BYNAME{icmp} = &Socket::IPPROTO_ICMP if defined &Socket::IPPROTO_ICMP;	655
		656	for (split /\n/, $_[0]) {
		657	s/#.*$//;
		658	s/^[ \t]+//;
		659	y/A-Z/a-z/;
		660
		661	my ($addr, @aliases) = split /[ \t]+/;
		662	next unless @aliases;
		663
		664	if (my $ip = parse_ipv4 $addr) {
		665	push @{ $HOSTS{$_}[0] }, $ip
		666	for @aliases;
		667	} elsif (my $ip = parse_ipv6 $addr) {
		668	push @{ $HOSTS{$_}[1] }, $ip
		669	for @aliases;
		670	}
		671	}
		672	}
		673
		674	# helper function - unless dns delivered results, check and parse hosts, then clal continuation code
		675	sub _load_hosts_unless(&$@) {
		676	my ($cont, $cv, @dns) = @_;
		677
		678	if (@dns) {
		679	$cv->end;
		680	} else {
		681	my $etc_hosts = length $ENV{PERL_ANYEVENT_HOSTS} ? $ENV{PERL_ANYEVENT_HOSTS}
		682	: AnyEvent::WIN32 ? "$ENV{SystemRoot}/system32/drivers/etc/hosts"
		683	: "/etc/hosts";
		684
		685	push @HOSTS_CHECKING, sub {
		686	$cont->();
		687	$cv->end;
		688	};
		689
		690	unless ($#HOSTS_CHECKING) {
		691	# we are not the first, so we actually have to do the work
		692	require AnyEvent::IO;
		693
		694	AnyEvent::IO::aio_stat ($etc_hosts, sub {
		695	if ((stat _)[9] ne $HOSTS_MTIME) {
		696	AE::log 8 => "(re)loading $etc_hosts.";
		697	$HOSTS_MTIME = (stat _)[9];
		698	# we might load a newer version of hosts,but that's a harmless race,
		699	# as the next call will just load it again.
		700	AnyEvent::IO::aio_load ($etc_hosts, sub {
		701	_parse_hosts $_[0];
		702	(shift @HOSTS_CHECKING)->() while @HOSTS_CHECKING;
		703	});
		704	} else {
		705	(shift @HOSTS_CHECKING)->() while @HOSTS_CHECKING;
		706	}
		707	});
		708	}
		709	}
		710	}
512		711
513	sub resolve_sockaddr($$$$$$) {	712	sub resolve_sockaddr($$$$$$) {
514	my ($node, $service, $proto, $family, $type, $cb) = @_;	713	my ($node, $service, $proto, $family, $type, $cb) = @_;
515		714
516	if ($node eq "unix/") {	715	if ($node eq "unix/") {
…		…
533	$family \|\|= 6 unless $AnyEvent::PROTOCOL{ipv4};	732	$family \|\|= 6 unless $AnyEvent::PROTOCOL{ipv4};
534		733
535	$proto \|\|= "tcp";	734	$proto \|\|= "tcp";
536	$type \|\|= $proto eq "udp" ? SOCK_DGRAM : SOCK_STREAM;	735	$type \|\|= $proto eq "udp" ? SOCK_DGRAM : SOCK_STREAM;
537		736
538	my $proton = $PROTO_BYNAME{lc $proto} \|\| (getprotobyname $proto)[2]	737	my $proton = AnyEvent::Socket::getprotobyname $proto
539	or Carp::croak "$proto: protocol unknown";	738	or Carp::croak "$proto: protocol unknown";
540		739
541	my $port;	740	my $port;
542		741
543	if ($service =~ /^(\S+)=(\d+)$/) {	742	if ($service =~ /^(\S+)=(\d+)$/) {
…		…
547	} else {	746	} else {
548	$port = (getservbyname $service, $proto)[2]	747	$port = (getservbyname $service, $proto)[2]
549	or Carp::croak "$service/$proto: service unknown";	748	or Carp::croak "$service/$proto: service unknown";
550	}	749	}
551		750
552	my @target = [$node, $port];
553
554	# resolve a records / provide sockaddr structures	751	# resolve a records / provide sockaddr structures
555	my $resolve = sub {	752	my $resolve = sub {
		753	my @target = @_;
		754
556	my @res;	755	my @res;
557	my $cv = AnyEvent->condvar (cb => sub {	756	my $cv = AE::cv {
558	$cb->(	757	$cb->(
559	map $_->[2],	758	map $_->[2],
560	sort {	759	sort {
561	$AnyEvent::PROTOCOL{$b->[1]} <=> $AnyEvent::PROTOCOL{$a->[1]}	760	$AnyEvent::PROTOCOL{$b->[1]} <=> $AnyEvent::PROTOCOL{$a->[1]}
562	or $a->[0] <=> $b->[0]	761	or $a->[0] <=> $b->[0]
563	}	762	}
564	@res	763	@res
565	)	764	)
566	});	765	};
567		766
568	$cv->begin;	767	$cv->begin;
569	for my $idx (0 .. $#target) {	768	for my $idx (0 .. $#target) {
570	my ($node, $port) = @{ $target[$idx] };	769	my ($node, $port) = @{ $target[$idx] };
571		770
…		…
580	if ($af == AF_INET6 && $family != 4) {	779	if ($af == AF_INET6 && $family != 4) {
581	push @res, [$idx, "ipv6", [AF_INET6, $type, $proton,	780	push @res, [$idx, "ipv6", [AF_INET6, $type, $proton,
582	pack_sockaddr $port, $noden]]	781	pack_sockaddr $port, $noden]]
583	}	782	}
584	} else {	783	} else {
585	# ipv4	784	$node =~ y/A-Z/a-z/;
		785
		786	my $hosts = $HOSTS{$node};
		787
		788	# a records
586	if ($family != 6) {	789	if ($family != 6) {
587	$cv->begin;	790	$cv->begin;
588	AnyEvent::DNS::a $node, sub {	791	AnyEvent::DNS::a $node, sub {
589	push @res, [$idx, "ipv4", [AF_INET, $type, $proton,	792	push @res, [$idx, "ipv4", [AF_INET , $type, $proton, pack_sockaddr $port, parse_ipv4 $_]]
590	pack_sockaddr $port, parse_ipv4 $_]]
591	for @_;	793	for @_;
		794
		795	# dns takes precedence over hosts
		796	_load_hosts_unless {
		797	push @res,
		798	map [$idx, "ipv4", [AF_INET , $type, $proton, pack_sockaddr $port, $_]],
		799	@{ $HOSTS{$node}[0] };
592	$cv->end;	800	} $cv, @_;
593	};	801	};
594	}	802	}
595		803
596	# ipv6	804	# aaaa records
597	if ($family != 4) {	805	if ($family != 4) {
598	$cv->begin;	806	$cv->begin;
599	AnyEvent::DNS::aaaa $node, sub {	807	AnyEvent::DNS::aaaa $node, sub {
600	push @res, [$idx, "ipv6", [AF_INET6, $type, $proton,	808	push @res, [$idx, "ipv6", [AF_INET6, $type, $proton, pack_sockaddr $port, parse_ipv6 $_]]
601	pack_sockaddr $port, parse_ipv6 $_]]
602	for @_;	809	for @_;
		810
		811	_load_hosts_unless {
		812	push @res,
		813	map [$idx + 0.5, "ipv6", [AF_INET6, $type, $proton, pack_sockaddr $port, $_]],
		814	@{ $HOSTS{$node}[1] }
603	$cv->end;	815	} $cv, @_;
604	};	816	};
605	}	817	}
606	}	818	}
607	}	819	}
608	$cv->end;	820	$cv->end;
609	};	821	};
610		822
		823	$node = AnyEvent::Util::idn_to_ascii $node
		824	if $node =~ /[^\x00-\x7f]/;
		825
611	# try srv records, if applicable	826	# try srv records, if applicable
612	if ($node eq "localhost") {	827	if ($node eq "localhost") {
613	@target = (["127.0.0.1", $port], ["::1", $port]);	828	$resolve->(["127.0.0.1", $port], ["::1", $port]);
614	&$resolve;
615	} elsif (defined $service && !parse_address $node) {	829	} elsif (defined $service && !parse_address $node) {
616	AnyEvent::DNS::srv $service, $proto, $node, sub {	830	AnyEvent::DNS::srv $service, $proto, $node, sub {
617	my (@srv) = @_;	831	my (@srv) = @_;
618		832
619	# no srv records, continue traditionally
620	@srv	833	if (@srv) {
621	or return &$resolve;
622
623	# the only srv record has "." ("" here) => abort	834	# the only srv record has "." ("" here) => abort
624	$srv[0][2] ne "" \|\| $#srv	835	$srv[0][2] ne "" \|\| $#srv
625	or return $cb->();	836	or return $cb->();
626		837
627	# use srv records then	838	# use srv records then
		839	$resolve->(
628	@target = map ["$_->[3].", $_->[2]],	840	map ["$_->[3].", $_->[2]],
629	grep $_->[3] ne ".",	841	grep $_->[3] ne ".",
630	@srv;	842	@srv
631		843	);
632	&$resolve;	844	} else {
		845	# no srv records, continue traditionally
		846	$resolve->([$node, $port]);
		847	}
633	};	848	};
634	} else {	849	} else {
635	&$resolve;	850	# most common case
		851	$resolve->([$node, $port]);
636	}	852	}
637	}	853	}
638		854
639	=item $guard = tcp_connect $host, $service, $connect_cb[, $prepare_cb]	855	=item $guard = tcp_connect $host, $service, $connect_cb[, $prepare_cb]
640		856
641	This is a convenience function that creates a TCP socket and makes a 100%	857	This is a convenience function that creates a TCP socket and makes a
642	non-blocking connect to the given C<$host> (which can be a hostname or	858	100% non-blocking connect to the given C<$host> (which can be a DNS/IDN
643	a textual IP address, or the string C<unix/> for UNIX domain sockets)	859	hostname or a textual IP address, or the string C<unix/> for UNIX domain
644	and C<$service> (which can be a numeric port number or a service name,	860	sockets) and C<$service> (which can be a numeric port number or a service
645	or a C<servicename=portnumber> string, or the pathname to a UNIX domain	861	name, or a C<servicename=portnumber> string, or the pathname to a UNIX
646	socket).	862	domain socket).
647		863
648	If both C<$host> and C<$port> are names, then this function will use SRV	864	If both C<$host> and C<$port> are names, then this function will use SRV
649	records to locate the real target(s).	865	records to locate the real target(s).
650		866
651	In either case, it will create a list of target hosts (e.g. for multihomed	867	In either case, it will create a list of target hosts (e.g. for multihomed
652	hosts or hosts with both IPv4 and IPv6 addresses) and try to connect to	868	hosts or hosts with both IPv4 and IPv6 addresses) and try to connect to
653	each in turn.	869	each in turn.
654		870
655	If the connect is successful, then the C<$connect_cb> will be invoked with	871	After the connection is established, then the C<$connect_cb> will be
656	the socket file handle (in non-blocking mode) as first and the peer host	872	invoked with the socket file handle (in non-blocking mode) as first, and
657	(as a textual IP address) and peer port as second and third arguments,	873	the peer host (as a textual IP address) and peer port as second and third
658	respectively. The fourth argument is a code reference that you can call	874	arguments, respectively. The fourth argument is a code reference that you
659	if, for some reason, you don't like this connection, which will cause	875	can call if, for some reason, you don't like this connection, which will
660	C<tcp_connect> to try the next one (or call your callback without any	876	cause C<tcp_connect> to try the next one (or call your callback without
661	arguments if there are no more connections). In most cases, you can simply	877	any arguments if there are no more connections). In most cases, you can
662	ignore this argument.	878	simply ignore this argument.
663		879
664	$cb->($filehandle, $host, $port, $retry)	880	$cb->($filehandle, $host, $port, $retry)
665		881
666	If the connect is unsuccessful, then the C<$connect_cb> will be invoked	882	If the connect is unsuccessful, then the C<$connect_cb> will be invoked
667	without any arguments and C<$!> will be set appropriately (with C<ENXIO>	883	without any arguments and C<$!> will be set appropriately (with C<ENXIO>
668	indicating a DNS resolution failure).	884	indicating a DNS resolution failure).
669		885
		886	The callback will I<never> be invoked before C<tcp_connect> returns, even
		887	if C<tcp_connect> was able to connect immediately (e.g. on unix domain
		888	sockets).
		889
670	The file handle is perfect for being plugged into L<AnyEvent::Handle>, but	890	The file handle is perfect for being plugged into L<AnyEvent::Handle>, but
671	can be used as a normal perl file handle as well.	891	can be used as a normal perl file handle as well.
672		892
673	Unless called in void context, C<tcp_connect> returns a guard object that	893	Unless called in void context, C<tcp_connect> returns a guard object that
674	will automatically abort connecting when it gets destroyed (it does not do	894	will automatically cancel the connection attempt when it gets destroyed
		895	- in which case the callback will not be invoked. Destroying it does not
675	anything to the socket after the connect was successful).	896	do anything to the socket after the connect was successful - you cannot
		897	"uncall" a callback that has been invoked already.
676		898
677	Sometimes you need to "prepare" the socket before connecting, for example,	899	Sometimes you need to "prepare" the socket before connecting, for example,
678	to C<bind> it to some port, or you want a specific connect timeout that	900	to C<bind> it to some port, or you want a specific connect timeout that
679	is lower than your kernel's default timeout. In this case you can specify	901	is lower than your kernel's default timeout. In this case you can specify
680	a second callback, C<$prepare_cb>. It will be called with the file handle	902	a second callback, C<$prepare_cb>. It will be called with the file handle
…		…
713		935
714	my $handle; # avoid direct assignment so on_eof has it in scope.	936	my $handle; # avoid direct assignment so on_eof has it in scope.
715	$handle = new AnyEvent::Handle	937	$handle = new AnyEvent::Handle
716	fh => $fh,	938	fh => $fh,
717	on_error => sub {	939	on_error => sub {
718	warn "error $_[2]\n";	940	AE::log error => $_[2];
719	$_[0]->destroy;	941	$_[0]->destroy;
720	},	942	},
721	on_eof => sub {	943	on_eof => sub {
722	$handle->destroy; # destroy handle	944	$handle->destroy; # destroy handle
723	warn "done.\n";	945	AE::log info => "Done.";
724	};	946	};
725		947
726	$handle->push_write ("GET / HTTP/1.0\015\012\015\012");	948	$handle->push_write ("GET / HTTP/1.0\015\012\015\012");
727		949
728	$handle->push_read_line ("\015\012\015\012", sub {	950	$handle->push_read (line => "\015\012\015\012", sub {
729	my ($handle, $line) = @_;	951	my ($handle, $line) = @_;
730		952
731	# print response header	953	# print response header
732	print "HEADER\n$line\n\nBODY\n";	954	print "HEADER\n$line\n\nBODY\n";
733		955
…		…
753	=cut	975	=cut
754		976
755	sub tcp_connect($$$;$) {	977	sub tcp_connect($$$;$) {
756	my ($host, $port, $connect, $prepare) = @_;	978	my ($host, $port, $connect, $prepare) = @_;
757		979
758	# see http://cr.yp.to/docs/connect.html for some background	980	# see http://cr.yp.to/docs/connect.html for some tricky aspects
759	# also http://advogato.org/article/672.html	981	# also http://advogato.org/article/672.html
760		982
761	my %state = ( fh => undef );	983	my %state = ( fh => undef );
762		984
763	# name/service to type/sockaddr resolution	985	# name/service to type/sockaddr resolution
…		…
765	my @target = @_;	987	my @target = @_;
766		988
767	$state{next} = sub {	989	$state{next} = sub {
768	return unless exists $state{fh};	990	return unless exists $state{fh};
769		991
		992	my $errno = $!;
770	my $target = shift @target	993	my $target = shift @target
771	or do {	994	or return AE::postpone {
		995	return unless exists $state{fh};
772	%state = ();	996	%state = ();
		997	$! = $errno;
773	return $connect->();	998	$connect->();
774	};	999	};
775		1000
776	my ($domain, $type, $proto, $sockaddr) = @$target;	1001	my ($domain, $type, $proto, $sockaddr) = @$target;
777		1002
778	# socket creation	1003	# socket creation
…		…
783		1008
784	my $timeout = $prepare && $prepare->($state{fh});	1009	my $timeout = $prepare && $prepare->($state{fh});
785		1010
786	$timeout \|\|= 30 if AnyEvent::WIN32;	1011	$timeout \|\|= 30 if AnyEvent::WIN32;
787		1012
788	$state{to} = AnyEvent->timer (after => $timeout, cb => sub {	1013	$state{to} = AE::timer $timeout, 0, sub {
789	$! = Errno::ETIMEDOUT;	1014	$! = Errno::ETIMEDOUT;
790	$state{next}();	1015	$state{next}();
791	}) if $timeout;	1016	} if $timeout;
792		1017
793	# called when the connect was successful, which,	1018	# now connect
794	# in theory, could be the case immediately (but never is in practise)	1019	if (
795	$state{connected} = sub {	1020	(connect $state{fh}, $sockaddr)
		1021	\|\| ($! == Errno::EINPROGRESS # POSIX
		1022	\|\| $! == Errno::EWOULDBLOCK
		1023	# WSAEINPROGRESS intentionally not checked - it means something else entirely
		1024	\|\| $! == AnyEvent::Util::WSAEINVAL # not convinced, but doesn't hurt
		1025	\|\| $! == AnyEvent::Util::WSAEWOULDBLOCK)
		1026	) {
		1027	$state{ww} = AE::io $state{fh}, 1, sub {
796	# we are connected, or maybe there was an error	1028	# we are connected, or maybe there was an error
797	if (my $sin = getpeername $state{fh}) {	1029	if (my $sin = getpeername $state{fh}) {
798	my ($port, $host) = unpack_sockaddr $sin;	1030	my ($port, $host) = unpack_sockaddr $sin;
799		1031
800	delete $state{ww}; delete $state{to};	1032	delete $state{ww}; delete $state{to};
801		1033
802	my $guard = guard { %state = () };	1034	my $guard = guard { %state = () };
803		1035
804	$connect->(delete $state{fh}, format_address $host, $port, sub {	1036	$connect->(delete $state{fh}, format_address $host, $port, sub {
805	$guard->cancel;	1037	$guard->cancel;
		1038	$state{next}();
		1039	});
		1040	} else {
		1041	if ($! == Errno::ENOTCONN) {
		1042	# dummy read to fetch real error code if !cygwin
		1043	sysread $state{fh}, my $buf, 1;
		1044
		1045	# cygwin 1.5 continously reports "ready' but never delivers
		1046	# an error with getpeername or sysread.
		1047	# cygwin 1.7 only reports readyness once, but is otherwise
		1048	# the same, which is actually more broken.
		1049	# Work around both by using unportable SO_ERROR for cygwin.
		1050	$! = (unpack "l", getsockopt $state{fh}, Socket::SOL_SOCKET(), Socket::SO_ERROR()) \|\| Errno::EAGAIN
		1051	if AnyEvent::CYGWIN && $! == Errno::EAGAIN;
		1052	}
		1053
		1054	return if $! == Errno::EAGAIN; # skip spurious wake-ups
		1055
		1056	delete $state{ww}; delete $state{to};
		1057
806	$state{next}();	1058	$state{next}();
807	});	1059	}
808	} else {
809	# dummy read to fetch real error code
810	sysread $state{fh}, my $buf, 1 if $! == Errno::ENOTCONN;
811
812	return if $! == Errno::EAGAIN; # skip spurious wake-ups
813
814	delete $state{ww}; delete $state{to};
815
816	$state{next}();
817	}	1060	};
818	};
819
820	# now connect
821	if (connect $state{fh}, $sockaddr) {
822	$state{connected}->();
823	} elsif ($! == Errno::EINPROGRESS # POSIX
824	\|\| $! == Errno::EWOULDBLOCK
825	# WSAEINPROGRESS intentionally not checked - it means something else entirely
826	\|\| $! == AnyEvent::Util::WSAEINVAL # not convinced, but doesn't hurt
827	\|\| $! == AnyEvent::Util::WSAEWOULDBLOCK) {
828	$state{ww} = AnyEvent->io (fh => $state{fh}, poll => 'w', cb => $state{connected});
829	} else {	1061	} else {
830	$state{next}();	1062	$state{next}();
831	}	1063	}
832	};	1064	};
833		1065
…		…
838	defined wantarray && guard { %state = () }	1070	defined wantarray && guard { %state = () }
839	}	1071	}
840		1072
841	=item $guard = tcp_server $host, $service, $accept_cb[, $prepare_cb]	1073	=item $guard = tcp_server $host, $service, $accept_cb[, $prepare_cb]
842		1074
843	Create and bind a stream socket to the given host, and port, set the	1075	Create and bind a stream socket to the given host address and port, set
844	SO_REUSEADDR flag (if applicable) and call C<listen>. Unlike the name	1076	the SO_REUSEADDR flag (if applicable) and call C<listen>. Unlike the name
845	implies, this function can also bind on UNIX domain sockets.	1077	implies, this function can also bind on UNIX domain sockets.
846		1078
847	For internet sockets, C<$host> must be an IPv4 or IPv6 address (or	1079	For internet sockets, C<$host> must be an IPv4 or IPv6 address (or
848	C<undef>, in which case it binds either to C<0> or to C<::>, depending	1080	C<undef>, in which case it binds either to C<0> or to C<::>, depending
849	on whether IPv4 or IPv6 is the preferred protocol, and maybe to both in	1081	on whether IPv4 or IPv6 is the preferred protocol, and maybe to both in
850	future versions, as applicable).	1082	future versions, as applicable).
851		1083
852	To bind to the IPv4 wildcard address, use C<0>, to bind to the IPv6	1084	To bind to the IPv4 wildcard address, use C<0>, to bind to the IPv6
853	wildcard address, use C<::>.	1085	wildcard address, use C<::>.
854		1086
855	The port is specified by C<$service>, which must be either a service name or	1087	The port is specified by C<$service>, which must be either a service name
856	a numeric port number (or C<0> or C<undef>, in which case an ephemeral	1088	or a numeric port number (or C<0> or C<undef>, in which case an ephemeral
857	port will be used).	1089	port will be used).
858		1090
859	For UNIX domain sockets, C<$host> must be C<unix/> and C<$service> must be	1091	For UNIX domain sockets, C<$host> must be C<unix/> and C<$service> must be
860	the absolute pathname of the socket. This function will try to C<unlink>	1092	the absolute pathname of the socket. This function will try to C<unlink>
861	the socket before it tries to bind to it. See SECURITY CONSIDERATIONS,	1093	the socket before it tries to bind to it, and will try to unlink it after
862	below.	1094	it stops using it. See SECURITY CONSIDERATIONS, below.
863		1095
864	For each new connection that could be C<accept>ed, call the C<<	1096	For each new connection that could be C<accept>ed, call the C<<
865	$accept_cb->($fh, $host, $port) >> with the file handle (in non-blocking	1097	$accept_cb->($fh, $host, $port) >> with the file handle (in non-blocking
866	mode) as first and the peer host and port as second and third arguments	1098	mode) as first, and the peer host and port as second and third arguments
867	(see C<tcp_connect> for details).	1099	(see C<tcp_connect> for details).
868		1100
869	Croaks on any errors it can detect before the listen.	1101	Croaks on any errors it can detect before the listen.
870		1102
871	If called in non-void context, then this function returns a guard object	1103	If called in non-void context, then this function returns a guard object
872	whose lifetime it tied to the TCP server: If the object gets destroyed,	1104	whose lifetime it tied to the TCP server: If the object gets destroyed,
873	the server will be stopped (but existing accepted connections will	1105	the server will be stopped (but existing accepted connections will
874	continue).	1106	not be affected).
		1107
		1108	Regardless, when the function returns to the caller, the socket is bound
		1109	and in listening state.
875		1110
876	If you need more control over the listening socket, you can provide a	1111	If you need more control over the listening socket, you can provide a
877	C<< $prepare_cb->($fh, $host, $port) >>, which is called just before the	1112	C<< $prepare_cb->($fh, $host, $port) >>, which is called just before the
878	C<listen ()> call, with the listen file handle as first argument, and IP	1113	C<listen ()> call, with the listen file handle as first argument, and IP
879	address and port number of the local socket endpoint as second and third	1114	address and port number of the local socket endpoint as second and third
…		…
895	my ($fh, $host, $port) = @_;	1130	my ($fh, $host, $port) = @_;
896		1131
897	syswrite $fh, "The internet is full, $host:$port. Go away!\015\012";	1132	syswrite $fh, "The internet is full, $host:$port. Go away!\015\012";
898	}, sub {	1133	}, sub {
899	my ($fh, $thishost, $thisport) = @_;	1134	my ($fh, $thishost, $thisport) = @_;
900	warn "bound to $thishost, port $thisport\n";	1135	AE::log info => "Bound to $thishost, port $thisport.";
901	};	1136	};
902		1137
903	Example: bind a server on a unix domain socket.	1138	Example: bind a server on a unix domain socket.
904		1139
905	tcp_server "unix/", "/tmp/mydir/mysocket", sub {	1140	tcp_server "unix/", "/tmp/mydir/mysocket", sub {
…		…
943	}	1178	}
944		1179
945	bind $state{fh}, pack_sockaddr $service, $ipn	1180	bind $state{fh}, pack_sockaddr $service, $ipn
946	or Carp::croak "bind: $!";	1181	or Carp::croak "bind: $!";
947		1182
		1183	if ($af == AF_UNIX) {
		1184	my $fh = $state{fh};
		1185	my $ino = (stat $fh)[1];
		1186	$state{unlink} = guard {
		1187	# this is racy, but is not designed to be foolproof, just best-effort
		1188	unlink $service
		1189	if $ino == (stat $fh)[1];
		1190	};
		1191	}
		1192
948	fh_nonblocking $state{fh}, 1;	1193	fh_nonblocking $state{fh}, 1;
949		1194
950	my $len;	1195	my $len;
951		1196
952	if ($prepare) {	1197	if ($prepare) {
…		…
957	$len \|\|= 128;	1202	$len \|\|= 128;
958		1203
959	listen $state{fh}, $len	1204	listen $state{fh}, $len
960	or Carp::croak "listen: $!";	1205	or Carp::croak "listen: $!";
961		1206
962	$state{aw} = AnyEvent->io (fh => $state{fh}, poll => 'r', cb => sub {	1207	$state{aw} = AE::io $state{fh}, 0, sub {
963	# this closure keeps $state alive	1208	# this closure keeps $state alive
964	while (my $peer = accept my $fh, $state{fh}) {	1209	while ($state{fh} && (my $peer = accept my $fh, $state{fh})) {
965	fh_nonblocking $fh, 1; # POSIX requires inheritance, the outside world does not	1210	fh_nonblocking $fh, 1; # POSIX requires inheritance, the outside world does not
966		1211
967	my ($service, $host) = unpack_sockaddr $peer;	1212	my ($service, $host) = unpack_sockaddr $peer;
968	$accept->($fh, format_address $host, $service);	1213	$accept->($fh, format_address $host, $service);
969	}	1214	}
970	});	1215	};
971		1216
972	defined wantarray	1217	defined wantarray
973	? guard { %state = () } # clear fh and watcher, which breaks the circular dependency	1218	? guard { %state = () } # clear fh and watcher, which breaks the circular dependency
974	: ()	1219	: ()
975	}	1220	}
976		1221
977	1;	1222	=item tcp_nodelay $fh, $enable
		1223
		1224	Enables (or disables) the C<TCP_NODELAY> socket option (also known as
		1225	Nagle's algorithm). Returns false on error, true otherwise.
		1226
		1227	=cut
		1228
		1229	sub tcp_nodelay($$) {
		1230	my $onoff = int ! ! $_[1];
		1231
		1232	setsockopt $_[0], Socket::IPPROTO_TCP (), Socket::TCP_NODELAY (), $onoff
		1233	}
		1234
		1235	=item tcp_congestion $fh, $algorithm
		1236
		1237	Sets the tcp congestion avoidance algorithm (via the C<TCP_CONGESTION>
		1238	socket option). The default is OS-specific, but is usually
		1239	C<reno>. Typical other available choices include C<cubic>, C<lp>, C<bic>,
		1240	C<highspeed>, C<htcp>, C<hybla>, C<illinois>, C<scalable>, C<vegas>,
		1241	C<veno>, C<westwood> and C<yeah>.
		1242
		1243	=cut
		1244
		1245	sub tcp_congestion($$) {
		1246	defined TCP_CONGESTION
		1247	? setsockopt $_[0], Socket::IPPROTO_TCP (), TCP_CONGESTION, "$_[1]"
		1248	: undef
		1249	}
978		1250
979	=back	1251	=back
980		1252
981	=head1 SECURITY CONSIDERATIONS	1253	=head1 SECURITY CONSIDERATIONS
982		1254
…		…
988	harmful in general.	1260	harmful in general.
989		1261
990	=head1 AUTHOR	1262	=head1 AUTHOR
991		1263
992	Marc Lehmann <schmorp@schmorp.de>	1264	Marc Lehmann <schmorp@schmorp.de>
993	http://home.schmorp.de/	1265	http://anyevent.schmorp.de
994		1266
995	=cut	1267	=cut
996		1268
		1269	1
		1270

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Socket.pm (file contents): Revision 1.91 by root, Thu Jul 16 04:20:24 2009 UTC vs. Revision 1.157 by root, Wed Oct 31 15:42:06 2012 UTC

Diff Legend

Comparing AnyEvent/lib/AnyEvent/Socket.pm (file contents):
Revision 1.91 by root, Thu Jul 16 04:20:24 2009 UTC vs.
Revision 1.157 by root, Wed Oct 31 15:42:06 2012 UTC