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

   1 '\" te
   2 .\"  Copyright (c) 1992, X/Open Company Limited  All Rights Reserved  Portions Copyright (c) 1998, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" 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 Sun OS 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.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" 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.
   8 .\" 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.
   9 .\" 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]
  10 .TH GETPEERNAME 3XNET "Jun 10, 2002"
  11 .SH NAME
  12 getpeername \- get the name of the peer socket
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lxnet\fR [ \fIlibrary\fR ... ]
  17 #include <sys/socket.h>
  18
  19 \fBint\fR \fBgetpeername\fR(\fBint\fR \fIsocket\fR, \fBstruct sockaddr *restrict\fR \fIaddress\fR,
  20      \fBsocklen_t *restrict\fR \fIaddress_len\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .LP
  25 The \fBgetpeername()\fR function retrieves the peer address of the specified
  26 socket, stores this address in the \fBsockaddr\fR structure pointed to by the
  27 \fIaddress\fR argument, and stores the length of this address in the object
  28 pointed to by the \fIaddress_len\fR argument.
  29 .sp
  30 .LP
  31 If the actual length of the address is greater than the length of the supplied
  32 \fBsockaddr\fR structure, the stored address will be truncated.
  33 .sp
  34 .LP
  35 If the protocol permits connections by unbound clients, and the peer is not
  36 bound, then the value stored in the object pointed to by \fIaddress\fR is
  37 unspecified.
  38 .SH RETURN VALUES
  39 .LP
  40 Upon successful completion, 0 is returned.  Otherwise, \(mi1 is returned and
  41 \fBerrno\fR is set to indicate the error.
  42 .SH ERRORS
  43 .LP
  44 The \fBgetpeername()\fR function will fail if:
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBEBADF\fR\fR
  49 .ad
  50 .RS 14n
  51 The \fIsocket\fR argument is not a valid file descriptor.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBEFAULT\fR\fR
  58 .ad
  59 .RS 14n
  60 The  \fIaddress\fR or  \fIaddress_len\fR parameter can not be accessed or
  61 written.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBEINVAL\fR\fR
  68 .ad
  69 .RS 14n
  70 The socket has been shut down.
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBENOTCONN\fR\fR
  77 .ad
  78 .RS 14n
  79 The socket is not connected or otherwise has not had the peer prespecified.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBENOTSOCK\fR\fR
  86 .ad
  87 .RS 14n
  88 The \fIsocket\fR argument does not refer to a socket.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBEOPNOTSUPP\fR\fR
  95 .ad
  96 .RS 14n
  97 The operation is not supported for the socket protocol.
  98 .RE
  99
 100 .sp
 101 .LP
 102 The \fBgetpeername()\fR function may fail if:
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBENOBUFS\fR\fR
 107 .ad
 108 .RS 11n
 109 Insufficient resources were available in the system to complete the call.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fB\fBENOSR\fR\fR
 116 .ad
 117 .RS 11n
 118 There were insufficient STREAMS resources available for the operation to
 119 complete.
 120 .RE
 121
 122 .SH ATTRIBUTES
 123 .LP
 124 See \fBattributes\fR(5) for descriptions of the following attributes:
 125 .sp
 126
 127 .sp
 128 .TS
 129 box;
 130 c | c
 131 l | l .
 132 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 133 _
 134 Interface Stability     Standard
 135 _
 136 MT-Level        MT-Safe
 137 .TE
 138
 139 .SH SEE ALSO
 140 .LP
 141 \fBsockaddr\fR(3SOCKET),
 142 \fBaccept\fR(3XNET), \fBbind\fR(3XNET), \fBgetsockname\fR(3XNET),
 143 \fBsocket\fR(3XNET), \fBattributes\fR(5), \fBstandards\fR(5)