Name

getpeername — get name of connected peer socket

Synopsis

#include <sys/socket.h>
int getpeername( int sockfd,
  struct sockaddr *addr,
  socklen_t *addrlen);
 

DESCRIPTION

getpeername() returns the address of the peer connected to the socket sockfd, in the buffer pointed to by addr. The addrlen argument should be initialized to indicate the amount of space pointed to by addr. On return it contains the actual size of the name returned (in bytes). The name is truncated if the buffer provided is too small.

The returned address is truncated if the buffer provided is too small; in this case, addrlen will return a value greater than was supplied to the call.

RETURN VALUE

On success, zero is returned. On error, −1 is returned, and errno is set appropriately.

ERRORS

EBADF

The argument sockfd is not a valid descriptor.

EFAULT

The addr argument points to memory not in a valid part of the process address space.

EINVAL

addrlen is invalid (e.g., is negative).

ENOBUFS

Insufficient resources were available in the system to perform the operation.

ENOTCONN

The socket is not connected.

ENOTSOCK

The argument sockfd is a file, not a socket.

CONFORMING TO

SVr4, 4.4BSD (the getpeername() function call first appeared in 4.2BSD), POSIX.1-2001.

NOTES

The third argument of getpeername() is in reality an int * (and this is what 4.x BSD and libc4 and libc5 have). Some POSIX confusion resulted in the present socklen_t, also used by glibc. See also accept(2).

SEE ALSO

accept(2), bind(2), getsockname(2), ip(7), socket(7), unix(7)

COLOPHON

This page is part of release 3.33 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://man7.org/linux/man-pages/.


  Copyright (c) 1983, 1991 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software
   must display the following acknowledgement:
This product includes software developed by the University of
California, Berkeley and its contributors.
4. Neither the name of the University nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

    (#)getpeername.2 6.5 (Berkeley) 3/10/91

Modified Sat Jul 24 16:37:50 1993 by Rik Faith <faithcs.unc.edu>
Modified Thu Jul 30 14:37:50 1993 by Martin Schulze <joeydebian.org>
Modified Sun Mar 28 21:26:46 1999 by Andries Brouwer <aebcwi.nl>
Modified 17 Jul 2002, Michael Kerrisk <mtk.manpagesgmail.com>
Added 'socket' to NAME, so that "man -k socket" will show this page.