NAME
getpeername — get
the name of the peer socket
SYNOPSIS
#include
<sys/socket.h>
int getpeername(int socket, struct sockaddr *restrict address,
socklen_t *restrict address_len);
DESCRIPTION
The getpeername () function shall retrieve
the peer address of the specified socket, store this address in the
sockaddr structure pointed to by the
address argument, and store the length of this address in
the object pointed to by the
address_len
argument.
If the actual length of the address is greater than the length of the supplied sockaddr structure, the stored address shall be truncated.
If the protocol permits connections by unbound clients, and the peer is not bound, then the value stored in the object pointed to by address is unspecified.
RETURN VALUE
Upon successful completion, 0 shall be returned. Otherwise, -1 shall be returned and errno set to indicate the error.
ERRORS
The getpeername () function shall fail
if:
- [EBADF]
- The socket argument is not a valid file descriptor.
- [EINVAL]
- The socket has been shut down.
- [ENOTCONN]
- The socket is not connected or otherwise has not had the peer pre-specified.
- [ENOTSOCK]
- The socket argument does not refer to a socket.
- [EOPNOTSUPP]
- The operation is not supported for the socket protocol.
The getpeername () function may fail
if:
- [ENOBUFS]
- Insufficient resources were available in the system to complete the call.
EXAMPLES
None.
APPLICATION USAGE
None.
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
accept(3) , bind(3) , getsockname(3) , socket(3)
XBD <sys/socket.h>
CHANGE HISTORY
First released in Issue 6. Derived from the XNS, Issue 5.2 specification.
The
restrict keyword
is added to the getpeername () prototype for
alignment with the ISO/IEC 9899:1999
(“ISO C99”) standard.