man2/getsockname.2

   1 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   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.
  32 .\" %%%LICENSE_END
  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 .\"
  40 .TH GETSOCKNAME 2 2021-03-22 "Linux" "Linux Programmer's Manual"
  41 .SH NAME
  42 getsockname \- get socket name
  43 .SH SYNOPSIS
  44 .nf
  45 .B #include <sys/socket.h>
  46 .PP
  47 .BI "int getsockname(int " sockfd ", struct sockaddr *restrict " addr ,
  48 .BI "                socklen_t *restrict " addrlen );
  49 .fi
  50 .SH DESCRIPTION
  51 .BR getsockname ()
  52 returns the current address to which the socket
  53 .I sockfd
  54 is bound, in the buffer pointed to by
  55 .IR addr .
  56 The
  57 .I addrlen
  58 argument should be initialized to indicate
  59 the amount of space (in bytes) pointed to by
  60 .IR addr .
  61 On return it contains the actual size of the socket address.
  62 .PP
  63 The returned address is truncated if the buffer provided is too small;
  64 in this case,
  65 .I addrlen
  66 will return a value greater than was supplied to the call.
  67 .SH RETURN VALUE
  68 On success, zero is returned.
  69 On error, \-1 is returned, and
  70 .I errno
  71 is set to indicate the error.
  72 .SH ERRORS
  73 .TP
  74 .B EBADF
  75 The argument
  76 .I sockfd
  77 is not a valid file descriptor.
  78 .TP
  79 .B EFAULT
  80 The
  81 .I addr
  82 argument points to memory not in a valid part of the
  83 process address space.
  84 .TP
  85 .B EINVAL
  86 .I addrlen
  87 is invalid (e.g., is negative).
  88 .TP
  89 .B ENOBUFS
  90 Insufficient resources were available in the system
  91 to perform the operation.
  92 .TP
  93 .B ENOTSOCK
  94 The file descriptor
  95 .I sockfd
  96 does not refer to a socket.
  97 .SH CONFORMING TO
  98 POSIX.1-2001, POSIX.1-2008, SVr4, 4.4BSD
  99 .RB ( getsockname ()
 100 first appeared in 4.2BSD).
 101 .\" SVr4 documents additional ENOMEM
 102 .\" and ENOSR error codes.
 103 .SH NOTES
 104 For background on the
 105 .I socklen_t
 106 type, see
 107 .BR accept (2).
 108 .SH SEE ALSO
 109 .BR bind (2),
 110 .BR socket (2),
 111 .BR getifaddrs (3),
 112 .BR ip (7),
 113 .BR socket (7),
 114 .BR unix (7)