diff --git a/gst/tcp/README b/gst/tcp/README index 05ef85e40b..47e4894b21 100644 --- a/gst/tcp/README +++ b/gst/tcp/README @@ -8,22 +8,25 @@ TESTS ----- Use these tests to test functionality of the various tcp plugins -* server: nc -l 3000 +* server: nc -l -p 3000 client: nc localhost 3000 everything you type in the server is shown on the client everything you type in the client is shown on the server -* server: nc -l 3000 +* server: nc -l -p 3000 client: gst-launch tcpclientsrc protocol=none port=3000 ! fdsink fd=2 everything you type in the server is shown on the client -* server: nc -l 3000 +* server: nc -l -p 3000 client: gst-launch fdsrc fd=1 ! tcpclientsink protocol=none port=3000 everything you type in the client is shown on the server * server: gst-launch tcpserversrc protocol=none port=3000 ! fdsink fd=2 client: gst-launch fdsrc fd=1 ! tcpclientsink protocol=none port=3000 +* server: gst-launch fdsrc fd=1 ! tcpserversink protocol=none port=3000 + client: gst-launch tcpclientsrc protocol=none port=3000 ! fdsink fd=2 + -> Received first buffer without caps set TODO ---- diff --git a/gst/tcp/gsttcpclientsink.c b/gst/tcp/gsttcpclientsink.c index af6efea54c..6fe08b603c 100644 --- a/gst/tcp/gsttcpclientsink.c +++ b/gst/tcp/gsttcpclientsink.c @@ -19,9 +19,18 @@ */ /** - * SECTION:tcpclientsink + * SECTION:element-tcpclientsink * @see_also: #tcpclientsrc * + * + * Example launch line + * |[ + * # server: + * nc -l -p 3000 + * # client: + * gst-launch fdsrc fd=1 ! tcpclientsink protocol=none port=3000 + * ]| everything you type in the client is shown on the server + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/tcp/gsttcpclientsrc.c b/gst/tcp/gsttcpclientsrc.c index 902c241d16..1b2b6f8494 100644 --- a/gst/tcp/gsttcpclientsrc.c +++ b/gst/tcp/gsttcpclientsrc.c @@ -19,9 +19,18 @@ */ /** - * SECTION:tcpclientsrc + * SECTION:element-tcpclientsrc * @see_also: #tcpclientsink * + * + * Example launch line + * |[ + * # server: + * nc -l -p 3000 + * # client: + * gst-launch tcpclientsrc protocol=none port=3000 ! fdsink fd=2 + * ]| everything you type in the server is shown on the client + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/tcp/gsttcpserversink.c b/gst/tcp/gsttcpserversink.c index 723c33a3d1..fcec3159a7 100644 --- a/gst/tcp/gsttcpserversink.c +++ b/gst/tcp/gsttcpserversink.c @@ -19,9 +19,18 @@ */ /** - * SECTION:tcpserversink + * SECTION:element-tcpserversink * @see_also: #multifdsink * + * + * Example launch line + * |[ + * # server: + * gst-launch fdsrc fd=1 ! tcpserversink protocol=none port=3000 + * # client: + * gst-launch tcpclientsrc protocol=none port=3000 ! fdsink fd=2 + * ]| + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/tcp/gsttcpserversrc.c b/gst/tcp/gsttcpserversrc.c index 5b6c3da1e4..1273e0a8de 100644 --- a/gst/tcp/gsttcpserversrc.c +++ b/gst/tcp/gsttcpserversrc.c @@ -19,9 +19,18 @@ */ /** - * SECTION:tcpserversrc + * SECTION:element-tcpserversrc * @see_also: #tcpserversink * + * + * Example launch line + * |[ + * # server: + * gst-launch tcpserversrc protocol=none port=3000 ! fdsink fd=2 + * # client: + * gst-launch fdsrc fd=1 ! tcpclientsink protocol=none port=3000 + * ]| + * */ #ifdef HAVE_CONFIG_H