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 .\" $DragonFly: src/lib/libc/sys/getpeername.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  35 .\"
  36 .Dd June 4, 1993
  37 .Dt GETPEERNAME 2
  38 .Os
  39 .Sh NAME
  40 .Nm getpeername
  41 .Nd get name of connected peer
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .In sys/socket.h
  47 .Ft int
  48 .Fn getpeername "int s" "struct sockaddr *name" "socklen_t *namelen"
  49 .Sh DESCRIPTION
  50 .Fn Getpeername
  51 returns the name of the peer connected to
  52 socket
  53 .Fa s .
  54 The
  55 .Fa namelen
  56 parameter should be initialized to indicate
  57 the amount of space pointed to by
  58 .Fa name .
  59 On return it contains the actual size of the name
  60 returned (in bytes).
  61 The name is truncated if the buffer provided is too small.
  62 .Sh RETURN VALUES
  63 .Rv -std getpeername
  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 ENOTCONN
  78 The socket is not connected.
  79 .It Bq Er ENOBUFS
  80 Insufficient resources were available in the system
  81 to perform the operation.
  82 .It Bq Er EFAULT
  83 The
  84 .Fa name
  85 parameter points to memory not in a valid part of the
  86 process address space.
  87 .El
  88 .Sh SEE ALSO
  89 .Xr accept 2 ,
  90 .Xr bind 2 ,
  91 .Xr getsockname 2 ,
  92 .Xr socket 2
  93 .Sh HISTORY
  94 The
  95 .Fn getpeername
  96 function call appeared in
  97 .Bx 4.2 .