From 587de5be303305a327ae9debd9d9b5c9646436b0 Mon Sep 17 00:00:00 2001 From: KongQun Yang Date: Tue, 6 Mar 2018 17:40:50 -0800 Subject: [PATCH] [Doc] Make UDP file options clearer Issue #332. Change-Id: I3a2b1e1e0525eaba5bb657ce0481d96ceafb4e89 --- docs/source/options/udp_file_options.rst | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/docs/source/options/udp_file_options.rst b/docs/source/options/udp_file_options.rst index 1d398dd762..24a8987eb6 100644 --- a/docs/source/options/udp_file_options.rst +++ b/docs/source/options/udp_file_options.rst @@ -1,23 +1,30 @@ UDP file options ^^^^^^^^^^^^^^^^ -UDP file is of the form udp://ip:port[?options]. Here is the list of supported -options: +UDP file is of the form:: + + udp://{ip}:{port}[?{option}[&{option}]...] + +Here is the list of supported options: :reuse=0|1: Allow or disallow reusing UDP sockets. -:interface=: +:interface={addr}: Multicast group interface address. Only the packets sent to this address are received. Default to "0.0.0.0" if not specified. -:source=: +:source={addr}: Multicast source ip address. Only the packets sent from this source address - are received. Defaults to "0.0.0.0" if not specified. + are received. Enables Source Specific Multicast (SSM) if set. -:timeout=: +:timeout={microseconds}: UDP timeout in microseconds. + +Example:: + + udp://224.1.2.30:88?interface=10.11.12.13&reuse=1