]> git.saurik.com Git - apple/xnu.git/blob - bsd/man/man2/getpeername.2
xnu-2782.30.5.tar.gz
[apple/xnu.git] / bsd / man / man2 / getpeername.2
1 .\" $NetBSD: getpeername.2,v 1.6 1995/10/12 15:40:56 jtc 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 address of connected peer
42 .Sh SYNOPSIS
43 .Fd #include <sys/socket.h>
44 .Ft int
45 .Fo getpeername
46 .Fa "int socket"
47 .Fa "struct sockaddr *restrict address"
48 .Fa "socklen_t *restrict address_len"
49 .Fc
50 .Sh DESCRIPTION
51 The
52 .Fn getpeername
53 function returns the address of the peer connected to the specified
54 socket.
55 .Pp
56 The
57 .Fa address_len
58 parameter should be initialized to indicate
59 the amount of space pointed to by
60 .Fa address .
61 On return it contains the actual size of the address
62 returned (in bytes).
63 .Pp
64 The address is truncated if the buffer provided is too small.
65 .Sh RETURN VALUES
66 .Rv -std getpeername
67 .Sh ERRORS
68 The call succeeds unless:
69 .Bl -tag -width Er
70 .\" ==========
71 .It Bq Er EBADF
72 The argument
73 .Fa socket
74 is not a valid descriptor.
75 .\" ==========
76 .It Bq Er EFAULT
77 The
78 .Fa address
79 parameter points to memory not in a valid part of the
80 process address space.
81 .\" ==========
82 .It Bq Er EINVAL
83 .Fa socket
84 has been shut down.
85 .\" ==========
86 .It Bq Er ENOBUFS
87 Insufficient resources were available in the system
88 to perform the operation.
89 .\" ==========
90 .It Bq Er ENOTCONN
91 Either the socket is not connected
92 or it has not had the peer pre-specified.
93 .\" ==========
94 .It Bq Er ENOTSOCK
95 The argument
96 .Fa socket
97 refers to something other than a socket (e.g., a file).
98 .\" ==========
99 .It Bq Er EOPNOTSUPP
100 .Fn getpeername
101 is not supported for the protocol in use by
102 .Fa socket .
103 .El
104 .Sh SEE ALSO
105 .Xr accept 2 ,
106 .Xr bind 2 ,
107 .Xr getsockname 2 ,
108 .Xr socket 2
109 .Sh HISTORY
110 The
111 .Fn getpeername
112 function call appeared in
113 .Bx 4.2 .