StarMirror/toxcore
1
0
Fork 0
mirror of https://github.com/irungentoo/toxcore.git synced 2024-03-22 13:30:51 +08:00
Code Issues Projects Releases Wiki Activity

Improve documentation about tcp_port

Browse Source 
Apparently it's not entirely clear that it's not needed in clients.

v2, as provided by @nurupo
This commit is contained in:
Zetok Zalbavar 2015-06-17 10:38:53 +01:00
parent 67df1ab7ce
commit 4ffd5584f9
No known key found for this signature in database
GPG Key ID: C953D3880212068A
2 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
other/apidsl/tox.in.h
View File

@ -431,7 +431,15 @@ static class options {
uint16_t end_port; 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; uint16_t tcp_port;

10
toxcore/tox.h
View File

@ -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; uint16_t tcp_port;