xref: /freebsd/lib/libsys/getsockname.2 (revision 8aac90f18aef7c9eea906c3ff9a001ca7b94f375)
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 GETSOCKNAME 2
30.Os
31.Sh NAME
32.Nm getsockname
33.Nd get socket name
34.Sh LIBRARY
35.Lb libc
36.Sh SYNOPSIS
37.In sys/types.h
38.In sys/socket.h
39.Ft int
40.Fn getsockname "int s" "struct sockaddr * restrict name" "socklen_t * restrict namelen"
41.Sh DESCRIPTION
42The
43.Fn getsockname
44system call
45returns the current
46.Fa name
47for the specified socket.
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).
55.Sh RETURN VALUES
56.Rv -std getsockname
57.Sh ERRORS
58The call succeeds unless:
59.Bl -tag -width Er
60.It Bq Er EBADF
61The argument
62.Fa s
63is not a valid descriptor.
64.It Bq Er ECONNRESET
65The connection has been reset by the peer.
66.It Bq Er EINVAL
67The value of the
68.Fa namelen
69argument is not valid.
70.It Bq Er ENOTSOCK
71The argument
72.Fa s
73is a file, not a socket.
74.It Bq Er ENOBUFS
75Insufficient resources were available in the system
76to perform the operation.
77.It Bq Er EFAULT
78The
79.Fa name
80argument points to memory not in a valid part of the
81process address space.
82.El
83.Sh SEE ALSO
84.Xr bind 2 ,
85.Xr getpeername 2 ,
86.Xr socket 2
87.Sh HISTORY
88The
89.Fn getsockname
90system call appeared in
91.Bx 4.2 .
92.Sh BUGS
93Names bound to sockets in the UNIX domain are inaccessible;
94.Fn getsockname
95returns a zero length name.
96