1.\" $NetBSD: getpeername.2,v 1.5 1995/02/27 12:33:06 cgd 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.Ft int 44.Fn getpeername "int s" "struct sockaddr *name" "int *namelen" 45.Sh DESCRIPTION 46.Fn Getpeername 47returns the name of the peer connected to 48socket 49.Fa s . 50The 51.Fa namelen 52parameter should be initialized to indicate 53the amount of space pointed to by 54.Fa name . 55On return it contains the actual size of the name 56returned (in bytes). 57The name is truncated if the buffer provided is too small. 58.Sh DIAGNOSTICS 59A 0 is returned if the call succeeds, -1 if it fails. 60.Sh ERRORS 61The call succeeds unless: 62.Bl -tag -width Er 63.It Bq Er EBADF 64The argument 65.Fa s 66is not a valid descriptor. 67.It Bq Er ENOTSOCK 68The argument 69.Fa s 70is a file, not a socket. 71.It Bq Er ENOTCONN 72The socket is not connected. 73.It Bq Er ENOBUFS 74Insufficient resources were available in the system 75to perform the operation. 76.It Bq Er EFAULT 77The 78.Fa name 79parameter points to memory not in a valid part of the 80process address space. 81.El 82.Sh SEE ALSO 83.Xr accept 2 , 84.Xr bind 2 , 85.Xr socket 2 , 86.Xr getsockname 2 87.Sh HISTORY 88The 89.Fn getpeername 90function call appeared in 91.Bx 4.2 . 92