From 29eabc470668fb6ad7df74e77776b5a7c1c30f23 Mon Sep 17 00:00:00 2001 From: zzz Date: Fri, 11 Oct 2019 16:14:26 +0000 Subject: [PATCH] TCG javadoc notes for android --- .../java/src/net/i2p/i2ptunnel/TunnelControllerGroup.java | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/TunnelControllerGroup.java b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/TunnelControllerGroup.java index 74ec79a5a..d25961bf8 100644 --- a/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/TunnelControllerGroup.java +++ b/apps/i2ptunnel/java/src/net/i2p/i2ptunnel/TunnelControllerGroup.java @@ -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 */