net.i2p.router.dummy
Class DummyTunnelManagerFacade

java.lang.Object
  net.i2p.router.dummy.DummyTunnelManagerFacade

All Implemented Interfaces:

Service, TunnelManagerFacade

public class DummyTunnelManagerFacade
extends Object
implements TunnelManagerFacade

Build and maintain tunnels throughout the network.

Constructor Summary

DummyTunnelManagerFacade()

Method Summary

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.
void	fail(Hash peer)
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
TunnelPoolSettings	getInboundSettings()
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) how many outbound client tunnels in this pool?
TunnelPool	getOutboundExploratoryPool() for TunnelRenderer in router console
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?
double	getShareRatio()
TunnelInfo	getTunnelInfo(TunnelId id) Retrieve the information related to a particular tunnel
boolean	isValidTunnel(Hash client, TunnelInfo tunnel) Is a tunnel a valid member of the pool?
void	listPools(List<TunnelPool> out) for TunnelRenderer in router console
void	renderStatusHTML(Writer out)
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()
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DummyTunnelManagerFacade

public DummyTunnelManagerFacade()

Method Detail

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

selectInboundTunnel

public TunnelInfo selectInboundTunnel()

Description copied from interface: TunnelManagerFacade

Pick a random inbound exploratory tunnel

Specified by:

selectInboundTunnel in interface TunnelManagerFacade

Returns:

null if none

selectInboundTunnel

public TunnelInfo selectInboundTunnel(Hash destination)

Description copied from interface: TunnelManagerFacade

Pick a random inbound tunnel from the given destination's pool

Specified by:

selectInboundTunnel in interface TunnelManagerFacade

Parameters:

destination - if null, returns inbound exploratory tunnel

Returns:

null if none

selectOutboundTunnel

public TunnelInfo selectOutboundTunnel()

Description copied from interface: TunnelManagerFacade

Pick a random outbound exploratory tunnel

Specified by:

selectOutboundTunnel in interface TunnelManagerFacade

Returns:

null if none

selectOutboundTunnel

public TunnelInfo selectOutboundTunnel(Hash destination)

Description copied from interface: TunnelManagerFacade

Pick a random outbound tunnel from the given destination's pool

Specified by:

selectOutboundTunnel in interface TunnelManagerFacade

Parameters:

destination - if null, returns outbound exploratory tunnel

Returns:

null if none

selectInboundExploratoryTunnel

public TunnelInfo selectInboundExploratoryTunnel(Hash closestTo)

Description copied from interface: TunnelManagerFacade

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

selectInboundTunnel

public TunnelInfo selectInboundTunnel(Hash destination,
                                      Hash closestTo)

Description copied from interface: TunnelManagerFacade

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

selectOutboundExploratoryTunnel

public TunnelInfo selectOutboundExploratoryTunnel(Hash closestTo)

Description copied from interface: TunnelManagerFacade

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

selectOutboundTunnel

public TunnelInfo selectOutboundTunnel(Hash destination,
                                       Hash closestTo)

Description copied from interface: TunnelManagerFacade

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

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

getParticipatingCount

public int getParticipatingCount()

Description copied from interface: TunnelManagerFacade

how many tunnels are we participating in?

Specified by:

getParticipatingCount in interface TunnelManagerFacade

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

getShareRatio

public double getShareRatio()

Specified by:

getShareRatio 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)

Description copied from interface: TunnelManagerFacade

how many outbound client tunnels in this pool?

Specified by:

getOutboundClientTunnelCount 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

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

getInboundSettings

public TunnelPoolSettings getInboundSettings()

Specified by:

getInboundSettings in interface TunnelManagerFacade

getOutboundSettings

public TunnelPoolSettings getOutboundSettings()

Specified by:

getOutboundSettings 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(TunnelPoolSettings settings)

Specified by:

setInboundSettings in interface TunnelManagerFacade

setOutboundSettings

public void setOutboundSettings(TunnelPoolSettings settings)

Specified by:

setOutboundSettings 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

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

selectPeersInTooManyTunnels

public Set<Hash> selectPeersInTooManyTunnels()

Specified by:

selectPeersInTooManyTunnels in interface TunnelManagerFacade

Returns:

Set of peers that should not be allowed to be in another tunnel

renderStatusHTML

public void renderStatusHTML(Writer out)
                      throws IOException

Specified by:

renderStatusHTML in interface Service

Throws:

IOException

restart

public void restart()

Description copied from interface: Service

Perform a soft restart.

Specified by:

restart 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

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

listPools

public void listPools(List<TunnelPool> out)

Description copied from interface: TunnelManagerFacade

for TunnelRenderer in router console

Specified by:

listPools in interface TunnelManagerFacade

getInboundClientPools

public Map<Hash,TunnelPool> getInboundClientPools()

Description copied from interface: TunnelManagerFacade

for TunnelRenderer in router console

Specified by:

getInboundClientPools in interface TunnelManagerFacade

getOutboundClientPools

public Map<Hash,TunnelPool> getOutboundClientPools()

Description copied from interface: TunnelManagerFacade

for TunnelRenderer in router console

Specified by:

getOutboundClientPools in interface TunnelManagerFacade

getInboundExploratoryPool

public TunnelPool getInboundExploratoryPool()

Description copied from interface: TunnelManagerFacade

for TunnelRenderer in router console

Specified by:

getInboundExploratoryPool in interface TunnelManagerFacade

getOutboundExploratoryPool

public TunnelPool getOutboundExploratoryPool()

Description copied from interface: TunnelManagerFacade

for TunnelRenderer in router console

Specified by:

getOutboundExploratoryPool in interface TunnelManagerFacade

fail

public void fail(Hash peer)

Specified by:

fail in interface TunnelManagerFacade