xref: /netbsd-src/lib/libc/sys/getpeername.2 (revision ae1bfcddc410612bc8c58b807e1830becb69a24c)
1.\" Copyright (c) 1983, 1991 The Regents of the University of California.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     from: @(#)getpeername.2	6.5 (Berkeley) 3/10/91
33.\"	$Id: getpeername.2,v 1.4 1993/11/29 21:25:09 jtc Exp $
34.\"
35.Dd March 10, 1991
36.Dt GETPEERNAME 2
37.Os BSD 4.2
38.Sh NAME
39.Nm getpeername
40.Nd get name of connected peer
41.Sh SYNOPSIS
42.Ft int
43.Fn getpeername "int s" "struct sockaddr *name" "int *namelen"
44.Sh DESCRIPTION
45.Fn Getpeername
46returns the name of the peer connected to
47socket
48.Fa s .
49The
50.Fa namelen
51parameter should be initialized to indicate
52the amount of space pointed to by
53.Fa name .
54On return it contains the actual size of the name
55returned (in bytes).
56The name is truncated if the buffer provided is too small.
57.Sh DIAGNOSTICS
58A 0 is returned if the call succeeds, -1 if it fails.
59.Sh ERRORS
60The call succeeds unless:
61.Bl -tag -width Er
62.It Bq Er EBADF
63The argument
64.Fa s
65is not a valid descriptor.
66.It Bq Er ENOTSOCK
67The argument
68.Fa s
69is a file, not a socket.
70.It Bq Er ENOTCONN
71The socket is not connected.
72.It Bq Er ENOBUFS
73Insufficient resources were available in the system
74to perform the operation.
75.It Bq Er EFAULT
76The
77.Fa name
78parameter points to memory not in a valid part of the
79process address space.
80.El
81.Sh SEE ALSO
82.Xr accept 2 ,
83.Xr bind 2 ,
84.Xr socket 2 ,
85.Xr getsockname 2
86.Sh HISTORY
87The
88.Fn getpeername
89function call appeared in
90.Bx 4.2 .
91