shutdown(2freebsd)

shutdown2freebsd

Disable sends and/or receives on a socket

Usage

#include <sys/types.h>

#include <sys/socket.h>

int

shutdown(int s, int how);

Library

Standard C Library (libc, -lc)

Overview

The shutdown() system call disables sends or receives on a socket. The how argument specifies the type of shutdown. Possible values are:

SHUT_RD

Further receives will be disallowed.

SHUT_WR

Further sends will be disallowed. This may cause actions specific to the protocol family of the socket s to happen; see IMPLEMENTATION NOTES.

SHUT_RDWR

Further sends and receives will be disallowed. Implies SHUT_WR.

If the file descriptor s is associated with a SOCK_STREAM socket, all or part of the full-duplex connection will be shut down.

Implementation notes

The following protocol specific actions apply to the use of SHUT_WR (and potentially also SHUT_RDWR), based on the properties of the socket associated with the file descriptor s.

DomainTypeProtocolAction
PF_INETSOCK_DGRAMIPPROTO_SCTP
PF_INETSOCK_DGRAMIPPROTO_UDP
PF_INETSOCK_STREAMIPPROTO_SCTP
PF_INETSOCK_STREAMIPPROTO_TCP
PF_INET6SOCK_DGRAMIPPROTO_SCTP
PF_INET6SOCK_DGRAMIPPROTO_UDP
PF_INET6SOCK_STREAMIPPROTO_SCTP
PF_INET6SOCK_STREAMIPPROTO_TCP

Return values

The shutdown() function returns the value 0 if successful; otherwise the value -1 is returned and the global variable errno is set to indicate the error.

Errors

The shutdown() system call fails if:

[EBADF]

The s argument is not a valid file descriptor.

[EINVAL]

The how argument is invalid.

[ENOTCONN]

The s argument specifies a socket which is not connected.

[ENOTSOCK]

The s argument does not refer to a socket.

Releases

9 releases since Debian 5.0 (Lenny); the text changed 6 times.

  1. 5.0
  2. 6.0
  3. 7
  4. 8
  5. 9
  6. 10
  7. 11–13

Standards

The shutdown() system call is expected to comply with IEEE Std 1003.1g-2000 (“POSIX.1g”), when finalized.

History

The shutdown() system call appeared in 4.2BSD. The SHUT_RD, SHUT_WR, and SHUT_RDWR constants appeared in IEEE Std 1003.1g-2000 (“POSIX.1g”).

Authors

This manual page was updated by Bruce M. Simpson ⟨[email protected]⟩ to reflect how shutdown() behaves with PF_INET and PF_INET6 sockets.

Bugs

The ICMP “port unreachable” message should be generated in response to datagrams received on a local port to which s is bound after shutdown() is called.

From freebsd-manpages 12.2-2 in Debian 13 (Trixie). Parsed by carta from the page's mdoc source.