getpeername.3.man

This a separate release of the OpenSS7 X/Open XTI/TLI library, TLI modules (timod, tirdwr) and the I

'\" rtp
.\" -*- nroff -*- vim: ft=nroff noautoindent nocindent nosmartindent
.\"
.\" @(#) getpeername.3.man,v 1.1.2.1 2004/05/16 02:35:34 brian Exp
.\"
.\" =========================================================================
.\"
.\" Copyright (C) 2001-2004  OpenSS7 Corporation <www.openss7.com>
.\"
.\" All Rights Reserved.
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one
.\" 
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\" 
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.\" -------------------------------------------------------------------------
.\"
.\" U.S. GOVERNMENT RESTRICTED RIGHTS.  If you are licensing this Software
.\" on behalf of the U.S. Government ("Government"), the following
.\" provisions apply to you.  If the Software is supplied by the Department
.\" of Defense ("DoD"), it is classified as "Commercial Computer Software"
.\" under paragraph 252.227-7014 of the DoD Supplement to the Federal
.\" Acquisition Regulations ("DFARS") (or any successor regulations) and the
.\" Government is acquiring only the license rights granted herein (the
.\" license rights customarily provided to non-Government users).  If the
.\" Software is supplied to any unit or agency of the Government other than
.\" DoD, it is classified as "Restricted Computer Software" and the
.\" Government's rights in the Software are defined in paragraph 52.227-19
.\" of the Federal Acquisition Regulations ("FAR") (or any success
.\" regulations) or, in the cases of NASA, in paragraph 18.52.227-86 of the
.\" NASA Supplement to the FAR (or any successor regulations).
.\"
.\" =========================================================================
.\" 
.\" Commercial licensing and support of this software is available from
.\" OpenSS7 Corporation at a fee.  See http://www.openss7.com/
.\" 
.\" =========================================================================
.\"
.\" Last Modified 2004/05/16 02:35:34 by brian
.\"
.\" =========================================================================
.so strxnet.macros
.R1
bracket-label "\fR[\fB" "\fR]" "\fR, \fB"
no-default-database
database strxnet.refs
accumulate
move-punctuation
abbreviate A
join-authors ", " ", " " and "
et-al " et al" 2 3
abbreviate-label-ranges ".."
sort-adjacent-labels
.R2
.\"
.\"
.\"
.\"
.TH GETPEERNAME 3 "2004/05/16 02:35:34" "strxnet-0_9_2-4" "Linux Fast-STREAMS Sockets Library"
.SH NAME
.B getpeername
\- get the name of the peer socket
.SH SYNOPSIS
.PP
.B #include <sys/socket.h>
.HP
.BI "int getpeername(int " socket ", struct sockaddr *" address ", socklen_t *" address_len );
.SH DESCRIPTION
.PP
The
.BR getpeername ()
function retrieves the peer address of the
specified
.IR socket ,
stores this address in the
.B sockaddr
structure
pointed to by the
.I address
argument, and stores the length of this
address in the object pointed to by the
.I address_len
argument.
.PP
If the actual length of the address is greater than the length of
the supplied
.B sockaddr
structure, the stored address will be
truncated.
.PP
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.
.SH CAVEATS
.PP
This system call is implemented as a
.B SIOCSOCKSYS
IOCTL.  See
.BR socksys (4)
for more information.
.SH "RETURN VALUE"
.PP
Upon successful completion, 0 is returned.  Otherwise, -1 is
returned and errno is set to indicate the error.
.SH ERRORS
.PP
The
.BR getpeername ()
function will fail if:
.TP
.RB [ EBADF ]
The
.I socket
argument is not a valid file descriptor.
.TP
.RB [ EFAULT ]
The
.I address
or
.I address_len
parameter can not be accessed or
written.
.TP
.RB [ EINVAL ]
The socket has been shut down.
.TP
.RB [ ENOTCONN ]
The socket is not connected or otherwise has not had the peer
prespecified.
.TP
.RB [ ENOTSOCK ]
The
.I socket
argument does not refer to a socket.
.TP
.RB [ EOPNOTSUPP ]
The operation is not supported for the socket protocol.
.PP
The
.BR getpeername ()
function may fail if:
.TP
.RB [ ENOBUFS ]
Insufficient resources were available in the system to complete
the call.
.TP
.RB [ ENOSR ]
There were insufficient
.IR STREAMS (4)
resources available for the
operation to complete.
.SH SEE ALSO
.PP
.BR accept (3),
.BR bind (3),
.BR getsockname (3),
.BR socket (3),
.BR <sys/socket.h> .
.SH "CONFORMING TO"
.PP
The Open Group XNS Issue 5.2.
.[
xns
.]
.\"
.\"
.[
$LIST$
.]
.TI