xref: /freebsd/lib/libsys/getpeername.2 (revision 5f757f3f)
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.Dd June 4, 1993
29.Dt GETPEERNAME 2
30.Os
31.Sh NAME
32.Nm getpeername
33.Nd get name of connected peer
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In sys/types.h
38.In sys/socket.h
39.Ft int
40.Fn getpeername "int s" "struct sockaddr * restrict name" "socklen_t * restrict namelen"
41.Sh DESCRIPTION
42The
43.Fn getpeername
44system call
45returns the name of the peer connected to
46socket
47.Fa s .
48The
49.Fa namelen
50argument should be initialized to indicate
51the amount of space pointed to by
52.Fa name .
53On return it contains the actual size of the name
54returned (in bytes).
55The name is truncated if the buffer provided is too small.
56.Sh RETURN VALUES
57.Rv -std getpeername
58.Sh ERRORS
59The call succeeds unless:
60.Bl -tag -width Er
61.It Bq Er EBADF
62The argument
63.Fa s
64is not a valid descriptor.
65.It Bq Er ECONNRESET
66The connection has been reset by the peer.
67.It Bq Er EINVAL
68The value of the
69.Fa namelen
70argument is not valid.
71.It Bq Er ENOTSOCK
72The argument
73.Fa s
74is a file, not a socket.
75.It Bq Er ENOTCONN
76The socket is not connected.
77.It Bq Er ENOBUFS
78Insufficient resources were available in the system
79to perform the operation.
80.It Bq Er EFAULT
81The
82.Fa name
83argument points to memory not in a valid part of the
84process address space.
85.El
86.Sh SEE ALSO
87.Xr accept 2 ,
88.Xr bind 2 ,
89.Xr getsockname 2 ,
90.Xr socket 2
91.Sh HISTORY
92The
93.Fn getpeername
94system call appeared in
95.Bx 4.2 .
96