TunnelController (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.i2ptunnel.TunnelController

All Implemented Interfaces:
Logging
```
public class TunnelController
extends Object
implements Logging
```
Coordinate the runtime operation and configuration of a single I2PTunnel. An I2PTunnel tracks one or more I2PTunnelTasks and one or more I2PSessions. Usually one of each. These objects are bundled together under a TunnelControllerGroup where the entire group is stored / loaded from a single config file. This is the class used by several plugins to create tunnels, so take care to maintain the public methods as a stable API.

Nested Class Summary
Nested Classes
Modifier and Type Class and Description
static class TunnelController.TunnelState
The tunnel state.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TunnelController.TunnelState` The tunnel state.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_MAX_CONNS_DAY`
`static int`	`DEFAULT_MAX_CONNS_HOUR`
`static int`	`DEFAULT_MAX_CONNS_MIN`
`static int`	`DEFAULT_MAX_STREAMS`
`static int`	`DEFAULT_MAX_TOTAL_CONNS_DAY`
`static int`	`DEFAULT_MAX_TOTAL_CONNS_HOUR`
`static int`	`DEFAULT_MAX_TOTAL_CONNS_MIN`
`static int`	`DEFAULT_SHUTDOWN_DELAY_MAX` Default maximum shutdown delay in seconds
`static int`	`DEFAULT_SHUTDOWN_DELAY_MIN` Default minimum shutdown delay in seconds
`static int`	`DEFAULT_STARTUP_DELAY_MAX` Default maximum startup delay in seconds
`static int`	`DEFAULT_STARTUP_DELAY_MIN` Default minimum startup delay in seconds
`static String`	`KEY_BACKUP_DIR` Key backup directory name.
`static String`	`OPT_BUNDLE_REPLY` Config key to bundle reply keys.
`static String`	`OPT_POST_MAX` Config key for max posts (delegated to HTTPServer).
`static String`	`OPT_POST_TOTAL_MAX` Config key for max total posts (delegated to HTTPServer).
`static String`	`PFX_OPTION` P f x o p t i o n
`static SigType`	`PREFERRED_SIGTYPE` This is guaranteed to be available.
`static String`	`PROP_CONFIG_FILE` P r o p c o n f i g f i l e
`static String`	`PROP_DESCR` all of these
`static String`	`PROP_DEST`
`static String`	`PROP_FILE`
`static String`	`PROP_FILTER`
`static String`	`PROP_I2CP_HOST`
`static String`	`PROP_I2CP_PORT`
`static String`	`PROP_INTFC`
`static String`	`PROP_LIMIT_ACTION` P r o p l i m i t a c t i o n
`static String`	`PROP_LIMITS_SET`
`static String`	`PROP_LISTEN_PORT`
`static String`	`PROP_MAX_CONNS_DAY`
`static String`	`PROP_MAX_CONNS_HOUR`
`static String`	`PROP_MAX_CONNS_MIN` all of these are (moved from TunnelConfig)
`static String`	`PROP_MAX_STREAMS`
`static String`	`PROP_MAX_TOTAL_CONNS_DAY`
`static String`	`PROP_MAX_TOTAL_CONNS_HOUR`
`static String`	`PROP_MAX_TOTAL_CONNS_MIN`
`static String`	`PROP_NAME`
`static String`	`PROP_PROXIES`
`static String`	`PROP_SHARED`
`static String`	`PROP_SHUTDOWN_DELAY_MAX` Configuration property for the maximum shutdown delay in seconds.
`static String`	`PROP_SHUTDOWN_DELAY_MIN` Configuration property for the minimum shutdown delay in seconds.
`static String`	`PROP_SPOOFED_HOST`
`static String`	`PROP_START`
`static String`	`PROP_STARTUP_DELAY_MAX` Configuration property for the maximum startup delay in seconds.
`static String`	`PROP_STARTUP_DELAY_MIN` Configuration property for the minimum startup delay in seconds.
`static String`	`PROP_TARGET_HOST`
`static String`	`PROP_TARGET_PORT`
`static String`	`PROP_TUN_GZIP` P r o p t u n g z i p
`static String`	`PROP_TYPE`
`static String`	`TYPE_CONNECT` all of these
`static String`	`TYPE_HTTP_BIDIR_SERVER`
`static String`	`TYPE_HTTP_CLIENT`
`static String`	`TYPE_HTTP_SERVER`
`static String`	`TYPE_IRC_CLIENT`
`static String`	`TYPE_IRC_SERVER`
`static String`	`TYPE_SOCKS`
`static String`	`TYPE_SOCKS_IRC`
`static String`	`TYPE_STD_CLIENT`
`static String`	`TYPE_STD_SERVER`
`static String`	`TYPE_STREAMR_CLIENT` Client in the UI and I2P side but a server on the localhost side
`static String`	`TYPE_STREAMR_SERVER` Server in the UI and I2P side but a client on the localhost side

Constructor Summary

Constructors
Constructor and Description
`TunnelController(Properties config, String prefix)` Create a new controller for a tunnel out of the specific config options.
`TunnelController(Properties config, String prefix, boolean createKey)` Create a new controller for a tunnel out of the specific config options.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`changeState(TunnelController.TunnelState state)` Void
`List<String>`	`clearMessages()` Pull off any messages that the I2PTunnel has produced
`void`	`destroyTunnel()` May NOT be restarted with restartTunnel() or startTunnel() later.
`(package private) static File`	`filenameToFile(String f)` Does not necessarily exist.
`File`	`getAlternatePrivateKeyFile()` Does not necessarily exist.
`Properties`	`getClientOptionProps()` These are the ones stored with a prefix of "option." Defaults in config properties are not honored.
`Properties`	`getConfig(String prefix)`
`File`	`getConfigFile()`
`String`	`getDescription()`
`Destination`	`getDestination()` Returns null if not running.
`String`	`getFilter()` Absolute path to filter definition file
`String`	`getI2CPHost()`
`String`	`getI2CPPort()`
`boolean`	`getIsOfflineKeys()` Returns false if not running.
`boolean`	`getIsRunning()` Checks if the tunnel is currently running.
`boolean`	`getIsStandby()` Checks if the tunnel is in standby mode.
`boolean`	`getIsStarting()` Checks if the tunnel is starting or starting on load.
`String`	`getListenOnInterface()`
`String`	`getListenPort()`
`String`	`getMyDestHashBase32()` Returns null if not running.
`String`	`getMyDestination()` Returns null if not running.
`String`	`getName()`
`boolean`	`getPersistentClientKey()`
`File`	`getPrivateKeyFile()` Does not necessarily exist.
`String`	`getPrivKeyFile()` Probably not absolute.
`String`	`getProxyList()`
`int`	`getRemainingStartupDelay()` Get the remaining startup delay time for tunnels with delayed startup.
`String`	`getSharedClient()` default true for clients, always false for servers
`int`	`getShutdownDelayMax()` When combined with a positive shutdownDelayMin less than this value, the tunnel will stop with a random delay between min and max seconds during router shutdown.
`int`	`getShutdownDelayMin()` When combined with a greater shutdownDelayMax, the tunnel will stop with a random delay between min and max seconds during router shutdown.
`String`	`getSpoofedHost()`
`boolean`	`getStartOnLoad()`
`int`	`getStartupDelayMax()` When combined with a positive startupDelayMin less than this value, the tunnel will start with a random delay between min and max seconds.
`int`	`getStartupDelayMin()` When combined with a greater startupDelayMax, the tunnel will start with a random delay between min and max seconds.
`TunnelController.TunnelState`	`getState()` Gets the current tunnel state.
`String`	`getTargetDestination()`
`String`	`getTargetHost()`
`String`	`getTargetPort()`
`I2PTunnel`	`getTunnel()` The I2PTunnel for advanced plugin usage
`String`	`getType()`
`boolean`	`isClient()` Is it a client or server in the UI and I2P side? Note that a streamr client is a UI and I2P client but a server on the localhost side.
`static boolean`	`isClient(String type)` Is it a client or server in the UI and I2P side? Note that a streamr client is a UI and I2P client but a server on the localhost side.
`void`	`log(String s)` Log a message.
`void`	`restartTunnel()` Stops and restarts the tunnel.
`void`	`restoreLog()` Restore log messages after restart
`void`	`setConfig(Properties config, String prefix)` As of 0.9.1, updates the options on an existing session
`void`	`setConfigFile(File file)` Set the config file.
`(package private) void`	`setStartupDelayEndTime(long delayMs)` Set the startup delay end time.
`void`	`startTunnel()` Start up the tunnel (if it isn't already running)
`void`	`startTunnelBackground()` Starts the tunnel in a background thread.
`void`	`stopTunnel()` May be restarted with restartTunnel() or startTunnel() later.
`void`	`suppressLog()` Suppress log messages during restart
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_MAX_CONNS_DAY
```
public static final int DEFAULT_MAX_CONNS_DAY
```
    See Also:
    Constant Field Values
  - DEFAULT_MAX_CONNS_HOUR
```
public static final int DEFAULT_MAX_CONNS_HOUR
```
    See Also:
    Constant Field Values
  - DEFAULT_MAX_CONNS_MIN
```
public static final int DEFAULT_MAX_CONNS_MIN
```
    See Also:
    Constant Field Values
  - DEFAULT_MAX_STREAMS
```
public static final int DEFAULT_MAX_STREAMS
```
    See Also:
    Constant Field Values
  - DEFAULT_MAX_TOTAL_CONNS_DAY
```
public static final int DEFAULT_MAX_TOTAL_CONNS_DAY
```
    See Also:
    Constant Field Values
  - DEFAULT_MAX_TOTAL_CONNS_HOUR
```
public static final int DEFAULT_MAX_TOTAL_CONNS_HOUR
```
    See Also:
    Constant Field Values
  - DEFAULT_MAX_TOTAL_CONNS_MIN
```
public static final int DEFAULT_MAX_TOTAL_CONNS_MIN
```
    See Also:
    Constant Field Values
  - DEFAULT_SHUTDOWN_DELAY_MAX
```
public static final int DEFAULT_SHUTDOWN_DELAY_MAX
```
    Default maximum shutdown delay in seconds
    See Also:
    Constant Field Values
  - DEFAULT_SHUTDOWN_DELAY_MIN
```
public static final int DEFAULT_SHUTDOWN_DELAY_MIN
```
    Default minimum shutdown delay in seconds
    See Also:
    Constant Field Values
  - DEFAULT_STARTUP_DELAY_MAX
```
public static final int DEFAULT_STARTUP_DELAY_MAX
```
    Default maximum startup delay in seconds
    See Also:
    Constant Field Values
  - DEFAULT_STARTUP_DELAY_MIN
```
public static final int DEFAULT_STARTUP_DELAY_MIN
```
    Default minimum startup delay in seconds
    See Also:
    Constant Field Values
  - KEY_BACKUP_DIR
```
public static final String KEY_BACKUP_DIR
```
    Key backup directory name.
    See Also:
    Constant Field Values
  - OPT_BUNDLE_REPLY
```
public static final String OPT_BUNDLE_REPLY
```
    Config key to bundle reply keys.
    See Also:
    Constant Field Values
  - OPT_POST_MAX
```
public static final String OPT_POST_MAX
```
    Config key for max posts (delegated to HTTPServer).
    See Also:
    Constant Field Values
  - OPT_POST_TOTAL_MAX
```
public static final String OPT_POST_TOTAL_MAX
```
    Config key for max total posts (delegated to HTTPServer).
    See Also:
    Constant Field Values
  - PFX_OPTION
```
public static final String PFX_OPTION
```
    P f x o p t i o n
    See Also:
    Constant Field Values
  - PREFERRED_SIGTYPE
```
public static final SigType PREFERRED_SIGTYPE
```
    This is guaranteed to be available.
  - PROP_CONFIG_FILE
```
public static final String PROP_CONFIG_FILE
```
    P r o p c o n f i g f i l e
    See Also:
    Constant Field Values
  - PROP_DESCR
```
public static final String PROP_DESCR
```
    all of these
    See Also:
    Constant Field Values
  - PROP_DEST
```
public static final String PROP_DEST
```
    See Also:
    Constant Field Values
  - PROP_FILE
```
public static final String PROP_FILE
```
    See Also:
    Constant Field Values
  - PROP_FILTER
```
public static final String PROP_FILTER
```
    See Also:
    Constant Field Values
  - PROP_I2CP_HOST
```
public static final String PROP_I2CP_HOST
```
    See Also:
    Constant Field Values
  - PROP_I2CP_PORT
```
public static final String PROP_I2CP_PORT
```
    See Also:
    Constant Field Values
  - PROP_INTFC
```
public static final String PROP_INTFC
```
    See Also:
    Constant Field Values
  - PROP_LIMIT_ACTION
```
public static final String PROP_LIMIT_ACTION
```
    P r o p l i m i t a c t i o n
    See Also:
    Constant Field Values
  - PROP_LIMITS_SET
```
public static final String PROP_LIMITS_SET
```
    See Also:
    Constant Field Values
  - PROP_LISTEN_PORT
```
public static final String PROP_LISTEN_PORT
```
    See Also:
    Constant Field Values
  - PROP_MAX_CONNS_DAY
```
public static final String PROP_MAX_CONNS_DAY
```
    See Also:
    Constant Field Values
  - PROP_MAX_CONNS_HOUR
```
public static final String PROP_MAX_CONNS_HOUR
```
    See Also:
    Constant Field Values
  - PROP_MAX_CONNS_MIN
```
public static final String PROP_MAX_CONNS_MIN
```
    all of these are (moved from TunnelConfig)
    See Also:
    Constant Field Values
  - PROP_MAX_STREAMS
```
public static final String PROP_MAX_STREAMS
```
    See Also:
    Constant Field Values
  - PROP_MAX_TOTAL_CONNS_DAY
```
public static final String PROP_MAX_TOTAL_CONNS_DAY
```
    See Also:
    Constant Field Values
  - PROP_MAX_TOTAL_CONNS_HOUR
```
public static final String PROP_MAX_TOTAL_CONNS_HOUR
```
    See Also:
    Constant Field Values
  - PROP_MAX_TOTAL_CONNS_MIN
```
public static final String PROP_MAX_TOTAL_CONNS_MIN
```
    See Also:
    Constant Field Values
  - PROP_NAME
```
public static final String PROP_NAME
```
    See Also:
    Constant Field Values
  - PROP_PROXIES
```
public static final String PROP_PROXIES
```
    See Also:
    Constant Field Values
  - PROP_SHARED
```
public static final String PROP_SHARED
```
    See Also:
    Constant Field Values
  - PROP_SHUTDOWN_DELAY_MAX
```
public static final String PROP_SHUTDOWN_DELAY_MAX
```
    Configuration property for the maximum shutdown delay in seconds. Only applies to server tunnels.
    See Also:
    Constant Field Values
  - PROP_SHUTDOWN_DELAY_MIN
```
public static final String PROP_SHUTDOWN_DELAY_MIN
```
    Configuration property for the minimum shutdown delay in seconds. Only applies to server tunnels.
    See Also:
    Constant Field Values
  - PROP_SPOOFED_HOST
```
public static final String PROP_SPOOFED_HOST
```
    See Also:
    Constant Field Values
  - PROP_START
```
public static final String PROP_START
```
    See Also:
    Constant Field Values
  - PROP_STARTUP_DELAY_MAX
```
public static final String PROP_STARTUP_DELAY_MAX
```
    Configuration property for the maximum startup delay in seconds. Only applies to server tunnels.
    See Also:
    Constant Field Values
  - PROP_STARTUP_DELAY_MIN
```
public static final String PROP_STARTUP_DELAY_MIN
```
    Configuration property for the minimum startup delay in seconds. Only applies to server tunnels.
    See Also:
    Constant Field Values
  - PROP_TARGET_HOST
```
public static final String PROP_TARGET_HOST
```
    See Also:
    Constant Field Values
  - PROP_TARGET_PORT
```
public static final String PROP_TARGET_PORT
```
    See Also:
    Constant Field Values
  - PROP_TUN_GZIP
```
public static final String PROP_TUN_GZIP
```
    P r o p t u n g z i p
    See Also:
    Constant Field Values
  - PROP_TYPE
```
public static final String PROP_TYPE
```
    See Also:
    Constant Field Values
  - TYPE_CONNECT
```
public static final String TYPE_CONNECT
```
    all of these
    See Also:
    Constant Field Values
  - TYPE_HTTP_BIDIR_SERVER
```
public static final String TYPE_HTTP_BIDIR_SERVER
```
    See Also:
    Constant Field Values
  - TYPE_HTTP_CLIENT
```
public static final String TYPE_HTTP_CLIENT
```
    See Also:
    Constant Field Values
  - TYPE_HTTP_SERVER
```
public static final String TYPE_HTTP_SERVER
```
    See Also:
    Constant Field Values
  - TYPE_IRC_CLIENT
```
public static final String TYPE_IRC_CLIENT
```
    See Also:
    Constant Field Values
  - TYPE_IRC_SERVER
```
public static final String TYPE_IRC_SERVER
```
    See Also:
    Constant Field Values
  - TYPE_SOCKS
```
public static final String TYPE_SOCKS
```
    See Also:
    Constant Field Values
  - TYPE_SOCKS_IRC
```
public static final String TYPE_SOCKS_IRC
```
    See Also:
    Constant Field Values
  - TYPE_STD_CLIENT
```
public static final String TYPE_STD_CLIENT
```
    See Also:
    Constant Field Values
  - TYPE_STD_SERVER
```
public static final String TYPE_STD_SERVER
```
    See Also:
    Constant Field Values
  - TYPE_STREAMR_CLIENT
```
public static final String TYPE_STREAMR_CLIENT
```
    Client in the UI and I2P side but a server on the localhost side
    See Also:
    Constant Field Values
  - TYPE_STREAMR_SERVER
```
public static final String TYPE_STREAMR_SERVER
```
    Server in the UI and I2P side but a client on the localhost side
    See Also:
    Constant Field Values
- Constructor Detail
  - TunnelController
```
public TunnelController(Properties config,
                        String prefix)
```
    Create a new controller for a tunnel out of the specific config options. The config may contain a large number of options - only ones that begin in the prefix should be used (and, in turn, that prefix should be stripped off before being interpreted by this controller) If config contains the "configFile" property, it will be set as the config path and may be retrieved with getConfigFile(). Defaults in config properties are not recommended, they may or may not be honored.
    Parameters:
    config - original key=value mapping non-null
    prefix - beginning of key values that are relevant to this tunnel
  - TunnelController
```
public TunnelController(Properties config,
                        String prefix,
                        boolean createKey)
```
    Create a new controller for a tunnel out of the specific config options. The config may contain a large number of options - only ones that begin in the prefix should be used (and, in turn, that prefix should be stripped off before being interpreted by this controller) If config contains the "configFile" property, it will be set as the config path and may be retrieved with getConfigFile(). Defaults in config properties are not recommended, they may or may not be honored.
    Parameters:
    config - original key=value mapping non-null
    prefix - beginning of key values that are relevant to this tunnel
    createKey - for servers, whether we want to create a brand new destination with private keys at the location specified or not (does not overwrite existing ones)
- Method Detail
  - changeState
```
public void changeState(TunnelController.TunnelState state)
```
    Void
  - clearMessages
```
public List<String> clearMessages()
```
    Pull off any messages that the I2PTunnel has produced
    Returns:
    list of messages pulled off (each is a String, earliest first)
  - destroyTunnel
```
public void destroyTunnel()
```
    May NOT be restarted with restartTunnel() or startTunnel() later. This should release all resources.
  - filenameToFile
```
static File filenameToFile(String f)
```
    Does not necessarily exist.
    Parameters:
    f - relative or absolute path, may be null
    Returns:
    absolute path or null
  - getAlternatePrivateKeyFile
```
public File getAlternatePrivateKeyFile()
```
    Does not necessarily exist.
    Returns:
    absolute path or null if unset
  - getClientOptionProps
```
public Properties getClientOptionProps()
```
    These are the ones stored with a prefix of "option." Defaults in config properties are not honored.
    Returns:
    keys with the "option." prefix stripped, non-null Much better than getClientOptions()
  - getConfig
```
public Properties getConfig(String prefix)
```
    Returns:
    a copy
  - getConfigFile
```
public File getConfigFile()
```
    Returns:
    the config file as passed into constructor via "configFile" property, or as set later, or null
  - getDescription
```
public String getDescription()
```
    Returns:
    the tunnel description
  - getDestination
```
public Destination getDestination()
```
    Returns null if not running.
    Returns:
    Destination or null
  - getFilter
```
public String getFilter()
```
    Absolute path to filter definition file
    Returns:
    the filter
  - getI2CPHost
```
public String getI2CPHost()
```
    Returns:
    the I2CP host
  - getI2CPPort
```
public String getI2CPPort()
```
    Returns:
    the I2CP port
  - getIsOfflineKeys
```
public boolean getIsOfflineKeys()
```
    Returns false if not running.
    Returns:
    true if the primary session has offline keys
  - getIsRunning
```
public boolean getIsRunning()
```
    Checks if the tunnel is currently running.
    Returns:
    true if the tunnel state is RUNNING
  - getIsStandby
```
public boolean getIsStandby()
```
    Checks if the tunnel is in standby mode.
    A tunnel is in standby when it is running but has no open sessions.
    Returns:
    true if the tunnel is running but has no active sessions
  - getIsStarting
```
public boolean getIsStarting()
```
    Checks if the tunnel is starting or starting on load.
    Returns:
    true if the tunnel is in the process of starting
  - getListenOnInterface
```
public String getListenOnInterface()
```
    Returns:
    the listen interface
  - getListenPort
```
public String getListenPort()
```
    Returns:
    the listen port
  - getMyDestHashBase32
```
public String getMyDestHashBase32()
```
    Returns null if not running.
    Returns:
    "{52 chars}.b32.i2p" or null
  - getMyDestination
```
public String getMyDestination()
```
    Returns null if not running.
    Returns:
    Base64 or null
  - getName
```
public String getName()
```
    Returns:
    the tunnel name
  - getPersistentClientKey
```
public boolean getPersistentClientKey()
```
    Returns:
    true if persistent client key is enabled
  - getPrivateKeyFile
```
public File getPrivateKeyFile()
```
    Does not necessarily exist.
    Returns:
    absolute path or null if unset
  - getPrivKeyFile
```
public String getPrivKeyFile()
```
    Probably not absolute. May be null. getPrivateKeyFile() recommended.
    Returns:
    the priv key file
  - getProxyList
```
public String getProxyList()
```
    Returns:
    the proxy list
  - getRemainingStartupDelay
```
public int getRemainingStartupDelay()
```
    Get the remaining startup delay time for tunnels with delayed startup.
    Returns:
    remaining delay in seconds, or 0 if not in delayed startup state or delay has passed
  - getSharedClient
```
public String getSharedClient()
```
    default true for clients, always false for servers
  - getShutdownDelayMax
```
public int getShutdownDelayMax()
```
    When combined with a positive shutdownDelayMin less than this value, the tunnel will stop with a random delay between min and max seconds during router shutdown.
    Returns:
    the maximum shutdown delay in seconds for server tunnels.
  - getShutdownDelayMin
```
public int getShutdownDelayMin()
```
    When combined with a greater shutdownDelayMax, the tunnel will stop with a random delay between min and max seconds during router shutdown.
    Returns:
    the minimum shutdown delay in seconds for server tunnels.
  - getSpoofedHost
```
public String getSpoofedHost()
```
    Returns:
    the spoofed host
  - getStartOnLoad
```
public boolean getStartOnLoad()
```
    Returns:
    true if this tunnel is configured to start when the router starts Default is true for clients, false for servers.
  - getStartupDelayMax
```
public int getStartupDelayMax()
```
    When combined with a positive startupDelayMin less than this value, the tunnel will start with a random delay between min and max seconds.
    Returns:
    the maximum startup delay in seconds for server tunnels.
  - getStartupDelayMin
```
public int getStartupDelayMin()
```
    When combined with a greater startupDelayMax, the tunnel will start with a random delay between min and max seconds.
    Returns:
    the minimum startup delay in seconds for server tunnels.
  - getState
```
public TunnelController.TunnelState getState()
```
    Gets the current tunnel state.
    Returns:
    the current TunnelState
  - getTargetDestination
```
public String getTargetDestination()
```
    Returns:
    the target destination
  - getTargetHost
```
public String getTargetHost()
```
    Returns:
    the target host
  - getTargetPort
```
public String getTargetPort()
```
    Returns:
    the target port
  - getTunnel
```
public I2PTunnel getTunnel()
```
    The I2PTunnel for advanced plugin usage
    Returns:
    the tunnel
  - getType
```
public String getType()
```
    Returns:
    the tunnel type
  - isClient
```
public boolean isClient()
```
    Is it a client or server in the UI and I2P side? Note that a streamr client is a UI and I2P client but a server on the localhost side. Note that a streamr server is a UI and I2P server but a client on the localhost side.
    Returns:
    whether client
  - isClient
```
public static boolean isClient(String type)
```
    Is it a client or server in the UI and I2P side? Note that a streamr client is a UI and I2P client but a server on the localhost side. Note that a streamr server is a UI and I2P server but a client on the localhost side. * @return false if type == null
  - log
```
public void log(String s)
```
    Description copied from interface: Logging
    Log a message.
    Specified by:
    log in interface Logging
    Parameters:
    s - the message to log
  - restartTunnel
```
public void restartTunnel()
```
    Stops and restarts the tunnel.
    This method stops the tunnel if running, waits briefly, then starts the tunnel again. The restart is performed synchronously, blocking until complete.
    See Also:
    startTunnel(), stopTunnel()
  - restoreLog
```
public void restoreLog()
```
    Restore log messages after restart
  - setConfig
```
public void setConfig(Properties config,
                      String prefix)
```
    As of 0.9.1, updates the options on an existing session
  - setConfigFile
```
public void setConfigFile(File file)
```
    Set the config file. Only do this if previously null.
  - setStartupDelayEndTime
```
void setStartupDelayEndTime(long delayMs)
```
    Set the startup delay end time. Called by TunnelControllerGroup when setting up delayed startup.
    Parameters:
    delayMs - the delay in milliseconds
  - startTunnel
```
public void startTunnel()
```
    Start up the tunnel (if it isn't already running)
  - startTunnelBackground
```
public void startTunnelBackground()
```
    Starts the tunnel in a background thread.
    This method spawns a new thread to start the tunnel, allowing the calling thread to return immediately. The tunnel state transitions to STARTING, and the actual startup is performed in the background thread.
    See Also:
    startTunnel()
  - stopTunnel
```
public void stopTunnel()
```
    May be restarted with restartTunnel() or startTunnel() later. This may not release all resources. In particular, the I2PSocketManager remains and it may have timer threads that continue running.
  - suppressLog
```
public void suppressLog()
```
    Suppress log messages during restart
  - toString
```
public String toString()
```
    Overrides:
    toString in class Object

Class TunnelController

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MAX_CONNS_DAY

DEFAULT_MAX_CONNS_HOUR

DEFAULT_MAX_CONNS_MIN

DEFAULT_MAX_STREAMS

DEFAULT_MAX_TOTAL_CONNS_DAY

DEFAULT_MAX_TOTAL_CONNS_HOUR

DEFAULT_MAX_TOTAL_CONNS_MIN

DEFAULT_SHUTDOWN_DELAY_MAX

DEFAULT_SHUTDOWN_DELAY_MIN

DEFAULT_STARTUP_DELAY_MAX

DEFAULT_STARTUP_DELAY_MIN

KEY_BACKUP_DIR

OPT_BUNDLE_REPLY

OPT_POST_MAX

OPT_POST_TOTAL_MAX

PFX_OPTION

PREFERRED_SIGTYPE

PROP_CONFIG_FILE

PROP_DESCR

PROP_DEST

PROP_FILE

PROP_FILTER

PROP_I2CP_HOST

PROP_I2CP_PORT

PROP_INTFC

PROP_LIMIT_ACTION

PROP_LIMITS_SET

PROP_LISTEN_PORT

PROP_MAX_CONNS_DAY

PROP_MAX_CONNS_HOUR

PROP_MAX_CONNS_MIN

PROP_MAX_STREAMS

PROP_MAX_TOTAL_CONNS_DAY

PROP_MAX_TOTAL_CONNS_HOUR

PROP_MAX_TOTAL_CONNS_MIN

PROP_NAME

PROP_PROXIES

PROP_SHARED

PROP_SHUTDOWN_DELAY_MAX

PROP_SHUTDOWN_DELAY_MIN

PROP_SPOOFED_HOST

PROP_START

PROP_STARTUP_DELAY_MAX

PROP_STARTUP_DELAY_MIN

PROP_TARGET_HOST

PROP_TARGET_PORT

PROP_TUN_GZIP

PROP_TYPE

TYPE_CONNECT

TYPE_HTTP_BIDIR_SERVER

TYPE_HTTP_CLIENT

TYPE_HTTP_SERVER

TYPE_IRC_CLIENT

TYPE_IRC_SERVER

TYPE_SOCKS

TYPE_SOCKS_IRC

TYPE_STD_CLIENT

TYPE_STD_SERVER

TYPE_STREAMR_CLIENT

TYPE_STREAMR_SERVER

Constructor Detail

TunnelController

TunnelController

Method Detail

changeState

clearMessages

destroyTunnel

filenameToFile

getAlternatePrivateKeyFile

getClientOptionProps

getConfig

getConfigFile

getDescription