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