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$
  30 .\"
  31 .Dd June 4, 1993
  32 .Dt GETPEERNAME 2
  33 .Os
  34 .Sh NAME
  35 .Nm getpeername
  36 .Nd get name of connected peer
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/types.h
  41 .In sys/socket.h
  42 .Ft int
  43 .Fn getpeername "int s" "struct sockaddr * restrict name" "socklen_t * restrict namelen"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn getpeername
  47 system call
  48 returns the name of the peer connected to
  49 socket
  50 .Fa s .
  51 The
  52 .Fa namelen
  53 argument 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 RETURN VALUES
  60 .Rv -std getpeername
  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 ECONNRESET
  69 The connection has been reset by the peer.
  70 .It Bq Er ENOTSOCK
  71 The argument
  72 .Fa s
  73 is a file, not a socket.
  74 .It Bq Er ENOTCONN
  75 The socket is not connected.
  76 .It Bq Er ENOBUFS
  77 Insufficient resources were available in the system
  78 to perform the operation.
  79 .It Bq Er EFAULT
  80 The
  81 .Fa name
  82 argument points to memory not in a valid part of the
  83 process address space.
  84 .El
  85 .Sh SEE ALSO
  86 .Xr accept 2 ,
  87 .Xr bind 2 ,
  88 .Xr getsockname 2 ,
  89 .Xr socket 2
  90 .Sh HISTORY
  91 The
  92 .Fn getpeername
  93 system call appeared in
  94 .Bx 4.2 .