xref: /illumos-gate/usr/src/man/man3socket/getpeername.3socket (revision 48edc7cf07b5dccc3ad84bf2dafe4150bd666d60)
te
Copyright 1989 AT&T Copyright (c) 1998, Sun Microsystems, Inc. All Rights Reserved
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]
GETPEERNAME 3SOCKET "Mar 26, 1998"
NAME
getpeername - get name of connected peer
SYNOPSIS

cc [ flag ... ] file ... -lsocket  -lnsl  [ library ... ]
#include <sys/types.h>
#include <sys/socket.h>

int getpeername(int s, struct sockaddr *name, socklen_t *namelen);
DESCRIPTION

getpeername() returns the name of the peer connected to socket s. The int pointed to by the namelen parameter should be initialized to indicate the amount of space pointed to by name. On return it contains the actual size of the name returned (in bytes), prior to any truncation. The name is truncated if the buffer provided is too small.

RETURN VALUES

If successful, getpeername() returns 0; otherwise it returns -1 and sets errno to indicate the error.

ERRORS

The call succeeds unless: EBADF

The argument s is not a valid descriptor.

ENOMEM

There was insufficient user memory for the operation to complete.

ENOSR

There were insufficient STREAMS resources available for the operation to complete.

ENOTCONN

The socket is not connected.

ENOTSOCK

The argument s is not a socket.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Safe
SEE ALSO

accept(3SOCKET), bind(3SOCKET), getsockname(3SOCKET), sockaddr(3SOCKET), socket(3SOCKET), attributes(5), socket.h(3HEAD)