doc/protocols: add a note regarding the circular RX UDP buffer

13 years ago · e1422940f2
parent 6b80f75848
commit e1422940f2
1 changed files with 5 additions and 0 deletions
--- 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