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