3 use vars qw($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
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.
69 =item inet_ntoa IP_ADDRESS
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).
78 Note: does not return a number, but a packed string.
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').
87 =item INADDR_BROADCAST
89 Note: does not return a number, but a packed string.
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').
98 Note - does not return a number.
100 Returns the 4-byte loopback address. Normally equivalent
101 to inet_aton('localhost').
105 Note - does not return a number.
107 Returns the 4-byte 'invalid' ip address. Normally equivalent
108 to inet_aton('255.255.255.255').
110 =item sockaddr_in PORT, ADDRESS
112 =item sockaddr_in SOCKADDR_IN
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.
119 =item pack_sockaddr_in PORT, IP_ADDRESS
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().
128 =item unpack_sockaddr_in SOCKADDR_IN
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.
134 =item sockaddr_un PATHNAME
136 =item sockaddr_un SOCKADDR_UN
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>.
144 =item pack_sockaddr_un PATH
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().
152 =item unpack_sockaddr_un SOCKADDR_UN
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.
166 @ISA = qw(Exporter DynaLoader);
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
251 @EXPORT_OK = qw(CR LF CRLF $CR $LF $CRLF);
254 crlf => [qw(CR LF CRLF $CR $LF $CRLF)],
255 all => [@EXPORT, @EXPORT_OK],
261 sub CRLF () {"\015\012"}
269 if (@_ == 6 && !wantarray) { # perl5.001m compat; use this && die
270 my($af, $port, @quad) = @_;
271 carp "6-ARG sockaddr_in call is deprecated" if $^W;
272 pack_sockaddr_in($port, inet_aton(join('.', @quad)));
273 } elsif (wantarray) {
274 croak "usage: (port,iaddr) = sockaddr_in(sin_sv)" unless @_ == 1;
275 unpack_sockaddr_in(@_);
277 croak "usage: sin_sv = sockaddr_in(port,iaddr))" unless @_ == 2;
278 pack_sockaddr_in(@_);
284 croak "usage: (filename) = sockaddr_un(sun_sv)" unless @_ == 1;
285 unpack_sockaddr_un(@_);
287 croak "usage: sun_sv = sockaddr_un(filename)" unless @_ == 1;
288 pack_sockaddr_un(@_);
295 ($constname = $AUTOLOAD) =~ s/.*:://;
296 my $val = constant($constname, @_ ? $_[0] : 0);
298 my ($pack,$file,$line) = caller;
299 croak "Your vendor has not defined Socket macro $constname, used";
301 eval "sub $AUTOLOAD { $val }";
305 bootstrap Socket $VERSION;