[p5sagit/p5-mst-13.2.git] / ext / Socket / Socket.pm

package Socket;

use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
$VERSION = "1.7";

=head1 NAME

Socket, sockaddr_in, sockaddr_un, inet_aton, inet_ntoa - load the C socket.h defines and structure manipulators 

=head1 SYNOPSIS

    use Socket;

    $proto = getprotobyname('udp');
    socket(Socket_Handle, PF_INET, SOCK_DGRAM, $proto);
    $iaddr = gethostbyname('hishost.com');
    $port = getservbyname('time', 'udp');
    $sin = sockaddr_in($port, $iaddr);
    send(Socket_Handle, 0, 0, $sin);

    $proto = getprotobyname('tcp');
    socket(Socket_Handle, PF_INET, SOCK_STREAM, $proto);
    $port = getservbyname('smtp', 'tcp');
    $sin = sockaddr_in($port,inet_aton("127.1"));
    $sin = sockaddr_in(7,inet_aton("localhost"));
    $sin = sockaddr_in(7,INADDR_LOOPBACK);
    connect(Socket_Handle,$sin);

    ($port, $iaddr) = sockaddr_in(getpeername(Socket_Handle));
    $peer_host = gethostbyaddr($iaddr, AF_INET);
    $peer_addr = inet_ntoa($iaddr);

    $proto = getprotobyname('tcp');
    socket(Socket_Handle, PF_UNIX, SOCK_STREAM, $proto);
    unlink('/tmp/usock');
    $sun = sockaddr_un('/tmp/usock');
    connect(Socket_Handle,$sun);

=head1 DESCRIPTION

This module is just a translation of the C F<socket.h> file.
Unlike the old mechanism of requiring a translated F<socket.ph>
file, this uses the B<h2xs> program (see the Perl source distribution)
and your native C compiler.  This means that it has a 
far more likely chance of getting the numbers right.  This includes
all of the commonly used pound-defines like AF_INET, SOCK_STREAM, etc.

Also, some common socket "newline" constants are provided: the
constants C<CR>, C<LF>, and C<CRLF>, as well as C<$CR>, C<$LF>, and
C<$CRLF>, which map to C<\015>, C<\012>, and C<\015\012>.  If you do
not want to use the literal characters in your programs, then use
the constants provided here.  They are not exported by default, but can
be imported individually, and with the C<:crlf> export tag:

    use Socket qw(:DEFAULT :crlf);

In addition, some structure manipulation functions are available:

=over

=item inet_aton HOSTNAME

Takes a string giving the name of a host, and translates that
to the 4-byte string (structure). Takes arguments of both
the 'rtfm.mit.edu' type and '18.181.0.24'. If the host name
cannot be resolved, returns undef. For multi-homed hosts (hosts
with more than one address), the first address found is returned.

=item inet_ntoa IP_ADDRESS

Takes a four byte ip address (as returned by inet_aton())
and translates it into a string of the form 'd.d.d.d'
where the 'd's are numbers less than 256 (the normal
readable four dotted number notation for internet addresses).

=item INADDR_ANY

Note: does not return a number, but a packed string.

Returns the 4-byte wildcard ip address which specifies any
of the hosts ip addresses. (A particular machine can have
more than one ip address, each address corresponding to
a particular network interface. This wildcard address
allows you to bind to all of them simultaneously.)
Normally equivalent to inet_aton('0.0.0.0').

=item INADDR_BROADCAST

Note: does not return a number, but a packed string.

Returns the 4-byte 'this-lan' ip broadcast address.
This can be useful for some protocols to solicit information
from all servers on the same LAN cable.
Normally equivalent to inet_aton('255.255.255.255').

=item INADDR_LOOPBACK

Note - does not return a number.

Returns the 4-byte loopback address. Normally equivalent
to inet_aton('localhost').

=item INADDR_NONE

Note - does not return a number.

Returns the 4-byte 'invalid' ip address. Normally equivalent
to inet_aton('255.255.255.255').

=item sockaddr_in PORT, ADDRESS

=item sockaddr_in SOCKADDR_IN

In an array context, unpacks its SOCKADDR_IN argument and returns an array
consisting of (PORT, ADDRESS).  In a scalar context, packs its (PORT,
ADDRESS) arguments as a SOCKADDR_IN and returns it.  If this is confusing,
use pack_sockaddr_in() and unpack_sockaddr_in() explicitly.

=item pack_sockaddr_in PORT, IP_ADDRESS

Takes two arguments, a port number and a 4 byte IP_ADDRESS (as returned by
inet_aton()). Returns the sockaddr_in structure with those arguments
packed in with AF_INET filled in.  For internet domain sockets, this
structure is normally what you need for the arguments in bind(),
connect(), and send(), and is also returned by getpeername(),
getsockname() and recv().

=item unpack_sockaddr_in SOCKADDR_IN

Takes a sockaddr_in structure (as returned by pack_sockaddr_in()) and
returns an array of two elements: the port and the 4-byte ip-address.
Will croak if the structure does not have AF_INET in the right place.

=item sockaddr_un PATHNAME

=item sockaddr_un SOCKADDR_UN

In an array context, unpacks its SOCKADDR_UN argument and returns an array
consisting of (PATHNAME).  In a scalar context, packs its PATHNAME
arguments as a SOCKADDR_UN and returns it.  If this is confusing, use
pack_sockaddr_un() and unpack_sockaddr_un() explicitly.
These are only supported if your system has E<lt>F<sys/un.h>E<gt>.

=item pack_sockaddr_un PATH

Takes one argument, a pathname. Returns the sockaddr_un structure with
that path packed in with AF_UNIX filled in. For unix domain sockets, this
structure is normally what you need for the arguments in bind(),
connect(), and send(), and is also returned by getpeername(),
getsockname() and recv().

=item unpack_sockaddr_un SOCKADDR_UN

Takes a sockaddr_un structure (as returned by pack_sockaddr_un())
and returns the pathname.  Will croak if the structure does not
have AF_UNIX in the right place.

=back

=cut

use Carp;

require Exporter;
require DynaLoader;
@ISA = qw(Exporter DynaLoader);
@EXPORT = qw(
	inet_aton inet_ntoa pack_sockaddr_in unpack_sockaddr_in
	pack_sockaddr_un unpack_sockaddr_un
	sockaddr_in sockaddr_un
	INADDR_ANY INADDR_BROADCAST INADDR_LOOPBACK INADDR_NONE
	AF_802
	AF_APPLETALK
	AF_CCITT
	AF_CHAOS
	AF_DATAKIT
	AF_DECnet
	AF_DLI
	AF_ECMA
	AF_GOSIP
	AF_HYLINK
	AF_IMPLINK
	AF_INET
	AF_LAT
	AF_MAX
	AF_NBS
	AF_NIT
	AF_NS
	AF_OSI
	AF_OSINET
	AF_PUP
	AF_SNA
	AF_UNIX
	AF_UNSPEC
	AF_X25
	MSG_CTLFLAGS
	MSG_CTLIGNORE
	MSG_CTRUNC
	MSG_DONTROUTE
	MSG_DONTWAIT
	MSG_EOF
	MSG_EOR
	MSG_ERRQUEUE
	MSG_FIN
	MSG_MAXIOVLEN
	MSG_NOSIGNAL
	MSG_OOB
	MSG_PEEK
	MSG_PROXY
	MSG_RST
	MSG_SYN
	MSG_TRUNC
	MSG_URG
	MSG_WAITALL
	PF_802
	PF_APPLETALK
	PF_CCITT
	PF_CHAOS
	PF_DATAKIT
	PF_DECnet
	PF_DLI
	PF_ECMA
	PF_GOSIP
	PF_HYLINK
	PF_IMPLINK
	PF_INET
	PF_LAT
	PF_MAX
	PF_NBS
	PF_NIT
	PF_NS
	PF_OSI
	PF_OSINET
	PF_PUP
	PF_SNA
	PF_UNIX
	PF_UNSPEC
	PF_X25
	SCM_CONNECT
	SCM_CREDENTIALS
	SCM_CREDS
	SCM_RIGHTS
	SCM_TIMESTAMP
	SOCK_DGRAM
	SOCK_RAW
	SOCK_RDM
	SOCK_SEQPACKET
	SOCK_STREAM
	SOL_SOCKET
	SOMAXCONN
	SO_ACCEPTCONN
	SO_BROADCAST
	SO_DEBUG
	SO_DONTLINGER
	SO_DONTROUTE
	SO_ERROR
	SO_KEEPALIVE
	SO_LINGER
	SO_OOBINLINE
	SO_RCVBUF
	SO_RCVLOWAT
	SO_RCVTIMEO
	SO_REUSEADDR
	SO_SNDBUF
	SO_SNDLOWAT
	SO_SNDTIMEO
	SO_TYPE
	SO_USELOOPBACK
);

@EXPORT_OK = qw(CR LF CRLF $CR $LF $CRLF);

%EXPORT_TAGS = (
    crlf    => [qw(CR LF CRLF $CR $LF $CRLF)],
    all     => [@EXPORT, @EXPORT_OK],
);

BEGIN {
    sub CR   () {"\015"}
    sub LF   () {"\012"}
    sub CRLF () {"\015\012"}
}

*CR   = \CR();
*LF   = \LF();
*CRLF = \CRLF();

sub sockaddr_in {
    if (@_ == 6 && !wantarray) { # perl5.001m compat; use this && die
	my($af, $port, @quad) = @_;
	carp "6-ARG sockaddr_in call is deprecated" if $^W;
	pack_sockaddr_in($port, inet_aton(join('.', @quad)));
    } elsif (wantarray) {
	croak "usage:   (port,iaddr) = sockaddr_in(sin_sv)" unless @_ == 1;
        unpack_sockaddr_in(@_);
    } else {
	croak "usage:   sin_sv = sockaddr_in(port,iaddr))" unless @_ == 2;
        pack_sockaddr_in(@_);
    }
}

sub sockaddr_un {
    if (wantarray) {
	croak "usage:   (filename) = sockaddr_un(sun_sv)" unless @_ == 1;
        unpack_sockaddr_un(@_);
    } else {
	croak "usage:   sun_sv = sockaddr_un(filename)" unless @_ == 1;
        pack_sockaddr_un(@_);
    }
}


sub AUTOLOAD {
    my($constname);
    ($constname = $AUTOLOAD) =~ s/.*:://;
    my $val = constant($constname, @_ ? $_[0] : 0);
    if ($! != 0) {
	my ($pack,$file,$line) = caller;
	croak "Your vendor has not defined Socket macro $constname, used";
    }
    eval "sub $AUTOLOAD { $val }";
    goto &$AUTOLOAD;
}

bootstrap Socket $VERSION;

1;
Commit	Line	Data
a0d0e21e	1	package Socket;
73c78b0a	2
fdb41d65	3	use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
fdb41d65	4	$VERSION = "1.7";
3b35bae3	5
	6	=head1 NAME
	7
cb1a09d0	8	Socket, sockaddr_in, sockaddr_un, inet_aton, inet_ntoa - load the C socket.h defines and structure manipulators
3b35bae3	9
	10	=head1 SYNOPSIS
	11
	12	use Socket;
	13
4633a7c4	14	$proto = getprotobyname('udp');
8e07c86e	15	socket(Socket_Handle, PF_INET, SOCK_DGRAM, $proto);
4633a7c4	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);
67d7c167	23	$port = getservbyname('smtp', 'tcp');
4633a7c4	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);
3b35bae3	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
4633a7c4	45	far more likely chance of getting the numbers right. This includes
4633a7c4	46	all of the commonly used pound-defines like AF_INET, SOCK_STREAM, etc.
3b35bae3	47
fdb41d65	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
8e07c86e	57	In addition, some structure manipulation functions are available:
8e07c86e	58
2ae324a7	59	=over
2ae324a7	60
8e07c86e	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
7e1af8bc	66	cannot be resolved, returns undef. For multi-homed hosts (hosts
7e1af8bc	67	with more than one address), the first address found is returned.
8e07c86e	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
4633a7c4	78	Note: does not return a number, but a packed string.
8e07c86e	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
7e1af8bc	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
8e07c86e	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').
3b35bae3	102
8e07c86e	103	=item INADDR_NONE
	104
	105	Note - does not return a number.
	106
7e1af8bc	107	Returns the 4-byte 'invalid' ip address. Normally equivalent
8e07c86e	108	to inet_aton('255.255.255.255').
8e07c86e	109
4633a7c4	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
8e07c86e	120
4633a7c4	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().
8e07c86e	127
	128	=item unpack_sockaddr_in SOCKADDR_IN
	129
4633a7c4	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
1fef88e7	139	consisting of (PATHNAME). In a scalar context, packs its PATHNAME
4633a7c4	140	arguments as a SOCKADDR_UN and returns it. If this is confusing, use
4633a7c4	141	pack_sockaddr_un() and unpack_sockaddr_un() explicitly.
1fef88e7	142	These are only supported if your system has E<lt>F<sys/un.h>E<gt>.
4633a7c4	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.
3b35bae3	157
2ae324a7	158	=back
2ae324a7	159
3b35bae3	160	=cut
3b35bae3	161
a0d0e21e	162	use Carp;
	163
	164	require Exporter;
a0d0e21e	165	require DynaLoader;
fec02dd3	166	@ISA = qw(Exporter DynaLoader);
a0d0e21e	167	@EXPORT = qw(
8e07c86e	168	inet_aton inet_ntoa pack_sockaddr_in unpack_sockaddr_in
4633a7c4	169	pack_sockaddr_un unpack_sockaddr_un
4633a7c4	170	sockaddr_in sockaddr_un
7e1af8bc	171	INADDR_ANY INADDR_BROADCAST INADDR_LOOPBACK INADDR_NONE
a0d0e21e	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
de4597cb	196	MSG_CTLFLAGS
	197	MSG_CTLIGNORE
	198	MSG_CTRUNC
a0d0e21e	199	MSG_DONTROUTE
de4597cb	200	MSG_DONTWAIT
	201	MSG_EOF
	202	MSG_EOR
	203	MSG_ERRQUEUE
	204	MSG_FIN
a0d0e21e	205	MSG_MAXIOVLEN
de4597cb	206	MSG_NOSIGNAL
a0d0e21e	207	MSG_OOB
a0d0e21e	208	MSG_PEEK
de4597cb	209	MSG_PROXY
	210	MSG_RST
	211	MSG_SYN
	212	MSG_TRUNC
	213	MSG_URG
	214	MSG_WAITALL
a0d0e21e	215	PF_802
	216	PF_APPLETALK
	217	PF_CCITT
	218	PF_CHAOS
	219	PF_DATAKIT
	220	PF_DECnet
	221	PF_DLI
	222	PF_ECMA
	223	PF_GOSIP
	224	PF_HYLINK
	225	PF_IMPLINK
	226	PF_INET
	227	PF_LAT
	228	PF_MAX
	229	PF_NBS
	230	PF_NIT
	231	PF_NS
	232	PF_OSI
	233	PF_OSINET
	234	PF_PUP
	235	PF_SNA
	236	PF_UNIX
	237	PF_UNSPEC
	238	PF_X25
de4597cb	239	SCM_CONNECT
	240	SCM_CREDENTIALS
	241	SCM_CREDS
	242	SCM_RIGHTS
	243	SCM_TIMESTAMP
a0d0e21e	244	SOCK_DGRAM
	245	SOCK_RAW
	246	SOCK_RDM
	247	SOCK_SEQPACKET
	248	SOCK_STREAM
	249	SOL_SOCKET
	250	SOMAXCONN
	251	SO_ACCEPTCONN
	252	SO_BROADCAST
	253	SO_DEBUG
	254	SO_DONTLINGER
	255	SO_DONTROUTE
	256	SO_ERROR
	257	SO_KEEPALIVE
	258	SO_LINGER
	259	SO_OOBINLINE
	260	SO_RCVBUF
	261	SO_RCVLOWAT
	262	SO_RCVTIMEO
	263	SO_REUSEADDR
	264	SO_SNDBUF
	265	SO_SNDLOWAT
	266	SO_SNDTIMEO
	267	SO_TYPE
	268	SO_USELOOPBACK
	269	);
	270
fdb41d65	271	@EXPORT_OK = qw(CR LF CRLF $CR $LF $CRLF);
	272
	273	%EXPORT_TAGS = (
dde527fc	274	crlf => [qw(CR LF CRLF $CR $LF $CRLF)],
fdb41d65	275	all => [@EXPORT, @EXPORT_OK],
	276	);
	277
	278	BEGIN {
	279	sub CR () {"\015"}
	280	sub LF () {"\012"}
	281	sub CRLF () {"\015\012"}
	282	}
	283
	284	*CR = \CR();
	285	*LF = \LF();
	286	*CRLF = \CRLF();
	287
4633a7c4	288	sub sockaddr_in {
	289	if (@_ == 6 && !wantarray) { # perl5.001m compat; use this && die
	290	my($af, $port, @quad) = @_;
	291	carp "6-ARG sockaddr_in call is deprecated" if $^W;
	292	pack_sockaddr_in($port, inet_aton(join('.', @quad)));
	293	} elsif (wantarray) {
	294	croak "usage: (port,iaddr) = sockaddr_in(sin_sv)" unless @_ == 1;
	295	unpack_sockaddr_in(@_);
	296	} else {
	297	croak "usage: sin_sv = sockaddr_in(port,iaddr))" unless @_ == 2;
	298	pack_sockaddr_in(@_);
	299	}
	300	}
	301
	302	sub sockaddr_un {
	303	if (wantarray) {
	304	croak "usage: (filename) = sockaddr_un(sun_sv)" unless @_ == 1;
	305	unpack_sockaddr_un(@_);
	306	} else {
37120919	307	croak "usage: sun_sv = sockaddr_un(filename)" unless @_ == 1;
37120919	308	pack_sockaddr_un(@_);
4633a7c4	309	}
	310	}
	311
	312
a0d0e21e	313	sub AUTOLOAD {
73c78b0a	314	my($constname);
a0d0e21e	315	($constname = $AUTOLOAD) =~ s/.*:://;
73c78b0a	316	my $val = constant($constname, @_ ? $_[0] : 0);
a0d0e21e	317	if ($! != 0) {
676d8cc7	318	my ($pack,$file,$line) = caller;
676d8cc7	319	croak "Your vendor has not defined Socket macro $constname, used";
a0d0e21e	320	}
	321	eval "sub $AUTOLOAD { $val }";
	322	goto &$AUTOLOAD;
	323	}
	324
73c78b0a	325	bootstrap Socket $VERSION;
a0d0e21e	326
a0d0e21e	327	1;