3 use vars qw($VERSION @ISA @EXPORT);
8 Socket, sockaddr_in, sockaddr_un, inet_aton, inet_ntoa - load the C socket.h defines and structure manipulators
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);
21 $proto = getprotobyname('tcp');
22 socket(Socket_Handle, PF_INET, SOCK_STREAM, $proto);
23 $port = getservbyname('smtp');
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);
29 ($port, $iaddr) = sockaddr_in(getpeername(Socket_Handle));
30 $peer_host = gethostbyaddr($iaddr, AF_INET);
31 $peer_addr = inet_ntoa($iaddr);
33 $proto = getprotobyname('tcp');
34 socket(Socket_Handle, PF_UNIX, SOCK_STREAM, $proto);
36 $sun = sockaddr_un('/tmp/usock');
37 connect(Socket_Handle,$sun);
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.
48 In addition, some structure manipulation functions are available:
50 =item inet_aton HOSTNAME
52 Takes a string giving the name of a host, and translates that
53 to the 4-byte string (structure). Takes arguments of both
54 the 'rtfm.mit.edu' type and '18.181.0.24'. If the host name
55 cannot be resolved, returns undef.
57 =item inet_ntoa IP_ADDRESS
59 Takes a four byte ip address (as returned by inet_aton())
60 and translates it into a string of the form 'd.d.d.d'
61 where the 'd's are numbers less than 256 (the normal
62 readable four dotted number notation for internet addresses).
66 Note: does not return a number, but a packed string.
68 Returns the 4-byte wildcard ip address which specifies any
69 of the hosts ip addresses. (A particular machine can have
70 more than one ip address, each address corresponding to
71 a particular network interface. This wildcard address
72 allows you to bind to all of them simultaneously.)
73 Normally equivalent to inet_aton('0.0.0.0').
77 Note - does not return a number.
79 Returns the 4-byte loopback address. Normally equivalent
80 to inet_aton('localhost').
84 Note - does not return a number.
86 Returns the 4-byte invalid ip address. Normally equivalent
87 to inet_aton('255.255.255.255').
89 =item sockaddr_in PORT, ADDRESS
91 =item sockaddr_in SOCKADDR_IN
93 In an array context, unpacks its SOCKADDR_IN argument and returns an array
94 consisting of (PORT, ADDRESS). In a scalar context, packs its (PORT,
95 ADDRESS) arguments as a SOCKADDR_IN and returns it. If this is confusing,
96 use pack_sockaddr_in() and unpack_sockaddr_in() explicitly.
98 =item pack_sockaddr_in PORT, IP_ADDRESS
100 Takes two arguments, a port number and a 4 byte IP_ADDRESS (as returned by
101 inet_aton()). Returns the sockaddr_in structure with those arguments
102 packed in with AF_INET filled in. For internet domain sockets, this
103 structure is normally what you need for the arguments in bind(),
104 connect(), and send(), and is also returned by getpeername(),
105 getsockname() and recv().
107 =item unpack_sockaddr_in SOCKADDR_IN
109 Takes a sockaddr_in structure (as returned by pack_sockaddr_in()) and
110 returns an array of two elements: the port and the 4-byte ip-address.
111 Will croak if the structure does not have AF_INET in the right place.
113 =item sockaddr_un PATHNAME
115 =item sockaddr_un SOCKADDR_UN
117 In an array context, unpacks its SOCKADDR_UN argument and returns an array
118 consisting of (PATHNAME). In a scalar context, packs its PATHNAME
119 arguments as a SOCKADDR_UN and returns it. If this is confusing, use
120 pack_sockaddr_un() and unpack_sockaddr_un() explicitly.
121 These are only supported if your system has E<lt>F<sys/un.h>E<gt>.
123 =item pack_sockaddr_un PATH
125 Takes one argument, a pathname. Returns the sockaddr_un structure with
126 that path packed in with AF_UNIX filled in. For unix domain sockets, this
127 structure is normally what you need for the arguments in bind(),
128 connect(), and send(), and is also returned by getpeername(),
129 getsockname() and recv().
131 =item unpack_sockaddr_un SOCKADDR_UN
133 Takes a sockaddr_un structure (as returned by pack_sockaddr_un())
134 and returns the pathname. Will croak if the structure does not
135 have AF_UNIX in the right place.
143 @ISA = qw(Exporter DynaLoader);
145 inet_aton inet_ntoa pack_sockaddr_in unpack_sockaddr_in
146 pack_sockaddr_un unpack_sockaddr_un
147 sockaddr_in sockaddr_un
148 INADDR_ANY INADDR_LOOPBACK INADDR_NONE
229 if (@_ == 6 && !wantarray) { # perl5.001m compat; use this && die
230 my($af, $port, @quad) = @_;
231 carp "6-ARG sockaddr_in call is deprecated" if $^W;
232 pack_sockaddr_in($port, inet_aton(join('.', @quad)));
233 } elsif (wantarray) {
234 croak "usage: (port,iaddr) = sockaddr_in(sin_sv)" unless @_ == 1;
235 unpack_sockaddr_in(@_);
237 croak "usage: sin_sv = sockaddr_in(port,iaddr))" unless @_ == 2;
238 pack_sockaddr_in(@_);
244 croak "usage: (filename) = sockaddr_un(sun_sv)" unless @_ == 1;
245 unpack_sockaddr_un(@_);
247 croak "usage: sun_sv = sockaddr_un(filename)" unless @_ == 1;
248 pack_sockaddr_un(@_);
255 ($constname = $AUTOLOAD) =~ s/.*:://;
256 my $val = constant($constname, @_ ? $_[0] : 0);
258 my ($pack,$file,$line) = caller;
259 croak "Your vendor has not defined Socket macro $constname, used";
261 eval "sub $AUTOLOAD { $val }";
265 bootstrap Socket $VERSION;