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