diff options
-rw-r--r-- | other/apidsl/tox.in.h | 10 | ||||
-rw-r--r-- | 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 189fc43d..4a0ab950 100644 --- a/other/apidsl/tox.in.h +++ b/other/apidsl/tox.in.h | |||
@@ -439,7 +439,15 @@ static class options { | |||
439 | uint16_t end_port; | 439 | uint16_t end_port; |
440 | 440 | ||
441 | /** | 441 | /** |
442 | * The port to use for the TCP server. If 0, the tcp server is disabled. | 442 | * The port to use for the TCP server (relay). If 0, the TCP server is |
443 | * disabled. | ||
444 | * | ||
445 | * Enabling it is not required for Tox to function properly. | ||
446 | * | ||
447 | * When enabled, your Tox instance can act as a TCP relay for other Tox | ||
448 | * instance. This leads to increased traffic, thus when writing a client | ||
449 | * it is recommended to enable TCP server only if the user has an option | ||
450 | * to disable it. | ||
443 | */ | 451 | */ |
444 | uint16_t tcp_port; | 452 | uint16_t tcp_port; |
445 | 453 | ||
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 | ||