]>
Commit | Line | Data |
---|---|---|
fea681da MK |
1 | .\" Copyright (c) 1983, 1991 The Regents of the University of California. |
2 | .\" All rights reserved. | |
3 | .\" | |
a9cd9cb7 | 4 | .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB) |
fea681da MK |
5 | .\" Redistribution and use in source and binary forms, with or without |
6 | .\" modification, are permitted provided that the following conditions | |
7 | .\" are met: | |
8 | .\" 1. Redistributions of source code must retain the above copyright | |
9 | .\" notice, this list of conditions and the following disclaimer. | |
10 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
11 | .\" notice, this list of conditions and the following disclaimer in the | |
12 | .\" documentation and/or other materials provided with the distribution. | |
13 | .\" 3. All advertising materials mentioning features or use of this software | |
14 | .\" must display the following acknowledgement: | |
15 | .\" This product includes software developed by the University of | |
16 | .\" California, Berkeley and its contributors. | |
17 | .\" 4. Neither the name of the University nor the names of its contributors | |
18 | .\" may be used to endorse or promote products derived from this software | |
19 | .\" without specific prior written permission. | |
20 | .\" | |
21 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | |
22 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
23 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
24 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
25 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
26 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
27 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
28 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
29 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
30 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
31 | .\" SUCH DAMAGE. | |
8c9302dc | 32 | .\" %%%LICENSE_END |
fea681da MK |
33 | .\" |
34 | .\" @(#)getpeername.2 6.5 (Berkeley) 3/10/91 | |
35 | .\" | |
36 | .\" Modified Sat Jul 24 16:37:50 1993 by Rik Faith <faith@cs.unc.edu> | |
37 | .\" Modified Thu Jul 30 14:37:50 1993 by Martin Schulze <joey@debian.org> | |
38 | .\" Modified Sun Mar 28 21:26:46 1999 by Andries Brouwer <aeb@cwi.nl> | |
c11b1abf | 39 | .\" Modified 17 Jul 2002, Michael Kerrisk <mtk.manpages@gmail.com> |
fea681da MK |
40 | .\" Added 'socket' to NAME, so that "man -k socket" will show this page. |
41 | .\" | |
0c56d917 | 42 | .TH GETPEERNAME 2 2013-02-12 "Linux" "Linux Programmer's Manual" |
fea681da MK |
43 | .SH NAME |
44 | getpeername \- get name of connected peer socket | |
45 | .SH SYNOPSIS | |
46 | .B #include <sys/socket.h> | |
47 | .sp | |
a2b8b6d6 MK |
48 | .BI "int getpeername(int " sockfd ", struct sockaddr *" addr \ |
49 | ", socklen_t *" addrlen ); | |
fea681da | 50 | .SH DESCRIPTION |
7145b9a9 | 51 | .BR getpeername () |
0b11419e | 52 | returns the address of the peer connected to the socket |
c4e7b714 | 53 | .IR sockfd , |
0b11419e | 54 | in the buffer pointed to by |
a2b8b6d6 | 55 | .IR addr . |
fea681da | 56 | The |
a2b8b6d6 | 57 | .I addrlen |
c4bb193f | 58 | argument should be initialized to indicate the amount of space pointed to |
fea681da | 59 | by |
a2b8b6d6 | 60 | .IR addr . |
c13182ef MK |
61 | On return it contains the actual size of the name returned (in bytes). |
62 | The name is truncated if the buffer provided is too small. | |
cb159038 MK |
63 | |
64 | The returned address is truncated if the buffer provided is too small; | |
65 | in this case, | |
a2b8b6d6 | 66 | .I addrlen |
cb159038 | 67 | will return a value greater than was supplied to the call. |
47297adb | 68 | .SH RETURN VALUE |
c13182ef MK |
69 | On success, zero is returned. |
70 | On error, \-1 is returned, and | |
fea681da MK |
71 | .I errno |
72 | is set appropriately. | |
73 | .SH ERRORS | |
74 | .TP | |
75 | .B EBADF | |
76 | The argument | |
3e4088f4 | 77 | .I sockfd |
fea681da MK |
78 | is not a valid descriptor. |
79 | .TP | |
80 | .B EFAULT | |
c13182ef | 81 | The |
a2b8b6d6 | 82 | .I addr |
c4bb193f | 83 | argument points to memory not in a valid part of the |
fea681da MK |
84 | process address space. |
85 | .TP | |
16c892d3 | 86 | .B EINVAL |
a2b8b6d6 | 87 | .I addrlen |
16c892d3 MK |
88 | is invalid (e.g., is negative). |
89 | .TP | |
fea681da MK |
90 | .B ENOBUFS |
91 | Insufficient resources were available in the system | |
92 | to perform the operation. | |
93 | .TP | |
94 | .B ENOTCONN | |
95 | The socket is not connected. | |
96 | .TP | |
97 | .B ENOTSOCK | |
98 | The argument | |
3e4088f4 | 99 | .I sockfd |
fea681da | 100 | is a file, not a socket. |
47297adb | 101 | .SH CONFORMING TO |
fea681da | 102 | SVr4, 4.4BSD (the |
e511ffb6 | 103 | .BR getpeername () |
97c1eac8 | 104 | function call first appeared in 4.2BSD), POSIX.1-2001. |
19c98696 | 105 | .SH NOTES |
c13182ef | 106 | The third argument of |
e511ffb6 | 107 | .BR getpeername () |
c13182ef | 108 | is in reality an |
97c1eac8 MK |
109 | .I int * |
110 | (and this is what 4.x BSD and libc4 and libc5 have). | |
c13182ef MK |
111 | Some POSIX confusion resulted in the present |
112 | .IR socklen_t , | |
97c1eac8 | 113 | also used by glibc. |
fea681da MK |
114 | See also |
115 | .BR accept (2). | |
0c56d917 MK |
116 | |
117 | For stream sockets, once a | |
118 | .BR connect (2) | |
119 | has been performed, either socket can call | |
120 | .BR getpeername () | |
121 | to obtain the address of the peer socket. | |
122 | On the other hand, datagram sockets are connectionless. | |
123 | Calling | |
124 | .BR connect (2) | |
125 | on a datagram socket merely sets the peer address for outgoing | |
126 | datagrams sent with | |
127 | .BR write (2) | |
128 | or | |
129 | .BR recv (2). | |
130 | The caller of | |
131 | .BR connect (2) | |
132 | can use | |
133 | .BR getpeername () | |
134 | to obtain the peer address that it earlier set for the socket. | |
135 | However, the peer socket is unaware of this information, and calling | |
136 | .BR getpeername () | |
137 | on the peer socket will return no useful information (unless a | |
138 | .BR connect (2) | |
139 | call was also executed on the peer). | |
140 | Note also that the receiver of a datagram can obtain | |
141 | the address of the sender when using | |
142 | .BR recvfrom (2). | |
47297adb | 143 | .SH SEE ALSO |
fea681da MK |
144 | .BR accept (2), |
145 | .BR bind (2), | |
ecae8a08 MK |
146 | .BR getsockname (2), |
147 | .BR ip (7), | |
5dfedcae | 148 | .BR socket (7), |
ecae8a08 | 149 | .BR unix (7) |