man.bsd.lv manual page server

Manual Page Search Parameters
GETPEERNAME(2) System Calls Manual GETPEERNAME(2)

getpeername — get name of connected peer

library “libc”

#include <sys/types.h>
#include <sys/socket.h>

int
getpeername(int s, struct sockaddr * restrict name, socklen_t * restrict namelen);

The () system call returns the name of the peer connected to socket s. The namelen argument should be initialized to indicate the amount of space pointed to by name. 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 getpeername() function returns the value 0 if successful; otherwise the value -1 is returned and the global variable errno is set to indicate the error.

The call succeeds unless:

[]
The argument s is not a valid descriptor.
[]
The connection has been reset by the peer.
[]
The value of the namelen argument is not valid.
[]
The argument s is a file, not a socket.
[]
The socket is not connected.
[]
Insufficient resources were available in the system to perform the operation.
[]
The name argument points to memory not in a valid part of the process address space.

accept(2), bind(2), getsockname(2), socket(2)

The getpeername() system call appeared in 4.2BSD.

June 4, 1993 FreeBSD-12.0