]> git.saurik.com Git - apple/xnu.git/blame - bsd/man/man2/shutdown.2
xnu-792.tar.gz
[apple/xnu.git] / bsd / man / man2 / shutdown.2
CommitLineData
9bccf70c
A
1.\" $NetBSD: shutdown.2,v 1.5 1995/02/27 12:37:11 cgd 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 June 4, 1993
37.Dt SHUTDOWN 2
38.Os BSD 4.2
39.Sh NAME
40.Nm shutdown
41.Nd shut down part of a full-duplex connection
42.Sh SYNOPSIS
43.Fd #include <sys/socket.h>
44.Ft int
45.Fn shutdown "int s" "int how"
46.Sh DESCRIPTION
47The
48.Fn shutdown
49call causes all or part of a full-duplex connection on
50the socket associated with
51.Fa s
52to be shut down.
53If
54.Fa how
91447636
A
55is
56.Dv SHUT_RD ,
57further receives will be disallowed.
9bccf70c
A
58If
59.Fa how
91447636
A
60is
61.Dv SHUT_WR ,
62further sends will be disallowed.
9bccf70c
A
63If
64.Fa how
91447636
A
65is
66.Dv SHUT_RDWR ,
67further sends and receives will be disallowed.
9bccf70c
A
68.Sh DIAGNOSTICS
69A 0 is returned if the call succeeds, -1 if it fails.
70.Sh ERRORS
71The call succeeds unless:
72.Bl -tag -width Er
73.It Bq Er EBADF
74.Fa S
75is not a valid descriptor.
76.It Bq Er ENOTSOCK
77.Fa S
78is a file, not a socket.
79.It Bq Er ENOTCONN
80The specified socket is not connected.
81.El
82.Sh SEE ALSO
83.Xr connect 2 ,
84.Xr socket 2
85.Sh HISTORY
86The
87.Fn shutdown
88function call appeared in
89.Bx 4.2 .