xref: /netbsd/lib/libc/sys/shutdown.2 (revision c4a72b64)
1.\"	$NetBSD: shutdown.2,v 1.13 2002/08/17 18:38:46 yamt 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. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)shutdown.2	8.1 (Berkeley) 6/4/93
35.\"
36.Dd August 18, 2002
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.Fd #include \*[Lt]sys/socket.h\*[Gt]
46.Ft int
47.Fn shutdown "int s" "int how"
48.Sh DESCRIPTION
49The
50.Fn shutdown
51call causes all or part of a full-duplex connection on
52the socket associated with
53.Fa s
54to be shut down.
55The
56.Fa how
57argument specifies which part of the connection will be shut down.
58Permissible values are:
59.Bl -tag -width SHUT_RDWRXX -offset indent
60.It SHUT_RD
61further receives will be disallowed.
62.It SHUT_WR
63further sends will be disallowed.
64.It SHUT_RDWR
65further sends and receives will be disallowed.
66.El
67.Sh RETURN VALUES
68A 0 is returned if the call succeeds, -1 if it fails.
69.Sh ERRORS
70The call succeeds unless:
71.Bl -tag -width Er
72.It Bq Er EBADF
73.Fa s
74is not a valid descriptor.
75.It Bq Er EINVAL
76The
77.Fa how
78argument is invalid.
79.It Bq Er ENOTCONN
80The specified socket is not connected.
81.It Bq Er ENOTSOCK
82.Fa s
83is a file, not a socket.
84.El
85.Sh SEE ALSO
86.Xr connect 2 ,
87.Xr socket 2
88.Sh HISTORY
89The
90.Fn shutdown
91function call appeared in
92.Bx 4.2 .
93The
94.Fa how
95arguments used to be simply 0, 1, and 2, but now have named values
96as specified by
97.St -xpg4 .
98