95 lines
2.9 KiB
Groff
95 lines
2.9 KiB
Groff
.\" Copyright (c) 1983, 1991, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" @(#)getpeername.2 8.1 (Berkeley) 6/4/93
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd June 4, 1993
|
|
.Dt GETPEERNAME 2
|
|
.Os
|
|
.Sh NAME
|
|
.Nm getpeername
|
|
.Nd get name of connected peer
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.In sys/types.h
|
|
.In sys/socket.h
|
|
.Ft int
|
|
.Fn getpeername "int s" "struct sockaddr * restrict name" "socklen_t * restrict namelen"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn getpeername
|
|
system call
|
|
returns the name of the peer connected to
|
|
socket
|
|
.Fa s .
|
|
The
|
|
.Fa namelen
|
|
argument should be initialized to indicate
|
|
the amount of space pointed to by
|
|
.Fa name .
|
|
On return it contains the actual size of the name
|
|
returned (in bytes).
|
|
The name is truncated if the buffer provided is too small.
|
|
.Sh RETURN VALUES
|
|
.Rv -std getpeername
|
|
.Sh ERRORS
|
|
The call succeeds unless:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EBADF
|
|
The argument
|
|
.Fa s
|
|
is not a valid descriptor.
|
|
.It Bq Er ECONNRESET
|
|
The connection has been reset by the peer.
|
|
.It Bq Er ENOTSOCK
|
|
The argument
|
|
.Fa s
|
|
is a file, not a socket.
|
|
.It Bq Er ENOTCONN
|
|
The socket is not connected.
|
|
.It Bq Er ENOBUFS
|
|
Insufficient resources were available in the system
|
|
to perform the operation.
|
|
.It Bq Er EFAULT
|
|
The
|
|
.Fa name
|
|
argument points to memory not in a valid part of the
|
|
process address space.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr accept 2 ,
|
|
.Xr bind 2 ,
|
|
.Xr getsockname 2 ,
|
|
.Xr socket 2
|
|
.Sh HISTORY
|
|
The
|
|
.Fn getpeername
|
|
system call appeared in
|
|
.Bx 4.2 .
|