TCG javadoc notes for android

This commit is contained in:
zzz
2019-10-11 16:14:26 +00:00
parent 049b34f7cf
commit 29eabc4706

View File

@@ -88,6 +88,10 @@ public class TunnelControllerGroup implements ClientApp {
* if the TCG has not yet been started by the router.
* As of 0.9.41, that's true for Android as well.
*
* In Android, this should be used for all calls except from LoadClientsJob,
* as we do not want to instantiate TCG too early. Android must do null
* checks on the return value.
*
* @throws IllegalArgumentException if unable to load from i2ptunnel.config
*/
public static TunnelControllerGroup getInstance() {
@@ -111,6 +115,9 @@ public class TunnelControllerGroup implements ClientApp {
* if the TCG has not yet been started by the router.
* In Android, if the old instance uses a stale context, it will replace it.
*
* In Android, this should only be called from LoadClientsJob, as we do not
* want to instantiate TCG too early.
*
* @throws IllegalArgumentException if unable to load from i2ptunnel.config
* @since 0.9.41
*/