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

Comparing AnyEvent/lib/AnyEvent/Socket.pm (file contents):
Revision 1.98 by root, Mon Jul 20 22:39:57 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
45		45
46	use base 'Exporter';	46	use base 'Exporter';
47		47
48	our @EXPORT = qw(	48	our @EXPORT = qw(
49	getprotobyname	49	getprotobyname
50	parse_hostport	50	parse_hostport format_hostport
51	parse_ipv4 parse_ipv6	51	parse_ipv4 parse_ipv6
52	parse_ip parse_address	52	parse_ip parse_address
53	format_ipv4 format_ipv6	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 = 4.86;	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
…		…
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
…		…
156	socket".	172	socket".
157		173
158	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>),
159	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
160	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
161		182
162	=item $ipn = AnyEvent::Socket::aton $ip	183	=item $ipn = AnyEvent::Socket::aton $ip
163		184
164	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
165	I<without> name resolution).	186	I<without> name resolution).
…		…
183		204
184	Works like the builtin function of the same name, except it tries hard to	205	Works like the builtin function of the same name, except it tries hard to
185	work even on broken platforms (well, that's windows), where getprotobyname	206	work even on broken platforms (well, that's windows), where getprotobyname
186	is traditionally very unreliable.	207	is traditionally very unreliable.
187		208
		209	Example: get the protocol number for TCP (usually 6)
		210
		211	my $proto = getprotobyname "tcp";
		212
188	=cut	213	=cut
189		214
190	# microsoft can't even get getprotobyname working (the etc/protocols file	215	# microsoft can't even get getprotobyname working (the etc/protocols file
191	# gets lost fairly often on windows), so we have to hardcode some common	216	# gets lost fairly often on windows), so we have to hardcode some common
192	# protocol numbers ourselves.	217	# protocol numbers ourselves.
…		…
210	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
211	problem. Unfortunately, just splitting on the colon makes it hard to	236	problem. Unfortunately, just splitting on the colon makes it hard to
212	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
213	standardised C<[ip literal]> syntax.	238	standardised C<[ip literal]> syntax.
214		239
215	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
216	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
217	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
218	parts are optional. Also, everywhere where an IP address is supported	243	C<:port> parts are optional. Also, everywhere where an IP address is
219	a hostname or unix domain socket address is also supported (see	244	supported a hostname or unix domain socket address is also supported (see
220	C<parse_unix>).	245	C<parse_unix>), and strings starting with C</> will also be interpreted as
		246	unix domain sockets.
221		247
222	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",
223	ipv4:port e.g. "198.182.196.56", "127.1:22"	249	ipv4:port e.g. "198.182.196.56", "127.1:22"
224	ipv6 e.g. "::1", "affe::1"	250	ipv6 e.g. "::1", "affe::1"
225	[ipv4or6]:port e.g. "[::1]", "[10.0.1]:80"	251	[ipv4or6]:port e.g. "[::1]", "[10.0.1]:80"
226	[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"
227	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"
228		256
229	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
230	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
231	detected nor a default was specified, then this function returns the	259	detected nor a default was specified, then this function returns the
232	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
233	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).
234		262
235	Example:	263	Example:
236		264
237	print join ",", parse_hostport "localhost:443";	265	print join ",", parse_hostport "localhost:443";
…		…
241	# => "localhost,https"	269	# => "localhost,https"
242		270
243	print join ",", parse_hostport "[::1]";	271	print join ",", parse_hostport "[::1]";
244	# => "," (empty list)	272	# => "," (empty list)
245		273
		274	print join ",", parse_host_port "/tmp/debug.sock";
		275	# => "unix/", "/tmp/debug.sock"
		276
246	=cut	277	=cut
247		278
248	sub parse_hostport($;$) {	279	sub parse_hostport($;$) {
249	my ($host, $port);	280	my ($host, $port);
250		281
251	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
252		283
		284	# shortcut for /path
		285	return ("unix/", $_)
		286	if m%^/%;
		287
253	# parse host, special cases: "ipv6" or "ipv6 port"	288	# parse host, special cases: "ipv6" or "ipv6[#p ]port"
254	unless (	289	unless (
255	($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
256	and parse_ipv6 $host	291	and parse_ipv6 $host
257	) {	292	) {
258	/^\s*/xgc;	293	/^\s*/xgc;
…		…
265	return;	300	return;
266	}	301	}
267	}	302	}
268		303
269	# parse port	304	# parse port
270	if (/\G (?:\s+\|:) ([^:[:space:]]+) \s*$/xgc) {	305	if (/\G (?:\s+\|:\|\#) ([^:[:space:]]+) \s*$/xgc) {
271	$port = $1;	306	$port = $1;
272	} elsif (/\G\s*$/gc && length $_[1]) {	307	} elsif (/\G\s*$/gc && length $_[1]) {
273	$port = $_[1];	308	$port = $_[1];
274	} else {	309	} else {
275	return;	310	return;
276	}	311	}
		312
277	}	313	}
278		314
279	# hostnames must not contain :'s	315	# hostnames must not contain :'s
280	return if $host =~ /:/ && !parse_ipv6 $host;	316	return if $host =~ /:/ && !parse_ipv6 $host;
281		317
282	($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"
283	}	335	}
284		336
285	=item $sa_family = address_family $ipn	337	=item $sa_family = address_family $ipn
286		338
287	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 :)
…		…
323		375
324	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
325	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
326	have to call C<format_ipv6> manually.	378	have to call C<format_ipv6> manually.
327		379
		380	Example:
		381
		382	print format_address "\x01\x02\x03\x05";
		383	=> 1.2.3.5
		384
328	=item $text = AnyEvent::Socket::ntoa $ipn	385	=item $text = AnyEvent::Socket::ntoa $ipn
329		386
330	Same as format_address, but not exported (think C<inet_ntoa>).	387	Same as format_address, but not exported (think C<inet_ntoa>).
331		388
332	=cut	389	=cut
…		…
334	sub format_ipv4($) {	391	sub format_ipv4($) {
335	join ".", unpack "C4", $_[0]	392	join ".", unpack "C4", $_[0]
336	}	393	}
337		394
338	sub format_ipv6($) {	395	sub format_ipv6($) {
		396	if ($_[0] =~ /^\x00\x00\x00\x00\x00\x00\x00\x00/) {
339	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]) {
340	return "::";	398	return "::";
341	} 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]) {
342	return "::1";	400	return "::1";
343	} 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) {
344	# v4compatible	402	# v4compatible
345	return "::" . format_ipv4 substr $_[0], 12;	403	return "::" . format_ipv4 substr $_[0], 12;
346	} 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) {
347	# v4mapped	405	# v4mapped
348	return "::ffff:" . format_ipv4 substr $_[0], 12;	406	return "::ffff:" . format_ipv4 substr $_[0], 12;
349	} 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) {
350	# v4translated	408	# v4translated
351	return "::ffff:0:" . format_ipv4 substr $_[0], 12;	409	return "::ffff:0:" . format_ipv4 substr $_[0], 12;
352	} else {	410	}
		411	}
		412
353	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];
354		414
355	# this is rather sucky, I admit	415	# this is admittedly rather sucky
356	$ip =~ s/^0:(?:0:)*(0$)?/::/	416	$ip =~ s/(?:^\|:) 0:0:0:0:0:0:0 (?:$\|:)/::/x
357	or $ip =~ s/(:0){7}$/::/ or $ip =~ s/(:0){7}/:/	417	or $ip =~ s/(?:^\|:) 0:0:0:0:0:0 (?:$\|:)/::/x
358	or $ip =~ s/(:0){6}$/::/ or $ip =~ s/(:0){6}/:/	418	or $ip =~ s/(?:^\|:) 0:0:0:0:0 (?:$\|:)/::/x
359	or $ip =~ s/(:0){5}$/::/ or $ip =~ s/(:0){5}/:/	419	or $ip =~ s/(?:^\|:) 0:0:0:0 (?:$\|:)/::/x
360	or $ip =~ s/(:0){4}$/::/ or $ip =~ s/(:0){4}/:/	420	or $ip =~ s/(?:^\|:) 0:0:0 (?:$\|:)/::/x
361	or $ip =~ s/(:0){3}$/::/ or $ip =~ s/(:0){3}/:/	421	or $ip =~ s/(?:^\|:) 0:0 (?:$\|:)/::/x
362	or $ip =~ s/(:0){2}$/::/ or $ip =~ s/(:0){2}/:/	422	or $ip =~ s/(?:^\|:) 0 (?:$\|:)/::/x;
363	or $ip =~ s/(:0){1}$/::/ or $ip =~ s/(:0){1}/:/;	423
364	return $ip	424	$ip
365	}
366	}	425	}
367		426
368	sub format_address($) {	427	sub format_address($) {
369	my $af = address_family $_[0];	428	if (4 == length $_[0]) {
370	if ($af == AF_INET) {
371	return &format_ipv4;	429	return &format_ipv4;
372	} elsif ($af == AF_INET6) {	430	} elsif (16 == length $_[0]) {
373	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
374	? format_ipv4 substr $_[0], 12	432	? format_ipv4 $1
375	: &format_ipv6;	433	: &format_ipv6;
376	} elsif ($af == AF_UNIX) {	434	} elsif (AF_UNIX == address_family $_[0]) {
377	return "unix/"	435	return "unix/"
378	} else {	436	} else {
379	return undef	437	return undef
380	}	438	}
381	}	439	}
…		…
383	*ntoa = \&format_address;	441	*ntoa = \&format_address;
384		442
385	=item inet_aton $name_or_address, $cb->(@addresses)	443	=item inet_aton $name_or_address, $cb->(@addresses)
386		444
387	Works similarly to its Socket counterpart, except that it uses a	445	Works similarly to its Socket counterpart, except that it uses a
388	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
389	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
390	for IPv6).	448	readable format.
391		449
392	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,
393	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
394		467
395	=cut	468	=cut
396		469
397	sub inet_aton {	470	sub inet_aton {
398	my ($name, $cb) = @_;	471	my ($name, $cb) = @_;
…		…
402	} elsif (my $ipn = &parse_ipv6) {	475	} elsif (my $ipn = &parse_ipv6) {
403	$cb->($ipn);	476	$cb->($ipn);
404	} elsif ($name eq "localhost") { # rfc2606 et al.	477	} elsif ($name eq "localhost") { # rfc2606 et al.
405	$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);
406	} else {	479	} else {
407	require AnyEvent::DNS;	480	require AnyEvent::DNS unless $AnyEvent::DNS::VERSION;
408		481
409	# 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;
410	AnyEvent::DNS::a ($name, sub {	495	AnyEvent::DNS::a ($name, sub {
411	if (@_) {	496	$res[$ipv4] = [map { parse_ipv4 $_ } @_];
412	$cb->(map +(parse_ipv4 $_), @_);
413	} else {
414	$cb->();	497	$cv->end;
415	#AnyEvent::DNS::aaaa ($name, $cb); need inet_pton
416	}	498	});
417	});	499	};
		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;
418	}	510	}
419	}	511	}
420		512
421	BEGIN {	513	BEGIN {
422	*sockaddr_family = $Socket::VERSION >= 1.75	514	*sockaddr_family = $Socket::VERSION >= 1.75
…		…
426	\| eval { Socket::pack_sockaddr_un "U" }) =~ /^\x00/	518	\| eval { Socket::pack_sockaddr_un "U" }) =~ /^\x00/
427	? sub { unpack "xC", $_[0] }	519	? sub { unpack "xC", $_[0] }
428	: sub { unpack "S" , $_[0] };	520	: sub { unpack "S" , $_[0] };
429	}	521	}
430		522
431	# check for broken platforms with extra field in sockaddr structure	523	# check for broken platforms with an extra field in sockaddr structure
432	# 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
433	# 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
434	# correctness vs. bsd issue.)	526	# correctness vs. bsd issue.)
435	my $pack_family = 0x55 == sockaddr_family ("\x55\x55")	527	my $pack_family = 0x55 == sockaddr_family ("\x55\x55")
436	? "xC" : "S";	528	? "xC" : "S";
…		…
439		531
440	Pack the given port/host combination into a binary sockaddr	532	Pack the given port/host combination into a binary sockaddr
441	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
442	domain sockets (C<$host> == C<unix/> and C<$service> == absolute	534	domain sockets (C<$host> == C<unix/> and C<$service> == absolute
443	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: $!";
444		542
445	=cut	543	=cut
446		544
447	sub pack_sockaddr($$) {	545	sub pack_sockaddr($$) {
448	my $af = address_family $_[1];	546	my $af = address_family $_[1];
…		…
475	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
476	module (C<format_address> converts it to C<unix/>).	574	module (C<format_address> converts it to C<unix/>).
477		575
478	=cut	576	=cut
479		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
480	sub unpack_sockaddr($) {	584	sub unpack_sockaddr($) {
481	my $af = sockaddr_family $_[0];	585	my $af = sockaddr_family $_[0];
482		586
483	if ($af == AF_INET) {	587	if ($af == AF_INET) {
484	Socket::unpack_sockaddr_in $_[0]	588	Socket::unpack_sockaddr_in $_[0]
485	} elsif ($af == AF_INET6) {	589	} elsif ($af == AF_INET6) {
486	unpack "x2 n x4 a16", $_[0]	590	unpack "x2 n x4 a16", $_[0]
487	} elsif ($af == AF_UNIX) {	591	} elsif ($af == AF_UNIX) {
488	((Socket::unpack_sockaddr_un $_[0]), pack "S", AF_UNIX)	592	((Socket::unpack_sockaddr_un $_[0] ^ $sa_un_zero), pack "S", AF_UNIX)
489	} else {	593	} else {
490	Carp::croak "unpack_sockaddr: unsupported protocol family $af";	594	Carp::croak "unpack_sockaddr: unsupported protocol family $af";
491	}	595	}
492	}	596	}
493		597
…		…
496	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
497	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
498	protocol-independent way. It works remotely similar to the getaddrinfo	602	protocol-independent way. It works remotely similar to the getaddrinfo
499	posix function.	603	posix function.
500		604
501	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
502	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
503	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
504	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
505	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
506	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
507	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.
508		619
509	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
510	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,
511	C<$proto> will be ignored.	622	C<$proto> will be ignored.
512		623
…		…
533		644
534	resolve_sockaddr "google.com", "http", 0, undef, undef, sub { ... };	645	resolve_sockaddr "google.com", "http", 0, undef, undef, sub { ... };
535		646
536	=cut	647	=cut
537		648
		649	our %HOSTS; # $HOSTS{$nodename}[$ipv6] = [@aliases...]
		650	our @HOSTS_CHECKING; # callbacks to call when hosts have been loaded
		651	our $HOSTS_MTIME;
		652
		653	sub _parse_hosts($) {
		654	%HOSTS = ();
		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	}
		711
538	sub resolve_sockaddr($$$$$$) {	712	sub resolve_sockaddr($$$$$$) {
539	my ($node, $service, $proto, $family, $type, $cb) = @_;	713	my ($node, $service, $proto, $family, $type, $cb) = @_;
540		714
541	if ($node eq "unix/") {	715	if ($node eq "unix/") {
542	return $cb->() if $family \|\| $service !~ /^\//; # no can do	716	return $cb->() if $family \|\| $service !~ /^\//; # no can do
…		…
558	$family \|\|= 6 unless $AnyEvent::PROTOCOL{ipv4};	732	$family \|\|= 6 unless $AnyEvent::PROTOCOL{ipv4};
559		733
560	$proto \|\|= "tcp";	734	$proto \|\|= "tcp";
561	$type \|\|= $proto eq "udp" ? SOCK_DGRAM : SOCK_STREAM;	735	$type \|\|= $proto eq "udp" ? SOCK_DGRAM : SOCK_STREAM;
562		736
563	my $proton = getprotobyname $proto	737	my $proton = AnyEvent::Socket::getprotobyname $proto
564	or Carp::croak "$proto: protocol unknown";	738	or Carp::croak "$proto: protocol unknown";
565		739
566	my $port;	740	my $port;
567		741
568	if ($service =~ /^(\S+)=(\d+)$/) {	742	if ($service =~ /^(\S+)=(\d+)$/) {
…		…
572	} else {	746	} else {
573	$port = (getservbyname $service, $proto)[2]	747	$port = (getservbyname $service, $proto)[2]
574	or Carp::croak "$service/$proto: service unknown";	748	or Carp::croak "$service/$proto: service unknown";
575	}	749	}
576		750
577	my @target = [$node, $port];
578
579	# resolve a records / provide sockaddr structures	751	# resolve a records / provide sockaddr structures
580	my $resolve = sub {	752	my $resolve = sub {
		753	my @target = @_;
		754
581	my @res;	755	my @res;
582	my $cv = AnyEvent->condvar (cb => sub {	756	my $cv = AE::cv {
583	$cb->(	757	$cb->(
584	map $_->[2],	758	map $_->[2],
585	sort {	759	sort {
586	$AnyEvent::PROTOCOL{$b->[1]} <=> $AnyEvent::PROTOCOL{$a->[1]}	760	$AnyEvent::PROTOCOL{$b->[1]} <=> $AnyEvent::PROTOCOL{$a->[1]}
587	or $a->[0] <=> $b->[0]	761	or $a->[0] <=> $b->[0]
588	}	762	}
589	@res	763	@res
590	)	764	)
591	});	765	};
592		766
593	$cv->begin;	767	$cv->begin;
594	for my $idx (0 .. $#target) {	768	for my $idx (0 .. $#target) {
595	my ($node, $port) = @{ $target[$idx] };	769	my ($node, $port) = @{ $target[$idx] };
596		770
…		…
605	if ($af == AF_INET6 && $family != 4) {	779	if ($af == AF_INET6 && $family != 4) {
606	push @res, [$idx, "ipv6", [AF_INET6, $type, $proton,	780	push @res, [$idx, "ipv6", [AF_INET6, $type, $proton,
607	pack_sockaddr $port, $noden]]	781	pack_sockaddr $port, $noden]]
608	}	782	}
609	} else {	783	} else {
610	# ipv4	784	$node =~ y/A-Z/a-z/;
		785
		786	my $hosts = $HOSTS{$node};
		787
		788	# a records
611	if ($family != 6) {	789	if ($family != 6) {
612	$cv->begin;	790	$cv->begin;
613	AnyEvent::DNS::a $node, sub {	791	AnyEvent::DNS::a $node, sub {
614	push @res, [$idx, "ipv4", [AF_INET, $type, $proton,	792	push @res, [$idx, "ipv4", [AF_INET , $type, $proton, pack_sockaddr $port, parse_ipv4 $_]]
615	pack_sockaddr $port, parse_ipv4 $_]]
616	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] };
617	$cv->end;	800	} $cv, @_;
618	};	801	};
619	}	802	}
620		803
621	# ipv6	804	# aaaa records
622	if ($family != 4) {	805	if ($family != 4) {
623	$cv->begin;	806	$cv->begin;
624	AnyEvent::DNS::aaaa $node, sub {	807	AnyEvent::DNS::aaaa $node, sub {
625	push @res, [$idx, "ipv6", [AF_INET6, $type, $proton,	808	push @res, [$idx, "ipv6", [AF_INET6, $type, $proton, pack_sockaddr $port, parse_ipv6 $_]]
626	pack_sockaddr $port, parse_ipv6 $_]]
627	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] }
628	$cv->end;	815	} $cv, @_;
629	};	816	};
630	}	817	}
631	}	818	}
632	}	819	}
633	$cv->end;	820	$cv->end;
634	};	821	};
635		822
		823	$node = AnyEvent::Util::idn_to_ascii $node
		824	if $node =~ /[^\x00-\x7f]/;
		825
636	# try srv records, if applicable	826	# try srv records, if applicable
637	if ($node eq "localhost") {	827	if ($node eq "localhost") {
638	@target = (["127.0.0.1", $port], ["::1", $port]);	828	$resolve->(["127.0.0.1", $port], ["::1", $port]);
639	&$resolve;
640	} elsif (defined $service && !parse_address $node) {	829	} elsif (defined $service && !parse_address $node) {
641	AnyEvent::DNS::srv $service, $proto, $node, sub {	830	AnyEvent::DNS::srv $service, $proto, $node, sub {
642	my (@srv) = @_;	831	my (@srv) = @_;
643		832
644	# no srv records, continue traditionally
645	@srv	833	if (@srv) {
646	or return &$resolve;
647
648	# the only srv record has "." ("" here) => abort	834	# the only srv record has "." ("" here) => abort
649	$srv[0][2] ne "" \|\| $#srv	835	$srv[0][2] ne "" \|\| $#srv
650	or return $cb->();	836	or return $cb->();
651		837
652	# use srv records then	838	# use srv records then
		839	$resolve->(
653	@target = map ["$_->[3].", $_->[2]],	840	map ["$_->[3].", $_->[2]],
654	grep $_->[3] ne ".",	841	grep $_->[3] ne ".",
655	@srv;	842	@srv
656		843	);
657	&$resolve;	844	} else {
		845	# no srv records, continue traditionally
		846	$resolve->([$node, $port]);
		847	}
658	};	848	};
659	} else {	849	} else {
660	&$resolve;	850	# most common case
		851	$resolve->([$node, $port]);
661	}	852	}
662	}	853	}
663		854
664	=item $guard = tcp_connect $host, $service, $connect_cb[, $prepare_cb]	855	=item $guard = tcp_connect $host, $service, $connect_cb[, $prepare_cb]
665		856
666	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
667	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
668	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
669	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
670	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
671	socket).	862	domain socket).
672		863
673	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
674	records to locate the real target(s).	865	records to locate the real target(s).
675		866
676	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
677	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
678	each in turn.	869	each in turn.
679		870
680	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
681	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
682	(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
683	respectively. The fourth argument is a code reference that you can call	874	arguments, respectively. The fourth argument is a code reference that you
684	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
685	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
686	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
687	ignore this argument.	878	simply ignore this argument.
688		879
689	$cb->($filehandle, $host, $port, $retry)	880	$cb->($filehandle, $host, $port, $retry)
690		881
691	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
692	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>
693	indicating a DNS resolution failure).	884	indicating a DNS resolution failure).
694		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
695	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
696	can be used as a normal perl file handle as well.	891	can be used as a normal perl file handle as well.
697		892
698	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
699	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
700	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.
701		898
702	Sometimes you need to "prepare" the socket before connecting, for example,	899	Sometimes you need to "prepare" the socket before connecting, for example,
703	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
704	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
705	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
…		…
738		935
739	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.
740	$handle = new AnyEvent::Handle	937	$handle = new AnyEvent::Handle
741	fh => $fh,	938	fh => $fh,
742	on_error => sub {	939	on_error => sub {
743	warn "error $_[2]\n";	940	AE::log error => $_[2];
744	$_[0]->destroy;	941	$_[0]->destroy;
745	},	942	},
746	on_eof => sub {	943	on_eof => sub {
747	$handle->destroy; # destroy handle	944	$handle->destroy; # destroy handle
748	warn "done.\n";	945	AE::log info => "Done.";
749	};	946	};
750		947
751	$handle->push_write ("GET / HTTP/1.0\015\012\015\012");	948	$handle->push_write ("GET / HTTP/1.0\015\012\015\012");
752		949
753	$handle->push_read_line ("\015\012\015\012", sub {	950	$handle->push_read (line => "\015\012\015\012", sub {
754	my ($handle, $line) = @_;	951	my ($handle, $line) = @_;
755		952
756	# print response header	953	# print response header
757	print "HEADER\n$line\n\nBODY\n";	954	print "HEADER\n$line\n\nBODY\n";
758		955
…		…
778	=cut	975	=cut
779		976
780	sub tcp_connect($$$;$) {	977	sub tcp_connect($$$;$) {
781	my ($host, $port, $connect, $prepare) = @_;	978	my ($host, $port, $connect, $prepare) = @_;
782		979
783	# see http://cr.yp.to/docs/connect.html for some background	980	# see http://cr.yp.to/docs/connect.html for some tricky aspects
784	# also http://advogato.org/article/672.html	981	# also http://advogato.org/article/672.html
785		982
786	my %state = ( fh => undef );	983	my %state = ( fh => undef );
787		984
788	# name/service to type/sockaddr resolution	985	# name/service to type/sockaddr resolution
…		…
790	my @target = @_;	987	my @target = @_;
791		988
792	$state{next} = sub {	989	$state{next} = sub {
793	return unless exists $state{fh};	990	return unless exists $state{fh};
794		991
		992	my $errno = $!;
795	my $target = shift @target	993	my $target = shift @target
796	or return (%state = (), $connect->());	994	or return AE::postpone {
		995	return unless exists $state{fh};
		996	%state = ();
		997	$! = $errno;
		998	$connect->();
		999	};
797		1000
798	my ($domain, $type, $proto, $sockaddr) = @$target;	1001	my ($domain, $type, $proto, $sockaddr) = @$target;
799		1002
800	# socket creation	1003	# socket creation
801	socket $state{fh}, $domain, $type, $proto	1004	socket $state{fh}, $domain, $type, $proto
…		…
805		1008
806	my $timeout = $prepare && $prepare->($state{fh});	1009	my $timeout = $prepare && $prepare->($state{fh});
807		1010
808	$timeout \|\|= 30 if AnyEvent::WIN32;	1011	$timeout \|\|= 30 if AnyEvent::WIN32;
809		1012
810	$state{to} = AnyEvent->timer (after => $timeout, cb => sub {	1013	$state{to} = AE::timer $timeout, 0, sub {
811	$! = Errno::ETIMEDOUT;	1014	$! = Errno::ETIMEDOUT;
812	$state{next}();	1015	$state{next}();
813	}) if $timeout;	1016	} if $timeout;
814		1017
815	# called when the connect was successful, which,	1018	# now connect
816	# in theory, could be the case immediately (but never is in practise)	1019	if (
817	$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 {
818	# we are connected, or maybe there was an error	1028	# we are connected, or maybe there was an error
819	if (my $sin = getpeername $state{fh}) {	1029	if (my $sin = getpeername $state{fh}) {
820	my ($port, $host) = unpack_sockaddr $sin;	1030	my ($port, $host) = unpack_sockaddr $sin;
821		1031
822	delete $state{ww}; delete $state{to};	1032	delete $state{ww}; delete $state{to};
823		1033
824	my $guard = guard { %state = () };	1034	my $guard = guard { %state = () };
825		1035
826	$connect->(delete $state{fh}, format_address $host, $port, sub {	1036	$connect->(delete $state{fh}, format_address $host, $port, sub {
827	$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
828	$state{next}();	1058	$state{next}();
829	});	1059	}
830	} else {
831	# dummy read to fetch real error code
832	sysread $state{fh}, my $buf, 1 if $! == Errno::ENOTCONN;
833
834	return if $! == Errno::EAGAIN; # skip spurious wake-ups
835
836	delete $state{ww}; delete $state{to};
837
838	$state{next}();
839	}	1060	};
840	};
841
842	# now connect
843	if (connect $state{fh}, $sockaddr) {
844	$state{connected}->();
845	} elsif ($! == Errno::EINPROGRESS # POSIX
846	\|\| $! == Errno::EWOULDBLOCK
847	# WSAEINPROGRESS intentionally not checked - it means something else entirely
848	\|\| $! == AnyEvent::Util::WSAEINVAL # not convinced, but doesn't hurt
849	\|\| $! == AnyEvent::Util::WSAEWOULDBLOCK) {
850	$state{ww} = AnyEvent->io (fh => $state{fh}, poll => 'w', cb => $state{connected});
851	} else {	1061	} else {
852	$state{next}();	1062	$state{next}();
853	}	1063	}
854	};	1064	};
855		1065
…		…
860	defined wantarray && guard { %state = () }	1070	defined wantarray && guard { %state = () }
861	}	1071	}
862		1072
863	=item $guard = tcp_server $host, $service, $accept_cb[, $prepare_cb]	1073	=item $guard = tcp_server $host, $service, $accept_cb[, $prepare_cb]
864		1074
865	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
866	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
867	implies, this function can also bind on UNIX domain sockets.	1077	implies, this function can also bind on UNIX domain sockets.
868		1078
869	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
870	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
871	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
872	future versions, as applicable).	1082	future versions, as applicable).
873		1083
874	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
875	wildcard address, use C<::>.	1085	wildcard address, use C<::>.
876		1086
877	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
878	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
879	port will be used).	1089	port will be used).
880		1090
881	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
882	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>
883	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
884	below.	1094	it stops using it. See SECURITY CONSIDERATIONS, below.
885		1095
886	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<<
887	$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
888	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
889	(see C<tcp_connect> for details).	1099	(see C<tcp_connect> for details).
890		1100
891	Croaks on any errors it can detect before the listen.	1101	Croaks on any errors it can detect before the listen.
892		1102
893	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
894	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,
895	the server will be stopped (but existing accepted connections will	1105	the server will be stopped (but existing accepted connections will
896	continue).	1106	not be affected).
		1107
		1108	Regardless, when the function returns to the caller, the socket is bound
		1109	and in listening state.
897		1110
898	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
899	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
900	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
901	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
…		…
917	my ($fh, $host, $port) = @_;	1130	my ($fh, $host, $port) = @_;
918		1131
919	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";
920	}, sub {	1133	}, sub {
921	my ($fh, $thishost, $thisport) = @_;	1134	my ($fh, $thishost, $thisport) = @_;
922	warn "bound to $thishost, port $thisport\n";	1135	AE::log info => "Bound to $thishost, port $thisport.";
923	};	1136	};
924		1137
925	Example: bind a server on a unix domain socket.	1138	Example: bind a server on a unix domain socket.
926		1139
927	tcp_server "unix/", "/tmp/mydir/mysocket", sub {	1140	tcp_server "unix/", "/tmp/mydir/mysocket", sub {
…		…
965	}	1178	}
966		1179
967	bind $state{fh}, pack_sockaddr $service, $ipn	1180	bind $state{fh}, pack_sockaddr $service, $ipn
968	or Carp::croak "bind: $!";	1181	or Carp::croak "bind: $!";
969		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
970	fh_nonblocking $state{fh}, 1;	1193	fh_nonblocking $state{fh}, 1;
971		1194
972	my $len;	1195	my $len;
973		1196
974	if ($prepare) {	1197	if ($prepare) {
…		…
979	$len \|\|= 128;	1202	$len \|\|= 128;
980		1203
981	listen $state{fh}, $len	1204	listen $state{fh}, $len
982	or Carp::croak "listen: $!";	1205	or Carp::croak "listen: $!";
983		1206
984	$state{aw} = AnyEvent->io (fh => $state{fh}, poll => 'r', cb => sub {	1207	$state{aw} = AE::io $state{fh}, 0, sub {
985	# this closure keeps $state alive	1208	# this closure keeps $state alive
986	while (my $peer = accept my $fh, $state{fh}) {	1209	while ($state{fh} && (my $peer = accept my $fh, $state{fh})) {
987	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
988		1211
989	my ($service, $host) = unpack_sockaddr $peer;	1212	my ($service, $host) = unpack_sockaddr $peer;
990	$accept->($fh, format_address $host, $service);	1213	$accept->($fh, format_address $host, $service);
991	}	1214	}
992	});	1215	};
993		1216
994	defined wantarray	1217	defined wantarray
995	? guard { %state = () } # clear fh and watcher, which breaks the circular dependency	1218	? guard { %state = () } # clear fh and watcher, which breaks the circular dependency
996	: ()	1219	: ()
997	}	1220	}
998		1221
999	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	}
1000		1250
1001	=back	1251	=back
1002		1252
1003	=head1 SECURITY CONSIDERATIONS	1253	=head1 SECURITY CONSIDERATIONS
1004		1254
…		…
1010	harmful in general.	1260	harmful in general.
1011		1261
1012	=head1 AUTHOR	1262	=head1 AUTHOR
1013		1263
1014	Marc Lehmann <schmorp@schmorp.de>	1264	Marc Lehmann <schmorp@schmorp.de>
1015	http://home.schmorp.de/	1265	http://anyevent.schmorp.de
1016		1266
1017	=cut	1267	=cut
1018		1268
		1269	1
		1270

Diff Legend

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

Comparing AnyEvent/lib/AnyEvent/Socket.pm (file contents): Revision 1.98 by root, Mon Jul 20 22:39:57 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.98 by root, Mon Jul 20 22:39:57 2009 UTC vs.
Revision 1.157 by root, Wed Oct 31 15:42:06 2012 UTC