doc/protocols: add a note regarding the circular RX UDP buffer
authorStefano Sabatini <stefasab@gmail.com>
Wed, 18 Jul 2012 14:56:11 +0000 (16:56 +0200)
committerStefano Sabatini <stefasab@gmail.com>
Thu, 19 Jul 2012 20:31:41 +0000 (22:31 +0200)
doc/protocols.texi

index 1321075..74c15f6 100644 (file)
@@ -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