clarify buffer size options

the documentation for {udp,tcp}-{send,receive}-buffer options
was not complete. also revised for grammar.
This commit is contained in:
Evan Hunt 2021-05-17 09:34:08 -07:00
parent e3b442e538
commit 05985f6889

View file

@ -3586,22 +3586,26 @@ Tuning
milliseconds.
``tcp-recv-buffer``; ``udp-recv-buffer``
These options control the operating system receiving network buffer sizes for
TCP and UDP respectively. Buffering on the operating system level can
prevent packet drops during short spikes, but if the value is set too large
it could clog up a running server with outstanding queries that have already
timeouted. The default is ``0`` which means to use the operating system
default value. The operating system caps the maximum value that the user can
set here.
These options control the operating system's receive buffer sizes
(``SO_RCVBUF``) for TCP and UDP sockets respectively. Buffering at
the operating system level can prevent packet drops during brief load
spikes, but if the value is set too high, it could clog a running server
with outstanding queries that have already timed out. The default is
``0``, which means the operating system's default value should be used.
The minimum configurable value is ``4096``; any nonzero value lower than
that will be silently raised. The maximum value is determined by the
kernel, and values exceeding the maximum will be silently reduced.
``tcp-send-buffer``; ``udp-send-buffer``
These options control the operating system sending network buffer sizes for
TCP and UDP respectively. Buffering on the operating system level can
prevent packet drops during short spikes, but if the value is set too large
it could clog up a running server with outstanding queries that have already
timeouted. The default is ``0`` which means to use the operating system
default value. The operating system caps the maximum value that the user can
set here.
These options control the operating system's send buffer sizes
(``SO_SNDBUF``) for TCP and UDP sockets respectively. Buffering at the
operating system level can prevent packet drops during brief load
spikes, but if the value is set too high, it could clog a running server
with outstanding queries that have already timed out. The default is
``0``, which means the operating system's default value should be used.
The minimum configurable value is ``4096``; any nonzero value lower than
that will be silently raised. The maximum value is determined by the
kernel, and values exceeding the maximum will be silently reduced.
.. _builtin: