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. 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$
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt GETSOCKNAME 2
  37 .Os BSD 4.2
  38 .Sh NAME
  39 .Nm getsockname
  40 .Nd get socket name
  41 .Sh SYNOPSIS
  42 .Fd #include <sys/types.h>
  43 .Fd #include <sys/socket.h>
  44 .Ft int
  45 .Fn getsockname "int s" "struct sockaddr *name" "socklen_t *namelen"
  46 .Sh DESCRIPTION
  47 .Fn Getsockname
  48 returns the current
  49 .Fa name
  50 for the specified socket.  The
  51 .Fa namelen
  52 parameter 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 IMPLEMENTATION NOTES
  58 .Pp
  59 In the non-threaded library
  60 .Fn getsockname
  61 is implemented as the
  62 .Va getsockname
  63 syscall.
  64 .Pp
  65 In the threaded library, the
  66 .Va getsockname
  67 syscall is assembled to
  68 .Fn _thread_sys_getsockname
  69 and
  70 .Fn getsockname
  71 is implemented as a function which locks
  72 .Va fd
  73 for read and write, then calls
  74 .Fn _thread_sys_getsockname .
  75 Before returning,
  76 .Fn getsockname
  77 unlocks
  78 .Va fd .
  79 .Sh RETURN VALUES
  80 A 0 is returned if the call succeeds, -1 if it fails.
  81 .Sh ERRORS
  82 The call succeeds unless:
  83 .Bl -tag -width ENOTSOCKAA
  84 .It Bq Er EBADF
  85 The argument
  86 .Fa s
  87 is not a valid descriptor.
  88 .It Bq Er ENOTSOCK
  89 The argument
  90 .Fa s
  91 is a file, not a socket.
  92 .It Bq Er ENOBUFS
  93 Insufficient resources were available in the system
  94 to perform the operation.
  95 .It Bq Er EFAULT
  96 The
  97 .Fa name
  98 parameter points to memory not in a valid part of the
  99 process address space.
 100 .El
 101 .Sh SEE ALSO
 102 .Xr bind 2 ,
 103 .Xr getpeername 2 ,
 104 .Xr socket 2
 105 .Sh BUGS
 106 Names bound to sockets in the UNIX domain are inaccessible;
 107 .Xr getsockname
 108 returns a zero length name.
 109 .Sh HISTORY
 110 The
 111 .Fn getsockname
 112 function call appeared in
 113 .Bx 4.2 .