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

.\"	$NetBSD: getpeername.2,v 1.6 1995/10/12 15:40:56 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.
.\"
.\"     @(#)getpeername.2	8.1 (Berkeley) 6/4/93
.\"
.Dd June 4, 1993
.Dt GETPEERNAME 2
.Os BSD 4.2
.Sh NAME
.Nm getpeername
.Nd get name of connected peer
.Sh SYNOPSIS
.Fd #include <sys/socket.h>
.Ft int
.Fo getpeername
.Fa "int socket"
.Fa "struct sockaddr *restrict address"
.Fa "socklen_t *restrict address_len"
.Fc
.Sh DESCRIPTION
.Fn Getpeername
returns the name of the peer connected to
socket
.Fa socket .
The
.Fa address_len
parameter should be initialized to indicate
the amount of space pointed to by
.Fa name .
On return it contains the actual size of the name
returned (in bytes).
The name is truncated if the buffer provided is too small.
.Sh RETURN VALUES
.Rv -std getpeername
.Sh ERRORS
The call succeeds unless:
.Bl -tag -width Er
.\" ==========
.It Bq Er EBADF
The argument
.Fa socket
is not a valid 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 ENOTCONN
Either the socket is not connected
or it has not had the peer pre-specified.
.\" ==========
.It Bq Er ENOTSOCK
The argument
.Fa socket
refers to something other than a socket (e.g., a file).
.\" ==========
.It Bq Er EOPNOTSUPP
.Fn getpeername
is not supported for the protocol in use by
.Fa socket .
.El
.Sh SEE ALSO
.Xr accept 2 ,
.Xr bind 2 ,
.Xr getsockname 2 ,
.Xr socket 2
.Sh HISTORY
The
.Fn getpeername
function call appeared in
.Bx 4.2 .
Commit	Line	Data
9bccf70c A	1	.\" $NetBSD: getpeername.2,v 1.6 1995/10/12 15:40:56 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	.\" @(#)getpeername.2 8.1 (Berkeley) 6/4/93
	35	.\"
	36	.Dd June 4, 1993
	37	.Dt GETPEERNAME 2
	38	.Os BSD 4.2
	39	.Sh NAME
	40	.Nm getpeername
	41	.Nd get name of connected peer
	42	.Sh SYNOPSIS
	43	.Fd #include <sys/socket.h>
	44	.Ft int
2d21ac55 A	45	.Fo getpeername
	46	.Fa "int socket"
	47	.Fa "struct sockaddr *restrict address"
	48	.Fa "socklen_t *restrict address_len"
	49	.Fc
9bccf70c A	50	.Sh DESCRIPTION
	51	.Fn Getpeername
	52	returns the name of the peer connected to
	53	socket
2d21ac55	54	.Fa socket .
9bccf70c	55	The
2d21ac55	56	.Fa address_len
9bccf70c A	57	parameter should be initialized to indicate
	58	the amount of space pointed to by
	59	.Fa name .
	60	On return it contains the actual size of the name
	61	returned (in bytes).
	62	The name is truncated if the buffer provided is too small.
2d21ac55 A	63	.Sh RETURN VALUES
2d21ac55 A	64	.Rv -std getpeername
9bccf70c A	65	.Sh ERRORS
	66	The call succeeds unless:
	67	.Bl -tag -width Er
2d21ac55	68	.\" ==========
9bccf70c A	69	.It Bq Er EBADF
9bccf70c A	70	The argument
2d21ac55	71	.Fa socket
9bccf70c	72	is not a valid descriptor.
2d21ac55	73	.\" ==========
9bccf70c A	74	.It Bq Er EFAULT
9bccf70c A	75	The
2d21ac55	76	.Fa address
9bccf70c A	77	parameter points to memory not in a valid part of the
9bccf70c A	78	process address space.
2d21ac55 A	79	.\" ==========
	80	.It Bq Er EINVAL
	81	.Fa socket
	82	has been shut down.
	83	.\" ==========
	84	.It Bq Er ENOBUFS
	85	Insufficient resources were available in the system
	86	to perform the operation.
	87	.\" ==========
	88	.It Bq Er ENOTCONN
	89	Either the socket is not connected
	90	or it has not had the peer pre-specified.
	91	.\" ==========
	92	.It Bq Er ENOTSOCK
	93	The argument
	94	.Fa socket
	95	refers to something other than a socket (e.g., a file).
	96	.\" ==========
	97	.It Bq Er EOPNOTSUPP
	98	.Fn getpeername
	99	is not supported for the protocol in use by
	100	.Fa socket .
9bccf70c A	101	.El
	102	.Sh SEE ALSO
	103	.Xr accept 2 ,
	104	.Xr bind 2 ,
2d21ac55 A	105	.Xr getsockname 2 ,
2d21ac55 A	106	.Xr socket 2
9bccf70c A	107	.Sh HISTORY
	108	The
	109	.Fn getpeername
	110	function call appeared in
	111	.Bx 4.2 .