usr/src/man/man3xnet/getsockname.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 GETSOCKNAME 3XNET "Jun 10, 2002"
  11 .SH NAME
  12 getsockname \- get the socket name
  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 \fBgetsockname\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 \fBgetsockname()\fR function retrieves the locally-bound name of the
  26 specified socket, stores this address in the \fBsockaddr\fR structure pointed
  27 to by the \fIaddress\fR argument, and stores the length of this address in the
  28 object 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 socket has not been bound to a local name, the value stored in the
  36 object pointed to by \fIaddress\fR is unspecified.
  37 .SH RETURN VALUES
  38 .LP
  39 Upon successful completion, 0 is returned, the \fIaddress\fR argument points to
  40 the address of the socket, and the \fIaddress_len\fR argument points to the
  41 length of the address.  Otherwise, \(mi1 is returned and \fBerrno\fR is set to
  42 indicate the error.
  43 .SH ERRORS
  44 .LP
  45 The \fBgetsockname()\fR function will fail:
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBEBADF\fR\fR
  50 .ad
  51 .RS 14n
  52 The \fIsocket\fR argument is not a valid file descriptor.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBEFAULT\fR\fR
  59 .ad
  60 .RS 14n
  61 The  \fIaddress\fR or  \fIaddress_len\fR parameter can not be accessed or
  62 written.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBENOTSOCK\fR\fR
  69 .ad
  70 .RS 14n
  71 The \fIsocket\fR argument does not refer to a socket.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBEOPNOTSUPP\fR\fR
  78 .ad
  79 .RS 14n
  80 The operation is not supported for this socket's protocol.
  81 .RE
  82
  83 .sp
  84 .LP
  85 The \fBgetsockname()\fR function may fail if:
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fBEINVAL\fR\fR
  90 .ad
  91 .RS 11n
  92 The socket has been shut down.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBENOBUFS\fR\fR
  99 .ad
 100 .RS 11n
 101 Insufficient resources were available in the system to complete the call.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBENOSR\fR\fR
 108 .ad
 109 .RS 11n
 110 There were insufficient STREAMS resources available for the operation to
 111 complete.
 112 .RE
 113
 114 .SH ATTRIBUTES
 115 .LP
 116 See \fBattributes\fR(5) for descriptions of the following attributes:
 117 .sp
 118
 119 .sp
 120 .TS
 121 box;
 122 c | c
 123 l | l .
 124 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 125 _
 126 Interface Stability     Standard
 127 _
 128 MT-Level        MT-Safe
 129 .TE
 130
 131 .SH SEE ALSO
 132 .LP
 133 \fBsockaddr\fR(3SOCKET),
 134 \fBaccept\fR(3XNET), \fBbind\fR(3XNET), \fBgetpeername\fR(3XNET),
 135 \fBsocket\fR(3XNET) \fBattributes\fR(5), \fBstandards\fR(5)