3 our($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
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', '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);
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 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:
55 use Socket qw(:DEFAULT :crlf);
57 In addition, some structure manipulation functions are available:
61 =item inet_aton HOSTNAME
63 Takes a string giving the name of a host, and translates that to an
64 opaque string (if programming in C, struct in_addr). Takes arguments
65 of both 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 with
67 more than one address), the first address found is returned.
69 For portability do not assume that the result of inet_aton() is 32
70 bits wide, in other words, that it would contain only the IPv4 address
73 =item inet_ntoa IP_ADDRESS
75 Takes a string (an opaque string as returned by inet_aton(),
76 or a v-string representing the four octets of the IPv4 address in
77 network order) and translates it into a string of the form 'd.d.d.d'
78 where the 'd's are numbers less than 256 (the normal human-readable
79 four dotted number notation for Internet addresses).
83 Note: does not return a number, but a packed string.
85 Returns the 4-byte wildcard ip address which specifies any
86 of the hosts ip addresses. (A particular machine can have
87 more than one ip address, each address corresponding to
88 a particular network interface. This wildcard address
89 allows you to bind to all of them simultaneously.)
90 Normally equivalent to inet_aton('0.0.0.0').
92 =item INADDR_BROADCAST
94 Note: does not return a number, but a packed string.
96 Returns the 4-byte 'this-lan' ip broadcast address.
97 This can be useful for some protocols to solicit information
98 from all servers on the same LAN cable.
99 Normally equivalent to inet_aton('255.255.255.255').
101 =item INADDR_LOOPBACK
103 Note - does not return a number.
105 Returns the 4-byte loopback address. Normally equivalent
106 to inet_aton('localhost').
110 Note - does not return a number.
112 Returns the 4-byte 'invalid' ip address. Normally equivalent
113 to inet_aton('255.255.255.255').
115 =item sockaddr_family SOCKADDR
117 Takes a sockaddr structure (as returned by pack_sockaddr_in(),
118 pack_sockaddr_un() or the perl builtin functions getsockname() and
119 getpeername()) and returns the address family tag. It will match the
120 constant AF_INET for a sockaddr_in and AF_UNIX for a sockaddr_un. It
121 can be used to figure out what unpacker to use for a sockaddr of
124 =item sockaddr_in PORT, ADDRESS
126 =item sockaddr_in SOCKADDR_IN
128 In a list context, unpacks its SOCKADDR_IN argument and returns an array
129 consisting of (PORT, ADDRESS). In a scalar context, packs its (PORT,
130 ADDRESS) arguments as a SOCKADDR_IN and returns it. If this is confusing,
131 use pack_sockaddr_in() and unpack_sockaddr_in() explicitly.
133 =item pack_sockaddr_in PORT, IP_ADDRESS
135 Takes two arguments, a port number and an opaque string, IP_ADDRESS
136 (as returned by inet_aton(), or a v-string). Returns the sockaddr_in
137 structure with those arguments packed in with AF_INET filled in. For
138 Internet domain sockets, this structure is normally what you need for
139 the arguments in bind(), connect(), and send(), and is also returned
140 by getpeername(), getsockname() and recv().
142 =item unpack_sockaddr_in SOCKADDR_IN
144 Takes a sockaddr_in structure (as returned by pack_sockaddr_in()) and
145 returns an array of two elements: the port and an opaque string
146 representing the IP address (you can use inet_ntoa() to convert the
147 address to the four-dotted numeric format). Will croak if the
148 structure does not have AF_INET in the right place.
150 =item sockaddr_un PATHNAME
152 =item sockaddr_un SOCKADDR_UN
154 In a list context, unpacks its SOCKADDR_UN argument and returns an array
155 consisting of (PATHNAME). In a scalar context, packs its PATHNAME
156 arguments as a SOCKADDR_UN and returns it. If this is confusing, use
157 pack_sockaddr_un() and unpack_sockaddr_un() explicitly.
158 These are only supported if your system has E<lt>F<sys/un.h>E<gt>.
160 =item pack_sockaddr_un PATH
162 Takes one argument, a pathname. Returns the sockaddr_un structure with
163 that path packed in with AF_UNIX filled in. For unix domain sockets, this
164 structure is normally what you need for the arguments in bind(),
165 connect(), and send(), and is also returned by getpeername(),
166 getsockname() and recv().
168 =item unpack_sockaddr_un SOCKADDR_UN
170 Takes a sockaddr_un structure (as returned by pack_sockaddr_un())
171 and returns the pathname. Will croak if the structure does not
172 have AF_UNIX in the right place.
179 use warnings::register;
187 pack_sockaddr_in unpack_sockaddr_in
188 pack_sockaddr_un unpack_sockaddr_un
189 sockaddr_in sockaddr_un
190 INADDR_ANY INADDR_BROADCAST INADDR_LOOPBACK INADDR_NONE
324 SO_SECURITY_AUTHENTICATION
325 SO_SECURITY_ENCRYPTION_NETWORK
326 SO_SECURITY_ENCRYPTION_TRANSPORT
338 @EXPORT_OK = qw(CR LF CRLF $CR $LF $CRLF
348 crlf => [qw(CR LF CRLF $CR $LF $CRLF)],
349 all => [@EXPORT, @EXPORT_OK],
355 sub CRLF () {"\015\012"}
363 if (@_ == 6 && !wantarray) { # perl5.001m compat; use this && die
364 my($af, $port, @quad) = @_;
365 warnings::warn "6-ARG sockaddr_in call is deprecated"
366 if warnings::enabled();
367 pack_sockaddr_in($port, inet_aton(join('.', @quad)));
368 } elsif (wantarray) {
369 croak "usage: (port,iaddr) = sockaddr_in(sin_sv)" unless @_ == 1;
370 unpack_sockaddr_in(@_);
372 croak "usage: sin_sv = sockaddr_in(port,iaddr))" unless @_ == 2;
373 pack_sockaddr_in(@_);
379 croak "usage: (filename) = sockaddr_un(sun_sv)" unless @_ == 1;
380 unpack_sockaddr_un(@_);
382 croak "usage: sun_sv = sockaddr_un(filename)" unless @_ == 1;
383 pack_sockaddr_un(@_);
389 ($constname = $AUTOLOAD) =~ s/.*:://;
390 croak "&Socket::constant not defined" if $constname eq 'constant';
391 my ($error, $val) = constant($constname);
395 *$AUTOLOAD = sub { $val };
399 XSLoader::load 'Socket', $VERSION;