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