3 # Copyright (c) 1997-8 Graham Barr <gbarr@pobox.com>. All rights reserved.
4 # This program is free software; you can redistribute it and/or
5 # modify it under the same terms as Perl itself.
7 package IO::Socket::INET;
10 use vars qw(@ISA $VERSION);
16 @ISA = qw(IO::Socket);
19 IO::Socket::INET->register_domain( AF_INET );
21 my %socket_type = ( tcp => SOCK_STREAM,
28 unshift(@_, "PeerAddr") if @_ == 1;
29 return $class->SUPER::new(@_);
33 my($addr,$port,$proto) = @_;
38 if(defined $addr && $addr =~ s,:([\w\(\)/]+)$,,);
41 @proto = $proto =~ m,\D, ? getprotobyname($proto)
42 : getprotobynumber($proto);
44 $proto = $proto[2] || undef;
48 $port =~ s,\((\d+)\)$,,;
50 my $defport = $1 || undef;
51 my $pnum = ($port =~ m,^(\d+)$,)[0];
53 @serv= getservbyname($port, $proto[0] || "")
56 $port = $pnum || $serv[2] || $defport || undef;
58 $proto = (getprotobyname($serv[3]))[2] || undef
62 return ($addr || undef,
71 $@ = join("",ref($sock),": ",@_);
73 if(defined fileno($sock));
78 my($sock,$addr_str, $multi) = @_;
80 if ($multi && $addr_str !~ /^\d+(?:\.\d+){3}$/) {
81 (undef, undef, undef, undef, @addr) = gethostbyname($addr_str);
83 my $h = inet_aton($addr_str);
84 push(@addr, $h) if defined $h;
91 my($lport,$rport,$laddr,$raddr,$proto,$type);
94 $arg->{LocalAddr} = $arg->{LocalHost}
95 if exists $arg->{LocalHost} && !exists $arg->{LocalAddr};
97 ($laddr,$lport,$proto) = _sock_info($arg->{LocalAddr},
101 $laddr = defined $laddr ? inet_aton($laddr)
104 return _error($sock,"Bad hostname '",$arg->{LocalAddr},"'")
105 unless(defined $laddr);
107 $arg->{PeerAddr} = $arg->{PeerHost}
108 if exists $arg->{PeerHost} && !exists $arg->{PeerAddr};
110 unless(exists $arg->{Listen}) {
111 ($raddr,$rport,$proto) = _sock_info($arg->{PeerAddr},
116 $proto ||= (getprotobyname('tcp'))[2];
118 my $pname = (getprotobynumber($proto))[0];
119 $type = $arg->{Type} || $socket_type{$pname};
124 @raddr = $sock->_get_addr($raddr, $arg->{MultiHomed});
125 return _error($sock,"Bad hostname '",$arg->{PeerAddr},"'")
131 $sock->socket(AF_INET, $type, $proto) or
132 return _error($sock,"$!");
135 $sock->sockopt(SO_REUSEADDR,1) or
136 return _error($sock,"$!");
139 if($lport || ($laddr ne INADDR_ANY) || exists $arg->{Listen}) {
140 $sock->bind($lport || 0, $laddr) or
141 return _error($sock,"$!");
144 if(exists $arg->{Listen}) {
145 $sock->listen($arg->{Listen} || 5) or
146 return _error($sock,"$!");
150 $raddr = shift @raddr;
152 return _error($sock,'Cannot determine remote port')
153 unless($rport || $type == SOCK_DGRAM || $type == SOCK_RAW);
156 unless($type == SOCK_STREAM || defined $raddr);
158 return _error($sock,"Bad hostname '",$arg->{PeerAddr},"'")
159 unless defined $raddr;
161 # my $timeout = ${*$sock}{'io_socket_timeout'};
162 # my $before = time() if $timeout;
164 if ($sock->connect(pack_sockaddr_in($rport, $raddr))) {
165 # ${*$sock}{'io_socket_timeout'} = $timeout;
169 return _error($sock,"$!")
173 # my $new_timeout = $timeout - (time() - $before);
174 # return _error($sock, "Timeout") if $new_timeout <= 0;
175 # ${*$sock}{'io_socket_timeout'} = $new_timeout;
184 @_ == 2 || @_ == 3 or
185 croak 'usage: $sock->connect(NAME) or $sock->connect(PORT, ADDR)';
187 return $sock->SUPER::connect(@_ == 1 ? shift : pack_sockaddr_in(@_));
191 @_ == 2 || @_ == 3 or
192 croak 'usage: $sock->bind(NAME) or $sock->bind(PORT, ADDR)';
194 return $sock->SUPER::bind(@_ == 1 ? shift : pack_sockaddr_in(@_))
198 @_ == 1 or croak 'usage: $sock->sockaddr()';
200 my $name = $sock->sockname;
201 $name ? (sockaddr_in($name))[1] : undef;
205 @_ == 1 or croak 'usage: $sock->sockport()';
207 my $name = $sock->sockname;
208 $name ? (sockaddr_in($name))[0] : undef;
212 @_ == 1 or croak 'usage: $sock->sockhost()';
214 my $addr = $sock->sockaddr;
215 $addr ? inet_ntoa($addr) : undef;
219 @_ == 1 or croak 'usage: $sock->peeraddr()';
221 my $name = $sock->peername;
222 $name ? (sockaddr_in($name))[1] : undef;
226 @_ == 1 or croak 'usage: $sock->peerport()';
228 my $name = $sock->peername;
229 $name ? (sockaddr_in($name))[0] : undef;
233 @_ == 1 or croak 'usage: $sock->peerhost()';
235 my $addr = $sock->peeraddr;
236 $addr ? inet_ntoa($addr) : undef;
245 IO::Socket::INET - Object interface for AF_INET domain sockets
249 use IO::Socket::INET;
253 C<IO::Socket::INET> provides an object interface to creating and using sockets
254 in the AF_INET domain. It is built upon the L<IO::Socket> interface and
255 inherits all the methods defined by L<IO::Socket>.
263 Creates an C<IO::Socket::INET> object, which is a reference to a
264 newly created symbol (see the C<Symbol> package). C<new>
265 optionally takes arguments, these arguments are in key-value pairs.
267 In addition to the key-value pairs accepted by L<IO::Socket>,
268 C<IO::Socket::INET> provides.
271 PeerAddr Remote host address <hostname>[:<port>]
272 PeerHost Synonym for PeerAddr
273 PeerPort Remote port or service <service>[(<no>)] | <no>
274 LocalAddr Local host bind address hostname[:port]
275 LocalHost Synonym for LocalAddr
276 LocalPort Local host bind port <service>[(<no>)] | <no>
277 Proto Protocol name (or number) "tcp" | "udp" | ...
278 Type Socket type SOCK_STREAM | SOCK_DGRAM | ...
279 Listen Queue size for listen
280 Reuse Set SO_REUSEADDR before binding
281 Timeout Timeout value for various operations
282 MultiHomed Try all adresses for multi-homed hosts
285 If C<Listen> is defined then a listen socket is created, else if the
286 socket type, which is derived from the protocol, is SOCK_STREAM then
289 Although it is not illegal, the use of C<MultiHomed> on a socket
290 which is in non-blocking mode is of little use. This is because the
291 first connect will never fail with a timeout as the connaect call
294 The C<PeerAddr> can be a hostname or the IP-address on the
295 "xx.xx.xx.xx" form. The C<PeerPort> can be a number or a symbolic
296 service name. The service name might be followed by a number in
297 parenthesis which is used if the service is not known by the system.
298 The C<PeerPort> specification can also be embedded in the C<PeerAddr>
299 by preceding it with a ":".
301 If C<Proto> is not given and you specify a symbolic C<PeerPort> port,
302 then the constructor will try to derive C<Proto> from the service
303 name. As a last resort C<Proto> "tcp" is assumed. The C<Type>
304 parameter will be deduced from C<Proto> if not specified.
306 If the constructor is only passed a single argument, it is assumed to
307 be a C<PeerAddr> specification.
311 $sock = IO::Socket::INET->new(PeerAddr => 'www.perl.org',
312 PeerPort => 'http(80)',
315 $sock = IO::Socket::INET->new(PeerAddr => 'localhost:smtp(25)');
317 $sock = IO::Socket::INET->new(Listen => 5,
318 LocalAddr => 'localhost',
322 $sock = IO::Socket::INET->new('127.0.0.1:25');
325 NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE
327 As of VERSION 1.18 all IO::Socket objects have autoflush turned on
328 by default. This was not the case with earlier releases.
330 NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE NOTE
338 Return the address part of the sockaddr structure for the socket
342 Return the port number that the socket is using on the local host
346 Return the address part of the sockaddr structure for the socket in a
347 text form xx.xx.xx.xx
351 Return the address part of the sockaddr structure for the socket on
356 Return the port number for the socket on the peer host.
360 Return the address part of the sockaddr structure for the socket on the
361 peer host in a text form xx.xx.xx.xx
367 L<Socket>, L<IO::Socket>
371 Graham Barr E<lt>F<gbarr@pobox.com>E<gt>
375 Copyright (c) 1996-8 Graham Barr <gbarr@pobox.com>. All rights reserved.
376 This program is free software; you can redistribute it and/or
377 modify it under the same terms as Perl itself.