man2/getpeername.2

   1 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     @(#)getpeername.2       6.5 (Berkeley) 3/10/91
  35 .\"
  36 .\" Modified Sat Jul 24 16:37:50 1993 by Rik Faith <faith@cs.unc.edu>
  37 .\" Modified Thu Jul 30 14:37:50 1993 by Martin Schulze <joey@debian.org>
  38 .\" Modified Sun Mar 28 21:26:46 1999 by Andries Brouwer <aeb@cwi.nl>
  39 .\" Modified 17 Jul 2002, Michael Kerrisk <mtk.manpages@gmail.com>
  40 .\"     Added 'socket' to NAME, so that "man -k socket" will show this page.
  41 .\"
  42 .TH GETPEERNAME 2 2021-03-22 "Linux" "Linux Programmer's Manual"
  43 .SH NAME
  44 getpeername \- get name of connected peer socket
  45 .SH SYNOPSIS
  46 .nf
  47 .B #include <sys/socket.h>
  48 .PP
  49 .BI "int getpeername(int " sockfd ", struct sockaddr *restrict " addr ,
  50 .BI "                socklen_t *restrict " addrlen );
  51 .fi
  52 .SH DESCRIPTION
  53 .BR getpeername ()
  54 returns the address of the peer connected to the socket
  55 .IR sockfd ,
  56 in the buffer pointed to by
  57 .IR addr .
  58 The
  59 .I addrlen
  60 argument should be initialized to indicate the amount of space pointed to
  61 by
  62 .IR addr .
  63 On return it contains the actual size of the name returned (in bytes).
  64 The name is truncated if the buffer provided is too small.
  65 .PP
  66 The returned address is truncated if the buffer provided is too small;
  67 in this case,
  68 .I addrlen
  69 will return a value greater than was supplied to the call.
  70 .SH RETURN VALUE
  71 On success, zero is returned.
  72 On error, \-1 is returned, and
  73 .I errno
  74 is set to indicate the error.
  75 .SH ERRORS
  76 .TP
  77 .B EBADF
  78 The argument
  79 .I sockfd
  80 is not a valid file descriptor.
  81 .TP
  82 .B EFAULT
  83 The
  84 .I addr
  85 argument points to memory not in a valid part of the
  86 process address space.
  87 .TP
  88 .B EINVAL
  89 .I addrlen
  90 is invalid (e.g., is negative).
  91 .TP
  92 .B ENOBUFS
  93 Insufficient resources were available in the system
  94 to perform the operation.
  95 .TP
  96 .B ENOTCONN
  97 The socket is not connected.
  98 .TP
  99 .B ENOTSOCK
 100 The file descriptor
 101 .I sockfd
 102 does not refer to a socket.
 103 .SH CONFORMING TO
 104 POSIX.1-2001, POSIX.1-2008, SVr4, 4.4BSD
 105 .RB ( getpeername ()
 106 first appeared in 4.2BSD).
 107 .SH NOTES
 108 For background on the
 109 .I socklen_t
 110 type, see
 111 .BR accept (2).
 112 .PP
 113 For stream sockets, once a
 114 .BR connect (2)
 115 has been performed, either socket can call
 116 .BR getpeername ()
 117 to obtain the address of the peer socket.
 118 On the other hand, datagram sockets are connectionless.
 119 Calling
 120 .BR connect (2)
 121 on a datagram socket merely sets the peer address for outgoing
 122 datagrams sent with
 123 .BR write (2)
 124 or
 125 .BR recv (2).
 126 The caller of
 127 .BR connect (2)
 128 can use
 129 .BR getpeername ()
 130 to obtain the peer address that it earlier set for the socket.
 131 However, the peer socket is unaware of this information, and calling
 132 .BR getpeername ()
 133 on the peer socket will return no useful information (unless a
 134 .BR connect (2)
 135 call was also executed on the peer).
 136 Note also that the receiver of a datagram can obtain
 137 the address of the sender when using
 138 .BR recvfrom (2).
 139 .SH SEE ALSO
 140 .BR accept (2),
 141 .BR bind (2),
 142 .BR getsockname (2),
 143 .BR ip (7),
 144 .BR socket (7),
 145 .BR unix (7)