*** UNIX MANUAL PAGE BROWSER ***

getpeername(2) System Calls Manual getpeername(2) NAME getpeername - Gets the name of the peer socket SYNOPSIS #include <sys/socket.h> int getpeername ( int socket, struct sockaddr *address, size_t *address_len ); [Digital] The following definition of the getpeername() function does not conform to current standards and is supported only for backward compatibility (see standards(5)): int getpeername ( int socket, struct sockaddr *address, int *address_len ); STANDARDS Interfaces documented on this reference page conform to industry stan- dards as follows: getpeername(): XPG4-UNIX Refer to the standards(5) reference page for more information about in- dustry standards and associated tags. PARAMETERS Specifies the descriptor number of a connected socket. Points 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 or sockaddr_un structure, depending on which of the supported address families is active. [Digital] 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 ad- dress assumed to be 14 bytes or less. If _SOCKADDR_LEN is defined, the 4.3BSD sockaddr structure is defined with the name osockaddr. Specifies the length of the sockaddr structure pointed to by the address parameter. DESCRIPTION The getpeername() function retrieves the name of the peer socket con- nected 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 ad- dress of a socket. [Digital] When compiled in the X/Open UNIX environment, calls to the getpeername() function are internally renamed by prepending _E to the function name. When you are debugging a module that includes the get- peername() function and for which _XOPEN_SOURCE_EXTENDED has been de- fined, use _Egetpeername to refer to the getpeername() call. See stan- dards(5) for further information. RETURN VALUES Upon successful completion, a value of 0 (zero) is returned and the ad- dress parameter holds the address of the peer socket. If the getpeer- name() 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: The socket parameter is not valid. The address or address_len parameter is not in a writable part of the user address space. The socket has been shut down. Insufficient resources were available in the system to complete the call. The socket is not con- nected. The socket parameter refers to a file, not a socket. The op- eration is not supported for the socket protocol. RELATED INFORMATION Functions: accept(2), bind(2), getsockname(2), socket(2) Standards: standards(5) delim off getpeername(2)