ext/Socket/Socket.pm

   1 package Socket;
   2
   3 our($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
   4 $VERSION = "1.71";
   5
   6 =head1 NAME
   7
   8 Socket, sockaddr_in, sockaddr_un, inet_aton, inet_ntoa - load the C socket.h defines and structure manipulators
   9
  10 =head1 SYNOPSIS
  11
  12     use Socket;
  13
  14     $proto = getprotobyname('udp');
  15     socket(Socket_Handle, PF_INET, SOCK_DGRAM, $proto);
  16     $iaddr = gethostbyname('hishost.com');
  17     $port = getservbyname('time', 'udp');
  18     $sin = sockaddr_in($port, $iaddr);
  19     send(Socket_Handle, 0, 0, $sin);
  20
  21     $proto = getprotobyname('tcp');
  22     socket(Socket_Handle, PF_INET, SOCK_STREAM, $proto);
  23     $port = getservbyname('smtp', 'tcp');
  24     $sin = sockaddr_in($port,inet_aton("127.1"));
  25     $sin = sockaddr_in(7,inet_aton("localhost"));
  26     $sin = sockaddr_in(7,INADDR_LOOPBACK);
  27     connect(Socket_Handle,$sin);
  28
  29     ($port, $iaddr) = sockaddr_in(getpeername(Socket_Handle));
  30     $peer_host = gethostbyaddr($iaddr, AF_INET);
  31     $peer_addr = inet_ntoa($iaddr);
  32
  33     $proto = getprotobyname('tcp');
  34     socket(Socket_Handle, PF_UNIX, SOCK_STREAM, $proto);
  35     unlink('/tmp/usock');
  36     $sun = sockaddr_un('/tmp/usock');
  37     connect(Socket_Handle,$sun);
  38
  39 =head1 DESCRIPTION
  40
  41 This module is just a translation of the C F<socket.h> file.
  42 Unlike the old mechanism of requiring a translated F<socket.ph>
  43 file, this uses the B<h2xs> program (see the Perl source distribution)
  44 and your native C compiler.  This means that it has a
  45 far more likely chance of getting the numbers right.  This includes
  46 all of the commonly used pound-defines like AF_INET, SOCK_STREAM, etc.
  47
  48 Also, some common socket "newline" constants are provided: the
  49 constants C<CR>, C<LF>, and C<CRLF>, as well as C<$CR>, C<$LF>, and
  50 C<$CRLF>, which map to C<\015>, C<\012>, and C<\015\012>.  If you do
  51 not want to use the literal characters in your programs, then use
  52 the constants provided here.  They are not exported by default, but can
  53 be imported individually, and with the C<:crlf> export tag:
  54
  55     use Socket qw(:DEFAULT :crlf);
  56
  57 In addition, some structure manipulation functions are available:
  58
  59 =over
  60
  61 =item inet_aton HOSTNAME
  62
  63 Takes a string giving the name of a host, and translates that
  64 to the 4-byte string (structure). Takes arguments of both
  65 the 'rtfm.mit.edu' type and '18.181.0.24'. If the host name
  66 cannot be resolved, returns undef. For multi-homed hosts (hosts
  67 with more than one address), the first address found is returned.
  68
  69 =item inet_ntoa IP_ADDRESS
  70
  71 Takes a four byte ip address (as returned by inet_aton())
  72 and translates it into a string of the form 'd.d.d.d'
  73 where the 'd's are numbers less than 256 (the normal
  74 readable four dotted number notation for internet addresses).
  75
  76 =item INADDR_ANY
  77
  78 Note: does not return a number, but a packed string.
  79
  80 Returns the 4-byte wildcard ip address which specifies any
  81 of the hosts ip addresses. (A particular machine can have
  82 more than one ip address, each address corresponding to
  83 a particular network interface. This wildcard address
  84 allows you to bind to all of them simultaneously.)
  85 Normally equivalent to inet_aton('0.0.0.0').
  86
  87 =item INADDR_BROADCAST
  88
  89 Note: does not return a number, but a packed string.
  90
  91 Returns the 4-byte 'this-lan' ip broadcast address.
  92 This can be useful for some protocols to solicit information
  93 from all servers on the same LAN cable.
  94 Normally equivalent to inet_aton('255.255.255.255').
  95
  96 =item INADDR_LOOPBACK
  97
  98 Note - does not return a number.
  99
 100 Returns the 4-byte loopback address. Normally equivalent
 101 to inet_aton('localhost').
 102
 103 =item INADDR_NONE
 104
 105 Note - does not return a number.
 106
 107 Returns the 4-byte 'invalid' ip address. Normally equivalent
 108 to inet_aton('255.255.255.255').
 109
 110 =item sockaddr_in PORT, ADDRESS
 111
 112 =item sockaddr_in SOCKADDR_IN
 113
 114 In an array context, unpacks its SOCKADDR_IN argument and returns an array
 115 consisting of (PORT, ADDRESS).  In a scalar context, packs its (PORT,
 116 ADDRESS) arguments as a SOCKADDR_IN and returns it.  If this is confusing,
 117 use pack_sockaddr_in() and unpack_sockaddr_in() explicitly.
 118
 119 =item pack_sockaddr_in PORT, IP_ADDRESS
 120
 121 Takes two arguments, a port number and a 4 byte IP_ADDRESS (as returned by
 122 inet_aton()). Returns the sockaddr_in structure with those arguments
 123 packed in with AF_INET filled in.  For internet domain sockets, this
 124 structure is normally what you need for the arguments in bind(),
 125 connect(), and send(), and is also returned by getpeername(),
 126 getsockname() and recv().
 127
 128 =item unpack_sockaddr_in SOCKADDR_IN
 129
 130 Takes a sockaddr_in structure (as returned by pack_sockaddr_in()) and
 131 returns an array of two elements: the port and the 4-byte ip-address.
 132 Will croak if the structure does not have AF_INET in the right place.
 133
 134 =item sockaddr_un PATHNAME
 135
 136 =item sockaddr_un SOCKADDR_UN
 137
 138 In an array context, unpacks its SOCKADDR_UN argument and returns an array
 139 consisting of (PATHNAME).  In a scalar context, packs its PATHNAME
 140 arguments as a SOCKADDR_UN and returns it.  If this is confusing, use
 141 pack_sockaddr_un() and unpack_sockaddr_un() explicitly.
 142 These are only supported if your system has E<lt>F<sys/un.h>E<gt>.
 143
 144 =item pack_sockaddr_un PATH
 145
 146 Takes one argument, a pathname. Returns the sockaddr_un structure with
 147 that path packed in with AF_UNIX filled in. For unix domain sockets, this
 148 structure is normally what you need for the arguments in bind(),
 149 connect(), and send(), and is also returned by getpeername(),
 150 getsockname() and recv().
 151
 152 =item unpack_sockaddr_un SOCKADDR_UN
 153
 154 Takes a sockaddr_un structure (as returned by pack_sockaddr_un())
 155 and returns the pathname.  Will croak if the structure does not
 156 have AF_UNIX in the right place.
 157
 158 =back
 159
 160 =cut
 161
 162 use Carp;
 163
 164 require Exporter;
 165 use XSLoader ();
 166 @ISA = qw(Exporter);
 167 @EXPORT = qw(
 168         inet_aton inet_ntoa pack_sockaddr_in unpack_sockaddr_in
 169         pack_sockaddr_un unpack_sockaddr_un
 170         sockaddr_in sockaddr_un
 171         INADDR_ANY INADDR_BROADCAST INADDR_LOOPBACK INADDR_NONE
 172         AF_802
 173         AF_APPLETALK
 174         AF_CCITT
 175         AF_CHAOS
 176         AF_DATAKIT
 177         AF_DECnet
 178         AF_DLI
 179         AF_ECMA
 180         AF_GOSIP
 181         AF_HYLINK
 182         AF_IMPLINK
 183         AF_INET
 184         AF_LAT
 185         AF_MAX
 186         AF_NBS
 187         AF_NIT
 188         AF_NS
 189         AF_OSI
 190         AF_OSINET
 191         AF_PUP
 192         AF_SNA
 193         AF_UNIX
 194         AF_UNSPEC
 195         AF_X25
 196         IOV_MAX
 197         MSG_BCAST
 198         MSG_CTLFLAGS
 199         MSG_CTLIGNORE
 200         MSG_CTRUNC
 201         MSG_DONTROUTE
 202         MSG_DONTWAIT
 203         MSG_EOF
 204         MSG_EOR
 205         MSG_ERRQUEUE
 206         MSG_FIN
 207         MSG_MAXIOVLEN
 208         MSG_MCAST
 209         MSG_NOSIGNAL
 210         MSG_OOB
 211         MSG_PEEK
 212         MSG_PROXY
 213         MSG_RST
 214         MSG_SYN
 215         MSG_TRUNC
 216         MSG_URG
 217         MSG_WAITALL
 218         PF_802
 219         PF_APPLETALK
 220         PF_CCITT
 221         PF_CHAOS
 222         PF_DATAKIT
 223         PF_DECnet
 224         PF_DLI
 225         PF_ECMA
 226         PF_GOSIP
 227         PF_HYLINK
 228         PF_IMPLINK
 229         PF_INET
 230         PF_LAT
 231         PF_MAX
 232         PF_NBS
 233         PF_NIT
 234         PF_NS
 235         PF_OSI
 236         PF_OSINET
 237         PF_PUP
 238         PF_SNA
 239         PF_UNIX
 240         PF_UNSPEC
 241         PF_X25
 242         SCM_CONNECT
 243         SCM_CREDENTIALS
 244         SCM_CREDS
 245         SCM_RIGHTS
 246         SCM_TIMESTAMP
 247         SHUT_RD
 248         SHUT_RDWR
 249         SHUT_WR
 250         SOCK_DGRAM
 251         SOCK_RAW
 252         SOCK_RDM
 253         SOCK_SEQPACKET
 254         SOCK_STREAM
 255         SOL_SOCKET
 256         SOMAXCONN
 257         SO_ACCEPTCONN
 258         SO_BROADCAST
 259         SO_DEBUG
 260         SO_DONTLINGER
 261         SO_DONTROUTE
 262         SO_ERROR
 263         SO_KEEPALIVE
 264         SO_LINGER
 265         SO_OOBINLINE
 266         SO_RCVBUF
 267         SO_RCVLOWAT
 268         SO_RCVTIMEO
 269         SO_REUSEADDR
 270         SO_SNDBUF
 271         SO_SNDLOWAT
 272         SO_SNDTIMEO
 273         SO_TYPE
 274         SO_USELOOPBACK
 275         UIO_MAXIOV
 276 );
 277
 278 @EXPORT_OK = qw(CR LF CRLF $CR $LF $CRLF
 279
 280                IPPROTO_TCP
 281                TCP_KEEPALIVE
 282                TCP_MAXRT
 283                TCP_MAXSEG
 284                TCP_NODELAY
 285                TCP_STDURG);
 286
 287 %EXPORT_TAGS = (
 288     crlf    => [qw(CR LF CRLF $CR $LF $CRLF)],
 289     all     => [@EXPORT, @EXPORT_OK],
 290 );
 291
 292 BEGIN {
 293     sub CR   () {"\015"}
 294     sub LF   () {"\012"}
 295     sub CRLF () {"\015\012"}
 296 }
 297
 298 *CR   = \CR();
 299 *LF   = \LF();
 300 *CRLF = \CRLF();
 301
 302 sub sockaddr_in {
 303     if (@_ == 6 && !wantarray) { # perl5.001m compat; use this && die
 304         my($af, $port, @quad) = @_;
 305         carp "6-ARG sockaddr_in call is deprecated" if $^W;
 306         pack_sockaddr_in($port, inet_aton(join('.', @quad)));
 307     } elsif (wantarray) {
 308         croak "usage:   (port,iaddr) = sockaddr_in(sin_sv)" unless @_ == 1;
 309         unpack_sockaddr_in(@_);
 310     } else {
 311         croak "usage:   sin_sv = sockaddr_in(port,iaddr))" unless @_ == 2;
 312         pack_sockaddr_in(@_);
 313     }
 314 }
 315
 316 sub sockaddr_un {
 317     if (wantarray) {
 318         croak "usage:   (filename) = sockaddr_un(sun_sv)" unless @_ == 1;
 319         unpack_sockaddr_un(@_);
 320     } else {
 321         croak "usage:   sun_sv = sockaddr_un(filename)" unless @_ == 1;
 322         pack_sockaddr_un(@_);
 323     }
 324 }
 325
 326 sub INADDR_ANY          ();
 327 sub INADDR_BROADCAST    ();
 328 sub INADDR_LOOPBACK     ();
 329 sub INADDR_LOOPBACK     ();
 330
 331 sub AF_802              ();
 332 sub AF_APPLETALK        ();
 333 sub AF_CCITT            ();
 334 sub AF_CHAOS            ();
 335 sub AF_DATAKIT          ();
 336 sub AF_DECnet           ();
 337 sub AF_DLI              ();
 338 sub AF_ECMA             ();
 339 sub AF_GOSIP            ();
 340 sub AF_HYLINK           ();
 341 sub AF_IMPLINK          ();
 342 sub AF_INET             ();
 343 sub AF_LAT              ();
 344 sub AF_MAX              ();
 345 sub AF_NBS              ();
 346 sub AF_NIT              ();
 347 sub AF_NS               ();
 348 sub AF_OSI              ();
 349 sub AF_OSINET           ();
 350 sub AF_PUP              ();
 351 sub AF_SNA              ();
 352 sub AF_UNIX             ();
 353 sub AF_UNSPEC           ();
 354 sub AF_X25              ();
 355 sub IOV_MAX             ();
 356 sub MSG_BCAST           ();
 357 sub MSG_CTLFLAGS        ();
 358 sub MSG_CTLIGNORE       ();
 359 sub MSG_CTRUNC          ();
 360 sub MSG_DONTROUTE       ();
 361 sub MSG_DONTWAIT        ();
 362 sub MSG_EOF             ();
 363 sub MSG_EOR             ();
 364 sub MSG_ERRQUEUE        ();
 365 sub MSG_FIN             ();
 366 sub MSG_MAXIOVLEN       ();
 367 sub MSG_MCAST           ();
 368 sub MSG_NOSIGNAL        ();
 369 sub MSG_OOB             ();
 370 sub MSG_PEEK            ();
 371 sub MSG_PROXY           ();
 372 sub MSG_RST             ();
 373 sub MSG_SYN             ();
 374 sub MSG_TRUNC           ();
 375 sub MSG_URG             ();
 376 sub MSG_WAITALL         ();
 377 sub PF_802              ();
 378 sub PF_APPLETALK        ();
 379 sub PF_CCITT            ();
 380 sub PF_CHAOS            ();
 381 sub PF_DATAKIT          ();
 382 sub PF_DECnet           ();
 383 sub PF_DLI              ();
 384 sub PF_ECMA             ();
 385 sub PF_GOSIP            ();
 386 sub PF_HYLINK           ();
 387 sub PF_IMPLINK          ();
 388 sub PF_INET             ();
 389 sub PF_LAT              ();
 390 sub PF_MAX              ();
 391 sub PF_NBS              ();
 392 sub PF_NIT              ();
 393 sub PF_NS               ();
 394 sub PF_OSI              ();
 395 sub PF_OSINET           ();
 396 sub PF_PUP              ();
 397 sub PF_SNA              ();
 398 sub PF_UNIX             ();
 399 sub PF_UNSPEC           ();
 400 sub PF_X25              ();
 401 sub SCM_CONNECT         ();
 402 sub SCM_CREDENTIALS     ();
 403 sub SCM_CREDS           ();
 404 sub SCM_RIGHTS          ();
 405 sub SCM_TIMESTAMP       ();
 406 sub SHUT_RD             ();
 407 sub SHUT_RDWR           ();
 408 sub SHUT_WR             ();
 409 sub SOCK_DGRAM          ();
 410 sub SOCK_RAW            ();
 411 sub SOCK_RDM            ();
 412 sub SOCK_SEQPACKET      ();
 413 sub SOCK_STREAM         ();
 414 sub SOL_SOCKET          ();
 415 sub SOMAXCONN           ();
 416 sub SO_ACCEPTCONN       ();
 417 sub SO_BROADCAST        ();
 418 sub SO_DEBUG            ();
 419 sub SO_DONTLINGER       ();
 420 sub SO_DONTROUTE        ();
 421 sub SO_ERROR            ();
 422 sub SO_KEEPALIVE        ();
 423 sub SO_LINGER           ();
 424 sub SO_OOBINLINE        ();
 425 sub SO_RCVBUF           ();
 426 sub SO_RCVLOWAT         ();
 427 sub SO_RCVTIMEO         ();
 428 sub SO_REUSEADDR        ();
 429 sub SO_SNDBUF           ();
 430 sub SO_SNDLOWAT         ();
 431 sub SO_SNDTIMEO         ();
 432 sub SO_TYPE             ();
 433 sub SO_USELOOPBACK      ();
 434 sub UIO_MAXIOV          ();
 435
 436 sub AUTOLOAD {
 437     my($constname);
 438     ($constname = $AUTOLOAD) =~ s/.*:://;
 439     my $val = constant($constname, @_ ? $_[0] : 0);
 440     if ($! != 0) {
 441         my ($pack,$file,$line) = caller;
 442         croak "Your vendor has not defined Socket macro $constname, used";
 443     }
 444     eval "sub $AUTOLOAD () { $val }";
 445     goto &$AUTOLOAD;
 446 }
 447
 448 XSLoader::load 'Socket', $VERSION;
 449
 450 1;