freebsd/lib/libc/sys/shutdown.2

.\" Copyright (c) 1983, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)shutdown.2	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd February 27, 2001
.Dt SHUTDOWN 2
.Os
.Sh NAME
.Nm shutdown
.Nd shut down part of a full-duplex connection
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In sys/types.h
.In sys/socket.h
.Ft int
.Fn shutdown "int s" "int how"
.Sh DESCRIPTION
The
.Fn shutdown
system call causes all or part of a full-duplex connection on
the socket associated with the file descriptor
.Fa s
to be shut down.
The
.Fa how
argument specifies the type of shutdown.
Possible values are:
.Bl -tag -width SHUT_RDWR
.It Dv SHUT_RD
further receives will be disallowed.
.It Dv SHUT_WR
further sends will be disallowed.
.It Dv SHUT_RDWR
further sends and receives will be disallowed.
.El
.Sh RETURN VALUES
.Rv -std shutdown
.Sh ERRORS
The
.Fn shutdown
system call fails if:
.Bl -tag -width Er
.It Bq Er EBADF
The
.Fa s
argument is not a valid file descriptor.
.It Bq Er EINVAL
The
.Fa how
argument is invalid.
.It Bq Er ENOTCONN
The socket is not connected.
.It Bq Er ENOTSOCK
The
.Fa s
argument does not refer to a socket.
.El
.Sh SEE ALSO
.Xr connect 2 ,
.Xr socket 2
.Sh STANDARDS
The
.Fn shutdown
system call is expected to comply with
.St -p1003.1g-2000 ,
when finalized.
.Sh HISTORY
The
.Fn shutdown
system call appeared in
.Bx 4.2 .
The
.Dv SHUT_RD , SHUT_WR ,
and
.Dv SHUT_RDWR
constants appeared in
.St -p1003.1g-2000 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1983, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)shutdown.2 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
In soshutdown(), use SHUT_{RD,WR,RDWR} instead of FREAD and FWRITE. Also, return EINVAL if `how' is invalid, as required by POSIX spec. 2001-02-27 13:48:07 +00:00			`.Dd February 27, 2001`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Dt SHUTDOWN 2`
In soshutdown(), use SHUT_{RD,WR,RDWR} instead of FREAD and FWRITE. Also, return EINVAL if `how' is invalid, as required by POSIX spec. 2001-02-27 13:48:07 +00:00			`.Os`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh NAME`
			`.Nm shutdown`
			`.Nd shut down part of a full-duplex connection`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/types.h`
			`.In sys/socket.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft int`
			`.Fn shutdown "int s" "int how"`
			`.Sh DESCRIPTION`
			`The`
			`.Fn shutdown`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call causes all or part of a full-duplex connection on`
In soshutdown(), use SHUT_{RD,WR,RDWR} instead of FREAD and FWRITE. Also, return EINVAL if `how' is invalid, as required by POSIX spec. 2001-02-27 13:48:07 +00:00			`the socket associated with the file descriptor`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Fa s`
			`to be shut down.`
In soshutdown(), use SHUT_{RD,WR,RDWR} instead of FREAD and FWRITE. Also, return EINVAL if `how' is invalid, as required by POSIX spec. 2001-02-27 13:48:07 +00:00			`The`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Fa how`
In soshutdown(), use SHUT_{RD,WR,RDWR} instead of FREAD and FWRITE. Also, return EINVAL if `how' is invalid, as required by POSIX spec. 2001-02-27 13:48:07 +00:00			`argument specifies the type of shutdown.`
			`Possible values are:`
			`.Bl -tag -width SHUT_RDWR`
			`.It Dv SHUT_RD`
Document the fact that shutdown(2) is expected to comply with Posix.1g, when it happens. 1998-09-12 21:38:30 +00:00			`further receives will be disallowed.`
In soshutdown(), use SHUT_{RD,WR,RDWR} instead of FREAD and FWRITE. Also, return EINVAL if `how' is invalid, as required by POSIX spec. 2001-02-27 13:48:07 +00:00			`.It Dv SHUT_WR`
Document the fact that shutdown(2) is expected to comply with Posix.1g, when it happens. 1998-09-12 21:38:30 +00:00			`further sends will be disallowed.`
In soshutdown(), use SHUT_{RD,WR,RDWR} instead of FREAD and FWRITE. Also, return EINVAL if `how' is invalid, as required by POSIX spec. 2001-02-27 13:48:07 +00:00			`.It Dv SHUT_RDWR`
Document the fact that shutdown(2) is expected to comply with Posix.1g, when it happens. 1998-09-12 21:38:30 +00:00			`further sends and receives will be disallowed.`
In soshutdown(), use SHUT_{RD,WR,RDWR} instead of FREAD and FWRITE. Also, return EINVAL if `how' is invalid, as required by POSIX spec. 2001-02-27 13:48:07 +00:00			`.El`
Rename the DIAGNOSTICS sections in several man pages to RETURN VALUES like they should be. 1997-01-12 00:09:02 +00:00			`.Sh RETURN VALUES`
mdoc(7) police: fixed the fatal. 2001-08-17 15:18:49 +00:00			`.Rv -std shutdown`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh ERRORS`
In soshutdown(), use SHUT_{RD,WR,RDWR} instead of FREAD and FWRITE. Also, return EINVAL if `how' is invalid, as required by POSIX spec. 2001-02-27 13:48:07 +00:00			`The`
			`.Fn shutdown`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call fails if:`
Use `Er' variable to define first column width in ERRORS section. It was initially suggested by mdoc(7) style, but was broken over the years 2000-05-04 13:09:25 +00:00			`.Bl -tag -width Er`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.It Bq Er EBADF`
In soshutdown(), use SHUT_{RD,WR,RDWR} instead of FREAD and FWRITE. Also, return EINVAL if `how' is invalid, as required by POSIX spec. 2001-02-27 13:48:07 +00:00			`The`
			`.Fa s`
			`argument is not a valid file descriptor.`
			`.It Bq Er EINVAL`
			`The`
			`.Fa how`
			`argument is invalid.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.It Bq Er ENOTCONN`
In soshutdown(), use SHUT_{RD,WR,RDWR} instead of FREAD and FWRITE. Also, return EINVAL if `how' is invalid, as required by POSIX spec. 2001-02-27 13:48:07 +00:00			`The socket is not connected.`
			`.It Bq Er ENOTSOCK`
			`The`
			`.Fa s`
			`argument does not refer to a socket.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.El`
			`.Sh SEE ALSO`
			`.Xr connect 2 ,`
			`.Xr socket 2`
Document the fact that shutdown(2) is expected to comply with Posix.1g, when it happens. 1998-09-12 21:38:30 +00:00			`.Sh STANDARDS`
			`The`
			`.Fn shutdown`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call is expected to comply with`
.St -p1003.1g -> .St -p1003.1g-2000. 2001-03-12 17:28:01 +00:00			`.St -p1003.1g-2000 ,`
Document the fact that shutdown(2) is expected to comply with Posix.1g, when it happens. 1998-09-12 21:38:30 +00:00			`when finalized.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh HISTORY`
			`The`
Correctly use .Fn instead of .Nm to reference function names in a bunch of man pages. Use the correct .Bx (BSD UNIX) or .At (AT&T UNIX) macros instead of explicitly specifying the version in the text in a bunch of man pages. 1996-08-22 23:31:07 +00:00			`.Fn shutdown`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call appeared in`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Bx 4.2 .`
Document the fact that shutdown(2) is expected to comply with Posix.1g, when it happens. 1998-09-12 21:38:30 +00:00			`The`
In soshutdown(), use SHUT_{RD,WR,RDWR} instead of FREAD and FWRITE. Also, return EINVAL if `how' is invalid, as required by POSIX spec. 2001-02-27 13:48:07 +00:00			`.Dv SHUT_RD , SHUT_WR ,`
			`and`
			`.Dv SHUT_RDWR`
Document the fact that shutdown(2) is expected to comply with Posix.1g, when it happens. 1998-09-12 21:38:30 +00:00			`constants appeared in`
.St -p1003.1g -> .St -p1003.1g-2000. 2001-03-12 17:28:01 +00:00			`.St -p1003.1g-2000 .`