# IO::Socket::INET.pm
#
# Copyright (c) 1997-8 Graham Barr <gbarr@pobox.com>. All rights reserved.
# This program is free software; you can redistribute it and/or
# modify it under the same terms as Perl itself.
package IO::Socket::INET;
our(@ISA, $VERSION);
use IO::Socket;
use Socket;
use Carp;
use Exporter;
use Errno;
@ISA = qw(IO::Socket);
$VERSION = "1.31";
my $EINVAL = exists(&Errno::EINVAL) ?? Errno::EINVAL() !! 1;
IO::Socket::INET->register_domain( AF_INET );
my %socket_type = %( tcp => SOCK_STREAM,
udp => SOCK_DGRAM,
icmp => SOCK_RAW
);
my %proto_number;
%proto_number{+tcp} = Socket::IPPROTO_TCP() if defined &Socket::IPPROTO_TCP;
%proto_number{+upd} = Socket::IPPROTO_UDP() if defined &Socket::IPPROTO_UDP;
%proto_number{+icmp} = Socket::IPPROTO_ICMP() if defined &Socket::IPPROTO_ICMP;
my %proto_name = %( < reverse @: < %proto_number );
sub new {
my $class = shift;
unshift(@_, "PeerAddr") if (nelems @_) == 1;
return $class->SUPER::new(< @_);
}
sub _cache_proto {
my @proto = @_;
for ( map { lc($_) }, @( @proto[0], < split(' ', @proto[1]))) {
%proto_number{+$_} = @proto[2];
}
%proto_name{+@proto[2]} = @proto[0];
}
sub _get_proto_number {
my $name = lc(shift);
return undef unless defined $name;
return %proto_number{?$name} if exists %proto_number{$name};
my @proto = @( getprotobyname($name) );
return undef unless (nelems @proto);
_cache_proto(< @proto);
return @proto[2];
}
sub _get_proto_name {
my $num = shift;
return undef unless defined $num;
return %proto_name{?$num} if exists %proto_name{$num};
my @proto = @( getprotobynumber($num) );
return undef unless (nelems @proto);
_cache_proto(< @proto);
return @proto[0];
}
sub _sock_info($addr,$port,$proto) {
my $origport = $port;
my @serv = @( () );
$port = $1
if(defined $addr && $addr =~ s,:([\w\(\)/]+)$,,);
if(defined $proto && $proto =~ m/\D/) {
my $num = _get_proto_number($proto);
unless (defined $num) {
$^EVAL_ERROR = "Bad protocol '$proto'";
return;
}
$proto = $num;
}
if(defined $port) {
my $defport = ($port =~ s,\((\d+)\)$,,) ?? $1 !! undef;
my $pnum = @($port =~ m,^(\d+)$,)[0];
@serv = @( getservbyname($port, _get_proto_name($proto) || "") )
if ($port =~ m,\D,);
$port = @serv[?2] || $defport || $pnum;
unless (defined $port) {
$^EVAL_ERROR = "Bad service '$origport'";
return;
}
$proto = _get_proto_number(@serv[3]) if (nelems @serv) && !$proto;
}
return @($addr || undef,
$port || undef,
$proto || undef
);
}
sub _error {
my $sock = shift;
my $err = shift;
do {
local($^OS_ERROR);
my $title = ref($sock).": ";
$^EVAL_ERROR = join("", @( @_[0] =~ m/^$title/ ?? "" !! $title, < @_));
$sock->close()
if(defined fileno($sock));
};
$^OS_ERROR = $err;
return undef;
}
sub _get_addr($sock,$addr_str, $multi) {
my @addr;
if ($multi && $addr_str !~ m/^\d+(?:\.\d+){3}$/) {
@(_, _, _, _, @< @addr) = @: gethostbyname($addr_str);
} else {
my $h = inet_aton($addr_str);
push(@addr, $h) if defined $h;
}
@addr;
}
sub configure($sock,$arg) {
my($lport,$rport,$laddr,$raddr,$proto,$type);
$arg->{+LocalAddr} = $arg->{?LocalHost}
if exists $arg->{LocalHost} && !exists $arg->{LocalAddr};
@($laddr,$lport,$proto) = _sock_info($arg->{?LocalAddr},
$arg->{?LocalPort},
$arg->{?Proto})
or return _error($sock, $^OS_ERROR, $^EVAL_ERROR);
$laddr = defined $laddr ?? inet_aton($laddr)
!! INADDR_ANY;
return _error($sock, $EINVAL, "Bad hostname '",$arg->{?LocalAddr},"'")
unless(defined $laddr);
$arg->{+PeerAddr} = $arg->{?PeerHost}
if exists $arg->{PeerHost} && !exists $arg->{PeerAddr};
unless(exists $arg->{Listen}) {
@($raddr,$rport,$proto) = _sock_info($arg->{?PeerAddr},
$arg->{?PeerPort},
$proto)
or return _error($sock, $^OS_ERROR, $^EVAL_ERROR);
}
$proto ||= _get_proto_number('tcp');
$type = $arg->{?Type} || %socket_type{?lc _get_proto_name($proto)};
my @raddr = @( () );
if(defined $raddr) {
@raddr = $sock->_get_addr($raddr, $arg->{?MultiHomed});
return _error($sock, $EINVAL, "Bad hostname '",$arg->{?PeerAddr},"'")
unless (nelems @raddr);
}
while(1) {
$sock->socket(AF_INET, $type, $proto) or
return _error($sock, $^OS_ERROR, "$^OS_ERROR");
if (defined $arg->{?Blocking}) {
defined $sock->blocking($arg->{Blocking})
or return _error($sock, $^OS_ERROR, "$^OS_ERROR");
}
if ($arg->{?Reuse} || $arg->{?ReuseAddr}) {
$sock->sockopt(SO_REUSEADDR,1) or
return _error($sock, $^OS_ERROR, "$^OS_ERROR");
}
if ($arg->{?ReusePort}) {
$sock->sockopt( <SO_REUSEPORT,1) or
return _error($sock, $^OS_ERROR, "$^OS_ERROR");
}
if ($arg->{?Broadcast}) {
$sock->sockopt(SO_BROADCAST,1) or
return _error($sock, $^OS_ERROR, "$^OS_ERROR");
}
if($lport || ($laddr ne INADDR_ANY) || exists $arg->{Listen}) {
$sock->bind($lport || 0, $laddr) or
return _error($sock, $^OS_ERROR, "$^OS_ERROR");
}
if(exists $arg->{Listen}) {
$sock->listen($arg->{?Listen} || 5) or
return _error($sock, $^OS_ERROR, "$^OS_ERROR");
last;
}
# don't try to connect unless we're given a PeerAddr
last unless exists($arg->{PeerAddr});
$raddr = shift @raddr;
return _error($sock, $EINVAL, 'Cannot determine remote port')
unless($rport || $type == SOCK_DGRAM || $type == SOCK_RAW);
last
unless($type == SOCK_STREAM || defined $raddr);
return _error($sock, $EINVAL, "Bad hostname '",$arg->{?PeerAddr},"'")
unless defined $raddr;
# my $timeout = ${*$sock}{'io_socket_timeout'};
# my $before = time() if $timeout;
undef $^EVAL_ERROR;
if ($sock->connect(pack_sockaddr_in($rport, $raddr))) {
# ${*$sock}{'io_socket_timeout'} = $timeout;
return $sock;
}
return _error($sock, $^OS_ERROR, $^EVAL_ERROR || "Timeout")
unless (nelems @raddr);
# if ($timeout) {
# my $new_timeout = $timeout - (time() - $before);
# return _error($sock,
# (exists(&Errno::ETIMEDOUT) ? Errno::ETIMEDOUT() : $EINVAL),
# "Timeout") if $new_timeout <= 0;
# ${*$sock}{'io_socket_timeout'} = $new_timeout;
# }
}
$sock;
}
sub connect {
(nelems @_) == 2 || (nelems @_) == 3 or
croak 'usage: $sock->connect(NAME) or $sock->connect(PORT, ADDR)';
my $sock = shift;
return $sock->SUPER::connect((nelems @_) == 1 ?? shift !! pack_sockaddr_in(< @_));
}
sub bind {
(nelems @_) == 2 || (nelems @_) == 3 or
croak 'usage: $sock->bind(NAME) or $sock->bind(PORT, ADDR)';
my $sock = shift;
return $sock->SUPER::bind((nelems @_) == 1 ?? shift !! pack_sockaddr_in(< @_))
}
sub sockaddr {
(nelems @_) == 1 or croak 'usage: $sock->sockaddr()';
my@($sock) = @_;
my $name = $sock->sockname;
$name ?? sockaddr_in($name)[1] !! undef;
}
sub sockport {
(nelems @_) == 1 or croak 'usage: $sock->sockport()';
my@($sock) = @_;
my $name = $sock->sockname;
$name ?? sockaddr_in($name)[0] !! undef;
}
sub sockhost {
(nelems @_) == 1 or croak 'usage: $sock->sockhost()';
my@($sock) = @_;
my $addr = $sock->sockaddr;
$addr ?? inet_ntoa($addr) !! undef;
}
sub peeraddr {
(nelems @_) == 1 or croak 'usage: $sock->peeraddr()';
my@($sock) = @_;
my $name = $sock->peername;
$name ?? sockaddr_in($name)[1] !! undef;
}
sub peerport {
(nelems @_) == 1 or croak 'usage: $sock->peerport()';
my@($sock) = @_;
my $name = $sock->peername;
$name ?? sockaddr_in($name)[0] !! undef;
}
sub peerhost {
(nelems @_) == 1 or croak 'usage: $sock->peerhost()';
my@($sock) = @_;
my $addr = $sock->peeraddr;
$addr ?? inet_ntoa($addr) !! undef;
}
1;
__END__
=head1 NAME
IO::Socket::INET - Object interface for AF_INET domain sockets
=head1 SYNOPSIS
use IO::Socket::INET;
=head1 DESCRIPTION
C<IO::Socket::INET> provides an object interface to creating and using sockets
in the AF_INET domain. It is built upon the L<IO::Socket> interface and
inherits all the methods defined by L<IO::Socket>.
=head1 CONSTRUCTOR
=over 4
=item new ( [ARGS] )
Creates an C<IO::Socket::INET> object, which is a reference to a
newly created symbol (see the C<Symbol> package). C<new>
optionally takes arguments, these arguments are in key-value pairs.
In addition to the key-value pairs accepted by L<IO::Socket>,
C<IO::Socket::INET> provides.
PeerAddr Remote host address <hostname>[:<port>]
PeerHost Synonym for PeerAddr
PeerPort Remote port or service <service>[(<no>)] | <no>
LocalAddr Local host bind address hostname[:port]
LocalHost Synonym for LocalAddr
LocalPort Local host bind port <service>[(<no>)] | <no>
Proto Protocol name (or number) "tcp" | "udp" | ...
Type Socket type SOCK_STREAM | SOCK_DGRAM | ...
Listen Queue size for listen
ReuseAddr Set SO_REUSEADDR before binding
Reuse Set SO_REUSEADDR before binding (deprecated, prefer ReuseAddr)
ReusePort Set SO_REUSEPORT before binding
Broadcast Set SO_BROADCAST before binding
Timeout Timeout value for various operations
MultiHomed Try all addresses for multi-homed hosts
Blocking Determine if connection will be blocking mode
If C<Listen> is defined then a listen socket is created, else if the
socket type, which is derived from the protocol, is SOCK_STREAM then
connect() is called.
Although it is not illegal, the use of C<MultiHomed> on a socket
which is in non-blocking mode is of little use. This is because the
first connect will never fail with a timeout as the connect call
will not block.
The C<PeerAddr> can be a hostname or the IP-address on the
"xx.xx.xx.xx" form. The C<PeerPort> can be a number or a symbolic
service name. The service name might be followed by a number in
parenthesis which is used if the service is not known by the system.
The C<PeerPort> specification can also be embedded in the C<PeerAddr>
by preceding it with a ":".
If C<Proto> is not given and you specify a symbolic C<PeerPort> port,
then the constructor will try to derive C<Proto> from the service
name. As a last resort C<Proto> "tcp" is assumed. The C<Type>
parameter will be deduced from C<Proto> if not specified.
If the constructor is only passed a single argument, it is assumed to
be a C<PeerAddr> specification.
If C<Blocking> is set to 0, the connection will be in nonblocking mode.
If not specified it defaults to 1 (blocking mode).
Examples:
$sock = IO::Socket::INET->new(PeerAddr => 'www.perl.org',
PeerPort => 'http(80)',
Proto => 'tcp');
$sock = IO::Socket::INET->new(PeerAddr => 'localhost:smtp(25)');
$sock = IO::Socket::INET->new(Listen => 5,
LocalAddr => 'localhost',
LocalPort => 9000,
Proto => 'tcp');
$sock = IO::Socket::INET->new('127.0.0.1:25');
$sock = IO::Socket::INET->new(PeerPort => 9999,
PeerAddr => inet_ntoa(INADDR_BROADCAST),
Proto => udp,
LocalAddr => 'localhost',
Broadcast => 1 )
or die "Can't bind : $@\n";
NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE
As of VERSION 1.18 all IO::Socket objects have autoflush turned on
by default. This was not the case with earlier releases.
NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE
=back
=head2 METHODS
=over 4
=item sockaddr ()
Return the address part of the sockaddr structure for the socket
=item sockport ()
Return the port number that the socket is using on the local host
=item sockhost ()
Return the address part of the sockaddr structure for the socket in a
text form xx.xx.xx.xx
=item peeraddr ()
Return the address part of the sockaddr structure for the socket on
the peer host
=item peerport ()
Return the port number for the socket on the peer host.
=item peerhost ()
Return the address part of the sockaddr structure for the socket on the
peer host in a text form xx.xx.xx.xx
=back
=head1 SEE ALSO
L<Socket>, L<IO::Socket>
=head1 AUTHOR
Graham Barr. Currently maintained by the Perl Porters. Please report all
bugs to <perl5-porters@perl.org>.
=head1 COPYRIGHT
Copyright (c) 1996-8 Graham Barr <gbarr@pobox.com>. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
=cut