This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Socket::sockaddr_family
[perl5.git] / ext / Socket / Socket.pm
index 1ed19f7..c8f2fde 100644 (file)
@@ -1,7 +1,7 @@
 package Socket;
 
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
-$VERSION = "1.7";
+our($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
+$VERSION = "1.75";
 
 =head1 NAME
 
@@ -56,29 +56,34 @@ be imported individually, and with the C<:crlf> export tag:
 
 In addition, some structure manipulation functions are available:
 
-=over
+=over 4
 
 =item inet_aton HOSTNAME
 
-Takes a string giving the name of a host, and translates that
-to the 4-byte string (structure). Takes arguments of both
-the 'rtfm.mit.edu' type and '18.181.0.24'. If the host name
-cannot be resolved, returns undef. For multi-homed hosts (hosts
-with more than one address), the first address found is returned.
+Takes a string giving the name of a host, and translates that to an
+opaque string (if programming in C, struct in_addr). Takes arguments
+of both the 'rtfm.mit.edu' type and '18.181.0.24'. If the host name
+cannot be resolved, returns undef.  For multi-homed hosts (hosts with
+more than one address), the first address found is returned.
+
+For portability do not assume that the result of inet_aton() is 32
+bits wide, in other words, that it would contain only the IPv4 address
+in network order.
 
 =item inet_ntoa IP_ADDRESS
 
-Takes a four byte ip address (as returned by inet_aton())
-and translates it into a string of the form 'd.d.d.d'
-where the 'd's are numbers less than 256 (the normal
-readable four dotted number notation for internet addresses).
+Takes a string (an opaque string as returned by inet_aton(),
+or a v-string representing the four octets of the IPv4 address in
+network order) and translates it into a string of the form 'd.d.d.d'
+where the 'd's are numbers less than 256 (the normal human-readable
+four dotted number notation for Internet addresses).
 
 =item INADDR_ANY
 
 Note: does not return a number, but a packed string.
 
 Returns the 4-byte wildcard ip address which specifies any
-of the hosts ip addresses. (A particular machine can have
+of the hosts ip addresses.  (A particular machine can have
 more than one ip address, each address corresponding to
 a particular network interface. This wildcard address
 allows you to bind to all of them simultaneously.)
@@ -97,45 +102,56 @@ Normally equivalent to inet_aton('255.255.255.255').
 
 Note - does not return a number.
 
-Returns the 4-byte loopback address. Normally equivalent
+Returns the 4-byte loopback address.  Normally equivalent
 to inet_aton('localhost').
 
 =item INADDR_NONE
 
 Note - does not return a number.
 
-Returns the 4-byte 'invalid' ip address. Normally equivalent
+Returns the 4-byte 'invalid' ip address.  Normally equivalent
 to inet_aton('255.255.255.255').
 
+=item sockaddr_family SOCKADDR
+
+Takes a sockaddr structure (as returned by pack_sockaddr_in(),
+pack_sockaddr_un() or the perl builtin functions getsockname() and
+getpeername()) and returns the address family tag.  It will match the
+constant AF_INET for a sockaddr_in and AF_UNIX for a sockaddr_un.  It
+can be used to figure out what unpacker to use for a sockaddr of
+unknown type.
+
 =item sockaddr_in PORT, ADDRESS
 
 =item sockaddr_in SOCKADDR_IN
 
-In an array context, unpacks its SOCKADDR_IN argument and returns an array
+In a list context, unpacks its SOCKADDR_IN argument and returns an array
 consisting of (PORT, ADDRESS).  In a scalar context, packs its (PORT,
 ADDRESS) arguments as a SOCKADDR_IN and returns it.  If this is confusing,
 use pack_sockaddr_in() and unpack_sockaddr_in() explicitly.
 
 =item pack_sockaddr_in PORT, IP_ADDRESS
 
-Takes two arguments, a port number and a 4 byte IP_ADDRESS (as returned by
-inet_aton()). Returns the sockaddr_in structure with those arguments
-packed in with AF_INET filled in.  For internet domain sockets, this
-structure is normally what you need for the arguments in bind(),
-connect(), and send(), and is also returned by getpeername(),
-getsockname() and recv().
+Takes two arguments, a port number and an opaque string, IP_ADDRESS
+(as returned by inet_aton(), or a v-string).  Returns the sockaddr_in
+structure with those arguments packed in with AF_INET filled in.  For
+Internet domain sockets, this structure is normally what you need for
+the arguments in bind(), connect(), and send(), and is also returned
+by getpeername(), getsockname() and recv().
 
 =item unpack_sockaddr_in SOCKADDR_IN
 
 Takes a sockaddr_in structure (as returned by pack_sockaddr_in()) and
-returns an array of two elements: the port and the 4-byte ip-address.
-Will croak if the structure does not have AF_INET in the right place.
+returns an array of two elements: the port and an opaque string
+representing the IP address (you can use inet_ntoa() to convert the
+address to the four-dotted numeric format).  Will croak if the
+structure does not have AF_INET in the right place.
 
 =item sockaddr_un PATHNAME
 
 =item sockaddr_un SOCKADDR_UN
 
-In an array context, unpacks its SOCKADDR_UN argument and returns an array
+In a list context, unpacks its SOCKADDR_UN argument and returns an array
 consisting of (PATHNAME).  In a scalar context, packs its PATHNAME
 arguments as a SOCKADDR_UN and returns it.  If this is confusing, use
 pack_sockaddr_un() and unpack_sockaddr_un() explicitly.
@@ -160,19 +176,24 @@ have AF_UNIX in the right place.
 =cut
 
 use Carp;
+use warnings::register;
 
 require Exporter;
-require DynaLoader;
-@ISA = qw(Exporter DynaLoader);
+use XSLoader ();
+@ISA = qw(Exporter);
 @EXPORT = qw(
-       inet_aton inet_ntoa pack_sockaddr_in unpack_sockaddr_in
+       inet_aton inet_ntoa
+       sockaddr_family
+       pack_sockaddr_in unpack_sockaddr_in
        pack_sockaddr_un unpack_sockaddr_un
        sockaddr_in sockaddr_un
        INADDR_ANY INADDR_BROADCAST INADDR_LOOPBACK INADDR_NONE
        AF_802
+       AF_AAL
        AF_APPLETALK
        AF_CCITT
        AF_CHAOS
+       AF_CTF
        AF_DATAKIT
        AF_DECnet
        AF_DLI
@@ -181,7 +202,12 @@ require DynaLoader;
        AF_HYLINK
        AF_IMPLINK
        AF_INET
+       AF_INET6
+       AF_ISO
+       AF_KEY
+       AF_LAST
        AF_LAT
+       AF_LINK
        AF_MAX
        AF_NBS
        AF_NIT
@@ -189,10 +215,16 @@ require DynaLoader;
        AF_OSI
        AF_OSINET
        AF_PUP
+       AF_ROUTE
        AF_SNA
        AF_UNIX
        AF_UNSPEC
+       AF_USER
+       AF_WAN
        AF_X25
+       IOV_MAX
+       MSG_BCAST
+       MSG_BTAG
        MSG_CTLFLAGS
        MSG_CTLIGNORE
        MSG_CTRUNC
@@ -201,8 +233,10 @@ require DynaLoader;
        MSG_EOF
        MSG_EOR
        MSG_ERRQUEUE
+       MSG_ETAG
        MSG_FIN
        MSG_MAXIOVLEN
+       MSG_MCAST
        MSG_NOSIGNAL
        MSG_OOB
        MSG_PEEK
@@ -212,10 +246,13 @@ require DynaLoader;
        MSG_TRUNC
        MSG_URG
        MSG_WAITALL
+       MSG_WIRE
        PF_802
+       PF_AAL
        PF_APPLETALK
        PF_CCITT
        PF_CHAOS
+       PF_CTF
        PF_DATAKIT
        PF_DECnet
        PF_DLI
@@ -224,7 +261,12 @@ require DynaLoader;
        PF_HYLINK
        PF_IMPLINK
        PF_INET
+       PF_INET6
+       PF_ISO
+       PF_KEY
+       PF_LAST
        PF_LAT
+       PF_LINK
        PF_MAX
        PF_NBS
        PF_NIT
@@ -232,15 +274,21 @@ require DynaLoader;
        PF_OSI
        PF_OSINET
        PF_PUP
+       PF_ROUTE
        PF_SNA
        PF_UNIX
        PF_UNSPEC
+       PF_USER
+       PF_WAN
        PF_X25
        SCM_CONNECT
        SCM_CREDENTIALS
        SCM_CREDS
        SCM_RIGHTS
        SCM_TIMESTAMP
+       SHUT_RD
+       SHUT_RDWR
+       SHUT_WR
        SOCK_DGRAM
        SOCK_RAW
        SOCK_RDM
@@ -249,26 +297,52 @@ require DynaLoader;
        SOL_SOCKET
        SOMAXCONN
        SO_ACCEPTCONN
+       SO_ATTACH_FILTER
+       SO_BACKLOG
        SO_BROADCAST
+       SO_CHAMELEON
        SO_DEBUG
+       SO_DETACH_FILTER
+       SO_DGRAM_ERRIND
        SO_DONTLINGER
        SO_DONTROUTE
        SO_ERROR
+       SO_FAMILY
        SO_KEEPALIVE
        SO_LINGER
        SO_OOBINLINE
+       SO_PASSCRED
+       SO_PASSIFNAME
+       SO_PEERCRED
+       SO_PROTOCOL
+       SO_PROTOTYPE
        SO_RCVBUF
        SO_RCVLOWAT
        SO_RCVTIMEO
        SO_REUSEADDR
+       SO_REUSEPORT
+       SO_SECURITY_AUTHENTICATION
+       SO_SECURITY_ENCRYPTION_NETWORK
+       SO_SECURITY_ENCRYPTION_TRANSPORT
        SO_SNDBUF
        SO_SNDLOWAT
        SO_SNDTIMEO
+       SO_STATE
        SO_TYPE
        SO_USELOOPBACK
+       SO_XOPEN
+       SO_XSE
+       UIO_MAXIOV
 );
 
-@EXPORT_OK = qw(CR LF CRLF $CR $LF $CRLF);
+@EXPORT_OK = qw(CR LF CRLF $CR $LF $CRLF
+
+              IPPROTO_TCP
+              TCP_KEEPALIVE
+              TCP_MAXRT
+              TCP_MAXSEG
+              TCP_NODELAY
+              TCP_STDURG);
 
 %EXPORT_TAGS = (
     crlf    => [qw(CR LF CRLF $CR $LF $CRLF)],
@@ -288,7 +362,8 @@ BEGIN {
 sub sockaddr_in {
     if (@_ == 6 && !wantarray) { # perl5.001m compat; use this && die
        my($af, $port, @quad) = @_;
-       carp "6-ARG sockaddr_in call is deprecated" if $^W;
+       warnings::warn "6-ARG sockaddr_in call is deprecated" 
+           if warnings::enabled();
        pack_sockaddr_in($port, inet_aton(join('.', @quad)));
     } elsif (wantarray) {
        croak "usage:   (port,iaddr) = sockaddr_in(sin_sv)" unless @_ == 1;
@@ -309,19 +384,18 @@ sub sockaddr_un {
     }
 }
 
-
 sub AUTOLOAD {
     my($constname);
     ($constname = $AUTOLOAD) =~ s/.*:://;
-    my $val = constant($constname, @_ ? $_[0] : 0);
-    if ($! != 0) {
-       my ($pack,$file,$line) = caller;
-       croak "Your vendor has not defined Socket macro $constname, used";
+    croak "&Socket::constant not defined" if $constname eq 'constant';
+    my ($error, $val) = constant($constname);
+    if ($error) {
+       croak $error;
     }
-    eval "sub $AUTOLOAD { $val }";
+    *$AUTOLOAD = sub { $val };
     goto &$AUTOLOAD;
 }
 
-bootstrap Socket $VERSION;
+XSLoader::load 'Socket', $VERSION;
 
 1;