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