net.i2p.router
Class Router

java.lang.Object
  extended by net.i2p.router.Router
All Implemented Interfaces:
RouterClock.ClockShiftListener

public class Router
extends Object
implements RouterClock.ClockShiftListener

Main driver for the router.


Field Summary
static char CAPABILITY_BW12
           
static char CAPABILITY_BW128
           
static char CAPABILITY_BW256
           
static char CAPABILITY_BW32
           
static char CAPABILITY_BW64
           
static char CAPABILITY_NEW_TUNNEL
          Deprecated. unused
static char CAPABILITY_REACHABLE
           
static char CAPABILITY_UNREACHABLE
           
static long CLOCK_FUDGE_FACTOR
          let clocks be off by 1 minute
static int COALESCE_TIME
          coalesce stats this often - should be a little less than one minute, so the graphs get updated
static int DEFAULT_SHARE_PERCENTAGE
           
static String DNS_CACHE_TIME
           
static int EXIT_GRACEFUL
           
static int EXIT_GRACEFUL_RESTART
           
static int EXIT_HARD
           
static int EXIT_HARD_RESTART
           
static int EXIT_OOM
           
(package private) static long LIVELINESS_DELAY
           
static int NETWORK_ID
          used to differentiate routerInfo files on different networks
static String PROP_BANDWIDTH_SHARE_PERCENTAGE
           
static String PROP_CONFIG_FILE
           
static String PROP_DYNAMIC_KEYS
           
static String PROP_FORCE_BWCLASS
           
static String PROP_FORCE_UNREACHABLE
           
static String PROP_HIDDEN
          this puts an 'H' in your routerInfo
static String PROP_HIDDEN_HIDDEN
          this does not put an 'H' in your routerInfo
static String PROP_INFO_FILENAME
           
static String PROP_INFO_FILENAME_DEFAULT
           
static String PROP_KEYS_FILENAME
           
static String PROP_KEYS_FILENAME_DEFAULT
           
static String PROP_SHUTDOWN_IN_PROGRESS
           
 Object routerInfoFileLock
           
static String UPDATE_FILE
           
 
Constructor Summary
Router()
          Instantiation only.
Router(Properties envProps)
           
Router(String configFilename)
           
Router(String configFilename, Properties envProps)
           
 
Method Summary
 void addCapabilities(RouterInfo ri)
           
 void cancelGracefulShutdown()
          Cancel any prior request to shut the router down gracefully.
static void clearCaches()
           
 void clockShift(long delta)
          The clock shift listener.
 Certificate createCertificate()
          Only called at startup via LoadRouterInfoJob and RebuildRouterInfoJob.
 EventLog eventLog()
           
 int get15sRate()
           
 int get15sRate(boolean outboundOnly)
           
 int get15sRateIn()
           
 int get1mRate()
           
 int get1mRate(boolean outboundOnly)
           
 int get1mRateIn()
           
 int get1sRate()
           
 int get1sRate(boolean outboundOnly)
           
 int get1sRateIn()
           
 int get5mRate()
           
 int get5mRate(boolean outboundOnly)
           
 String getConfigFilename()
           
 Map<String,String> getConfigMap()
           
 String getConfigSetting(String name)
           
 Set<String> getConfigSettings()
           
 RouterContext getContext()
           
 boolean getHigherVersionSeen()
          Deprecated. unused
 boolean getKillVMOnEnd()
          Deprecated. unused
 RouterInfo getRouterInfo()
          Warning, may be null if called very early
 double getSharePercentage()
          What fraction of the bandwidth specified in our bandwidth limits should we allow to be consumed by participating tunnels?
 long getShutdownTimeRemaining()
          How long until the graceful shutdown will kill us?
 long getUptime()
          wall clock uptime
 long getWhenStarted()
           
 boolean gracefulShutdownInProgress()
          Is a graceful shutdown in progress? This may be cancelled.
 boolean isAlive()
           
 boolean isFinalShutdownInProgress()
          Is a final shutdown in progress? This may not be cancelled.
 boolean isHidden()
           
 void killKeys()
           
static void main(String[] args)
           
 void readConfig()
          This updates the config with all settings found in the file.
 void rebuildNewIdentity()
          Rebuild a new identity the hard way - delete all of our old identity files, then reboot the router.
 void rebuildRouterInfo()
          Rebuild and republish our routerInfo since something significant has changed.
 void rebuildRouterInfo(boolean blockingRebuild)
           
 void removeConfigSetting(String name)
          Warning, race between here and saveConfig(), saveConfig(String name, String value) or saveConfig(Map toAdd, Set toRemove) is recommended.
 void restart()
          A "soft" restart, primarily of the comm system, after a port change or large step-change in system time.
 void runRouter()
          This must be called after instantiation.
 boolean saveConfig()
          Save the current config options (returning true if save was successful, false otherwise) Synchronized with file read in getConfig()
 boolean saveConfig(Map toAdd, Collection<String> toRemove)
          Updates the current config and then saves it.
 boolean saveConfig(String name, String value)
          Updates the current config and then saves it.
 int scheduledGracefulExitCode()
          What exit code do we plan on using when we shut down (or -1, if there isn't a graceful shutdown planned)
 void setConfigFilename(String filename)
          Deprecated. unused
 void setConfigSetting(String name, String value)
          Warning, race between here and saveConfig(), saveConfig(String name, String value) or saveConfig(Map toAdd, Set toRemove) is recommended.
 void setHigherVersionSeen(boolean seen)
          Deprecated. unused
 void setIsAlive()
          Only for Restarter
 void setKillVMOnEnd(boolean shouldDie)
          Configure the router to kill the JVM when the router shuts down, as well as whether to explicitly halt the JVM during the hard fail process.
 void setRouterInfo(RouterInfo info)
          Caller must ensure info is valid - no validation done here
 void shutdown(int exitCode)
          Shutdown with no chance of cancellation
 void shutdown2(int exitCode)
          Cancel the JVM runtime hook before calling this.
 void shutdownGracefully()
          Call this if we want the router to kill itself as soon as we aren't participating in any more tunnels (etc).
 void shutdownGracefully(int exitCode)
          Call this with EXIT_HARD or EXIT_HARD_RESTART for a non-blocking, hard, non-graceful shutdown with a brief delay to allow a UI response
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

routerInfoFileLock

public final Object routerInfoFileLock

PROP_CONFIG_FILE

public static final String PROP_CONFIG_FILE
See Also:
Constant Field Values

CLOCK_FUDGE_FACTOR

public static final long CLOCK_FUDGE_FACTOR
let clocks be off by 1 minute

See Also:
Constant Field Values

NETWORK_ID

public static final int NETWORK_ID
used to differentiate routerInfo files on different networks

See Also:
Constant Field Values

COALESCE_TIME

public static final int COALESCE_TIME
coalesce stats this often - should be a little less than one minute, so the graphs get updated

See Also:
Constant Field Values

PROP_HIDDEN

public static final String PROP_HIDDEN
this puts an 'H' in your routerInfo

See Also:
Constant Field Values

PROP_HIDDEN_HIDDEN

public static final String PROP_HIDDEN_HIDDEN
this does not put an 'H' in your routerInfo

See Also:
Constant Field Values

PROP_DYNAMIC_KEYS

public static final String PROP_DYNAMIC_KEYS
See Also:
Constant Field Values

PROP_INFO_FILENAME

public static final String PROP_INFO_FILENAME
See Also:
Constant Field Values

PROP_INFO_FILENAME_DEFAULT

public static final String PROP_INFO_FILENAME_DEFAULT
See Also:
Constant Field Values

PROP_KEYS_FILENAME

public static final String PROP_KEYS_FILENAME
See Also:
Constant Field Values

PROP_KEYS_FILENAME_DEFAULT

public static final String PROP_KEYS_FILENAME_DEFAULT
See Also:
Constant Field Values

PROP_SHUTDOWN_IN_PROGRESS

public static final String PROP_SHUTDOWN_IN_PROGRESS
See Also:
Constant Field Values

DNS_CACHE_TIME

public static final String DNS_CACHE_TIME
See Also:
Constant Field Values

CAPABILITY_BW12

public static final char CAPABILITY_BW12
See Also:
Constant Field Values

CAPABILITY_BW32

public static final char CAPABILITY_BW32
See Also:
Constant Field Values

CAPABILITY_BW64

public static final char CAPABILITY_BW64
See Also:
Constant Field Values

CAPABILITY_BW128

public static final char CAPABILITY_BW128
See Also:
Constant Field Values

CAPABILITY_BW256

public static final char CAPABILITY_BW256
See Also:
Constant Field Values

PROP_FORCE_BWCLASS

public static final String PROP_FORCE_BWCLASS
See Also:
Constant Field Values

CAPABILITY_REACHABLE

public static final char CAPABILITY_REACHABLE
See Also:
Constant Field Values

CAPABILITY_UNREACHABLE

public static final char CAPABILITY_UNREACHABLE
See Also:
Constant Field Values

PROP_FORCE_UNREACHABLE

public static final String PROP_FORCE_UNREACHABLE
See Also:
Constant Field Values

CAPABILITY_NEW_TUNNEL

public static final char CAPABILITY_NEW_TUNNEL
Deprecated. unused
See Also:
Constant Field Values

EXIT_GRACEFUL

public static final int EXIT_GRACEFUL
See Also:
Constant Field Values

EXIT_HARD

public static final int EXIT_HARD
See Also:
Constant Field Values

EXIT_OOM

public static final int EXIT_OOM
See Also:
Constant Field Values

EXIT_HARD_RESTART

public static final int EXIT_HARD_RESTART
See Also:
Constant Field Values

EXIT_GRACEFUL_RESTART

public static final int EXIT_GRACEFUL_RESTART
See Also:
Constant Field Values

UPDATE_FILE

public static final String UPDATE_FILE
See Also:
Constant Field Values

LIVELINESS_DELAY

static final long LIVELINESS_DELAY
See Also:
Constant Field Values

PROP_BANDWIDTH_SHARE_PERCENTAGE

public static final String PROP_BANDWIDTH_SHARE_PERCENTAGE
See Also:
Constant Field Values

DEFAULT_SHARE_PERCENTAGE

public static final int DEFAULT_SHARE_PERCENTAGE
See Also:
Constant Field Values
Constructor Detail

Router

public Router()
Instantiation only. Starts no threads. Does not install updates. RouterContext is created but not initialized. You must call runRouter() after any constructor to start things up.


Router

public Router(Properties envProps)

Router

public Router(String configFilename)

Router

public Router(String configFilename,
              Properties envProps)
Method Detail

clearCaches

public static final void clearCaches()
Since:
0.8.8

setKillVMOnEnd

public void setKillVMOnEnd(boolean shouldDie)
Configure the router to kill the JVM when the router shuts down, as well as whether to explicitly halt the JVM during the hard fail process.


getKillVMOnEnd

public boolean getKillVMOnEnd()
Deprecated. unused


getConfigFilename

public String getConfigFilename()
Returns:
absolute path

setConfigFilename

public void setConfigFilename(String filename)
Deprecated. unused


getConfigSetting

public String getConfigSetting(String name)

setConfigSetting

public void setConfigSetting(String name,
                             String value)
Warning, race between here and saveConfig(), saveConfig(String name, String value) or saveConfig(Map toAdd, Set toRemove) is recommended.

Since:
0.8.13

removeConfigSetting

public void removeConfigSetting(String name)
Warning, race between here and saveConfig(), saveConfig(String name, String value) or saveConfig(Map toAdd, Set toRemove) is recommended.

Since:
0.8.13

getConfigSettings

public Set<String> getConfigSettings()
Returns:
unmodifiable Set, unsorted

getConfigMap

public Map<String,String> getConfigMap()
Returns:
unmodifiable Map, unsorted

getRouterInfo

public RouterInfo getRouterInfo()
Warning, may be null if called very early


setRouterInfo

public void setRouterInfo(RouterInfo info)
Caller must ensure info is valid - no validation done here


getHigherVersionSeen

public boolean getHigherVersionSeen()
Deprecated. unused

True if the router has tried to communicate with another router who is running a higher incompatible protocol version.


setHigherVersionSeen

public void setHigherVersionSeen(boolean seen)
Deprecated. unused

True if the router has tried to communicate with another router who is running a higher incompatible protocol version.


getWhenStarted

public long getWhenStarted()

getUptime

public long getUptime()
wall clock uptime


getContext

public RouterContext getContext()

runRouter

public void runRouter()
This must be called after instantiation. Starts the threads. Does not install updates. Most users will just call main() instead.

Since:
public as of 0.9 for Android and other embedded uses

readConfig

public void readConfig()
This updates the config with all settings found in the file. It does not clear the config first, so settings not found in the file will remain in the config. This is synchronized with saveConfig()


isAlive

public boolean isAlive()

rebuildRouterInfo

public void rebuildRouterInfo()
Rebuild and republish our routerInfo since something significant has changed.


rebuildRouterInfo

public void rebuildRouterInfo(boolean blockingRebuild)

addCapabilities

public void addCapabilities(RouterInfo ri)

isHidden

public boolean isHidden()

createCertificate

public Certificate createCertificate()
Only called at startup via LoadRouterInfoJob and RebuildRouterInfoJob. Not called by periodic RepublishLocalRouterInfoJob. We don't want to change the cert on the fly as it changes the router hash. RouterInfo.isHidden() checks the capability, but RouterIdentity.isHidden() checks the cert. There's no reason to ever add a hidden cert?

Returns:
the certificate for a new RouterInfo - probably a null cert.

eventLog

public EventLog eventLog()
Since:
0.9.3

killKeys

public void killKeys()

rebuildNewIdentity

public void rebuildNewIdentity()
Rebuild a new identity the hard way - delete all of our old identity files, then reboot the router.


shutdown

public void shutdown(int exitCode)
Shutdown with no chance of cancellation


shutdown2

public void shutdown2(int exitCode)
Cancel the JVM runtime hook before calling this. Called by the ShutdownHook. NOT to be called by others, use shutdown().


shutdownGracefully

public void shutdownGracefully()
Call this if we want the router to kill itself as soon as we aren't participating in any more tunnels (etc). This will not block and doesn't guarantee any particular time frame for shutting down. To shut the router down immediately, use shutdown(int). If you want to cancel the graceful shutdown (prior to actual shutdown ;), call cancelGracefulShutdown().


shutdownGracefully

public void shutdownGracefully(int exitCode)
Call this with EXIT_HARD or EXIT_HARD_RESTART for a non-blocking, hard, non-graceful shutdown with a brief delay to allow a UI response


cancelGracefulShutdown

public void cancelGracefulShutdown()
Cancel any prior request to shut the router down gracefully.


scheduledGracefulExitCode

public int scheduledGracefulExitCode()
What exit code do we plan on using when we shut down (or -1, if there isn't a graceful shutdown planned)


gracefulShutdownInProgress

public boolean gracefulShutdownInProgress()
Is a graceful shutdown in progress? This may be cancelled.


isFinalShutdownInProgress

public boolean isFinalShutdownInProgress()
Is a final shutdown in progress? This may not be cancelled.

Since:
0.8.12

getShutdownTimeRemaining

public long getShutdownTimeRemaining()
How long until the graceful shutdown will kill us?


saveConfig

public boolean saveConfig()
Save the current config options (returning true if save was successful, false otherwise) Synchronized with file read in getConfig()


saveConfig

public boolean saveConfig(String name,
                          String value)
Updates the current config and then saves it. Prevents a race in the interval between setConfigSetting() / removeConfigSetting() and saveConfig(), Synchronized with getConfig() / saveConfig()

Parameters:
name - setting to add/change/remove before saving
value - if non-null, updated value; if null, setting will be removed
Returns:
success
Since:
0.8.13

saveConfig

public boolean saveConfig(Map toAdd,
                          Collection<String> toRemove)
Updates the current config and then saves it. Prevents a race in the interval between setConfigSetting() / removeConfigSetting() and saveConfig(), Synchronized with getConfig() / saveConfig()

Parameters:
toAdd - settings to add/change before saving, may be null or empty
toRemove - settings to remove before saving, may be null or empty
Returns:
success
Since:
0.8.13

clockShift

public void clockShift(long delta)
The clock shift listener. Restart the router if we should.

Specified by:
clockShift in interface RouterClock.ClockShiftListener
Parameters:
delta - The system clock and adjusted clock just changed by this much, in milliseconds (approximately)
Since:
0.8.8

restart

public void restart()
A "soft" restart, primarily of the comm system, after a port change or large step-change in system time. Does not stop the whole JVM, so it is safe even in the absence of the wrapper. This is not a graceful restart - all peer connections are dropped immediately. As of 0.8.8, this returns immediately and does the actual restart in a separate thread. Poll isAlive() if you need to know when the restart is complete.


setIsAlive

public void setIsAlive()
Only for Restarter

Since:
0.8.12

main

public static void main(String[] args)

getSharePercentage

public double getSharePercentage()
What fraction of the bandwidth specified in our bandwidth limits should we allow to be consumed by participating tunnels?

Returns:
a number less than one, not a percentage!

get1sRate

public int get1sRate()

get1sRate

public int get1sRate(boolean outboundOnly)

get1sRateIn

public int get1sRateIn()

get15sRate

public int get15sRate()

get15sRate

public int get15sRate(boolean outboundOnly)

get15sRateIn

public int get15sRateIn()

get1mRate

public int get1mRate()

get1mRate

public int get1mRate(boolean outboundOnly)

get1mRateIn

public int get1mRateIn()

get5mRate

public int get5mRate()

get5mRate

public int get5mRate(boolean outboundOnly)