summaryrefslogtreecommitdiff
path: root/usr/src/man/man3socket/shutdown.3socket
blob: 912797fec8b5850bf2b7c5e24a58508579120f1e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
'\" te
.\"  Copyright 1989 AT&T  Copyright (c) 2005,
.\" Sun Microsystems, Inc.  All Rights Reserved
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH shutdown 3SOCKET "31 Jan 2005" "SunOS 5.11" "Sockets Library Functions"
.SH NAME
shutdown \- shut down part of a full-duplex connection
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lsocket\fR \fB -lnsl \fR [ \fIlibrary\fR... ]
#include <sys/socket.h>

\fBint\fR \fBshutdown\fR(\fBint\fR \fIs\fR, \fBint\fR \fIhow\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The \fBshutdown()\fR call shuts down all or part of a full-duplex connection on
the socket associated with \fIs\fR. If \fIhow\fR is \fBSHUT_RD\fR, further
receives are disallowed. If \fIhow\fR is \fBSHUT_WR\fR, further sends are
disallowed. If \fIhow\fR is \fBSHUT_RDWR\fR, further sends and receives are
disallowed.
.sp
.LP
The \fIhow\fR values should be defined constants.
.SH RETURN VALUES
.sp
.LP
\fB0\fR is returned if the call succeeds.
.sp
.LP
\fB\(mi1\fR is returned if the call fails.
.SH ERRORS
.sp
.LP
The call succeeds unless one of the following conditions exists:
.sp
.ne 2
.mk
.na
\fB\fBEBADF\fR\fR
.ad
.RS 12n
.rt  
The \fIs\fR value is not a valid file descriptor.
.RE

.sp
.ne 2
.mk
.na
\fB\fBENOMEM\fR\fR
.ad
.RS 12n
.rt  
Insufficient user memory is available for the operation to complete.
.RE

.sp
.ne 2
.mk
.na
\fB\fBENOSR\fR\fR
.ad
.RS 12n
.rt  
Insufficient \fBSTREAMS\fR resources are available for the operation to
complete.
.RE

.sp
.ne 2
.mk
.na
\fB\fBENOTCONN\fR\fR
.ad
.RS 12n
.rt  
The specified socket is not connected.
.RE

.sp
.ne 2
.mk
.na
\fB\fBENOTSOCK\fR\fR
.ad
.RS 12n
.rt  
The \fIs\fR value is not a socket.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
MT-LevelSafe
.TE

.SH SEE ALSO
.sp
.LP
\fBconnect\fR(3SOCKET), \fBsocket\fR(3SOCKET), \fBsocket.h\fR(3HEAD),
\fBattributes\fR(5)