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

   1 '\" te
   2 .\"  Copyright (c) 1992, X/Open Company Limited  All Rights Reserved  Portions
   3 .\" Copyright (c) 1998, Sun Microsystems, Inc.  All Rights Reserved
   4 .\" 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
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" 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.
   9 .\" 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.
  10 .\" 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]
  11 .TH SHUTDOWN 3XNET "Jun 10, 2002"
  12 .SH NAME
  13 shutdown \- shut down socket send and receive operations
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lxnet\fR [ \fIlibrary\fR ... ]
  18 #include <sys/socket.h>
  19
  20 \fBint\fR \fBshutdown\fR(\fBint\fR \fIsocket\fR, \fBint\fR \fIhow\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBshutdown()\fR function disables subsequent \fBsend()\fR and
  27 \fBreceive()\fR operations on a socket, depending on the value of the \fIhow\fR
  28 argument.
  29 .SH PARAMETERS
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIhow\fR\fR
  34 .ad
  35 .RS 10n
  36 Specifies the type of shutdown.  The values are as follows:
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBSHUT_RD\fR\fR
  41 .ad
  42 .RS 13n
  43 Disables further receive operations.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fBSHUT_WR\fR\fR
  50 .ad
  51 .RS 13n
  52 Disables further send operations.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBSHUT_RDWR\fR\fR
  59 .ad
  60 .RS 13n
  61 Disables further send and receive operations.
  62 .RE
  63
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fIsocket\fR\fR
  70 .ad
  71 .RS 10n
  72 Specifies the file descriptor of the socket.
  73 .RE
  74
  75 .SH RETURN VALUES
  76 .sp
  77 .LP
  78 Upon successful completion, \fBshutdown()\fR returns 0.  Otherwise, \(mi1 is
  79 returned and \fBerrno\fR is set to indicate the error.
  80 .SH ERRORS
  81 .sp
  82 .LP
  83 The \fBshutdown()\fR function will fail if:
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBEBADF\fR\fR
  88 .ad
  89 .RS 12n
  90 The \fIsocket\fR argument is not a valid file descriptor.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBEINVAL\fR\fR
  97 .ad
  98 .RS 12n
  99 The \fIhow\fR argument is invalid.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBENOTCONN\fR\fR
 106 .ad
 107 .RS 12n
 108 The socket is not connected.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBENOTSOCK\fR\fR
 115 .ad
 116 .RS 12n
 117 The \fIsocket\fR argument does not refer to a socket.
 118 .RE
 119
 120 .sp
 121 .LP
 122 The \fBshutdown()\fR function may fail if:
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBENOBUFS\fR\fR
 127 .ad
 128 .RS 11n
 129 Insufficient resources were available in the system to perform the operation.
 130 .RE
 131
 132 .sp
 133 .ne 2
 134 .na
 135 \fB\fBENOSR\fR\fR
 136 .ad
 137 .RS 11n
 138 There were insufficient STREAMS resources available for the operation to
 139 complete.
 140 .RE
 141
 142 .SH ATTRIBUTES
 143 .sp
 144 .LP
 145 See \fBattributes\fR(5) for descriptions of the following attributes:
 146 .sp
 147
 148 .sp
 149 .TS
 150 box;
 151 c | c
 152 l | l .
 153 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 154 _
 155 Interface Stability     Standard
 156 _
 157 MT-Level        MT-Safe
 158 .TE
 159
 160 .SH SEE ALSO
 161 .sp
 162 .LP
 163 \fBgetsockopt\fR(3XNET), \fBrecv\fR(3XNET), \fBrecvfrom\fR(3XNET),
 164 \fBrecvmsg\fR(3XNET), \fBselect\fR(3C), \fBsend\fR(3XNET), \fBsendto\fR(3XNET),
 165 \fBsetsockopt\fR(3XNET), \fBsocket\fR(3XNET), \fBattributes\fR(5),
 166 \fBstandards\fR(5)