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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)getpeername.2       8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/sys/getpeername.2,v 1.9.2.8 2001/12/14 18:34:00 ru Exp $
  30 .\" $DragonFly: src/lib/libc/sys/getpeername.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  31 .\"
  32 .Dd June 4, 1993
  33 .Dt GETPEERNAME 2
  34 .Os
  35 .Sh NAME
  36 .Nm getpeername
  37 .Nd get name of connected peer
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/types.h
  42 .In sys/socket.h
  43 .Ft int
  44 .Fn getpeername "int s" "struct sockaddr *name" "socklen_t *namelen"
  45 .Sh DESCRIPTION
  46 .Fn Getpeername
  47 returns the name of the peer connected to
  48 socket
  49 .Fa s .
  50 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 The name is truncated if the buffer provided is too small.
  58 .Sh RETURN VALUES
  59 .Rv -std getpeername
  60 .Sh ERRORS
  61 The call succeeds unless:
  62 .Bl -tag -width Er
  63 .It Bq Er EBADF
  64 The argument
  65 .Fa s
  66 is not a valid descriptor.
  67 .It Bq Er ECONNRESET
  68 The connection has been reset by the peer.
  69 .It Bq Er ENOTSOCK
  70 The argument
  71 .Fa s
  72 is a file, not a socket.
  73 .It Bq Er ENOTCONN
  74 The socket is not connected.
  75 .It Bq Er ENOBUFS
  76 Insufficient resources were available in the system
  77 to perform the operation.
  78 .It Bq Er EFAULT
  79 The
  80 .Fa name
  81 parameter points to memory not in a valid part of the
  82 process address space.
  83 .El
  84 .Sh SEE ALSO
  85 .Xr accept 2 ,
  86 .Xr bind 2 ,
  87 .Xr getsockname 2 ,
  88 .Xr socket 2
  89 .Sh HISTORY
  90 The
  91 .Fn getpeername
  92 function call appeared in
  93 .Bx 4.2 .