Skip to content

Commit

Permalink
[Doc] Make UDP file options clearer
Browse files Browse the repository at this point in the history
Issue #332.

Change-Id: I3a2b1e1e0525eaba5bb657ce0481d96ceafb4e89
  • Loading branch information
kqyang committed Mar 17, 2018
1 parent 833b816 commit 587de5b
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions docs/source/options/udp_file_options.rst
Original file line number Diff line number Diff line change
@@ -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=<addr>:
: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=<addr>:
: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=<microseconds>:
:timeout={microseconds}:

UDP timeout in microseconds.

Example::

udp://224.1.2.30:88?interface=10.11.12.13&reuse=1

0 comments on commit 587de5b

Please # to comment.