Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.
In the following statement, the phrase ``this text'' refers to portions
of the system documentation.
Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]
Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Portions Copyright (c) 1998, Sun Microsystems, Inc. All Rights Reserved.
cc [ flag ... ] file ... -lxnet [ library ... ] #include <sys/socket.h> int getpeername(int socket, struct sockaddr *restrict address, socklen_t *restrict address_len);
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.
Upon successful completion, 0 is returned. Otherwise, -1 is returned and errno is set to indicate the error.
The getpeername() function will fail if: EBADF
The socket argument is not a valid file descriptor.
The address or address_len parameter can not be accessed or written.
The socket has been shut down.
The socket is not connected or otherwise has not had the peer prespecified.
The socket argument does not refer to a socket.
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.
There were insufficient STREAMS resources available for the operation to complete.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| Interface Stability Standard |
| MT-Level MT-Safe |
sockaddr(3SOCKET), accept(3XNET), bind(3XNET), getsockname(3XNET), socket(3XNET), attributes(5), standards(5)