This commit is contained in:
irungentoo 2015-06-20 21:35:20 -04:00
commit 022a3ec0d8
No known key found for this signature in database
GPG Key ID: 10349DC9BED89E98
2 changed files with 18 additions and 2 deletions

View File

@ -439,7 +439,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;

View File

@ -460,7 +460,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 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;