lib/libc/sys/shutdown.2

   1 .\"     $NetBSD: shutdown.2,v 1.17 2004/05/13 10:20:58 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1983, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)shutdown.2  8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd August 18, 2002
  33 .Dt SHUTDOWN 2
  34 .Os
  35 .Sh NAME
  36 .Nm shutdown
  37 .Nd shut down part of a full-duplex connection
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  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
  49 .Fa s
  50 to be shut down.
  51 The
  52 .Fa how
  53 argument specifies which part of the connection will be shut down.
  54 Permissible values are:
  55 .Bl -tag -width SHUT_RDWRXX -offset indent
  56 .It SHUT_RD
  57 further receives will be disallowed.
  58 .It SHUT_WR
  59 further sends will be disallowed.
  60 .It SHUT_RDWR
  61 further sends and receives will be disallowed.
  62 .El
  63 .Sh RETURN VALUES
  64 A 0 is returned if the call succeeds, \-1 if it fails.
  65 .Sh ERRORS
  66 The call succeeds unless:
  67 .Bl -tag -width Er
  68 .It Bq Er EBADF
  69 .Fa s
  70 is not a valid descriptor.
  71 .It Bq Er EINVAL
  72 The
  73 .Fa how
  74 argument is invalid.
  75 .It Bq Er ENOTCONN
  76 The specified socket is not connected.
  77 .It Bq Er ENOTSOCK
  78 .Fa s
  79 is a file, not a socket.
  80 .El
  81 .Sh SEE ALSO
  82 .Xr connect 2 ,
  83 .Xr socket 2
  84 .Sh HISTORY
  85 The
  86 .Fn shutdown
  87 function call appeared in
  88 .Bx 4.2 .
  89 The
  90 .Fa how
  91 arguments used to be simply 0, 1, and 2, but now have named values
  92 as specified by
  93 .St -xpg4 .