bsd/man/man2/getpeername.2

   1 .\"     $NetBSD: getpeername.2,v 1.6 1995/10/12 15:40:56 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 .\"     @(#)getpeername.2       8.1 (Berkeley) 6/4/93
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt GETPEERNAME 2
  38 .Os BSD 4.2
  39 .Sh NAME
  40 .Nm getpeername
  41 .Nd get name of connected peer
  42 .Sh SYNOPSIS
  43 .Fd #include <sys/socket.h>
  44 .Ft int
  45 .Fn getpeername "int s" "struct sockaddr *name" "int *namelen"
  46 .Sh DESCRIPTION
  47 .Fn Getpeername
  48 returns the name of the peer connected to
  49 socket
  50 .Fa s .
  51 The
  52 .Fa namelen
  53 parameter should be initialized to indicate
  54 the amount of space pointed to by
  55 .Fa name .
  56 On return it contains the actual size of the name
  57 returned (in bytes).
  58 The name is truncated if the buffer provided is too small.
  59 .Sh DIAGNOSTICS
  60 A 0 is returned if the call succeeds, -1 if it fails.
  61 .Sh ERRORS
  62 The call succeeds unless:
  63 .Bl -tag -width Er
  64 .It Bq Er EBADF
  65 The argument
  66 .Fa s
  67 is not a valid descriptor.
  68 .It Bq Er ENOTSOCK
  69 The argument
  70 .Fa s
  71 is a file, not a socket.
  72 .It Bq Er ENOTCONN
  73 The socket is not connected.
  74 .It Bq Er ENOBUFS
  75 Insufficient resources were available in the system
  76 to perform the operation.
  77 .It Bq Er EFAULT
  78 The
  79 .Fa name
  80 parameter points to memory not in a valid part of the
  81 process address space.
  82 .El
  83 .Sh SEE ALSO
  84 .Xr accept 2 ,
  85 .Xr bind 2 ,
  86 .Xr socket 2 ,
  87 .Xr getsockname 2
  88 .Sh HISTORY
  89 The
  90 .Fn getpeername
  91 function call appeared in
  92 .Bx 4.2 .