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

package Socket;
$VERSION = 1.5;

=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');
    $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.

In addition, some structure manipulation functions are available:

=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.

=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_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 PATHANE
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 <sys/un.h>.

=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.

=cut

use Carp;

require Exporter;
use AutoLoader;
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_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_DONTROUTE
	MSG_MAXIOVLEN
	MSG_OOB
	MSG_PEEK
	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
	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
);

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 {
    local($constname);
    ($constname = $AUTOLOAD) =~ s/.*:://;
    $val = constant($constname, @_ ? $_[0] : 0);
    if ($! != 0) {
	if ($! =~ /Invalid/) {
	    $AutoLoader::AUTOLOAD = $AUTOLOAD;
	    goto &AutoLoader::AUTOLOAD;
	}
	else {
	    ($pack,$file,$line) = caller;
	    croak "Your vendor has not defined Socket macro $constname, used";
	}
    }
    eval "sub $AUTOLOAD { $val }";
    goto &$AUTOLOAD;
}

bootstrap Socket;

# Preloaded methods go here.  Autoload methods go after __END__, and are
# processed by the autosplit program.

1;
__END__
Commit	Line	Data
a0d0e21e	1	package Socket;
25f94b33	2	$VERSION = 1.5;
3b35bae3	3
	4	=head1 NAME
	5
4633a7c4	6	Socket, sockaddr_in, sockaddr_un, inet_aton, inet_ntoa - load the C
4633a7c4	7	socket.h defines and structure manipulators
3b35bae3	8
	9	=head1 SYNOPSIS
	10
	11	use Socket;
	12
4633a7c4	13	$proto = getprotobyname('udp');
8e07c86e	14	socket(Socket_Handle, PF_INET, SOCK_DGRAM, $proto);
4633a7c4	15	$iaddr = gethostbyname('hishost.com');
	16	$port = getservbyname('time', 'udp');
	17	$sin = sockaddr_in($port, $iaddr);
	18	send(Socket_Handle, 0, 0, $sin);
	19
	20	$proto = getprotobyname('tcp');
	21	socket(Socket_Handle, PF_INET, SOCK_STREAM, $proto);
	22	$port = getservbyname('smtp');
	23	$sin = sockaddr_in($port,inet_aton("127.1"));
	24	$sin = sockaddr_in(7,inet_aton("localhost"));
	25	$sin = sockaddr_in(7,INADDR_LOOPBACK);
	26	connect(Socket_Handle,$sin);
	27
	28	($port, $iaddr) = sockaddr_in(getpeername(Socket_Handle));
	29	$peer_host = gethostbyaddr($iaddr, AF_INET);
	30	$peer_addr = inet_ntoa($iaddr);
	31
	32	$proto = getprotobyname('tcp');
	33	socket(Socket_Handle, PF_UNIX, SOCK_STREAM, $proto);
	34	unlink('/tmp/usock');
	35	$sun = sockaddr_un('/tmp/usock');
	36	connect(Socket_Handle,$sun);
3b35bae3	37
	38	=head1 DESCRIPTION
	39
	40	This module is just a translation of the C F<socket.h> file.
	41	Unlike the old mechanism of requiring a translated F<socket.ph>
	42	file, this uses the B<h2xs> program (see the Perl source distribution)
	43	and your native C compiler. This means that it has a
4633a7c4	44	far more likely chance of getting the numbers right. This includes
4633a7c4	45	all of the commonly used pound-defines like AF_INET, SOCK_STREAM, etc.
3b35bae3	46
8e07c86e	47	In addition, some structure manipulation functions are available:
	48
	49	=item inet_aton HOSTNAME
	50
	51	Takes a string giving the name of a host, and translates that
	52	to the 4-byte string (structure). Takes arguments of both
	53	the 'rtfm.mit.edu' type and '18.181.0.24'. If the host name
	54	cannot be resolved, returns undef.
	55
	56	=item inet_ntoa IP_ADDRESS
	57
	58	Takes a four byte ip address (as returned by inet_aton())
	59	and translates it into a string of the form 'd.d.d.d'
	60	where the 'd's are numbers less than 256 (the normal
	61	readable four dotted number notation for internet addresses).
	62
	63	=item INADDR_ANY
	64
4633a7c4	65	Note: does not return a number, but a packed string.
8e07c86e	66
	67	Returns the 4-byte wildcard ip address which specifies any
	68	of the hosts ip addresses. (A particular machine can have
	69	more than one ip address, each address corresponding to
	70	a particular network interface. This wildcard address
	71	allows you to bind to all of them simultaneously.)
	72	Normally equivalent to inet_aton('0.0.0.0').
	73
	74	=item INADDR_LOOPBACK
	75
	76	Note - does not return a number.
	77
	78	Returns the 4-byte loopback address. Normally equivalent
	79	to inet_aton('localhost').
3b35bae3	80
8e07c86e	81	=item INADDR_NONE
	82
	83	Note - does not return a number.
	84
	85	Returns the 4-byte invalid ip address. Normally equivalent
	86	to inet_aton('255.255.255.255').
	87
4633a7c4	88	=item sockaddr_in PORT, ADDRESS
	89
	90	=item sockaddr_in SOCKADDR_IN
	91
	92	In an array context, unpacks its SOCKADDR_IN argument and returns an array
	93	consisting of (PORT, ADDRESS). In a scalar context, packs its (PORT,
	94	ADDRESS) arguments as a SOCKADDR_IN and returns it. If this is confusing,
	95	use pack_sockaddr_in() and unpack_sockaddr_in() explicitly.
	96
	97	=item pack_sockaddr_in PORT, IP_ADDRESS
8e07c86e	98
4633a7c4	99	Takes two arguments, a port number and a 4 byte IP_ADDRESS (as returned by
	100	inet_aton()). Returns the sockaddr_in structure with those arguments
	101	packed in with AF_INET filled in. For internet domain sockets, this
	102	structure is normally what you need for the arguments in bind(),
	103	connect(), and send(), and is also returned by getpeername(),
	104	getsockname() and recv().
8e07c86e	105
	106	=item unpack_sockaddr_in SOCKADDR_IN
	107
4633a7c4	108	Takes a sockaddr_in structure (as returned by pack_sockaddr_in()) and
	109	returns an array of two elements: the port and the 4-byte ip-address.
	110	Will croak if the structure does not have AF_INET in the right place.
	111
	112	=item sockaddr_un PATHNAME
	113
	114	=item sockaddr_un SOCKADDR_UN
	115
	116	In an array context, unpacks its SOCKADDR_UN argument and returns an array
	117	consisting of (PATHNAME). In a scalar context, packs its PATHANE
	118	arguments as a SOCKADDR_UN and returns it. If this is confusing, use
	119	pack_sockaddr_un() and unpack_sockaddr_un() explicitly.
25f94b33	120	These are only supported if your system has <sys/un.h>.
4633a7c4	121
	122	=item pack_sockaddr_un PATH
	123
	124	Takes one argument, a pathname. Returns the sockaddr_un structure with
	125	that path packed in with AF_UNIX filled in. For unix domain sockets, this
	126	structure is normally what you need for the arguments in bind(),
	127	connect(), and send(), and is also returned by getpeername(),
	128	getsockname() and recv().
	129
	130	=item unpack_sockaddr_un SOCKADDR_UN
	131
	132	Takes a sockaddr_un structure (as returned by pack_sockaddr_un())
	133	and returns the pathname. Will croak if the structure does not
	134	have AF_UNIX in the right place.
3b35bae3	135
	136	=cut
	137
a0d0e21e	138	use Carp;
	139
	140	require Exporter;
3b35bae3	141	use AutoLoader;
a0d0e21e	142	require DynaLoader;
fec02dd3	143	@ISA = qw(Exporter DynaLoader);
a0d0e21e	144	@EXPORT = qw(
8e07c86e	145	inet_aton inet_ntoa pack_sockaddr_in unpack_sockaddr_in
4633a7c4	146	pack_sockaddr_un unpack_sockaddr_un
4633a7c4	147	sockaddr_in sockaddr_un
8e07c86e	148	INADDR_ANY INADDR_LOOPBACK INADDR_NONE
a0d0e21e	149	AF_802
	150	AF_APPLETALK
	151	AF_CCITT
	152	AF_CHAOS
	153	AF_DATAKIT
	154	AF_DECnet
	155	AF_DLI
	156	AF_ECMA
	157	AF_GOSIP
	158	AF_HYLINK
	159	AF_IMPLINK
	160	AF_INET
	161	AF_LAT
	162	AF_MAX
	163	AF_NBS
	164	AF_NIT
	165	AF_NS
	166	AF_OSI
	167	AF_OSINET
	168	AF_PUP
	169	AF_SNA
	170	AF_UNIX
	171	AF_UNSPEC
	172	AF_X25
	173	MSG_DONTROUTE
	174	MSG_MAXIOVLEN
	175	MSG_OOB
	176	MSG_PEEK
	177	PF_802
	178	PF_APPLETALK
	179	PF_CCITT
	180	PF_CHAOS
	181	PF_DATAKIT
	182	PF_DECnet
	183	PF_DLI
	184	PF_ECMA
	185	PF_GOSIP
	186	PF_HYLINK
	187	PF_IMPLINK
	188	PF_INET
	189	PF_LAT
	190	PF_MAX
	191	PF_NBS
	192	PF_NIT
	193	PF_NS
	194	PF_OSI
	195	PF_OSINET
	196	PF_PUP
	197	PF_SNA
	198	PF_UNIX
	199	PF_UNSPEC
	200	PF_X25
	201	SOCK_DGRAM
	202	SOCK_RAW
	203	SOCK_RDM
	204	SOCK_SEQPACKET
	205	SOCK_STREAM
	206	SOL_SOCKET
	207	SOMAXCONN
	208	SO_ACCEPTCONN
	209	SO_BROADCAST
	210	SO_DEBUG
	211	SO_DONTLINGER
	212	SO_DONTROUTE
213	SO_ERROR
214	SO_KEEPALIVE
215	SO_LINGER
216	SO_OOBINLINE
217	SO_RCVBUF
218	SO_RCVLOWAT
219	SO_RCVTIMEO
220	SO_REUSEADDR
221	SO_SNDBUF
222	SO_SNDLOWAT
223	SO_SNDTIMEO
224	SO_TYPE
225	SO_USELOOPBACK
226	);
227
4633a7c4	228	sub sockaddr_in {
	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(@_);
	236	} else {
	237	croak "usage: sin_sv = sockaddr_in(port,iaddr))" unless @_ == 2;
	238	pack_sockaddr_in(@_);
	239	}
	240	}
	241
	242	sub sockaddr_un {
	243	if (wantarray) {
	244	croak "usage: (filename) = sockaddr_un(sun_sv)" unless @_ == 1;
	245	unpack_sockaddr_un(@_);
	246	} else {
37120919	247	croak "usage: sun_sv = sockaddr_un(filename)" unless @_ == 1;
37120919	248	pack_sockaddr_un(@_);
4633a7c4	249	}
	250	}
	251
	252
a0d0e21e	253	sub AUTOLOAD {
a0d0e21e	254	local($constname);
	255	($constname = $AUTOLOAD) =~ s/.*:://;
	256	$val = constant($constname, @_ ? $_[0] : 0);
	257	if ($! != 0) {
	258	if ($! =~ /Invalid/) {
	259	$AutoLoader::AUTOLOAD = $AUTOLOAD;
	260	goto &AutoLoader::AUTOLOAD;
	261	}
	262	else {
	263	($pack,$file,$line) = caller;
	264	croak "Your vendor has not defined Socket macro $constname, used";
	265	}
	266	}
	267	eval "sub $AUTOLOAD { $val }";
	268	goto &$AUTOLOAD;
	269	}
	270
	271	bootstrap Socket;
	272
	273	# Preloaded methods go here. Autoload methods go after __END__, and are
	274	# processed by the autosplit program.
	275
	276	1;
	277	__END__