lib/libc/sys/getsockname.2

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