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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)shutdown.2  8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/sys/shutdown.2,v 1.7.2.7 2001/12/14 18:34:01 ru Exp $
  30 .\"
  31 .Dd February 27, 2001
  32 .Dt SHUTDOWN 2
  33 .Os
  34 .Sh NAME
  35 .Nm shutdown
  36 .Nd shut down part of a full-duplex connection
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In sys/types.h
  41 .In sys/socket.h
  42 .Ft int
  43 .Fn shutdown "int s" "int how"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn shutdown
  47 call causes all or part of a full-duplex connection on
  48 the socket associated with the file descriptor
  49 .Fa s
  50 to be shut down.
  51 The
  52 .Fa how
  53 argument specifies the type of shutdown.
  54 Possible values are:
  55 .Bl -tag -width ".Dv SHUT_RDWR"
  56 .It Dv SHUT_RD
  57 further receives will be disallowed.
  58 .It Dv SHUT_WR
  59 further sends will be disallowed.
  60 .It Dv SHUT_RDWR
  61 further sends and receives will be disallowed.
  62 .El
  63 .Sh RETURN VALUES
  64 .Rv -std shutdown
  65 .Sh ERRORS
  66 The
  67 .Fn shutdown
  68 call fails if:
  69 .Bl -tag -width Er
  70 .It Bq Er EBADF
  71 The
  72 .Fa s
  73 argument is not a valid file descriptor.
  74 .It Bq Er EINVAL
  75 The
  76 .Fa how
  77 argument is invalid.
  78 .It Bq Er ENOTCONN
  79 The socket is not connected.
  80 .It Bq Er ENOTSOCK
  81 The
  82 .Fa s
  83 argument does not refer to a socket.
  84 .El
  85 .Sh SEE ALSO
  86 .Xr connect 2 ,
  87 .Xr socket 2
  88 .Sh STANDARDS
  89 The
  90 .Fn shutdown
  91 function is expected to comply with
  92 .St -p1003.1g-2000 ,
  93 when finalized.
  94 .Sh HISTORY
  95 The
  96 .Fn shutdown
  97 function call appeared in
  98 .Bx 4.2 .
  99 The
 100 .Dv SHUT_RD , SHUT_WR ,
 101 and
 102 .Dv SHUT_RDWR
 103 constants appeared in
 104 .St -p1003.1g-2000 .