net.i2p.router.tunnel.pool.TunnelPoolManager

All Implemented Interfaces:: Service, TunnelManagerFacade

public class TunnelPoolManager
extends Object
implements TunnelManagerFacade

Manage all the exploratory and client tunnel pools. Run the tunnel builder and handler threads.

Constructor Summary

Constructors

Constructor Description

TunnelPoolManager(RouterContext ctx)

Method Summary

Modifier and Type	Method	Description
`boolean`	`addAlias(Destination dest, ClientTunnelSettings settings, Destination existingClient)`	Add another destination to the same tunnels.
`(package private) void`	`buildComplete(PooledTunnelCreatorConfig cfg)`	queue a recurring test job if appropriate
`void`	`buildTunnels(Destination client, ClientTunnelSettings settings)`	Used only at session startup.
`boolean`	`disableTunnelTesting()`
`void`	`fail(Hash peer)`	Fail all outbound tunnels with this peer as first hop, and all inbound tunnels with this peer as the last hop, baecause we can't contact it any more.
`(package private) BuildExecutor`	`getExecutor()`
`int`	`getFreeTunnelCount()`	how many free inbound tunnels do we have available?
`int`	`getInboundBuildQueueSize()`	count how many inbound tunnel requests we have received but not yet processed
`Map<Hash,TunnelPool>`	`getInboundClientPools()`	for TunnelRenderer in router console
`int`	`getInboundClientTunnelCount()`	how many free inbound client tunnels do we have available?
`TunnelPool`	`getInboundExploratoryPool()`	For TunnelRenderer in router console
`TunnelPool`	`getInboundPool(Hash client)`
`TunnelPoolSettings`	`getInboundSettings()`	exploratory
`TunnelPoolSettings`	`getInboundSettings(Hash client)`
`long`	`getLastParticipatingExpiration()`	When does the last tunnel we are participating in expire?
`Map<Hash,TunnelPool>`	`getOutboundClientPools()`	for TunnelRenderer in router console
`int`	`getOutboundClientTunnelCount()`	how many outbound client tunnels do we have available?
`int`	`getOutboundClientTunnelCount(Hash destination)`	Use to verify a tunnel pool is alive
`TunnelPool`	`getOutboundExploratoryPool()`	For TunnelRenderer in router console
`TunnelPool`	`getOutboundPool(Hash client)`
`TunnelPoolSettings`	`getOutboundSettings()`	exploratory
`TunnelPoolSettings`	`getOutboundSettings(Hash client)`
`int`	`getOutboundTunnelCount()`	how many outbound tunnels do we have available?
`int`	`getParticipatingCount()`	how many tunnels are we participating in?
`double`	`getShareRatio()`
`TunnelInfo`	`getTunnelInfo(TunnelId id)`	Deprecated. unused
`(package private) boolean`	`isShutdown()`
`boolean`	`isValidTunnel(Hash client, TunnelInfo tunnel)`	Is a tunnel a valid member of the pool?
`void`	`listPools(List<TunnelPool> out)`	list of TunnelPool instances currently in play
`void`	`removeAlias(Destination dest)`	Remove a destination for the same tunnels as another.
`void`	`removeTunnels(Destination dest)`	Must be called AFTER deregistration by the client manager.
`void`	`removeTunnels(Hash destination)`	This will be called twice, once by the inbound and once by the outbound pool.
`void`	`renderStatusHTML(Writer out)`	Deprecated. moved to routerconsole
`void`	`restart()`	Perform a soft restart.
`TunnelInfo`	`selectInboundExploratoryTunnel(Hash closestTo)`	Pick the inbound exploratory tunnel with the gateway closest to the given hash.
`TunnelInfo`	`selectInboundTunnel()`	Pick a random inbound exploratory tunnel.
`TunnelInfo`	`selectInboundTunnel(Hash destination)`	Pick a random inbound tunnel from the given destination's pool.
`TunnelInfo`	`selectInboundTunnel(Hash destination, Hash closestTo)`	Pick the inbound tunnel with the gateway closest to the given hash from the given destination's pool.
`TunnelInfo`	`selectOutboundExploratoryTunnel(Hash closestTo)`	Pick the outbound exploratory tunnel with the endpoint closest to the given hash.
`TunnelInfo`	`selectOutboundTunnel()`	Pick a random outbound exploratory tunnel.
`TunnelInfo`	`selectOutboundTunnel(Hash destination)`	Pick a random outbound tunnel from the given destination's pool.
`TunnelInfo`	`selectOutboundTunnel(Hash destination, Hash closestTo)`	Pick the outbound tunnel with the endpoint closest to the given hash from the given destination's pool.
`Set<Hash>`	`selectPeersInTooManyTunnels()`	For reliability reasons, don't allow a peer in more than x% of client and exploratory tunnels.
`void`	`setInboundSettings(Hash client, TunnelPoolSettings settings)`
`void`	`setInboundSettings(TunnelPoolSettings settings)`	exploratory
`void`	`setOutboundSettings(Hash client, TunnelPoolSettings settings)`
`void`	`setOutboundSettings(TunnelPoolSettings settings)`	exploratory
`void`	`shutdown()`	Cannot be restarted
`void`	`startup()`	Instruct the service that it should start normal operation.
`(package private) void`	`tunnelFailed()`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- TunnelPoolManager
  
  public TunnelPoolManager(RouterContext ctx)
Method Details
- selectInboundTunnel
  
  public TunnelInfo selectInboundTunnel()
  
  Pick a random inbound exploratory tunnel. Warning - selectInboundExploratoryTunnel(Hash) is preferred.
  
  Specified by:
  
  selectInboundTunnel in interface TunnelManagerFacade
  
  Returns:
  
  null if none
- selectInboundTunnel
  
  public TunnelInfo selectInboundTunnel(Hash destination)
  
  Pick a random inbound tunnel from the given destination's pool. Warning - selectOutboundTunnel(Hash, Hash) is preferred.
  
  Specified by:
  
  selectInboundTunnel in interface TunnelManagerFacade
  
  Parameters:
  
  destination - if null, returns inbound exploratory tunnel
  
  Returns:
  
  null if none
- selectOutboundTunnel
  
  public TunnelInfo selectOutboundTunnel()
  
  Pick a random outbound exploratory tunnel. Warning - selectOutboundExploratoryTunnel(Hash) is preferred.
  
  Specified by:
  
  selectOutboundTunnel in interface TunnelManagerFacade
  
  Returns:
  
  null if none
- selectOutboundTunnel
  
  public TunnelInfo selectOutboundTunnel(Hash destination)
  
  Pick a random outbound tunnel from the given destination's pool. Warning - selectOutboundTunnel(Hash, Hash) is preferred.
  
  Specified by:
  
  selectOutboundTunnel in interface TunnelManagerFacade
  
  Parameters:
  
  destination - if null, returns outbound exploratory tunnel
  
  Returns:
  
  null if none
- selectInboundExploratoryTunnel
  
  public TunnelInfo selectInboundExploratoryTunnel(Hash closestTo)
  
  Pick the inbound exploratory tunnel with the gateway closest to the given hash. By using this instead of the random selectTunnel(), we force some locality in OBEP-IBGW connections to minimize those connections network-wide.
  
  Specified by:
  
  selectInboundExploratoryTunnel in interface TunnelManagerFacade
  
  Parameters:
  
  closestTo - non-null
  
  Returns:
  
  null if none
  
  Since:
  
  0.8.10
- selectInboundTunnel
  
  public TunnelInfo selectInboundTunnel(Hash destination, Hash closestTo)
  
  Pick the inbound tunnel with the gateway closest to the given hash from the given destination's pool. By using this instead of the random selectTunnel(), we force some locality in OBEP-IBGW connections to minimize those connections network-wide.
  
  Specified by:
  
  selectInboundTunnel in interface TunnelManagerFacade
  
  Parameters:
  
  destination - if null, returns inbound exploratory tunnel
  
  closestTo - non-null
  
  Returns:
  
  null if none
  
  Since:
  
  0.8.10
- selectOutboundExploratoryTunnel
  
  public TunnelInfo selectOutboundExploratoryTunnel(Hash closestTo)
  
  Pick the outbound exploratory tunnel with the endpoint closest to the given hash. By using this instead of the random selectTunnel(), we force some locality in OBEP-IBGW connections to minimize those connections network-wide.
  
  Specified by:
  
  selectOutboundExploratoryTunnel in interface TunnelManagerFacade
  
  Parameters:
  
  closestTo - non-null
  
  Returns:
  
  null if none
  
  Since:
  
  0.8.10
- selectOutboundTunnel
  
  public TunnelInfo selectOutboundTunnel(Hash destination, Hash closestTo)
  
  Pick the outbound tunnel with the endpoint closest to the given hash from the given destination's pool. By using this instead of the random selectTunnel(), we force some locality in OBEP-IBGW connections to minimize those connections network-wide.
  
  Specified by:
  
  selectOutboundTunnel in interface TunnelManagerFacade
  
  Parameters:
  
  destination - if null, returns outbound exploratory tunnel
  
  closestTo - non-null
  
  Returns:
  
  null if none
  
  Since:
  
  0.8.10
- getTunnelInfo
  
  @Deprecated public TunnelInfo getTunnelInfo(TunnelId id)
  
  Deprecated.
  unused
  
  Expensive (iterates through all tunnels of all pools) and unnecessary.
  
  Specified by:
  
  getTunnelInfo in interface TunnelManagerFacade
  
  Parameters:
  
  id - the tunnelId as seen at the gateway
- getFreeTunnelCount
  
  public int getFreeTunnelCount()
  
  Description copied from interface: TunnelManagerFacade
  
  how many free inbound tunnels do we have available?
  
  Specified by:
  
  getFreeTunnelCount in interface TunnelManagerFacade
  
  Returns:
  
  number of inbound exploratory tunnels
- getOutboundTunnelCount
  
  public int getOutboundTunnelCount()
  
  Description copied from interface: TunnelManagerFacade
  
  how many outbound tunnels do we have available?
  
  Specified by:
  
  getOutboundTunnelCount in interface TunnelManagerFacade
  
  Returns:
  
  number of outbound exploratory tunnels
- getInboundClientTunnelCount
  
  public int getInboundClientTunnelCount()
  
  Description copied from interface: TunnelManagerFacade
  
  how many free inbound client tunnels do we have available?
  
  Specified by:
  
  getInboundClientTunnelCount in interface TunnelManagerFacade
- getOutboundClientTunnelCount
  
  public int getOutboundClientTunnelCount()
  
  Description copied from interface: TunnelManagerFacade
  
  how many outbound client tunnels do we have available?
  
  Specified by:
  
  getOutboundClientTunnelCount in interface TunnelManagerFacade
- getOutboundClientTunnelCount
  
  public int getOutboundClientTunnelCount(Hash destination)
  
  Use to verify a tunnel pool is alive
  
  Specified by:
  
  getOutboundClientTunnelCount in interface TunnelManagerFacade
  
  Since:
  
  0.7.11
- getParticipatingCount
  
  public int getParticipatingCount()
  
  Description copied from interface: TunnelManagerFacade
  
  how many tunnels are we participating in?
  
  Specified by:
  
  getParticipatingCount in interface TunnelManagerFacade
- getLastParticipatingExpiration
  
  public long getLastParticipatingExpiration()
  
  Description copied from interface: TunnelManagerFacade
  
  When does the last tunnel we are participating in expire?
  
  Specified by:
  
  getLastParticipatingExpiration in interface TunnelManagerFacade
- getShareRatio
  
  public double getShareRatio()
  
  Specified by:
  
  getShareRatio in interface TunnelManagerFacade
  
  Returns:
  
  (number of part. tunnels) / (estimated total number of hops in our expl.+client tunnels) We just use length setting, not variance, for speed
  
  Since:
  
  0.7.10
- isValidTunnel
  
  public boolean isValidTunnel(Hash client, TunnelInfo tunnel)
  
  Description copied from interface: TunnelManagerFacade
  
  Is a tunnel a valid member of the pool?
  
  Specified by:
  
  isValidTunnel in interface TunnelManagerFacade
- getInboundSettings
  
  public TunnelPoolSettings getInboundSettings()
  
  exploratory
  
  Specified by:
  
  getInboundSettings in interface TunnelManagerFacade
- getOutboundSettings
  
  public TunnelPoolSettings getOutboundSettings()
  
  exploratory
  
  Specified by:
  
  getOutboundSettings in interface TunnelManagerFacade
- setInboundSettings
  
  public void setInboundSettings(TunnelPoolSettings settings)
  
  exploratory
  
  Specified by:
  
  setInboundSettings in interface TunnelManagerFacade
- setOutboundSettings
  
  public void setOutboundSettings(TunnelPoolSettings settings)
  
  exploratory
  
  Specified by:
  
  setOutboundSettings in interface TunnelManagerFacade
- getInboundSettings
  
  public TunnelPoolSettings getInboundSettings(Hash client)
  
  Specified by:
  
  getInboundSettings in interface TunnelManagerFacade
- getOutboundSettings
  
  public TunnelPoolSettings getOutboundSettings(Hash client)
  
  Specified by:
  
  getOutboundSettings in interface TunnelManagerFacade
- setInboundSettings
  
  public void setInboundSettings(Hash client, TunnelPoolSettings settings)
  
  Specified by:
  
  setInboundSettings in interface TunnelManagerFacade
- setOutboundSettings
  
  public void setOutboundSettings(Hash client, TunnelPoolSettings settings)
  
  Specified by:
  
  setOutboundSettings in interface TunnelManagerFacade
- restart
  
  public void restart()
  
  Description copied from interface: Service
  
  Perform a soft restart.
  
  Specified by:
  
  restart in interface Service
- buildTunnels
  
  public void buildTunnels(Destination client, ClientTunnelSettings settings)
  
  Used only at session startup. Do not use to change settings. Do not use for aliased destinations; use addAlias().
  
  Specified by:
  
  buildTunnels in interface TunnelManagerFacade
- addAlias
  
  public boolean addAlias(Destination dest, ClientTunnelSettings settings, Destination existingClient)
  
  Add another destination to the same tunnels. Must have same encryption key and a different signing key.
  
  Specified by:
  
  addAlias in interface TunnelManagerFacade
  
  Returns:
  
  success
  
  Throws:
  
  IllegalArgumentException - if not
  
  Since:
  
  0.9.21
- removeAlias
  
  public void removeAlias(Destination dest)
  
  Remove a destination for the same tunnels as another.
  
  Specified by:
  
  removeAlias in interface TunnelManagerFacade
  
  Since:
  
  0.9.21
- removeTunnels
  
  public void removeTunnels(Destination dest)
  
  Must be called AFTER deregistration by the client manager.
  
  Specified by:
  
  removeTunnels in interface TunnelManagerFacade
  
  Since:
  
  0.9.48
- removeTunnels
  
  public void removeTunnels(Hash destination)
  
  This will be called twice, once by the inbound and once by the outbound pool. Synched with buildTunnels() above. Must be called AFTER deregistration by the client manager.
- buildComplete
  
  void buildComplete(PooledTunnelCreatorConfig cfg)
  
  queue a recurring test job if appropriate
- disableTunnelTesting
  
  public boolean disableTunnelTesting()
- startup
  
  public void startup()
  
  Description copied from interface: Service
  
  Instruct the service that it should start normal operation. This call DOES block until the service is ready.
  
  Specified by:
  
  startup in interface Service
- shutdown
  
  public void shutdown()
  
  Cannot be restarted
  
  Specified by:
  
  shutdown in interface Service
- listPools
  
  public void listPools(List<TunnelPool> out)
  
  list of TunnelPool instances currently in play
  
  Specified by:
  
  listPools in interface TunnelManagerFacade
- tunnelFailed
  
  void tunnelFailed()
- getExecutor
  
  BuildExecutor getExecutor()
- isShutdown
  
  boolean isShutdown()
- getInboundBuildQueueSize
  
  public int getInboundBuildQueueSize()
  
  Description copied from interface: TunnelManagerFacade
  
  count how many inbound tunnel requests we have received but not yet processed
  
  Specified by:
  
  getInboundBuildQueueSize in interface TunnelManagerFacade
- renderStatusHTML
  
  @Deprecated public void renderStatusHTML(Writer out) throws IOException
  
  Deprecated.
  moved to routerconsole
  
  Specified by:
  
  renderStatusHTML in interface Service
  
  Throws:
  
  IOException
- selectPeersInTooManyTunnels
  
  public Set<Hash> selectPeersInTooManyTunnels()
  
  For reliability reasons, don't allow a peer in more than x% of client and exploratory tunnels. This also will prevent a single huge-capacity (or malicious) peer from taking all the tunnels in the network (although it would be nice to limit the % of total network tunnels to 10% or so, but that appears to be too low to set as a default here... much lower than 33% will push client tunnels out of the fast tier into high cap or beyond...) Possible improvement - restrict based on count per IP, or IP block, to slightly increase costs of collusion
  
  Specified by:
  
  selectPeersInTooManyTunnels in interface TunnelManagerFacade
  
  Returns:
  
  Set of peers that should not be allowed in another tunnel
- getInboundClientPools
  
  public Map<Hash,TunnelPool> getInboundClientPools()
  
  for TunnelRenderer in router console
  
  Specified by:
  
  getInboundClientPools in interface TunnelManagerFacade
- getOutboundClientPools
  
  public Map<Hash,TunnelPool> getOutboundClientPools()
  
  for TunnelRenderer in router console
  
  Specified by:
  
  getOutboundClientPools in interface TunnelManagerFacade
- getInboundExploratoryPool
  
  public TunnelPool getInboundExploratoryPool()
  
  For TunnelRenderer in router console
  
  Specified by:
  
  getInboundExploratoryPool in interface TunnelManagerFacade
  
  Returns:
  
  non-null
- getOutboundExploratoryPool
  
  public TunnelPool getOutboundExploratoryPool()
  
  For TunnelRenderer in router console
  
  Specified by:
  
  getOutboundExploratoryPool in interface TunnelManagerFacade
  
  Returns:
  
  non-null
- getInboundPool
  
  public TunnelPool getInboundPool(Hash client)
  
  Specified by:
  
  getInboundPool in interface TunnelManagerFacade
  
  Returns:
  
  pool or null
  
  Since:
  
  0.9.34
- getOutboundPool
  
  public TunnelPool getOutboundPool(Hash client)
  
  Specified by:
  
  getOutboundPool in interface TunnelManagerFacade
  
  Returns:
  
  pool or null
  
  Since:
  
  0.9.34
- fail
  
  public void fail(Hash peer)
  
  Fail all outbound tunnels with this peer as first hop, and all inbound tunnels with this peer as the last hop, baecause we can't contact it any more. This is most likely to be triggered by an outbound tunnel.
  
  Specified by:
  
  fail in interface TunnelManagerFacade
  
  Since:
  
  0.8.13

Class TunnelPoolManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details