The Open Group Base Specifications Issue 8
IEEE Std 1003.1-2024
Copyright © 2001-2024 The IEEE and The Open Group

NAME

shutdown — shut down socket send and receive operations

SYNOPSIS

#include <sys/socket.h>

int shutdown(int
socket, int how);

DESCRIPTION

The shutdown() function shall cause all or part of a full-duplex connection on the socket associated with the file descriptor socket to be shut down.

The shutdown() function takes the following arguments:

socket
Specifies the file descriptor of the socket.
how
Specifies the type of shutdown. The values are as follows:
SHUT_RD
Disables further receive operations.
SHUT_WR
Disables further send operations.
SHUT_RDWR
Disables further send and receive operations.

The shutdown() function disables subsequent send and/or receive operations on a socket, depending on the value of the how argument.

RETURN VALUE

Upon successful completion, shutdown() shall return 0; otherwise, -1 shall be returned and errno set to indicate the error.

ERRORS

The shutdown() function shall fail if:

[EBADF]
The socket argument is not a valid file descriptor.
[EINVAL]
The how argument is invalid.
[ENOTCONN]
The socket is not connected.
[ENOTSOCK]
The socket argument does not refer to a socket.

The shutdown() function may fail if:

[ENOBUFS]
Insufficient resources were available in the system to perform the operation.

The following sections are informative.

EXAMPLES

None.

APPLICATION USAGE

The file descriptor remains open after shutdown() returns to the calling application.

RATIONALE

None.

FUTURE DIRECTIONS

None.

SEE ALSO

close , getsockopt , pselect , read , recv , recvfrom , recvmsg , send , sendto , setsockopt , socket , write

XBD <sys/socket.h>

CHANGE HISTORY

First released in Issue 6. Derived from the XNS, Issue 5.2 specification.

Issue 8

Austin Group Defect 1475 is applied, changing the APPLICATION USAGE section and adding close() to the SEE ALSO section.

End of informative text.

 

return to top of page

UNIX® is a registered Trademark of The Open Group.
POSIX™ is a Trademark of The IEEE.
Copyright © 2001-2024 The IEEE and The Open Group, All Rights Reserved
[ Main Index | XBD | XSH | XCU | XRAT ]