xref: /freebsd-14.2/lib/libc/sys/getpeername.2 (revision b2c76c41)
1.\" Copyright (c) 1983, 1991, 1993
2.\"	The Regents of the University of California.  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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)getpeername.2	8.1 (Berkeley) 6/4/93
29.\"
30.Dd June 4, 1993
31.Dt GETPEERNAME 2
32.Os
33.Sh NAME
34.Nm getpeername
35.Nd get name of connected peer
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In sys/types.h
40.In sys/socket.h
41.Ft int
42.Fn getpeername "int s" "struct sockaddr * restrict name" "socklen_t * restrict namelen"
43.Sh DESCRIPTION
44The
45.Fn getpeername
46system call
47returns the name of the peer connected to
48socket
49.Fa s .
50The
51.Fa namelen
52argument 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 RETURN VALUES
59.Rv -std getpeername
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 ECONNRESET
68The connection has been reset by the peer.
69.It Bq Er EINVAL
70The value of the
71.Fa namelen
72argument is not valid.
73.It Bq Er ENOTSOCK
74The argument
75.Fa s
76is a file, not a socket.
77.It Bq Er ENOTCONN
78The socket is not connected.
79.It Bq Er ENOBUFS
80Insufficient resources were available in the system
81to perform the operation.
82.It Bq Er EFAULT
83The
84.Fa name
85argument points to memory not in a valid part of the
86process address space.
87.El
88.Sh SEE ALSO
89.Xr accept 2 ,
90.Xr bind 2 ,
91.Xr getsockname 2 ,
92.Xr socket 2
93.Sh HISTORY
94The
95.Fn getpeername
96system call appeared in
97.Bx 4.2 .
98