xref: /dragonfly/lib/libc/sys/getsockname.2 (revision 1de703da)
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. 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.\"     @(#)getsockname.2	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD: src/lib/libc/sys/getsockname.2,v 1.9.2.8 2001/12/14 18:34:00 ru Exp $
34.\" $DragonFly: src/lib/libc/sys/getsockname.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
35.\"
36.Dd June 4, 1993
37.Dt GETSOCKNAME 2
38.Os
39.Sh NAME
40.Nm getsockname
41.Nd get socket name
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.In sys/types.h
46.In sys/socket.h
47.Ft int
48.Fn getsockname "int s" "struct sockaddr *name" "socklen_t *namelen"
49.Sh DESCRIPTION
50.Fn Getsockname
51returns the current
52.Fa name
53for the specified socket.  The
54.Fa namelen
55parameter should be initialized to indicate
56the amount of space pointed to by
57.Fa name .
58On return it contains the actual size of the name
59returned (in bytes).
60.Sh RETURN VALUES
61.Rv -std getsockname
62.Sh ERRORS
63The call succeeds unless:
64.Bl -tag -width Er
65.It Bq Er EBADF
66The argument
67.Fa s
68is not a valid descriptor.
69.It Bq Er ECONNRESET
70The connection has been reset by the peer.
71.It Bq Er ENOTSOCK
72The argument
73.Fa s
74is a file, not a socket.
75.It Bq Er ENOBUFS
76Insufficient resources were available in the system
77to perform the operation.
78.It Bq Er EFAULT
79The
80.Fa name
81parameter points to memory not in a valid part of the
82process address space.
83.El
84.Sh SEE ALSO
85.Xr bind 2 ,
86.Xr getpeername 2 ,
87.Xr socket 2
88.Sh BUGS
89Names bound to sockets in the UNIX domain are inaccessible;
90.Xr getsockname
91returns a zero length name.
92.Sh HISTORY
93The
94.Fn getsockname
95function call appeared in
96.Bx 4.2 .
97