Document tcp proto 'timeout' parameter behavior
authorAndrey Utkin <andrey.krieger.utkin@gmail.com>
Thu, 13 Sep 2012 00:43:29 +0000 (03:43 +0300)
committerMichael Niedermayer <michaelni@gmx.at>
Sat, 15 Sep 2012 14:26:00 +0000 (16:26 +0200)
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
doc/protocols.texi

index 0ad985c..e790459 100644 (file)
@@ -578,6 +578,11 @@ tcp://@var{hostname}:@var{port}[?@var{options}]
 @item listen
 Listen for an incoming connection
 
+@item timeout=@var{microseconds}
+In read mode: if no data arrived in more than this time interval, raise error.
+In write mode: if socket cannot be written in more than this time interval, raise error.
+This also sets timeout on TCP connection establishing.
+
 @example
 ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
 ffplay tcp://@var{hostname}:@var{port}