ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent/lib/AnyEvent/Socket.pm
(Generate patch)

Comparing AnyEvent/lib/AnyEvent/Socket.pm (file contents):
Revision 1.61 by root, Thu Aug 21 23:48:35 2008 UTC vs.
Revision 1.121 by root, Sat Jan 30 21:28:00 2010 UTC

33 33
34=cut 34=cut
35 35
36package AnyEvent::Socket; 36package AnyEvent::Socket;
37 37
38no warnings;
39use strict;
40
41use Carp (); 38use Carp ();
42use Errno (); 39use Errno ();
43use Socket qw(AF_INET AF_UNIX SOCK_STREAM SOCK_DGRAM SOL_SOCKET SO_REUSEADDR); 40use Socket qw(AF_INET AF_UNIX SOCK_STREAM SOCK_DGRAM SOL_SOCKET SO_REUSEADDR);
44 41
45use AnyEvent (); 42use AnyEvent (); BEGIN { AnyEvent::common_sense }
46use AnyEvent::Util qw(guard fh_nonblocking AF_INET6); 43use AnyEvent::Util qw(guard fh_nonblocking AF_INET6);
47use AnyEvent::DNS (); 44use AnyEvent::DNS ();
48 45
49use base 'Exporter'; 46use base 'Exporter';
50 47
51our @EXPORT = qw( 48our @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
53 format_ipv4 format_ipv6
55 format_ip format_address 54 format_ip format_address
56 address_family 55 address_family
57 inet_aton 56 inet_aton
58 tcp_server 57 tcp_server
59 tcp_connect 58 tcp_connect
60); 59);
61 60
62our $VERSION = 4.233; 61our $VERSION = $AnyEvent::VERSION;
62
63# used in cases where we may return immediately but want the
64# caller to do stuff first
65sub _postpone {
66 my ($cb, @args) = (@_, $!);
67
68 my $w; $w = AE::timer 0, 0, sub {
69 undef $w;
70 $! = pop @args;
71 $cb->(@args);
72 };
73}
63 74
64=item $ipn = parse_ipv4 $dotted_quad 75=item $ipn = parse_ipv4 $dotted_quad
65 76
66Tries to parse the given dotted quad IPv4 address and return it in 77Tries to parse the given dotted quad IPv4 address and return it in
67octet form (or undef when it isn't in a parsable format). Supports all 78octet form (or undef when it isn't in a parsable format). Supports all
98forms supported by parse_ipv4). Note that scope-id's are not supported 109forms supported by parse_ipv4). Note that scope-id's are not supported
99(and will not parse). 110(and will not parse).
100 111
101This function works similarly to C<inet_pton AF_INET6, ...>. 112This function works similarly to C<inet_pton AF_INET6, ...>.
102 113
114Example:
115
116 print unpack "H*", parse_ipv6 "2002:5345::10.0.0.1";
117 # => 2002534500000000000000000a000001
118
103=cut 119=cut
104 120
105sub parse_ipv6($) { 121sub parse_ipv6($) {
106 # quick test to avoid longer processing 122 # quick test to avoid longer processing
107 my $n = $_[0] =~ y/://; 123 my $n = $_[0] =~ y/://;
144 ? pack "S", AF_UNIX 160 ? pack "S", AF_UNIX
145 : undef 161 : undef
146 162
147} 163}
148 164
149=item $ipn = parse_address $text 165=item $ipn = parse_address $ip
150 166
151Combines C<parse_ipv4> and C<parse_ipv6> in one function. The address 167Combines C<parse_ipv4> and C<parse_ipv6> in one function. The address
152here refers to the host address (not socket address) in network form 168here refers to the host address (not socket address) in network form
153(binary). 169(binary).
154 170
155If the C<$text> is C<unix/>, then this function returns a special token 171If the C<$text> is C<unix/>, then this function returns a special token
156recognised by the other functions in this module to mean "UNIX domain 172recognised by the other functions in this module to mean "UNIX domain
157socket". 173socket".
158 174
175If the C<$text> to parse is a mapped IPv4 in IPv6 address (:ffff::<ipv4>),
176then it will be treated as an IPv4 address. If you don't want that, you
177have to call C<parse_ipv4> and/or C<parse_ipv6> manually.
178
179Example:
180
181 print unpack "H*", parse_address "10.1.2.3";
182 # => 0a010203
183
159=item $text = AnyEvent::Socket::aton $ipn 184=item $ipn = AnyEvent::Socket::aton $ip
160 185
161Same as C<parse_address>, but not exported (think C<Socket::inet_aton> but 186Same as C<parse_address>, but not exported (think C<Socket::inet_aton> but
162I<without> name resolution). 187I<without> name resolution).
163 188
164=cut 189=cut
165 190
166sub parse_address($) { 191sub parse_address($) {
167 &parse_ipv4 || &parse_ipv6 || &parse_unix 192 for (&parse_ipv6) {
193 if ($_) {
194 s/^\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff\xff//;
195 return $_;
196 } else {
197 return &parse_ipv4 || &parse_unix
198 }
199 }
168} 200}
169 201
170*aton = \&parse_address; 202*aton = \&parse_address;
203
204=item ($name, $aliases, $proto) = getprotobyname $name
205
206Works like the builtin function of the same name, except it tries hard to
207work even on broken platforms (well, that's windows), where getprotobyname
208is traditionally very unreliable.
209
210Example: get the protocol number for TCP (usually 6)
211
212 my $proto = getprotobyname "tcp";
213
214=cut
215
216# microsoft can't even get getprotobyname working (the etc/protocols file
217# gets lost fairly often on windows), so we have to hardcode some common
218# protocol numbers ourselves.
219our %PROTO_BYNAME;
220
221$PROTO_BYNAME{tcp} = Socket::IPPROTO_TCP () if defined &Socket::IPPROTO_TCP;
222$PROTO_BYNAME{udp} = Socket::IPPROTO_UDP () if defined &Socket::IPPROTO_UDP;
223$PROTO_BYNAME{icmp} = Socket::IPPROTO_ICMP() if defined &Socket::IPPROTO_ICMP;
224
225sub getprotobyname($) {
226 my $name = lc shift;
227
228 defined (my $proton = $PROTO_BYNAME{$name} || (getprotobyname $name)[2])
229 or return;
230
231 ($name, uc $name, $proton)
232}
171 233
172=item ($host, $service) = parse_hostport $string[, $default_service] 234=item ($host, $service) = parse_hostport $string[, $default_service]
173 235
174Splitting a string of the form C<hostname:port> is a common 236Splitting a string of the form C<hostname:port> is a common
175problem. Unfortunately, just splitting on the colon makes it hard to 237problem. Unfortunately, just splitting on the colon makes it hard to
191 ipv4or6 port e.g. "::1 443", "10.0.0.1 smtp" 253 ipv4or6 port e.g. "::1 443", "10.0.0.1 smtp"
192 254
193It also supports defaulting the service name in a simple way by using 255It also supports defaulting the service name in a simple way by using
194C<$default_service> if no service was detected. If neither a service was 256C<$default_service> if no service was detected. If neither a service was
195detected nor a default was specified, then this function returns the 257detected nor a default was specified, then this function returns the
196empty list. The same happens when a parse error weas detected, such as a 258empty list. The same happens when a parse error was detected, such as a
197hostname with a colon in it (the function is rather conservative, though). 259hostname with a colon in it (the function is rather conservative, though).
198 260
199Example: 261Example:
200 262
201 print join ",", parse_hostport "localhost:443"; 263 print join ",", parse_hostport "localhost:443";
244 return if $host =~ /:/ && !parse_ipv6 $host; 306 return if $host =~ /:/ && !parse_ipv6 $host;
245 307
246 ($host, $port) 308 ($host, $port)
247} 309}
248 310
311=item $string = format_hostport $host, $port
312
313Takes a host (in textual form) and a port and formats in unambigiously in
314a way that C<parse_hostport> can parse it again. C<$port> can be C<undef>.
315
316=cut
317
318sub format_hostport($;$) {
319 my ($host, $port) = @_;
320
321 $port = ":$port" if length $port;
322 $host = "[$host]" if $host =~ /:/;
323
324 "$host$port"
325}
326
249=item $sa_family = address_family $ipn 327=item $sa_family = address_family $ipn
250 328
251Returns the address family/protocol-family (AF_xxx/PF_xxx, in one value :) 329Returns the address family/protocol-family (AF_xxx/PF_xxx, in one value :)
252of the given host address in network format. 330of the given host address in network format.
253 331
259 : 16 == length $_[0] 337 : 16 == length $_[0]
260 ? AF_INET6 338 ? AF_INET6
261 : unpack "S", $_[0] 339 : unpack "S", $_[0]
262} 340}
263 341
342=item $text = format_ipv4 $ipn
343
344Expects a four octet string representing a binary IPv4 address and returns
345its textual format. Rarely used, see C<format_address> for a nicer
346interface.
347
348=item $text = format_ipv6 $ipn
349
350Expects a sixteen octet string representing a binary IPv6 address and
351returns its textual format. Rarely used, see C<format_address> for a
352nicer interface.
353
264=item $text = format_address $ipn 354=item $text = format_address $ipn
265 355
266Covnvert a host address in network format (e.g. 4 octets for IPv4 or 16 356Covnvert a host address in network format (e.g. 4 octets for IPv4 or 16
267octets for IPv6) and convert it into textual form. 357octets for IPv6) and convert it into textual form.
268 358
271This function works similarly to C<inet_ntop AF_INET || AF_INET6, ...>, 361This function works similarly to C<inet_ntop AF_INET || AF_INET6, ...>,
272except it automatically detects the address type. 362except it automatically detects the address type.
273 363
274Returns C<undef> if it cannot detect the type. 364Returns C<undef> if it cannot detect the type.
275 365
366If the C<$ipn> is a mapped IPv4 in IPv6 address (:ffff::<ipv4>), then just
367the contained IPv4 address will be returned. If you do not want that, you
368have to call C<format_ipv6> manually.
369
370Example:
371
372 print format_address "\x01\x02\x03\x05";
373 => 1.2.3.5
374
276=item $text = AnyEvent::Socket::ntoa $ipn 375=item $text = AnyEvent::Socket::ntoa $ipn
277 376
278Same as format_address, but not exported (think C<inet_ntoa>). 377Same as format_address, but not exported (think C<inet_ntoa>).
279 378
280=cut 379=cut
281 380
282sub format_address; 381sub format_ipv4($) {
283sub format_address($) {
284 my $af = address_family $_[0];
285 if ($af == AF_INET) {
286 return join ".", unpack "C4", $_[0] 382 join ".", unpack "C4", $_[0]
287 } elsif ($af == AF_INET6) { 383}
384
385sub format_ipv6($) {
386 if ($_[0] =~ /^\x00\x00\x00\x00\x00\x00\x00\x00/) {
288 if (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0 eq $_[0]) { 387 if (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0 eq $_[0]) {
289 return "::"; 388 return "::";
290 } elsif (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.1 eq $_[0]) { 389 } elsif (v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.1 eq $_[0]) {
291 return "::1"; 390 return "::1";
292 } elsif (v0.0.0.0.0.0.0.0.0.0.0.0 eq substr $_[0], 0, 12) { 391 } elsif (v0.0.0.0.0.0.0.0.0.0.0.0 eq substr $_[0], 0, 12) {
293 # v4compatible 392 # v4compatible
294 return "::" . format_address substr $_[0], 12; 393 return "::" . format_ipv4 substr $_[0], 12;
295 } elsif (v0.0.0.0.0.0.0.0.0.0.255.255 eq substr $_[0], 0, 12) { 394 } elsif (v0.0.0.0.0.0.0.0.0.0.255.255 eq substr $_[0], 0, 12) {
296 # v4mapped 395 # v4mapped
297 return "::ffff:" . format_address substr $_[0], 12; 396 return "::ffff:" . format_ipv4 substr $_[0], 12;
298 } elsif (v0.0.0.0.0.0.0.0.255.255.0.0 eq substr $_[0], 0, 12) { 397 } elsif (v0.0.0.0.0.0.0.0.255.255.0.0 eq substr $_[0], 0, 12) {
299 # v4translated 398 # v4translated
300 return "::ffff:0:" . format_address substr $_[0], 12; 399 return "::ffff:0:" . format_ipv4 substr $_[0], 12;
301 } else {
302 my $ip = sprintf "%x:%x:%x:%x:%x:%x:%x:%x", unpack "n8", $_[0];
303
304 # this is rather sucky, I admit
305 $ip =~ s/^0:(?:0:)*(0$)?/::/
306 or $ip =~ s/(:0){7}$/::/ or $ip =~ s/(:0){7}/:/
307 or $ip =~ s/(:0){6}$/::/ or $ip =~ s/(:0){6}/:/
308 or $ip =~ s/(:0){5}$/::/ or $ip =~ s/(:0){5}/:/
309 or $ip =~ s/(:0){4}$/::/ or $ip =~ s/(:0){4}/:/
310 or $ip =~ s/(:0){3}$/::/ or $ip =~ s/(:0){3}/:/
311 or $ip =~ s/(:0){2}$/::/ or $ip =~ s/(:0){2}/:/
312 or $ip =~ s/(:0){1}$/::/ or $ip =~ s/(:0){1}/:/;
313 return $ip
314 } 400 }
315 } elsif ($af == AF_UNIX) { 401 }
402
403 my $ip = sprintf "%x:%x:%x:%x:%x:%x:%x:%x", unpack "n8", $_[0];
404
405 # this is admittedly rather sucky
406 $ip =~ s/(?:^|:) 0:0:0:0:0:0:0 (?:$|:)/::/x
407 or $ip =~ s/(?:^|:) 0:0:0:0:0:0 (?:$|:)/::/x
408 or $ip =~ s/(?:^|:) 0:0:0:0:0 (?:$|:)/::/x
409 or $ip =~ s/(?:^|:) 0:0:0:0 (?:$|:)/::/x
410 or $ip =~ s/(?:^|:) 0:0:0 (?:$|:)/::/x
411 or $ip =~ s/(?:^|:) 0:0 (?:$|:)/::/x
412 or $ip =~ s/(?:^|:) 0 (?:$|:)/::/x;
413
414 $ip
415}
416
417sub format_address($) {
418 if (4 == length $_[0]) {
419 return &format_ipv4;
420 } elsif (16 == length $_[0]) {
421 return $_[0] =~ /^\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xff\xff(....)$/s
422 ? format_ipv4 $1
423 : &format_ipv6;
424 } elsif (AF_UNIX == address_family $_[0]) {
316 return "unix/" 425 return "unix/"
317 } else { 426 } else {
318 return undef 427 return undef
319 } 428 }
320} 429}
322*ntoa = \&format_address; 431*ntoa = \&format_address;
323 432
324=item inet_aton $name_or_address, $cb->(@addresses) 433=item inet_aton $name_or_address, $cb->(@addresses)
325 434
326Works similarly to its Socket counterpart, except that it uses a 435Works similarly to its Socket counterpart, except that it uses a
327callback. Also, if a host has only an IPv6 address, this might be passed 436callback. Use the length to distinguish between ipv4 and ipv6 (4 octets
328to the callback instead (use the length to detect this - 4 for IPv4, 16 437for IPv4, 16 for IPv6), or use C<format_address> to convert it to a more
329for IPv6). 438readable format.
330 439
331Unlike the L<Socket> function of the same name, you can get multiple IPv4 440Note that C<resolve_sockaddr>, while initially a more complex interface,
332and IPv6 addresses as result (and maybe even other adrdess types). 441resolves host addresses, IDNs, service names and SRV records and gives you
442an ordered list of socket addresses to try and should be preferred over
443C<inet_aton>.
444
445Example.
446
447 inet_aton "www.google.com", my $cv = AE::cv;
448 say unpack "H*", $_
449 for $cv->recv;
450 # => d155e363
451 # => d155e367 etc.
452
453 inet_aton "ipv6.google.com", my $cv = AE::cv;
454 say unpack "H*", $_
455 for $cv->recv;
456 # => 20014860a00300000000000000000068
333 457
334=cut 458=cut
335 459
336sub inet_aton { 460sub inet_aton {
337 my ($name, $cb) = @_; 461 my ($name, $cb) = @_;
343 } elsif ($name eq "localhost") { # rfc2606 et al. 467 } elsif ($name eq "localhost") { # rfc2606 et al.
344 $cb->(v127.0.0.1, v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.1); 468 $cb->(v127.0.0.1, v0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.1);
345 } else { 469 } else {
346 require AnyEvent::DNS; 470 require AnyEvent::DNS;
347 471
348 # simple, bad suboptimal algorithm 472 my $ipv4 = $AnyEvent::PROTOCOL{ipv4};
473 my $ipv6 = $AnyEvent::PROTOCOL{ipv6};
474
475 my @res;
476
477 my $cv = AE::cv {
478 $cb->(map @$_, reverse @res);
479 };
480
481 $cv->begin;
482
483 if ($ipv4) {
484 $cv->begin;
349 AnyEvent::DNS::a ($name, sub { 485 AnyEvent::DNS::a ($name, sub {
350 if (@_) { 486 $res[$ipv4] = [map &parse_ipv4, @_];
351 $cb->(map +(parse_ipv4 $_), @_);
352 } else {
353 $cb->(); 487 $cv->end;
354 #AnyEvent::DNS::aaaa ($name, $cb); need inet_pton
355 } 488 });
356 }); 489 };
357 }
358}
359 490
491 if ($ipv6) {
492 $cv->begin;
493 AnyEvent::DNS::aaaa ($name, sub {
494 $res[$ipv6] = [map &parse_ipv6, @_];
495 $cv->end;
496 });
497 };
498
499 $cv->end;
500 }
501}
502
503BEGIN {
504 *sockaddr_family = $Socket::VERSION >= 1.75
505 ? \&Socket::sockaddr_family
506 : # for 5.6.x, we need to do something much more horrible
507 (Socket::pack_sockaddr_in 0x5555, "\x55\x55\x55\x55"
508 | eval { Socket::pack_sockaddr_un "U" }) =~ /^\x00/
509 ? sub { unpack "xC", $_[0] }
510 : sub { unpack "S" , $_[0] };
511}
512
360# check for broken platforms with extra field in sockaddr structure 513# check for broken platforms with an extra field in sockaddr structure
361# kind of a rfc vs. bsd issue, as usual (ok, normally it's a 514# kind of a rfc vs. bsd issue, as usual (ok, normally it's a
362# unix vs. bsd issue, a iso C vs. bsd issue or simply a 515# unix vs. bsd issue, a iso C vs. bsd issue or simply a
363# correctness vs. bsd issue. 516# correctness vs. bsd issue.)
364my $pack_family = (0x55 == Socket::sockaddr_family "\x55\x55") 517my $pack_family = 0x55 == sockaddr_family ("\x55\x55")
365 ? "xC" : "S"; 518 ? "xC" : "S";
366 519
367=item $sa = AnyEvent::Socket::pack_sockaddr $service, $host 520=item $sa = AnyEvent::Socket::pack_sockaddr $service, $host
368 521
369Pack the given port/host combination into a binary sockaddr 522Pack the given port/host combination into a binary sockaddr
370structure. Handles both IPv4 and IPv6 host addresses, as well as UNIX 523structure. Handles both IPv4 and IPv6 host addresses, as well as UNIX
371domain sockets (C<$host> == C<unix/> and C<$service> == absolute 524domain sockets (C<$host> == C<unix/> and C<$service> == absolute
372pathname). 525pathname).
526
527Example:
528
529 my $bind = AnyEvent::Socket::pack_sockaddr 43, v195.234.53.120;
530 bind $socket, $bind
531 or die "bind: $!";
373 532
374=cut 533=cut
375 534
376sub pack_sockaddr($$) { 535sub pack_sockaddr($$) {
377 my $af = address_family $_[1]; 536 my $af = address_family $_[1];
404is a special token that is understood by the other functions in this 563is a special token that is understood by the other functions in this
405module (C<format_address> converts it to C<unix/>). 564module (C<format_address> converts it to C<unix/>).
406 565
407=cut 566=cut
408 567
568# perl contains a bug (imho) where it requires that the kernel always returns
569# sockaddr_un structures of maximum length (which is not, AFAICS, required
570# by any standard). try to 0-pad structures for the benefit of those platforms.
571
572my $sa_un_zero = eval { Socket::pack_sockaddr_un "" }; $sa_un_zero ^= $sa_un_zero;
573
409sub unpack_sockaddr($) { 574sub unpack_sockaddr($) {
410 my $af = Socket::sockaddr_family $_[0]; 575 my $af = sockaddr_family $_[0];
411 576
412 if ($af == AF_INET) { 577 if ($af == AF_INET) {
413 Socket::unpack_sockaddr_in $_[0] 578 Socket::unpack_sockaddr_in $_[0]
414 } elsif ($af == AF_INET6) { 579 } elsif ($af == AF_INET6) {
415 unpack "x2 n x4 a16", $_[0] 580 unpack "x2 n x4 a16", $_[0]
416 } elsif ($af == AF_UNIX) { 581 } elsif ($af == AF_UNIX) {
417 ((Socket::unpack_sockaddr_un $_[0]), pack "S", AF_UNIX) 582 ((Socket::unpack_sockaddr_un $_[0] ^ $sa_un_zero), pack "S", AF_UNIX)
418 } else { 583 } else {
419 Carp::croak "unpack_sockaddr: unsupported protocol family $af"; 584 Carp::croak "unpack_sockaddr: unsupported protocol family $af";
420 } 585 }
421} 586}
422 587
425Tries to resolve the given nodename and service name into protocol families 590Tries to resolve the given nodename and service name into protocol families
426and sockaddr structures usable to connect to this node and service in a 591and sockaddr structures usable to connect to this node and service in a
427protocol-independent way. It works remotely similar to the getaddrinfo 592protocol-independent way. It works remotely similar to the getaddrinfo
428posix function. 593posix function.
429 594
430For internet addresses, C<$node> is either an IPv4 or IPv6 address or an 595For internet addresses, C<$node> is either an IPv4 or IPv6 address, an
431internet hostname, and C<$service> is either a service name (port name 596internet hostname (DNS domain name or IDN), and C<$service> is either
432from F</etc/services>) or a numerical port number. If both C<$node> and 597a service name (port name from F</etc/services>) or a numerical port
433C<$service> are names, then SRV records will be consulted to find the real 598number. If both C<$node> and C<$service> are names, then SRV records
434service, otherwise they will be used as-is. If you know that the service 599will be consulted to find the real service, otherwise they will be
435name is not in your services database, then you can specify the service in 600used as-is. If you know that the service name is not in your services
436the format C<name=port> (e.g. C<http=80>). 601database, then you can specify the service in the format C<name=port>
602(e.g. C<http=80>).
437 603
438For UNIX domain sockets, C<$node> must be the string C<unix/> and 604For UNIX domain sockets, C<$node> must be the string C<unix/> and
439C<$service> must be the absolute pathname of the socket. In this case, 605C<$service> must be the absolute pathname of the socket. In this case,
440C<$proto> will be ignored. 606C<$proto> will be ignored.
441 607
443C<sctp>. The default is currently C<tcp>, but in the future, this function 609C<sctp>. The default is currently C<tcp>, but in the future, this function
444might try to use other protocols such as C<sctp>, depending on the socket 610might try to use other protocols such as C<sctp>, depending on the socket
445type and any SRV records it might find. 611type and any SRV records it might find.
446 612
447C<$family> must be either C<0> (meaning any protocol is OK), C<4> (use 613C<$family> must be either C<0> (meaning any protocol is OK), C<4> (use
448only IPv4) or C<6> (use only IPv6). This setting might be influenced by 614only IPv4) or C<6> (use only IPv6). The default is influenced by
449C<$ENV{PERL_ANYEVENT_PROTOCOLS}>. 615C<$ENV{PERL_ANYEVENT_PROTOCOLS}>.
450 616
451C<$type> must be C<SOCK_STREAM>, C<SOCK_DGRAM> or C<SOCK_SEQPACKET> (or 617C<$type> must be C<SOCK_STREAM>, C<SOCK_DGRAM> or C<SOCK_SEQPACKET> (or
452C<undef> in which case it gets automatically chosen). 618C<undef> in which case it gets automatically chosen to be C<SOCK_STREAM>
619unless C<$proto> is C<udp>).
453 620
454The callback will receive zero or more array references that contain 621The callback will receive zero or more array references that contain
455C<$family, $type, $proto> for use in C<socket> and a binary 622C<$family, $type, $proto> for use in C<socket> and a binary
456C<$sockaddr> for use in C<connect> (or C<bind>). 623C<$sockaddr> for use in C<connect> (or C<bind>).
457 624
461 628
462 resolve_sockaddr "google.com", "http", 0, undef, undef, sub { ... }; 629 resolve_sockaddr "google.com", "http", 0, undef, undef, sub { ... };
463 630
464=cut 631=cut
465 632
466# microsoft can't even get getprotobyname working (the etc/protocols file
467# gets lost fairly often on windows), so we have to hardcode some common
468# protocol numbers ourselves.
469our %PROTO_BYNAME;
470
471$PROTO_BYNAME{tcp} = &Socket::IPPROTO_TCP if defined &Socket::IPPROTO_TCP;
472$PROTO_BYNAME{udp} = &Socket::IPPROTO_UDP if defined &Socket::IPPROTO_UDP;
473$PROTO_BYNAME{icmp} = &Socket::IPPROTO_ICMP if defined &Socket::IPPROTO_ICMP;
474
475sub resolve_sockaddr($$$$$$) { 633sub resolve_sockaddr($$$$$$) {
476 my ($node, $service, $proto, $family, $type, $cb) = @_; 634 my ($node, $service, $proto, $family, $type, $cb) = @_;
477 635
478 if ($node eq "unix/") { 636 if ($node eq "unix/") {
479 return $cb->() if $family || !/^\//; # no can do 637 return $cb->() if $family || $service !~ /^\//; # no can do
480 638
481 return $cb->([AF_UNIX, $type, 0, Socket::pack_sockaddr_un $service]); 639 return $cb->([AF_UNIX, defined $type ? $type : SOCK_STREAM, 0, Socket::pack_sockaddr_un $service]);
482 } 640 }
483 641
484 unless (AF_INET6) { 642 unless (AF_INET6) {
485 $family != 6 643 $family != 6
486 or return $cb->(); 644 or return $cb->();
495 $family ||= 6 unless $AnyEvent::PROTOCOL{ipv4}; 653 $family ||= 6 unless $AnyEvent::PROTOCOL{ipv4};
496 654
497 $proto ||= "tcp"; 655 $proto ||= "tcp";
498 $type ||= $proto eq "udp" ? SOCK_DGRAM : SOCK_STREAM; 656 $type ||= $proto eq "udp" ? SOCK_DGRAM : SOCK_STREAM;
499 657
500 my $proton = $PROTO_BYNAME{lc $proto} || (getprotobyname $proto)[2] 658 my $proton = getprotobyname $proto
501 or Carp::croak "$proto: protocol unknown"; 659 or Carp::croak "$proto: protocol unknown";
502 660
503 my $port; 661 my $port;
504 662
505 if ($service =~ /^(\S+)=(\d+)$/) { 663 if ($service =~ /^(\S+)=(\d+)$/) {
509 } else { 667 } else {
510 $port = (getservbyname $service, $proto)[2] 668 $port = (getservbyname $service, $proto)[2]
511 or Carp::croak "$service/$proto: service unknown"; 669 or Carp::croak "$service/$proto: service unknown";
512 } 670 }
513 671
514 my @target = [$node, $port];
515
516 # resolve a records / provide sockaddr structures 672 # resolve a records / provide sockaddr structures
517 my $resolve = sub { 673 my $resolve = sub {
674 my @target = @_;
675
518 my @res; 676 my @res;
519 my $cv = AnyEvent->condvar (cb => sub { 677 my $cv = AE::cv {
520 $cb->( 678 $cb->(
521 map $_->[2], 679 map $_->[2],
522 sort { 680 sort {
523 $AnyEvent::PROTOCOL{$b->[1]} <=> $AnyEvent::PROTOCOL{$a->[1]} 681 $AnyEvent::PROTOCOL{$b->[1]} <=> $AnyEvent::PROTOCOL{$a->[1]}
524 or $a->[0] <=> $b->[0] 682 or $a->[0] <=> $b->[0]
525 } 683 }
526 @res 684 @res
527 ) 685 )
528 }); 686 };
529 687
530 $cv->begin; 688 $cv->begin;
531 for my $idx (0 .. $#target) { 689 for my $idx (0 .. $#target) {
532 my ($node, $port) = @{ $target[$idx] }; 690 my ($node, $port) = @{ $target[$idx] };
533 691
568 } 726 }
569 } 727 }
570 $cv->end; 728 $cv->end;
571 }; 729 };
572 730
731 $node = AnyEvent::Util::idn_to_ascii $node
732 if $node =~ /[^\x00-\x7f]/;
733
573 # try srv records, if applicable 734 # try srv records, if applicable
574 if ($node eq "localhost") { 735 if ($node eq "localhost") {
575 @target = (["127.0.0.1", $port], ["::1", $port]); 736 $resolve->(["127.0.0.1", $port], ["::1", $port]);
576 &$resolve;
577 } elsif (defined $service && !parse_address $node) { 737 } elsif (defined $service && !parse_address $node) {
578 AnyEvent::DNS::srv $service, $proto, $node, sub { 738 AnyEvent::DNS::srv $service, $proto, $node, sub {
579 my (@srv) = @_; 739 my (@srv) = @_;
580 740
581 # no srv records, continue traditionally
582 @srv 741 if (@srv) {
583 or return &$resolve;
584
585 # the only srv record has "." ("" here) => abort 742 # the only srv record has "." ("" here) => abort
586 $srv[0][2] ne "" || $#srv 743 $srv[0][2] ne "" || $#srv
587 or return $cb->(); 744 or return $cb->();
588 745
589 # use srv records then 746 # use srv records then
747 $resolve->(
590 @target = map ["$_->[3].", $_->[2]], 748 map ["$_->[3].", $_->[2]],
591 grep $_->[3] ne ".", 749 grep $_->[3] ne ".",
592 @srv; 750 @srv
593 751 );
594 &$resolve; 752 } else {
753 # no srv records, continue traditionally
754 $resolve->([$node, $port]);
755 }
595 }; 756 };
596 } else { 757 } else {
597 &$resolve; 758 # most common case
759 $resolve->([$node, $port]);
598 } 760 }
599} 761}
600 762
601=item $guard = tcp_connect $host, $service, $connect_cb[, $prepare_cb] 763=item $guard = tcp_connect $host, $service, $connect_cb[, $prepare_cb]
602 764
603This is a convenience function that creates a TCP socket and makes a 100% 765This is a convenience function that creates a TCP socket and makes a
604non-blocking connect to the given C<$host> (which can be a hostname or 766100% non-blocking connect to the given C<$host> (which can be a DNS/IDN
605a textual IP address, or the string C<unix/> for UNIX domain sockets) 767hostname or a textual IP address, or the string C<unix/> for UNIX domain
606and C<$service> (which can be a numeric port number or a service name, 768sockets) and C<$service> (which can be a numeric port number or a service
607or a C<servicename=portnumber> string, or the pathname to a UNIX domain 769name, or a C<servicename=portnumber> string, or the pathname to a UNIX
608socket). 770domain socket).
609 771
610If both C<$host> and C<$port> are names, then this function will use SRV 772If both C<$host> and C<$port> are names, then this function will use SRV
611records to locate the real target(s). 773records to locate the real target(s).
612 774
613In either case, it will create a list of target hosts (e.g. for multihomed 775In either case, it will create a list of target hosts (e.g. for multihomed
614hosts or hosts with both IPv4 and IPv6 addresses) and try to connect to 776hosts or hosts with both IPv4 and IPv6 addresses) and try to connect to
615each in turn. 777each in turn.
616 778
617If the connect is successful, then the C<$connect_cb> will be invoked with 779After the connection is established, then the C<$connect_cb> will be
618the socket file handle (in non-blocking mode) as first and the peer host 780invoked with the socket file handle (in non-blocking mode) as first and
619(as a textual IP address) and peer port as second and third arguments, 781the peer host (as a textual IP address) and peer port as second and third
620respectively. The fourth argument is a code reference that you can call 782arguments, respectively. The fourth argument is a code reference that you
621if, for some reason, you don't like this connection, which will cause 783can call if, for some reason, you don't like this connection, which will
622C<tcp_connect> to try the next one (or call your callback without any 784cause C<tcp_connect> to try the next one (or call your callback without
623arguments if there are no more connections). In most cases, you can simply 785any arguments if there are no more connections). In most cases, you can
624ignore this argument. 786simply ignore this argument.
625 787
626 $cb->($filehandle, $host, $port, $retry) 788 $cb->($filehandle, $host, $port, $retry)
627 789
628If the connect is unsuccessful, then the C<$connect_cb> will be invoked 790If the connect is unsuccessful, then the C<$connect_cb> will be invoked
629without any arguments and C<$!> will be set appropriately (with C<ENXIO> 791without any arguments and C<$!> will be set appropriately (with C<ENXIO>
630indicating a DNS resolution failure). 792indicating a DNS resolution failure).
793
794The callback will I<never> be invoked before C<tcp_connect> returns, even
795if C<tcp_connect> was able to connect immediately (e.g. on unix domain
796sockets).
631 797
632The file handle is perfect for being plugged into L<AnyEvent::Handle>, but 798The file handle is perfect for being plugged into L<AnyEvent::Handle>, but
633can be used as a normal perl file handle as well. 799can be used as a normal perl file handle as well.
634 800
635Unless called in void context, C<tcp_connect> returns a guard object that 801Unless called in void context, C<tcp_connect> returns a guard object that
674 or die "unable to connect: $!"; 840 or die "unable to connect: $!";
675 841
676 my $handle; # avoid direct assignment so on_eof has it in scope. 842 my $handle; # avoid direct assignment so on_eof has it in scope.
677 $handle = new AnyEvent::Handle 843 $handle = new AnyEvent::Handle
678 fh => $fh, 844 fh => $fh,
845 on_error => sub {
846 warn "error $_[2]\n";
847 $_[0]->destroy;
848 },
679 on_eof => sub { 849 on_eof => sub {
680 undef $handle; # keep it alive till eof 850 $handle->destroy; # destroy handle
681 warn "done.\n"; 851 warn "done.\n";
682 }; 852 };
683 853
684 $handle->push_write ("GET / HTTP/1.0\015\012\015\012"); 854 $handle->push_write ("GET / HTTP/1.0\015\012\015\012");
685 855
686 $handle->push_read_line ("\015\012\015\012", sub { 856 $handle->push_read (line => "\015\012\015\012", sub {
687 my ($handle, $line) = @_; 857 my ($handle, $line) = @_;
688 858
689 # print response header 859 # print response header
690 print "HEADER\n$line\n\nBODY\n"; 860 print "HEADER\n$line\n\nBODY\n";
691 861
711=cut 881=cut
712 882
713sub tcp_connect($$$;$) { 883sub tcp_connect($$$;$) {
714 my ($host, $port, $connect, $prepare) = @_; 884 my ($host, $port, $connect, $prepare) = @_;
715 885
716 # see http://cr.yp.to/docs/connect.html for some background 886 # see http://cr.yp.to/docs/connect.html for some tricky aspects
717 # also http://advogato.org/article/672.html 887 # also http://advogato.org/article/672.html
718 888
719 my %state = ( fh => undef ); 889 my %state = ( fh => undef );
720 890
721 # name/service to type/sockaddr resolution 891 # name/service to type/sockaddr resolution
722 resolve_sockaddr $host, $port, 0, 0, 0, sub { 892 resolve_sockaddr $host, $port, 0, 0, undef, sub {
723 my @target = @_; 893 my @target = @_;
724 894
725 $state{next} = sub { 895 $state{next} = sub {
726 return unless exists $state{fh}; 896 return unless exists $state{fh};
727 897
728 my $target = shift @target 898 my $target = shift @target
729 or do { 899 or return (%state = (), _postpone $connect);
730 %state = ();
731 return $connect->();
732 };
733 900
734 my ($domain, $type, $proto, $sockaddr) = @$target; 901 my ($domain, $type, $proto, $sockaddr) = @$target;
735 902
736 # socket creation 903 # socket creation
737 socket $state{fh}, $domain, $type, $proto 904 socket $state{fh}, $domain, $type, $proto
741 908
742 my $timeout = $prepare && $prepare->($state{fh}); 909 my $timeout = $prepare && $prepare->($state{fh});
743 910
744 $timeout ||= 30 if AnyEvent::WIN32; 911 $timeout ||= 30 if AnyEvent::WIN32;
745 912
746 $state{to} = AnyEvent->timer (after => $timeout, cb => sub { 913 $state{to} = AE::timer $timeout, 0, sub {
747 $! = &Errno::ETIMEDOUT; 914 $! = Errno::ETIMEDOUT;
748 $state{next}(); 915 $state{next}();
749 }) if $timeout; 916 } if $timeout;
750 917
751 # called when the connect was successful, which, 918 # now connect
752 # in theory, could be the case immediately (but never is in practise) 919 if (
753 my $connected = sub { 920 (connect $state{fh}, $sockaddr)
754 delete $state{ww}; 921 || ($! == Errno::EINPROGRESS # POSIX
755 delete $state{to}; 922 || $! == Errno::EWOULDBLOCK
756 923 # WSAEINPROGRESS intentionally not checked - it means something else entirely
924 || $! == AnyEvent::Util::WSAEINVAL # not convinced, but doesn't hurt
925 || $! == AnyEvent::Util::WSAEWOULDBLOCK)
926 ) {
927 $state{ww} = AE::io $state{fh}, 1, sub {
757 # we are connected, or maybe there was an error 928 # we are connected, or maybe there was an error
758 if (my $sin = getpeername $state{fh}) { 929 if (my $sin = getpeername $state{fh}) {
759 my ($port, $host) = unpack_sockaddr $sin; 930 my ($port, $host) = unpack_sockaddr $sin;
760 931
932 delete $state{ww}; delete $state{to};
933
761 my $guard = guard { 934 my $guard = guard { %state = () };
762 %state = ();
763 };
764 935
765 $connect->($state{fh}, format_address $host, $port, sub { 936 $connect->(delete $state{fh}, format_address $host, $port, sub {
766 $guard->cancel; 937 $guard->cancel;
938 $state{next}();
939 });
940 } else {
941 if ($! == Errno::ENOTCONN) {
942 # dummy read to fetch real error code if !cygwin
943 sysread $state{fh}, my $buf, 1;
944
945 # cygwin 1.5 continously reports "ready' but never delivers
946 # an error with getpeername or sysread.
947 # cygwin 1.7 only reports readyness *once*, but is otherwise
948 # the same, which is atcually more broken.
949 # Work around both by using unportable SO_ERROR for cygwin.
950 $! = (unpack "l", getsockopt $state{fh}, Socket::SOL_SOCKET(), Socket::SO_ERROR()) || Errno::EAGAIN
951 if AnyEvent::CYGWIN && $! == Errno::EAGAIN;
952 }
953
954 return if $! == Errno::EAGAIN; # skip spurious wake-ups
955
956 delete $state{ww}; delete $state{to};
957
767 $state{next}(); 958 $state{next}();
768 }); 959 }
769 } else {
770 # dummy read to fetch real error code
771 sysread $state{fh}, my $buf, 1 if $! == &Errno::ENOTCONN;
772 $state{next}();
773 } 960 };
774 };
775
776 # now connect
777 if (connect $state{fh}, $sockaddr) {
778 $connected->();
779 } elsif ($! == &Errno::EINPROGRESS # POSIX
780 || $! == &Errno::EWOULDBLOCK
781 # WSAEINPROGRESS intentionally not checked - it means something else entirely
782 || $! == AnyEvent::Util::WSAEINVAL # not convinced, but doesn't hurt
783 || $! == AnyEvent::Util::WSAEWOULDBLOCK) {
784 $state{ww} = AnyEvent->io (fh => $state{fh}, poll => 'w', cb => $connected);
785 } else { 961 } else {
786 $state{next}(); 962 $state{next}();
787 } 963 }
788 }; 964 };
789 965
790 $! = &Errno::ENXIO; 966 $! = Errno::ENXIO;
791 $state{next}(); 967 $state{next}();
792 }; 968 };
793 969
794 defined wantarray && guard { %state = () } 970 defined wantarray && guard { %state = () }
795} 971}
854 }, sub { 1030 }, sub {
855 my ($fh, $thishost, $thisport) = @_; 1031 my ($fh, $thishost, $thisport) = @_;
856 warn "bound to $thishost, port $thisport\n"; 1032 warn "bound to $thishost, port $thisport\n";
857 }; 1033 };
858 1034
1035Example: bind a server on a unix domain socket.
1036
1037 tcp_server "unix/", "/tmp/mydir/mysocket", sub {
1038 my ($fh) = @_;
1039 };
1040
859=cut 1041=cut
860 1042
861sub tcp_server($$$;$) { 1043sub tcp_server($$$;$) {
862 my ($host, $service, $accept, $prepare) = @_; 1044 my ($host, $service, $accept, $prepare) = @_;
863 1045
907 $len ||= 128; 1089 $len ||= 128;
908 1090
909 listen $state{fh}, $len 1091 listen $state{fh}, $len
910 or Carp::croak "listen: $!"; 1092 or Carp::croak "listen: $!";
911 1093
912 $state{aw} = AnyEvent->io (fh => $state{fh}, poll => 'r', cb => sub { 1094 $state{aw} = AE::io $state{fh}, 0, sub {
913 # this closure keeps $state alive 1095 # this closure keeps $state alive
914 while (my $peer = accept my $fh, $state{fh}) { 1096 while ($state{fh} && (my $peer = accept my $fh, $state{fh})) {
915 fh_nonblocking $fh, 1; # POSIX requires inheritance, the outside world does not 1097 fh_nonblocking $fh, 1; # POSIX requires inheritance, the outside world does not
916 1098
917 my ($service, $host) = unpack_sockaddr $peer; 1099 my ($service, $host) = unpack_sockaddr $peer;
918 $accept->($fh, format_address $host, $service); 1100 $accept->($fh, format_address $host, $service);
919 } 1101 }
920 }); 1102 };
921 1103
922 defined wantarray 1104 defined wantarray
923 ? guard { %state = () } # clear fh and watcher, which breaks the circular dependency 1105 ? guard { %state = () } # clear fh and watcher, which breaks the circular dependency
924 : () 1106 : ()
925} 1107}

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines