original/man2/shutdown.2

   1 .\" Copyright (c) 1983, 1991 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" %%%LICENSE_START(BSD_4_CLAUSE_UCB)
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by the University of
  16 .\"     California, Berkeley and its contributors.
  17 .\" 4. Neither the name of the University nor the names of its contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\" %%%LICENSE_END
  33 .\"
  34 .\"     $Id: shutdown.2,v 1.1.1.1 1999/03/21 22:52:23 freitag Exp $
  35 .\"
  36 .\" Modified Sat Jul 24 09:57:55 1993 by Rik Faith <faith@cs.unc.edu>
  37 .\" Modified Tue Oct 22 22:04:51 1996 by Eric S. Raymond <esr@thyrsus.com>
  38 .\" Modified 1998 by Andi Kleen
  39 .\"
  40 .TH SHUTDOWN 2 2012-09-06 "Linux" "Linux Programmer's Manual"
  41 .SH NAME
  42 shutdown \- shut down part of a full-duplex connection
  43 .SH SYNOPSIS
  44 .B #include <sys/socket.h>
  45 .sp
  46 .BI "int shutdown(int " sockfd ", int " how );
  47 .SH DESCRIPTION
  48 The
  49 .BR shutdown ()
  50 call causes all or part of a full-duplex connection on the socket
  51 associated with
  52 .I sockfd
  53 to be shut down.
  54 If
  55 .I how
  56 is
  57 .BR SHUT_RD ,
  58 further receptions will be disallowed.
  59 If
  60 .I how
  61 is
  62 .BR SHUT_WR ,
  63 further transmissions will be disallowed.
  64 If
  65 .I how
  66 is
  67 .BR SHUT_RDWR ,
  68 further receptions and transmissions will be disallowed.
  69 .SH RETURN VALUE
  70 On success, zero is returned.
  71 On error, \-1 is returned, and
  72 .I errno
  73 is set appropriately.
  74 .SH ERRORS
  75 .TP
  76 .B EBADF
  77 .I sockfd
  78 is not a valid descriptor.
  79 .TP
  80 .B EINVAL
  81 An invalid value was specified in
  82 .IR how
  83 (but see BUGS).
  84 .TP
  85 .B ENOTCONN
  86 The specified socket is not connected.
  87 .TP
  88 .B ENOTSOCK
  89 .I sockfd
  90 is a file, not a socket.
  91 .SH CONFORMING TO
  92 POSIX.1-2001, 4.4BSD (the
  93 .BR shutdown ()
  94 function call first appeared in 4.2BSD).
  95 .SH NOTES
  96 The constants
  97 .BR SHUT_RD ,
  98 .BR SHUT_WR ,
  99 .B SHUT_RDWR
 100 have the value 0, 1, 2,
 101 respectively, and are defined in
 102 .I <sys/socket.h>
 103 since glibc-2.1.91.
 104 .SH BUGS
 105 As currently implemented,
 106 checks for the validity of
 107 .I how
 108 are done in domain-specific code, and not all domains perform these checks.
 109 .\" FIXME
 110 .\" https://bugzilla.kernel.org/show_bug.cgi?id=47111
 111 Most notably, UNIX domain sockets simply ignore invalid values;
 112 this may change in the future.
 113 .SH SEE ALSO
 114 .BR connect (2),
 115 .BR socket (2),
 116 .BR socket (7)
 117 .SH COLOPHON
 118 This page is part of release 3.67 of the Linux
 119 .I man-pages
 120 project.
 121 A description of the project,
 122 information about reporting bugs,
 123 and the latest version of this page,
 124 can be found at
 125 \%http://www.kernel.org/doc/man\-pages/.