usr/src/man/man3xnet/getpeername.3xnet

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Portions Copyright (c) 1998, Sun Microsystems, Inc.  All Rights Reserved.
  45 .\"
  46 .TH GETPEERNAME 3XNET "Jun 10, 2002"
  47 .SH NAME
  48 getpeername \- get the name of the peer socket
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lxnet\fR [ \fIlibrary\fR ... ]
  53 #include <sys/socket.h>
  54
  55 \fBint\fR \fBgetpeername\fR(\fBint\fR \fIsocket\fR, \fBstruct sockaddr *restrict\fR \fIaddress\fR,
  56      \fBsocklen_t *restrict\fR \fIaddress_len\fR);
  57 .fi
  58
  59 .SH DESCRIPTION
  60 .LP
  61 The \fBgetpeername()\fR function retrieves the peer address of the specified
  62 socket, stores this address in the \fBsockaddr\fR structure pointed to by the
  63 \fIaddress\fR argument, and stores the length of this address in the object
  64 pointed to by the \fIaddress_len\fR argument.
  65 .sp
  66 .LP
  67 If the actual length of the address is greater than the length of the supplied
  68 \fBsockaddr\fR structure, the stored address will be truncated.
  69 .sp
  70 .LP
  71 If the protocol permits connections by unbound clients, and the peer is not
  72 bound, then the value stored in the object pointed to by \fIaddress\fR is
  73 unspecified.
  74 .SH RETURN VALUES
  75 .LP
  76 Upon successful completion, 0 is returned.  Otherwise, \(mi1 is returned and
  77 \fBerrno\fR is set to indicate the error.
  78 .SH ERRORS
  79 .LP
  80 The \fBgetpeername()\fR function will fail if:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBEBADF\fR\fR
  85 .ad
  86 .RS 14n
  87 The \fIsocket\fR argument is not a valid file descriptor.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBEFAULT\fR\fR
  94 .ad
  95 .RS 14n
  96 The  \fIaddress\fR or  \fIaddress_len\fR parameter can not be accessed or
  97 written.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBEINVAL\fR\fR
 104 .ad
 105 .RS 14n
 106 The socket has been shut down.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBENOTCONN\fR\fR
 113 .ad
 114 .RS 14n
 115 The socket is not connected or otherwise has not had the peer prespecified.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBENOTSOCK\fR\fR
 122 .ad
 123 .RS 14n
 124 The \fIsocket\fR argument does not refer to a socket.
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fBEOPNOTSUPP\fR\fR
 131 .ad
 132 .RS 14n
 133 The operation is not supported for the socket protocol.
 134 .RE
 135
 136 .sp
 137 .LP
 138 The \fBgetpeername()\fR function may fail if:
 139 .sp
 140 .ne 2
 141 .na
 142 \fB\fBENOBUFS\fR\fR
 143 .ad
 144 .RS 11n
 145 Insufficient resources were available in the system to complete the call.
 146 .RE
 147
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fBENOSR\fR\fR
 152 .ad
 153 .RS 11n
 154 There were insufficient STREAMS resources available for the operation to
 155 complete.
 156 .RE
 157
 158 .SH ATTRIBUTES
 159 .LP
 160 See \fBattributes\fR(5) for descriptions of the following attributes:
 161 .sp
 162
 163 .sp
 164 .TS
 165 box;
 166 c | c
 167 l | l .
 168 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 169 _
 170 Interface Stability     Standard
 171 _
 172 MT-Level        MT-Safe
 173 .TE
 174
 175 .SH SEE ALSO
 176 .LP
 177 \fBsockaddr\fR(3SOCKET),
 178 \fBaccept\fR(3XNET), \fBbind\fR(3XNET), \fBgetsockname\fR(3XNET),
 179 \fBsocket\fR(3XNET), \fBattributes\fR(5), \fBstandards\fR(5)