Plan 9 from Bell Labs’s /usr/web/sources/contrib/fgb/root/sys/lib/ape/man/3/shutdown

Copyright © 2021 Plan 9 Foundation.
Distributed under the MIT License.
Download the Plan 9 distribution.


.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved 
.TH "SHUTDOWN" 3P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\" shutdown 
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.SH NAME
shutdown \- shut down socket send and receive operations
.SH SYNOPSIS
.LP
\fB#include <sys/socket.h>
.br
.sp
int shutdown(int\fP \fIsocket\fP\fB, int\fP \fIhow\fP\fB);
.br
\fP
.SH DESCRIPTION
.LP
The \fIshutdown\fP() function shall cause all or part of a full-duplex
connection on the socket associated with the file
descriptor \fIsocket\fP to be shut down.
.LP
The \fIshutdown\fP() function takes the following arguments:
.TP 7
\fIsocket\fP
Specifies the file descriptor of the socket.
.TP 7
\fIhow\fP
Specifies the type of shutdown. The values are as follows: 
.TP 7
SHUT_RD
.RS
Disables further receive operations.
.RE
.TP 7
SHUT_WR
.RS
Disables further send operations.
.RE
.TP 7
SHUT_RDWR
.RS
Disables further send and receive operations.
.RE
.sp
.sp
.LP
The \fIshutdown\fP() function disables subsequent send and/or receive
operations on a socket, depending on the value of the
\fIhow\fP argument.
.SH RETURN VALUE
.LP
Upon successful completion, \fIshutdown\fP() shall return 0; otherwise,
-1 shall be returned and \fIerrno\fP set to indicate
the error.
.SH ERRORS
.LP
The \fIshutdown\fP() function shall fail if:
.TP 7
.B EBADF
The \fIsocket\fP argument is not a valid file descriptor.
.TP 7
.B EINVAL
The \fIhow\fP argument is invalid.
.TP 7
.B ENOTCONN
The socket is not connected.
.TP 7
.B ENOTSOCK
The \fIsocket\fP argument does not refer to a socket.
.sp
.LP
The \fIshutdown\fP() function may fail if:
.TP 7
.B ENOBUFS
Insufficient resources were available in the system to perform the
operation.
.sp
.LP
\fIThe following sections are informative.\fP
.SH EXAMPLES
.LP
None.
.SH APPLICATION USAGE
.LP
None.
.SH RATIONALE
.LP
None.
.SH FUTURE DIRECTIONS
.LP
None.
.SH SEE ALSO
.LP
\fIgetsockopt\fP(), \fIread\fP(), \fIrecv\fP(), \fIrecvfrom\fP(),
\fIrecvmsg\fP(), \fIselect\fP(), \fIsend\fP(), \fIsendto\fP(),
\fIsetsockopt\fP(), \fIsocket\fP(), \fIwrite\fP(), the Base Definitions
volume of IEEE\ Std\ 1003.1-2001, \fI<sys/socket.h>\fP
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group. In the
event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .

Bell Labs OSI certified Powered by Plan 9

(Return to Plan 9 Home Page)

Copyright © 2021 Plan 9 Foundation. All Rights Reserved.
Comments to [email protected].