xref: /dragonfly/lib/libc/sys/shutdown.2 (revision 279dd846)
1.\" Copyright (c) 1983, 1991, 1993
2.\"	The Regents of the University of California.  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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)shutdown.2	8.1 (Berkeley) 6/4/93
29.\" $FreeBSD: src/lib/libc/sys/shutdown.2,v 1.7.2.7 2001/12/14 18:34:01 ru Exp $
30.\" $DragonFly: src/lib/libc/sys/shutdown.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
31.\"
32.Dd February 27, 2001
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/types.h
42.In 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 the file descriptor
50.Fa s
51to be shut down.
52The
53.Fa how
54argument specifies the type of shutdown.
55Possible values are:
56.Bl -tag -width SHUT_RDWR
57.It Dv SHUT_RD
58further receives will be disallowed.
59.It Dv SHUT_WR
60further sends will be disallowed.
61.It Dv SHUT_RDWR
62further sends and receives will be disallowed.
63.El
64.Sh RETURN VALUES
65.Rv -std shutdown
66.Sh ERRORS
67The
68.Fn shutdown
69call fails if:
70.Bl -tag -width Er
71.It Bq Er EBADF
72The
73.Fa s
74argument is not a valid file descriptor.
75.It Bq Er EINVAL
76The
77.Fa how
78argument is invalid.
79.It Bq Er ENOTCONN
80The socket is not connected.
81.It Bq Er ENOTSOCK
82The
83.Fa s
84argument does not refer to a socket.
85.El
86.Sh SEE ALSO
87.Xr connect 2 ,
88.Xr socket 2
89.Sh STANDARDS
90The
91.Fn shutdown
92function is expected to comply with
93.St -p1003.1g-2000 ,
94when finalized.
95.Sh HISTORY
96The
97.Fn shutdown
98function call appeared in
99.Bx 4.2 .
100The
101.Dv SHUT_RD , SHUT_WR ,
102and
103.Dv SHUT_RDWR
104constants appeared in
105.St -p1003.1g-2000 .
106