xref: /netbsd-src/lib/libc/sys/shutdown.2 (revision 38023541164cff097d5fadec63134189b1453b8c)
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.\"     from: @(#)shutdown.2	6.4 (Berkeley) 3/10/91
33.\"	$Id: shutdown.2,v 1.4 1993/11/29 21:25:38 jtc Exp $
34.\"
35.Dd March 10, 1991
36.Dt SHUTDOWN 2
37.Os BSD 4.2
38.Sh NAME
39.Nm shutdown
40.Nd shut down part of a full-duplex connection
41.Sh SYNOPSIS
42.Fd #include <sys/socket.h>
43.Ft int
44.Fn shutdown "int s" "int how"
45.Sh DESCRIPTION
46The
47.Fn shutdown
48call causes all or part of a full-duplex connection on
49the socket associated with
50.Fa s
51to be shut down.
52If
53.Fa how
54is 0, further receives will be disallowed.
55If
56.Fa how
57is 1, further sends will be disallowed.
58If
59.Fa how
60is 2, further sends and receives will be disallowed.
61.Sh DIAGNOSTICS
62A 0 is returned if the call succeeds, -1 if it fails.
63.Sh ERRORS
64The call succeeds unless:
65.Bl -tag -width Er
66.It Bq Er EBADF
67.Fa S
68is not a valid descriptor.
69.It Bq Er ENOTSOCK
70.Fa S
71is a file, not a socket.
72.It Bq Er ENOTCONN
73The specified socket is not connected.
74.El
75.Sh SEE ALSO
76.Xr connect 2 ,
77.Xr socket 2
78.Sh HISTORY
79The
80.Fn shutdown
81function call appeared in
82.Bx 4.2 .
83