[apple/xnu.git] / bsd / man / man2 / getsockname.2

.\"	$NetBSD: getsockname.2,v 1.6 1995/10/12 15:41:00 jtc Exp $
.\"
.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)getsockname.2	8.1 (Berkeley) 6/4/93
.\"
.Dd June 4, 1993
.Dt GETSOCKNAME 2
.Os BSD 4.2
.Sh NAME
.Nm getsockname
.Nd get socket name
.Sh SYNOPSIS
.Fd #include <sys/socket.h>
.Ft int
.Fo getsockname
.Fa "int socket"
.Fa "struct sockaddr *restrict address"
.Fa "socklen_t *restrict address_len"
.Fc
.Sh DESCRIPTION
The
.Fn getsockname
function returns the current
.Fa address
for the specified socket. 
.Pp
The
.Fa address_len
parameter should be initialized to indicate
the amount of space pointed to by
.Fa address .
On return it contains the actual size of the address
returned (in bytes).
.Pp
The address is truncated if the buffer provided is too small.
.Sh RETURN VALUES
.Rv -std getsockname
.Sh ERRORS
The
.Fn getsockname
system call will succeed unless:
.Bl -tag -width Er
.\" ==========
.It Bq Er EBADF
The argument
.Fa socket
is not a valid file descriptor.
.\" ==========
.It Bq Er EFAULT
The 
.Fa address
parameter points to memory not in a valid part of the
process address space.
.\" ==========
.It Bq Er EINVAL
.Fa socket
has been shut down.
.\" ==========
.It Bq Er ENOBUFS
Insufficient resources were available in the system
to perform the operation.
.\" ==========
.It Bq Er ENOTSOCK
The argument
.Fa socket
is not a socket (e.g., a plain file).
.\" ==========
.It Bq Er EOPNOTSUPP
.Fn getsockname
is not supported for the protocol in use by
.Fa socket .
.El
.Sh SEE ALSO
.Xr bind 2 ,
.Xr socket 2
.Sh BUGS
Names bound to sockets in the UNIX domain are inaccessible;
.Fn getsockname
returns a zero-length address.
.Sh HISTORY
The
.Fn getsockname
call appeared in
.Bx 4.2 .
Commit	Line	Data
9bccf70c A	1	.\" $NetBSD: getsockname.2,v 1.6 1995/10/12 15:41:00 jtc Exp $
	2	.\"
	3	.\" Copyright (c) 1983, 1991, 1993
	4	.\" The Regents of the University of California. All rights reserved.
	5	.\"
	6	.\" Redistribution and use in source and binary forms, with or without
	7	.\" modification, are permitted provided that the following conditions
	8	.\" are met:
	9	.\" 1. Redistributions of source code must retain the above copyright
	10	.\" notice, this list of conditions and the following disclaimer.
	11	.\" 2. Redistributions in binary form must reproduce the above copyright
	12	.\" notice, this list of conditions and the following disclaimer in the
	13	.\" documentation and/or other materials provided with the distribution.
	14	.\" 3. All advertising materials mentioning features or use of this software
	15	.\" must display the following acknowledgement:
	16	.\" This product includes software developed by the University of
	17	.\" California, Berkeley and its contributors.
	18	.\" 4. Neither the name of the University nor the names of its contributors
	19	.\" may be used to endorse or promote products derived from this software
	20	.\" without specific prior written permission.
	21	.\"
	22	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	23	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	24	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	25	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	26	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	27	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	28	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	29	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	30	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	31	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	32	.\" SUCH DAMAGE.
	33	.\"
	34	.\" @(#)getsockname.2 8.1 (Berkeley) 6/4/93
	35	.\"
	36	.Dd June 4, 1993
	37	.Dt GETSOCKNAME 2
	38	.Os BSD 4.2
	39	.Sh NAME
	40	.Nm getsockname
	41	.Nd get socket name
	42	.Sh SYNOPSIS
	43	.Fd #include <sys/socket.h>
	44	.Ft int
2d21ac55 A	45	.Fo getsockname
	46	.Fa "int socket"
	47	.Fa "struct sockaddr *restrict address"
	48	.Fa "socklen_t *restrict address_len"
	49	.Fc
9bccf70c	50	.Sh DESCRIPTION
b0d623f7 A	51	The
b0d623f7 A	52	.Fn getsockname
3e170ce0	53	function returns the current
2d21ac55	54	.Fa address
b0d623f7 A	55	for the specified socket.
	56	.Pp
	57	The
2d21ac55	58	.Fa address_len
9bccf70c A	59	parameter should be initialized to indicate
9bccf70c A	60	the amount of space pointed to by
2d21ac55	61	.Fa address .
b0d623f7	62	On return it contains the actual size of the address
9bccf70c	63	returned (in bytes).
b0d623f7 A	64	.Pp
b0d623f7 A	65	The address is truncated if the buffer provided is too small.
2d21ac55 A	66	.Sh RETURN VALUES
2d21ac55 A	67	.Rv -std getsockname
9bccf70c	68	.Sh ERRORS
2d21ac55 A	69	The
	70	.Fn getsockname
	71	system call will succeed unless:
9bccf70c	72	.Bl -tag -width Er
2d21ac55	73	.\" ==========
9bccf70c A	74	.It Bq Er EBADF
9bccf70c A	75	The argument
2d21ac55 A	76	.Fa socket
	77	is not a valid file descriptor.
	78	.\" ==========
9bccf70c A	79	.It Bq Er EFAULT
9bccf70c A	80	The
2d21ac55	81	.Fa address
9bccf70c A	82	parameter points to memory not in a valid part of the
9bccf70c A	83	process address space.
2d21ac55 A	84	.\" ==========
	85	.It Bq Er EINVAL
	86	.Fa socket
	87	has been shut down.
	88	.\" ==========
	89	.It Bq Er ENOBUFS
	90	Insufficient resources were available in the system
	91	to perform the operation.
	92	.\" ==========
	93	.It Bq Er ENOTSOCK
	94	The argument
	95	.Fa socket
	96	is not a socket (e.g., a plain file).
	97	.\" ==========
	98	.It Bq Er EOPNOTSUPP
	99	.Fn getsockname
	100	is not supported for the protocol in use by
	101	.Fa socket .
9bccf70c A	102	.El
	103	.Sh SEE ALSO
	104	.Xr bind 2 ,
	105	.Xr socket 2
	106	.Sh BUGS
	107	Names bound to sockets in the UNIX domain are inaccessible;
2d21ac55	108	.Fn getsockname
b0d623f7	109	returns a zero-length address.
9bccf70c A	110	.Sh HISTORY
	111	The
	112	.Fn getsockname
2d21ac55	113	call appeared in
9bccf70c	114	.Bx 4.2 .