xref: /386bsd/usr/src/lib/libc/sys/getpeername.2 (revision a2142627)
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.\"     @(#)getpeername.2	6.5 (Berkeley) 3/10/91
33.\"
34.Dd March 10, 1991
35.Dt GETPEERNAME 2
36.Os BSD 4.2
37.Sh NAME
38.Nm getpeername
39.Nd get name of connected peer
40.Sh SYNOPSIS
41.Ft int
42.Fn getpeername "int s" "struct sockaddr *name" "int *namelen"
43.Sh DESCRIPTION
44.Fn Getpeername
45returns the name of the peer connected to
46socket
47.Fa s .
48The
49.Fa namelen
50parameter 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 DIAGNOSTICS
57A 0 is returned if the call succeeds, -1 if it fails.
58.Sh ERRORS
59The call succeeds unless:
60.Bl -tag -width ENOTSOCKAA
61.It Bq Er EBADF
62The argument
63.Fa s
64is not a valid descriptor.
65.It Bq Er ENOTSOCK
66The argument
67.Fa s
68is a file, not a socket.
69.It Bq Er ENOTCONN
70The socket is not connected.
71.It Bq Er ENOBUFS
72Insufficient resources were available in the system
73to perform the operation.
74.It Bq Er EFAULT
75The
76.Fa name
77parameter points to memory not in a valid part of the
78process address space.
79.El
80.Sh SEE ALSO
81.Xr accept 2 ,
82.Xr bind 2 ,
83.Xr socket 2 ,
84.Xr getsockname 2
85.Sh HISTORY
86The
87.Nm
88function call appeared in
89.Bx 4.2 .
90