summaryrefslogtreecommitdiffstats
path: root/man3p/shutdown.3p
diff options
context:
space:
mode:
Diffstat (limited to 'man3p/shutdown.3p')
-rw-r--r--man3p/shutdown.3p105
1 files changed, 105 insertions, 0 deletions
diff --git a/man3p/shutdown.3p b/man3p/shutdown.3p
new file mode 100644
index 000000000..0d7b51d6d
--- /dev/null
+++ b/man3p/shutdown.3p
@@ -0,0 +1,105 @@
+.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved
+.TH "SHUTDOWN" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.\" shutdown
+.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 .