summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2012-07-18 16:56:11 +0200
committerStefano Sabatini <stefasab@gmail.com>2012-07-19 22:31:41 +0200
commite1422940f2edcb2518cc9e7da2a8206f420511b1 (patch)
treed273755016b5f6aafb2d0ca7a18120e1239e82d8
parent6b80f7584866271a8c1a1d4665e3c1c6d0a14d9a (diff)
doc/protocols: add a note regarding the circular RX UDP buffer
-rw-r--r--doc/protocols.texi5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/protocols.texi b/doc/protocols.texi
index 1321075af6..74c15f6932 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -556,6 +556,11 @@ udp://@var{hostname}:@var{port}[?@var{options}]
@var{options} contains a list of &-separated options of the form @var{key}=@var{val}.
+In case threading is enabled on the system, a circular buffer is used
+to store the incoming data, which allows to reduce loss of data due to
+UDP socket buffer overruns. The @var{fifo_size} and
+@var{overrun_nonfatal} options are related to this buffer.
+
The list of supported options follows.
@table @option