diff options
author | irungentoo <irungentoo@gmail.com> | 2015-06-20 21:35:20 -0400 |
---|---|---|
committer | irungentoo <irungentoo@gmail.com> | 2015-06-20 21:35:20 -0400 |
commit | 022a3ec0d87b5d029ab82fcf61dd5cb400831eb5 (patch) | |
tree | 3d175ac5dbf8b841086f271cd157a3cd9412d76e /toxcore | |
parent | 8383cc5ae327ba31b461493b571d0ee0834ef333 (diff) | |
parent | 4ffd5584f9dcbd5ed321239c1d78a852fafdc0b8 (diff) |
Merge branch 'doc' of https://github.com/zetok/ProjectTox-Core
Diffstat (limited to 'toxcore')
-rw-r--r-- | toxcore/tox.h | 10 |
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 | ||