bsd/man/man2/getsockname.2

   1 .\"     $NetBSD: getsockname.2,v 1.6 1995/10/12 15:41:00 jtc Exp $
   2 .\"
   3 .\" Copyright (c) 1983, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"     This product includes software developed by the University of
  17 .\"     California, Berkeley and its contributors.
  18 .\" 4. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)getsockname.2       8.1 (Berkeley) 6/4/93
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt GETSOCKNAME 2
  38 .Os BSD 4.2
  39 .Sh NAME
  40 .Nm getsockname
  41 .Nd get socket name
  42 .Sh SYNOPSIS
  43 .Fd #include <sys/socket.h>
  44 .Ft int
  45 .Fo getsockname
  46 .Fa "int socket"
  47 .Fa "struct sockaddr *restrict address"
  48 .Fa "socklen_t *restrict address_len"
  49 .Fc
  50 .Sh DESCRIPTION
  51 .Fn Getsockname
  52 returns the current
  53 .Fa address
  54 for the specified socket.  The
  55 .Fa address_len
  56 parameter should be initialized to indicate
  57 the amount of space pointed to by
  58 .Fa address .
  59 On return it contains the actual size of the name
  60 returned (in bytes).
  61 .Sh RETURN VALUES
  62 .Rv -std getsockname
  63 .Sh ERRORS
  64 The
  65 .Fn getsockname
  66 system call will succeed unless:
  67 .Bl -tag -width Er
  68 .\" ==========
  69 .It Bq Er EBADF
  70 The argument
  71 .Fa socket
  72 is not a valid file descriptor.
  73 .\" ==========
  74 .It Bq Er EFAULT
  75 The
  76 .Fa address
  77 parameter points to memory not in a valid part of the
  78 process address space.
  79 .\" ==========
  80 .It Bq Er EINVAL
  81 .Fa socket
  82 has been shut down.
  83 .\" ==========
  84 .It Bq Er ENOBUFS
  85 Insufficient resources were available in the system
  86 to perform the operation.
  87 .\" ==========
  88 .It Bq Er ENOTSOCK
  89 The argument
  90 .Fa socket
  91 is not a socket (e.g., a plain file).
  92 .\" ==========
  93 .It Bq Er EOPNOTSUPP
  94 .Fn getsockname
  95 is not supported for the protocol in use by
  96 .Fa socket .
  97 .El
  98 .Sh SEE ALSO
  99 .Xr bind 2 ,
 100 .Xr socket 2
 101 .Sh BUGS
 102 Names bound to sockets in the UNIX domain are inaccessible;
 103 .Fn getsockname
 104 returns a zero-length name.
 105 .Sh HISTORY
 106 The
 107 .Fn getsockname
 108 call appeared in
 109 .Bx 4.2 .