]>
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 | .\" @(#)getsockname.2 6.4 (Berkeley) 3/10/91 | |
35 | .\" | |
36 | .\" Modified Sat Jul 24 16:30:29 1993 by Rik Faith <faith@cs.unc.edu> | |
37 | .\" Modified Tue Oct 22 00:22:35 EDT 1996 by Eric S. Raymond <esr@thyrsus.com> | |
38 | .\" Modified Sun Mar 28 21:26:46 1999 by Andries Brouwer <aeb@cwi.nl> | |
39 | .\" | |
29b41e74 | 40 | .TH GETSOCKNAME 2 2015-12-28 "Linux" "Linux Programmer's Manual" |
fea681da MK |
41 | .SH NAME |
42 | getsockname \- get socket name | |
43 | .SH SYNOPSIS | |
44 | .nf | |
45 | .B #include <sys/socket.h> | |
46 | .sp | |
a2b8b6d6 MK |
47 | .BI "int getsockname(int " sockfd ", struct sockaddr *" addr \ |
48 | ", socklen_t *" addrlen ); | |
fea681da MK |
49 | .fi |
50 | .SH DESCRIPTION | |
7145b9a9 | 51 | .BR getsockname () |
3c19f5ed MK |
52 | returns the current address to which the socket |
53 | .I sockfd | |
54 | is bound, in the buffer pointed to by | |
a2b8b6d6 | 55 | .IR addr . |
c13182ef | 56 | The |
a2b8b6d6 | 57 | .I addrlen |
c4bb193f | 58 | argument should be initialized to indicate |
f7c494fb | 59 | the amount of space (in bytes) pointed to by |
a2b8b6d6 | 60 | .IR addr . |
f7c494fb MK |
61 | On return it contains the actual size of the socket address. |
62 | ||
63 | The returned address is truncated if the buffer provided is too small; | |
64 | in this case, | |
a2b8b6d6 | 65 | .I addrlen |
f7c494fb | 66 | will return a value greater than was supplied to the call. |
47297adb | 67 | .SH RETURN VALUE |
c13182ef MK |
68 | On success, zero is returned. |
69 | On error, \-1 is returned, and | |
fea681da MK |
70 | .I errno |
71 | is set appropriately. | |
72 | .SH ERRORS | |
73 | .TP | |
74 | .B EBADF | |
75 | The argument | |
3e4088f4 | 76 | .I sockfd |
d9cb0d7d | 77 | is not a valid file descriptor. |
fea681da MK |
78 | .TP |
79 | .B EFAULT | |
c13182ef | 80 | The |
a2b8b6d6 | 81 | .I addr |
c4bb193f | 82 | argument points to memory not in a valid part of the |
fea681da MK |
83 | process address space. |
84 | .TP | |
16c892d3 | 85 | .B EINVAL |
a2b8b6d6 | 86 | .I addrlen |
16c892d3 MK |
87 | is invalid (e.g., is negative). |
88 | .TP | |
fea681da MK |
89 | .B ENOBUFS |
90 | Insufficient resources were available in the system | |
91 | to perform the operation. | |
92 | .TP | |
93 | .B ENOTSOCK | |
deedfd97 | 94 | The file descriptor |
3e4088f4 | 95 | .I sockfd |
deedfd97 | 96 | does not refer to a socket. |
47297adb | 97 | .SH CONFORMING TO |
7c69088e MK |
98 | POSIX.1-2001, POSIX.1-2008, SVr4, 4.4BSD |
99 | .RB ( getsockname () | |
100 | first appeared in 4.2BSD). | |
97c1eac8 | 101 | .\" SVr4 documents additional ENOMEM |
c13182ef | 102 | .\" and ENOSR error codes. |
19c98696 | 103 | .SH NOTES |
c13182ef | 104 | The third argument of |
e511ffb6 | 105 | .BR getsockname () |
c6fa0841 MK |
106 | is in reality an |
107 | .I "int\ *" | |
2b0fa182 | 108 | (and this is what 4.x BSD and libc4 and libc5 have). |
c6fa0841 MK |
109 | Some POSIX confusion resulted in the present |
110 | .IR socklen_t , | |
2b0fa182 | 111 | also used by glibc. |
fea681da MK |
112 | See also |
113 | .BR accept (2). | |
47297adb | 114 | .SH SEE ALSO |
fea681da | 115 | .BR bind (2), |
ecae8a08 | 116 | .BR socket (2), |
e174ff0a | 117 | .BR getifaddrs (3), |
ecae8a08 | 118 | .BR ip (7), |
5dfedcae | 119 | .BR socket (7), |
ecae8a08 | 120 | .BR unix (7) |