lib/libc/sys/shutdown.2

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  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 .\"     @(#)shutdown.2  8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/sys/shutdown.2,v 1.7.2.7 2001/12/14 18:34:01 ru Exp $
  34 .\" $DragonFly: src/lib/libc/sys/shutdown.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  35 .\"
  36 .Dd February 27, 2001
  37 .Dt SHUTDOWN 2
  38 .Os
  39 .Sh NAME
  40 .Nm shutdown
  41 .Nd shut down part of a full-duplex connection
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In sys/types.h
  46 .In sys/socket.h
  47 .Ft int
  48 .Fn shutdown "int s" "int how"
  49 .Sh DESCRIPTION
  50 The
  51 .Fn shutdown
  52 call causes all or part of a full-duplex connection on
  53 the socket associated with the file descriptor
  54 .Fa s
  55 to be shut down.
  56 The
  57 .Fa how
  58 argument specifies the type of shutdown.
  59 Possible values are:
  60 .Bl -tag -width SHUT_RDWR
  61 .It Dv SHUT_RD
  62 further receives will be disallowed.
  63 .It Dv SHUT_WR
  64 further sends will be disallowed.
  65 .It Dv SHUT_RDWR
  66 further sends and receives will be disallowed.
  67 .El
  68 .Sh RETURN VALUES
  69 .Rv -std shutdown
  70 .Sh ERRORS
  71 The
  72 .Fn shutdown
  73 call fails if:
  74 .Bl -tag -width Er
  75 .It Bq Er EBADF
  76 The
  77 .Fa s
  78 argument is not a valid file descriptor.
  79 .It Bq Er EINVAL
  80 The
  81 .Fa how
  82 argument is invalid.
  83 .It Bq Er ENOTCONN
  84 The socket is not connected.
  85 .It Bq Er ENOTSOCK
  86 The
  87 .Fa s
  88 argument does not refer to a socket.
  89 .El
  90 .Sh SEE ALSO
  91 .Xr connect 2 ,
  92 .Xr socket 2
  93 .Sh STANDARDS
  94 The
  95 .Fn shutdown
  96 function is expected to comply with
  97 .St -p1003.1g-2000 ,
  98 when finalized.
  99 .Sh HISTORY
 100 The
 101 .Fn shutdown
 102 function call appeared in
 103 .Bx 4.2 .
 104 The
 105 .Dv SHUT_RD , SHUT_WR ,
 106 and
 107 .Dv SHUT_RDWR
 108 constants appeared in
 109 .St -p1003.1g-2000 .