summaryrefslogtreecommitdiff
path: root/toxcore/tox.h
diff options
context:
space:
mode:
Diffstat (limited to 'toxcore/tox.h')
-rw-r--r--toxcore/tox.h10
1 files changed, 9 insertions, 1 deletions
diff --git a/toxcore/tox.h b/toxcore/tox.h
index fd0792f2..3b2da2f7 100644
--- a/toxcore/tox.h
+++ b/toxcore/tox.h
@@ -460,7 +460,15 @@ struct Tox_Options {
460 460
461 461
462 /** 462 /**
463 * The port to use for the TCP server. If 0, the tcp server is disabled. 463 * The port to use for the TCP server (relay). If 0, the TCP server is
464 * disabled.
465 *
466 * Enabling it is not required for Tox to function properly.
467 *
468 * When enabled, your Tox instance can act as a TCP relay for other Tox
469 * instance. This leads to increased traffic, thus when writing a client
470 * it is recommended to enable TCP server only if the user has an option
471 * to disable it.
464 */ 472 */
465 uint16_t tcp_port; 473 uint16_t tcp_port;
466 474