Commit 1b4da43c authored by Stefano Sabatini's avatar Stefano Sabatini

doc/protocols/tcp,lavf/tcp: apply minor fixes to TCP protocol documentation

parent 702d9a23
...@@ -897,23 +897,32 @@ The required syntax for a TCP url is: ...@@ -897,23 +897,32 @@ The required syntax for a TCP url is:
tcp://@var{hostname}:@var{port}[?@var{options}] tcp://@var{hostname}:@var{port}[?@var{options}]
@end example @end example
@table @option @var{options} contains a list of &-separated options of the form
@var{key}=@var{val}.
@item listen The list of supported options follows.
Listen for an incoming connection
@table @option
@item listen=@var{1|0}
Listen for an incoming connection. Default value is 0.
@item timeout=@var{microseconds} @item timeout=@var{microseconds}
In read mode: if no data arrived in more than this time interval, raise error. Set raise error timeout, expressed in microseconds.
In write mode: if socket cannot be written in more than this time interval, raise error.
This also sets timeout on TCP connection establishing.
This option is only relevant in read mode: if no data arrived in more
than this time interval, raise error.
@item listen_timeout=@var{microseconds}
Set listen timeout, expressed in microseconds.
@end table
The following example shows how to setup a listening TCP connection
with @command{ffmpeg}, which is then accessed with @command{ffplay}:
@example @example
ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen
ffplay tcp://@var{hostname}:@var{port} ffplay tcp://@var{hostname}:@var{port}
@end example @end example
@end table
@section tls @section tls
Transport Layer Security (TLS) / Secure Sockets Layer (SSL) Transport Layer Security (TLS) / Secure Sockets Layer (SSL)
......
...@@ -44,8 +44,8 @@ typedef struct TCPContext { ...@@ -44,8 +44,8 @@ typedef struct TCPContext {
#define E AV_OPT_FLAG_ENCODING_PARAM #define E AV_OPT_FLAG_ENCODING_PARAM
static const AVOption options[] = { static const AVOption options[] = {
{"listen", "listen on port instead of connecting", OFFSET(listen), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D|E }, {"listen", "listen on port instead of connecting", OFFSET(listen), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 1, D|E },
{"timeout", "timeout of socket i/o operations", OFFSET(rw_timeout), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, D|E }, {"timeout", "set timeout of socket I/O operations", OFFSET(rw_timeout), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, D|E },
{"listen_timeout", "connection awaiting timeout", OFFSET(listen_timeout), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, D|E }, {"listen_timeout", "set connection awaiting timeout", OFFSET(listen_timeout), AV_OPT_TYPE_INT, {.i64 = -1}, -1, INT_MAX, D|E },
{NULL} {NULL}
}; };
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment