git.saurik.com Git - apple/xnu.git/blob

1 .\" $NetBSD: shutdown.2,v 1.5 1995/02/27 12:37:11 cgd Exp $

2 .\"

5 .\"

6 .\" Redistribution and use in source and binary forms, with or without

7 .\" modification, are permitted provided that the following conditions

8 .\" are met:

9 .\" 1. Redistributions of source code must retain the above copyright

10 .\" notice, this list of conditions and the following disclaimer.

11 .\" 2. Redistributions in binary form must reproduce the above copyright

12 .\" notice, this list of conditions and the following disclaimer in the

13 .\" documentation and/or other materials provided with the distribution.

14 .\" 3. All advertising materials mentioning features or use of this software

15 .\" must display the following acknowledgement:

16 .\" This product includes software developed by the University of

17 .\" California, Berkeley and its contributors.

18 .\" 4. Neither the name of the University nor the names of its contributors

19 .\" may be used to endorse or promote products derived from this software

20 .\" without specific prior written permission.

21 .\"

22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND

23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

25 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE

26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

32 .\" SUCH DAMAGE.

33 .\"

34 .\" @(#)shutdown.2 8.1 (Berkeley) 6/4/93

35 .\"

36 .Dd March 18, 2015

37 .Dt SHUTDOWN 2

38 .Os BSD 4.2

39 .Sh NAME

40 .Nm shutdown

41 .Nd shut down part of a full-duplex connection

42 .Sh SYNOPSIS

43 .Fd #include <sys/socket.h>

44 .Ft int

45 .Fo shutdown

46 .Fa "int socket"

47 .Fa "int how"

48 .Fc

49 .Sh DESCRIPTION

50 The

51 .Fn shutdown

52 call causes all or part of a full-duplex connection on

53 the socket associated with

54 .Fa socket

55 to be shut down.

56 If

57 .Fa how

58 is

59 .Dv SHUT_RD ,

60 further receives will be disallowed.

61 If

62 .Fa how

63 is

64 .Dv SHUT_WR ,

65 further sends will be disallowed.

66 If

67 .Fa how

68 is

69 .Dv SHUT_RDWR ,

70 further sends and receives will be disallowed.

71 .Sh RETURN VALUES

72 .Rv -std shutdown

73 .Sh ERRORS

74 The call succeeds unless:

75 .Bl -tag -width Er

76 .\" ===========

77 .It Bq Er EBADF

78 .Fa Socket

79 is not a valid descriptor.

80 .\" ===========

81 .It Bq Er EINVAL

82 The

83 .Fa how

84 argument is invalid.

85 .\" ===========

86 .It Bq Er ENOTCONN

87 The specified socket is not connected.

88 .\" ===========

89 .It Bq Er ENOTSOCK

90 .Fa Socket

91 is a file, not a socket.

92 .El

93 .Sh SEE ALSO

94 .Xr connect 2 ,

95 .Xr connectx 2 ,

96 .Xr disconnectx 2 ,

97 .Xr socket 2

98 .Sh HISTORY

99 The

100 .Fn shutdown

101 function call appeared in

102 .Bx 4.2 .