Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

getpeername(2) [osx man page]

GETPEERNAME(2)						      BSD System Calls Manual						    GETPEERNAME(2)

NAME
getpeername -- get address of connected peer SYNOPSIS
#include <sys/socket.h> int getpeername(int socket, struct sockaddr *restrict address, socklen_t *restrict address_len); DESCRIPTION
The getpeername() function returns the address of the peer connected to the specified socket. The address_len parameter should be initialized to indicate the amount of space pointed to by address. On return it contains the actual size of the address returned (in bytes). The address is truncated if the buffer provided is too small. RETURN VALUES
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. ERRORS
The call succeeds unless: [EBADF] The argument socket is not a valid descriptor. [EFAULT] The address parameter points to memory not in a valid part of the process address space. [EINVAL] socket has been shut down. [ENOBUFS] Insufficient resources were available in the system to perform the operation. [ENOTCONN] Either the socket is not connected or it has not had the peer pre-specified. [ENOTSOCK] The argument socket refers to something other than a socket (e.g., a file). [EOPNOTSUPP] getpeername() is not supported for the protocol in use by socket. SEE ALSO
accept(2), bind(2), getsockname(2), socket(2) HISTORY
The getpeername() function call appeared in 4.2BSD. 4.2 Berkeley Distribution June 4, 1993 4.2 Berkeley Distribution

Check Out this Related Man Page

getpeername(3XNET)				   X/Open Networking Services Library Functions 				getpeername(3XNET)

NAME
getpeername - get the name of the peer socket SYNOPSIS
cc [ flag ... ] file ... -lxnet [ library ... ] #include <sys/socket.h> int getpeername(int socket, struct sockaddr *restrict address, socklen_t *restrict address_len); DESCRIPTION
The getpeername() function retrieves the peer address of the specified socket, stores this address in the sockaddr structure pointed to by the address argument, and stores 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 will 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 VALUES
Upon successful completion, 0 is returned. Otherwise, -1 is returned and errno is set to indicate the error. ERRORS
The getpeername() function will fail if: EBADF The socket argument is not a valid file descriptor. EFAULT The address or address_len parameter can not be accessed or written. EINVAL The socket has been shut down. ENOTCONN The socket is not connected or otherwise has not had the peer prespecified. 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. ENOSR There were insufficient STREAMS resources available for the operation to complete. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Standard | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ SEE ALSO
accept(3XNET), bind(3XNET), getsockname(3XNET), socket(3XNET), attributes(5), standards(5) SunOS 5.11 10 Jun 2002 getpeername(3XNET)
Man Page