summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJoseph Barker <j.barker@leeds.ac.uk>2019-10-29 09:47:45 +0900
committerBrian May <brian@linuxpenguins.xyz>2019-11-08 08:01:52 +1100
commit23516ebd71d6518f30a3cfadbe424481c2c13cab (patch)
tree46c1eb31def928874d21caf726fda3034a200d03 /docs
parentc69b9d6f4bcb0a7016ef5927493daf4a8654cefb (diff)
Add option for latency control buffer size
This commit resolves #297, allowing the buffers used in the latency control to be changed with a command line option ‘--latency-buffer-size’. We do this by changing a module variable in ssnet.py (similar to the MAX_CHANNEL variable) which seems to be the simplest code change without extensive hacking. Documentation is also updated.
Diffstat (limited to 'docs')
-rw-r--r--docs/manpage.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/manpage.rst b/docs/manpage.rst
index f0703ca..5d09c25 100644
--- a/docs/manpage.rst
+++ b/docs/manpage.rst
@@ -189,6 +189,13 @@ Options
control feature, maximizing bandwidth usage. Use at
your own risk.
+.. option:: --latency-buffer-size
+
+ Set the size of the buffer used in latency control. The
+ default is ``32768``. Changing this option allows a compromise
+ to be made between latency and bandwidth without completely
+ disabling latency control (with :option:`--no-latency-control`).
+
.. option:: -D, --daemon
Automatically fork into the background after connecting