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