summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2017/man3p/shutdown.3p
diff options
context:
space:
mode:
Diffstat (limited to 'man-pages-posix-2017/man3p/shutdown.3p')
-rw-r--r--man-pages-posix-2017/man3p/shutdown.3p128
1 files changed, 128 insertions, 0 deletions
diff --git a/man-pages-posix-2017/man3p/shutdown.3p b/man-pages-posix-2017/man3p/shutdown.3p
new file mode 100644
index 0000000..fc1ac57
--- /dev/null
+++ b/man-pages-posix-2017/man3p/shutdown.3p
@@ -0,0 +1,128 @@
+'\" et
+.TH SHUTDOWN "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.\"
+.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
+\(em shut down socket send and receive operations
+.SH SYNOPSIS
+.LP
+.nf
+#include <sys/socket.h>
+.P
+int shutdown(int \fIsocket\fP, int \fIhow\fP);
+.fi
+.SH DESCRIPTION
+The
+\fIshutdown\fR()
+function shall cause all or part of a full-duplex connection on the
+socket associated with the file descriptor
+.IR socket
+to be shut down.
+.P
+The
+\fIshutdown\fR()
+function takes the following arguments:
+.IP "\fIsocket\fR" 12
+Specifies the file descriptor of the socket.
+.IP "\fIhow\fR" 12
+Specifies the type of shutdown. The values are as follows:
+.RS 12
+.IP SHUT_RD 12
+Disables further receive operations.
+.IP SHUT_WR 12
+Disables further send operations.
+.IP SHUT_RDWR 12
+Disables further send and receive operations.
+.RE
+.P
+The
+\fIshutdown\fR()
+function disables subsequent send and/or receive operations on a
+socket, depending on the value of the
+.IR how
+argument.
+.SH "RETURN VALUE"
+Upon successful completion,
+\fIshutdown\fR()
+shall return 0; otherwise, \-1 shall be returned and
+.IR errno
+set to indicate the error.
+.SH ERRORS
+The
+\fIshutdown\fR()
+function shall fail if:
+.TP
+.BR EBADF
+The
+.IR socket
+argument is not a valid file descriptor.
+.TP
+.BR EINVAL
+The
+.IR how
+argument is invalid.
+.TP
+.BR ENOTCONN
+The socket is not connected.
+.TP
+.BR ENOTSOCK
+The
+.IR socket
+argument does not refer to a socket.
+.P
+The
+\fIshutdown\fR()
+function may fail if:
+.TP
+.BR ENOBUFS
+Insufficient resources were available in the system to perform the
+operation.
+.LP
+.IR "The following sections are informative."
+.SH "EXAMPLES"
+None.
+.SH "APPLICATION USAGE"
+None.
+.SH "RATIONALE"
+None.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "\fIgetsockopt\fR\^(\|)",
+.IR "\fIpselect\fR\^(\|)",
+.IR "\fIread\fR\^(\|)",
+.IR "\fIrecv\fR\^(\|)",
+.IR "\fIrecvfrom\fR\^(\|)",
+.IR "\fIrecvmsg\fR\^(\|)",
+.IR "\fIsend\fR\^(\|)",
+.IR "\fIsendto\fR\^(\|)",
+.IR "\fIsetsockopt\fR\^(\|)",
+.IR "\fIsocket\fR\^(\|)",
+.IR "\fIwrite\fR\^(\|)"
+.P
+The Base Definitions volume of POSIX.1\(hy2017,
+.IR "\fB<sys_socket.h>\fP"
+.\"
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1-2017, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 7, 2018 Edition,
+Copyright (C) 2018 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 .
+.PP
+Any typographical or formatting errors that appear
+in this page are most likely
+to have been introduced during the conversion of the source files to
+man page format. To report such errors, see
+https://www.kernel.org/doc/man-pages/reporting_bugs.html .