This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
What am I thinking? Just bump the version.
[perl5.git] / ext / Socket / Socket.pm
1 package Socket;
2
3 our($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS);
4 $VERSION = "1.82";
5
6 =head1 NAME
7
8 Socket, sockaddr_in, sockaddr_un, inet_aton, inet_ntoa, inet_pton, inet_ntop - 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('/var/run/usock');
36     $sun = sockaddr_un('/var/run/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 4
60
61 =item inet_aton HOSTNAME
62
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.
68
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
71 in network order.
72
73 =item inet_ntoa IP_ADDRESS
74
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).
80
81 =item INADDR_ANY
82
83 Note: does not return a number, but a packed string.
84
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').
91
92 =item INADDR_BROADCAST
93
94 Note: does not return a number, but a packed string.
95
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').
100
101 =item INADDR_LOOPBACK
102
103 Note - does not return a number.
104
105 Returns the 4-byte loopback address.  Normally equivalent
106 to inet_aton('localhost').
107
108 =item INADDR_NONE
109
110 Note - does not return a number.
111
112 Returns the 4-byte 'invalid' ip address.  Normally equivalent
113 to inet_aton('255.255.255.255').
114
115 =item sockaddr_family SOCKADDR
116
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
122 unknown type.
123
124 =item sockaddr_in PORT, ADDRESS
125
126 =item sockaddr_in SOCKADDR_IN
127
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.
132
133 =item pack_sockaddr_in PORT, IP_ADDRESS
134
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().
141
142 =item unpack_sockaddr_in SOCKADDR_IN
143
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.
149
150 =item sockaddr_un PATHNAME
151
152 =item sockaddr_un SOCKADDR_UN
153
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>.
159
160 =item pack_sockaddr_un PATH
161
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().
167
168 =item unpack_sockaddr_un SOCKADDR_UN
169
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.
173
174 =item inet_pton ADDRESS_FAMILY, HOSTNAME
175
176 Takes an address family, either AF_INET or AF_INET6, and a string giving
177 the name of a host, and translates that to an opaque string
178 (if programming in C, struct in_addr or struct in6_addr depending on the 
179 address family passed in).  The host string may be a string hostname, such
180 as 'www.perl.org', or an IP address.  If using an IP address, the type of
181 IP address must be consistant with the address family passed into the function.
182
183 =item inet_ntop ADDRESS_FAMILY, IP_ADDRESS
184
185 Takes an address family, either AF_INET or AF_INET6, and a string 
186 (an opaque string as returned by inet_aton() or inet_pton()) and
187 translates it to an IPv4 or IPv6 address string.
188
189 =back
190
191 =cut
192
193 use Carp;
194 use warnings::register;
195
196 require Exporter;
197 use XSLoader ();
198 @ISA = qw(Exporter);
199 @EXPORT = qw(
200         inet_aton inet_ntoa
201         sockaddr_family
202         pack_sockaddr_in unpack_sockaddr_in
203         pack_sockaddr_un unpack_sockaddr_un
204         sockaddr_in sockaddr_un
205         INADDR_ANY INADDR_BROADCAST INADDR_LOOPBACK INADDR_NONE
206         AF_802
207         AF_AAL
208         AF_APPLETALK
209         AF_CCITT
210         AF_CHAOS
211         AF_CTF
212         AF_DATAKIT
213         AF_DECnet
214         AF_DLI
215         AF_ECMA
216         AF_GOSIP
217         AF_HYLINK
218         AF_IMPLINK
219         AF_INET
220         AF_INET6
221         AF_ISO
222         AF_KEY
223         AF_LAST
224         AF_LAT
225         AF_LINK
226         AF_MAX
227         AF_NBS
228         AF_NIT
229         AF_NS
230         AF_OSI
231         AF_OSINET
232         AF_PUP
233         AF_ROUTE
234         AF_SNA
235         AF_UNIX
236         AF_UNSPEC
237         AF_USER
238         AF_WAN
239         AF_X25
240         IOV_MAX
241         IP_OPTIONS
242         IP_HDRINCL
243         IP_TOS
244         IP_TTL
245         IP_RECVOPTS
246         IP_RECVRETOPTS
247         IP_RETOPTS
248         MSG_BCAST
249         MSG_BTAG
250         MSG_CTLFLAGS
251         MSG_CTLIGNORE
252         MSG_CTRUNC
253         MSG_DONTROUTE
254         MSG_DONTWAIT
255         MSG_EOF
256         MSG_EOR
257         MSG_ERRQUEUE
258         MSG_ETAG
259         MSG_FIN
260         MSG_MAXIOVLEN
261         MSG_MCAST
262         MSG_NOSIGNAL
263         MSG_OOB
264         MSG_PEEK
265         MSG_PROXY
266         MSG_RST
267         MSG_SYN
268         MSG_TRUNC
269         MSG_URG
270         MSG_WAITALL
271         MSG_WIRE
272         PF_802
273         PF_AAL
274         PF_APPLETALK
275         PF_CCITT
276         PF_CHAOS
277         PF_CTF
278         PF_DATAKIT
279         PF_DECnet
280         PF_DLI
281         PF_ECMA
282         PF_GOSIP
283         PF_HYLINK
284         PF_IMPLINK
285         PF_INET
286         PF_INET6
287         PF_ISO
288         PF_KEY
289         PF_LAST
290         PF_LAT
291         PF_LINK
292         PF_MAX
293         PF_NBS
294         PF_NIT
295         PF_NS
296         PF_OSI
297         PF_OSINET
298         PF_PUP
299         PF_ROUTE
300         PF_SNA
301         PF_UNIX
302         PF_UNSPEC
303         PF_USER
304         PF_WAN
305         PF_X25
306         SCM_CONNECT
307         SCM_CREDENTIALS
308         SCM_CREDS
309         SCM_RIGHTS
310         SCM_TIMESTAMP
311         SHUT_RD
312         SHUT_RDWR
313         SHUT_WR
314         SOCK_DGRAM
315         SOCK_RAW
316         SOCK_RDM
317         SOCK_SEQPACKET
318         SOCK_STREAM
319         SOL_SOCKET
320         SOMAXCONN
321         SO_ACCEPTCONN
322         SO_ATTACH_FILTER
323         SO_BACKLOG
324         SO_BROADCAST
325         SO_CHAMELEON
326         SO_DEBUG
327         SO_DETACH_FILTER
328         SO_DGRAM_ERRIND
329         SO_DONTLINGER
330         SO_DONTROUTE
331         SO_ERROR
332         SO_FAMILY
333         SO_KEEPALIVE
334         SO_LINGER
335         SO_OOBINLINE
336         SO_PASSCRED
337         SO_PASSIFNAME
338         SO_PEERCRED
339         SO_PROTOCOL
340         SO_PROTOTYPE
341         SO_RCVBUF
342         SO_RCVLOWAT
343         SO_RCVTIMEO
344         SO_REUSEADDR
345         SO_REUSEPORT
346         SO_SECURITY_AUTHENTICATION
347         SO_SECURITY_ENCRYPTION_NETWORK
348         SO_SECURITY_ENCRYPTION_TRANSPORT
349         SO_SNDBUF
350         SO_SNDLOWAT
351         SO_SNDTIMEO
352         SO_STATE
353         SO_TYPE
354         SO_USELOOPBACK
355         SO_XOPEN
356         SO_XSE
357         UIO_MAXIOV
358 );
359
360 @EXPORT_OK = qw(CR LF CRLF $CR $LF $CRLF
361
362                IPPROTO_IP
363                IPPROTO_IPV6
364                IPPROTO_RAW
365                IPPROTO_ICMP
366                IPPROTO_TCP
367                IPPROTO_UDP
368
369                TCP_KEEPALIVE
370                TCP_MAXRT
371                TCP_MAXSEG
372                TCP_NODELAY
373                TCP_STDURG);
374
375 %EXPORT_TAGS = (
376     crlf    => [qw(CR LF CRLF $CR $LF $CRLF)],
377     all     => [@EXPORT, @EXPORT_OK],
378 );
379
380 BEGIN {
381     sub CR   () {"\015"}
382     sub LF   () {"\012"}
383     sub CRLF () {"\015\012"}
384 }
385
386 *CR   = \CR();
387 *LF   = \LF();
388 *CRLF = \CRLF();
389
390 sub sockaddr_in {
391     if (@_ == 6 && !wantarray) { # perl5.001m compat; use this && die
392         my($af, $port, @quad) = @_;
393         warnings::warn "6-ARG sockaddr_in call is deprecated" 
394             if warnings::enabled();
395         pack_sockaddr_in($port, inet_aton(join('.', @quad)));
396     } elsif (wantarray) {
397         croak "usage:   (port,iaddr) = sockaddr_in(sin_sv)" unless @_ == 1;
398         unpack_sockaddr_in(@_);
399     } else {
400         croak "usage:   sin_sv = sockaddr_in(port,iaddr))" unless @_ == 2;
401         pack_sockaddr_in(@_);
402     }
403 }
404
405 sub sockaddr_un {
406     if (wantarray) {
407         croak "usage:   (filename) = sockaddr_un(sun_sv)" unless @_ == 1;
408         unpack_sockaddr_un(@_);
409     } else {
410         croak "usage:   sun_sv = sockaddr_un(filename)" unless @_ == 1;
411         pack_sockaddr_un(@_);
412     }
413 }
414
415 sub AUTOLOAD {
416     my($constname);
417     ($constname = $AUTOLOAD) =~ s/.*:://;
418     croak "&Socket::constant not defined" if $constname eq 'constant';
419     my ($error, $val) = constant($constname);
420     if ($error) {
421         croak $error;
422     }
423     *$AUTOLOAD = sub { $val };
424     goto &$AUTOLOAD;
425 }
426
427 XSLoader::load 'Socket', $VERSION;
428
429 1;