OSF

NAME

getpeername − Gets the name of the peer socket

SYNOPSIS

#include<sys/types.h>
#include <sys/socket.h>
int getpeername (
int socket,
struct sockaddr ∗address,
int ∗address_len );

PARAMETERS

socketSpecifies the descriptor number of a connected socket. 

addressPoints to a sockaddr structure, the format of which is determined by the domain and by the behavior requested for the socket.  The sockaddr structure is an overlay for a sockaddr_in, sockaddr_un, or sockaddr_ns structure, depending on which of the supported address families is active.  If the compile-time option _SOCKADDR_LEN is defined before the sys/socket.h header file is included, the sockaddr structure takes 4.4BSD behavior, with a field for specifying the length of the socket address.  Otherwise, the default 4.3BSD sockaddr structure is used, with the length of the socket address assumed to be 14 bytes or less.  If _SOCKADDR_LEN is defined, the 4.3BSD sockaddr structure is defined with the name osockaddr. 

address_lenSpecifies the length of the sockaddr structure pointed to by the address parameter. 

DESCRIPTION

The getpeername() function retrieves the name of the peer socket connected to the specified socket. 

A process created by another process can inherit open sockets, but may need to identify the addresses of the sockets it has inherited.  The getpeername() function allows a process to retrieve the address of the peer socket at the remote end of the socket connection. 

NOTES

The getpeername() function operates only on connected sockets. 

A process can use the getsockname() function to retrieve the local address of a socket. 

RETURN VALUES

Upon successful completion, a value of 0 (zero) is returned and the address parameter holds the address of the peer socket.  If the getpeername() function fails, a value of -1 is returned and errno is set to indicate the error. 

ERRORS

If the getpeername() function fails, errno may be set to one of the following values:

[EBADF]The socket parameter is not valid. 

[ENOTSOCK]
The socket parameter refers to a file, not a socket. 

[ENOTCONN]
The socket is not connected.

[ENOBUFS]Insufficient resources were available in the system to complete the call. 

[EFAULT]The address or address_len parameter is not in a writable part of the user address space. 

RELATED INFORMATION

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