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 2021-03-22 "Linux" "Linux Programmer's Manual"
  41 .SH NAME
  42 shutdown \- shut down part of a full-duplex connection
  43 .SH SYNOPSIS
  44 .nf
  45 .B #include <sys/socket.h>
  46 .PP
  47 .BI "int shutdown(int " sockfd ", int " how );
  48 .fi
  49 .SH DESCRIPTION
  50 The
  51 .BR shutdown ()
  52 call causes all or part of a full-duplex connection on the socket
  53 associated with
  54 .I sockfd
  55 to be shut down.
  56 If
  57 .I how
  58 is
  59 .BR SHUT_RD ,
  60 further receptions will be disallowed.
  61 If
  62 .I how
  63 is
  64 .BR SHUT_WR ,
  65 further transmissions will be disallowed.
  66 If
  67 .I how
  68 is
  69 .BR SHUT_RDWR ,
  70 further receptions and transmissions will be disallowed.
  71 .SH RETURN VALUE
  72 On success, zero is returned.
  73 On error, \-1 is returned, and
  74 .I errno
  75 is set to indicate the error.
  76 .SH ERRORS
  77 .TP
  78 .B EBADF
  79 .I sockfd
  80 is not a valid file descriptor.
  81 .TP
  82 .B EINVAL
  83 An invalid value was specified in
  84 .IR how
  85 (but see BUGS).
  86 .TP
  87 .B ENOTCONN
  88 The specified socket is not connected.
  89 .TP
  90 .B ENOTSOCK
  91 The file descriptor
  92 .I sockfd
  93 does not refer to a socket.
  94 .SH CONFORMING TO
  95 POSIX.1-2001, POSIX.1-2008, 4.4BSD
  96 .RB ( shutdown ()
  97 first appeared in 4.2BSD).
  98 .SH NOTES
  99 The constants
 100 .BR SHUT_RD ,
 101 .BR SHUT_WR ,
 102 .B SHUT_RDWR
 103 have the value 0, 1, 2,
 104 respectively, and are defined in
 105 .I <sys/socket.h>
 106 since glibc-2.1.91.
 107 .SH BUGS
 108 Checks for the validity of
 109 .I how
 110 are done in domain-specific code,
 111 and before Linux 3.7 not all domains performed these checks.
 112 .\" https://bugzilla.kernel.org/show_bug.cgi?id=47111
 113 Most notably, UNIX domain sockets simply ignored invalid values.
 114 This problem was fixed for UNIX domain sockets
 115 .\" commit fc61b928dc4d72176cf4bd4d30bf1d22e599aefc
 116 .\" and for DECnet sockets in commit 46b66d7077b89fb4917ceef19b3f7dd86055c94a
 117 in Linux 3.7.
 118 .SH SEE ALSO
 119 .BR close (2),
 120 .BR connect (2),
 121 .BR socket (2),
 122 .BR socket (7)