net.i2p.router.tunnel.pool
Class TunnelPoolManager

java.lang.Object
  extended by net.i2p.router.tunnel.pool.TunnelPoolManager
All Implemented Interfaces:
Service, TunnelManagerFacade

public class TunnelPoolManager
extends java.lang.Object
implements TunnelManagerFacade


Constructor Summary
TunnelPoolManager(RouterContext ctx)
           
 
Method Summary
(package private)  void buildComplete()
           
(package private)  void buildComplete(PooledTunnelCreatorConfig cfg)
           
 void buildTunnels(Destination client, ClientTunnelSettings settings)
          the client connected (or updated their settings), so make sure we have the tunnels for them, and whenever necessary, ask them to authorize leases.
(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
 int getInboundClientTunnelCount()
          how many free inbound client tunnels do we have available?
 TunnelPoolSettings getInboundSettings()
           
 TunnelPoolSettings getInboundSettings(Hash client)
           
 long getLastParticipatingExpiration()
          When does the last tunnel we are participating in expire?
 int getOutboundClientTunnelCount()
          how many outbound client tunnels do we have available?
 TunnelPoolSettings getOutboundSettings()
           
 TunnelPoolSettings getOutboundSettings(Hash client)
           
 int getOutboundTunnelCount()
          how many outbound tunnels do we have available?
 int getParticipatingCount()
          how many tunnels are we participating in?
 TunnelInfo getTunnelInfo(TunnelId id)
          Retrieve the information related to a particular tunnel
 boolean isInUse(Hash peer)
          True if the peer currently part of a tunnel
(package private)  boolean isShutdown()
           
 boolean isValidTunnel(Hash client, TunnelInfo tunnel)
          Is a tunnel a valid member of the pool?
(package private)  void listPools(java.util.List out)
          list of TunnelPool instances currently in play
 void removeTunnels(Hash destination)
           
 void renderStatusHTML(java.io.Writer out)
           
 void restart()
          Perform a soft restart.
 TunnelInfo selectInboundTunnel()
          pick an inbound tunnel not bound to a particular destination
 TunnelInfo selectInboundTunnel(Hash destination)
          pick an inbound tunnel bound to the given destination
 TunnelInfo selectOutboundTunnel()
          pick an outbound tunnel not bound to a particular destination
 TunnelInfo selectOutboundTunnel(Hash destination)
          pick an outbound tunnel bound to the given destination
 void setInboundSettings(Hash client, TunnelPoolSettings settings)
           
 void setInboundSettings(TunnelPoolSettings settings)
           
 void setOutboundSettings(Hash client, TunnelPoolSettings settings)
           
 void setOutboundSettings(TunnelPoolSettings settings)
           
 void shutdown()
          Instruct the service that the router is shutting down and that it should do whatever is necessary to go down gracefully.
 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 Detail

TunnelPoolManager

public TunnelPoolManager(RouterContext ctx)
Method Detail

selectInboundTunnel

public TunnelInfo selectInboundTunnel()
pick an inbound tunnel not bound to a particular destination

Specified by:
selectInboundTunnel in interface TunnelManagerFacade

selectInboundTunnel

public TunnelInfo selectInboundTunnel(Hash destination)
pick an inbound tunnel bound to the given destination

Specified by:
selectInboundTunnel in interface TunnelManagerFacade

selectOutboundTunnel

public TunnelInfo selectOutboundTunnel()
pick an outbound tunnel not bound to a particular destination

Specified by:
selectOutboundTunnel in interface TunnelManagerFacade

selectOutboundTunnel

public TunnelInfo selectOutboundTunnel(Hash destination)
pick an outbound tunnel bound to the given destination

Specified by:
selectOutboundTunnel in interface TunnelManagerFacade

getTunnelInfo

public TunnelInfo getTunnelInfo(TunnelId id)
Description copied from interface: TunnelManagerFacade
Retrieve the information related to a particular tunnel

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

getOutboundTunnelCount

public int getOutboundTunnelCount()
Description copied from interface: TunnelManagerFacade
how many outbound tunnels do we have available?

Specified by:
getOutboundTunnelCount in interface TunnelManagerFacade

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

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

isInUse

public boolean isInUse(Hash peer)
Description copied from interface: TunnelManagerFacade
True if the peer currently part of a tunnel

Specified by:
isInUse in interface TunnelManagerFacade

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()
Specified by:
getInboundSettings in interface TunnelManagerFacade

getOutboundSettings

public TunnelPoolSettings getOutboundSettings()
Specified by:
getOutboundSettings in interface TunnelManagerFacade

setInboundSettings

public void setInboundSettings(TunnelPoolSettings settings)
Specified by:
setInboundSettings in interface TunnelManagerFacade

setOutboundSettings

public void setOutboundSettings(TunnelPoolSettings settings)
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)
Description copied from interface: TunnelManagerFacade
the client connected (or updated their settings), so make sure we have the tunnels for them, and whenever necessary, ask them to authorize leases.

Specified by:
buildTunnels in interface TunnelManagerFacade

removeTunnels

public void removeTunnels(Hash destination)

buildComplete

void buildComplete(PooledTunnelCreatorConfig cfg)

buildComplete

void buildComplete()

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()
Description copied from interface: Service
Instruct the service that the router is shutting down and that it should do whatever is necessary to go down gracefully. It should not depend on other components at this point. This call DOES block.

Specified by:
shutdown in interface Service

listPools

void listPools(java.util.List out)
list of TunnelPool instances currently in play


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

public void renderStatusHTML(java.io.Writer out)
                      throws java.io.IOException
Specified by:
renderStatusHTML in interface Service
Throws:
java.io.IOException