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 .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 DIAGNOSTICS
  58 A 0 is returned if the call succeeds, -1 if it fails.
  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 ENOTSOCK
  67 The argument
  68 .Fa s
  69 is a file, not a socket.
  70 .It Bq Er ENOBUFS
  71 Insufficient resources were available in the system
  72 to perform the operation.
  73 .It Bq Er EFAULT
  74 The
  75 .Fa name
  76 parameter points to memory not in a valid part of the
  77 process address space.
  78 .El
  79 .Sh SEE ALSO
  80 .Xr bind 2 ,
  81 .Xr socket 2
  82 .Sh BUGS
  83 Names bound to sockets in the UNIX domain are inaccessible;
  84 .Xr getsockname
  85 returns a zero length name.
  86 .Sh HISTORY
  87 The
  88 .Fn getsockname
  89 function call appeared in
  90 .Bx 4.2 .