From: Stefano Sabatini <stefasab@gmail.com>
Date: Wed, 18 Jul 2012 14:56:11 +0000 (+0200)
Subject: doc/protocols: add a note regarding the circular RX UDP buffer
X-Git-Tag: android-x86-4.4-r1~10575
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=e1422940f2edcb2518cc9e7da2a8206f420511b1;p=android-x86%2Fexternal-ffmpeg.git

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

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