manual/LDP_man-pages/original/man2/shutdown.2

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