From 4ffd5584f9dcbd5ed321239c1d78a852fafdc0b8 Mon Sep 17 00:00:00 2001 From: Zetok Zalbavar Date: Wed, 17 Jun 2015 10:38:53 +0100 Subject: [PATCH] Improve documentation about tcp_port Apparently it's not entirely clear that it's not needed in clients. v2, as provided by @nurupo --- other/apidsl/tox.in.h | 10 +++++++++- toxcore/tox.h | 10 +++++++++- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/other/apidsl/tox.in.h b/other/apidsl/tox.in.h index 30c78e44..493dd18e 100644 --- a/other/apidsl/tox.in.h +++ b/other/apidsl/tox.in.h @@ -431,7 +431,15 @@ static class options { uint16_t end_port; /** - * The port to use for the TCP server. If 0, the tcp server is disabled. + * The port to use for the TCP server (relay). If 0, the TCP server is + * disabled. + * + * Enabling it is not required for Tox to function properly. + * + * When enabled, your Tox instance can act as a TCP relay for other Tox + * instance. This leads to increased traffic, thus when writing a client + * it is recommended to enable TCP server only if the user has an option + * to disable it. */ uint16_t tcp_port; diff --git a/toxcore/tox.h b/toxcore/tox.h index 14c9f616..5af92c72 100644 --- a/toxcore/tox.h +++ b/toxcore/tox.h @@ -451,7 +451,15 @@ struct Tox_Options { /** - * The port to use for the TCP server. If 0, the tcp server is disabled. + * The port to use for the TCP server (relay). If 0, the TCP server is + * disabled. + * + * Enabling it is not required for Tox to function normally. + * + * When enabled, your Tox instance can act as a TCP relay for other Tox + * instance. This leads to increased traffic, thus when writing a client + * it is recommended to enable TCP server only if the user has an option + * to disable it. */ uint16_t tcp_port;