net.i2p.router.tunnel.pool

Class TunnelPeerSelector

java.lang.Object

net.i2p.router.tunnel.pool.ConnectChecker

net.i2p.router.tunnel.pool.TunnelPeerSelector

Direct Known Subclasses:

ClientPeerSelector, ExploratoryPeerSelector

public abstract class TunnelPeerSelector
extends ConnectChecker

Coordinate the selection of peers to go into a tunnel for one particular pool.

Field Summary

Fields inherited from class net.i2p.router.tunnel.pool.ConnectChecker

ANY_V4, ctx, log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TunnelPeerSelector(RouterContext context)

Method Summary

Modifier and Type	Method and Description
protected boolean	checkTunnel(boolean isInbound, List<net.i2p.data.Hash> tunnel) Connectivity check.
protected boolean	filterSlow(boolean isInbound, boolean isExploratory) do we want to skip peers that are slow?
protected Set<net.i2p.data.Hash>	getClosestHopExclude(boolean isInbound) Pick peers that we want to avoid for the first OB hop or last IB hop.
Set<net.i2p.data.Hash>	getExclude(boolean isInbound, boolean isExploratory) Pick peers that we want to avoid
protected int	getLength(TunnelPoolSettings settings)
protected boolean	isIPv6Only() Are we IPv6 only?
protected void	orderPeers(List<net.i2p.data.Hash> rv, net.i2p.data.Hash hash) see HashComparator
protected List<net.i2p.data.Hash>	selectExplicit(TunnelPoolSettings settings, int length) For debugging, also possibly for restricted routes? Needs analysis and testing
abstract List<net.i2p.data.Hash>	selectPeers(TunnelPoolSettings settings) Which peers should go into the next tunnel for the given settings?
static boolean	shouldExclude(RouterContext ctx, RouterInfo peer) warning, this is also called by ProfileOrganizer.isSelectable()
protected boolean	shouldSelectExplicit(TunnelPoolSettings settings) For debugging, also possibly for restricted routes? Needs analysis and testing

Methods inherited from class net.i2p.router.tunnel.pool.ConnectChecker

canConnect, canConnect, canConnect, getInboundMask, getOutboundMask, isNTCPDisabled, isSSUDisabled

Methods inherited from class java.lang.Object

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

Constructor Detail

TunnelPeerSelector

protected TunnelPeerSelector(RouterContext context)

Method Detail

selectPeers

public abstract List<net.i2p.data.Hash> selectPeers(TunnelPoolSettings settings)

Which peers should go into the next tunnel for the given settings?

Returns:

ordered list of Hash objects (one per peer) specifying what order they should appear in a tunnel (ENDPOINT FIRST). This includes the local router in the list. If there are no tunnels or peers to build through, and the settings reject 0 hop tunnels, this will return null.

getLength

protected int getLength(TunnelPoolSettings settings)

Returns:

randomized number of hops 0-7, not including ourselves

shouldSelectExplicit

protected boolean shouldSelectExplicit(TunnelPoolSettings settings)

For debugging, also possibly for restricted routes? Needs analysis and testing

Returns:

usually false

selectExplicit

protected List<net.i2p.data.Hash> selectExplicit(TunnelPoolSettings settings,
                                                 int length)

For debugging, also possibly for restricted routes? Needs analysis and testing

Returns:

the peers

getExclude

public Set<net.i2p.data.Hash> getExclude(boolean isInbound,
                                         boolean isExploratory)

Pick peers that we want to avoid

isIPv6Only

protected boolean isIPv6Only()

Are we IPv6 only?

Since:

0.9.34

getClosestHopExclude

protected Set<net.i2p.data.Hash> getClosestHopExclude(boolean isInbound)

Pick peers that we want to avoid for the first OB hop or last IB hop. There's several cases of importance:

1. Inbound and we are hidden - Exclude all unless connected. This is taken care of in ClientPeerSelector and TunnelPeerSelector selectPeers(), not here.
2. We are IPv6-only. Exclude all v4-only peers, unless connected This is taken care of here.
3. We have NTCP or SSU disabled. Exclude all incompatible peers, unless connected This is taken care of here.
4. Minimum version check, if we are some brand-new sig type, or are using some new tunnel build method. Not currently used, but this is where to implement the checks if needed. Make sure that ClientPeerSelector and TunnelPeerSelector selectPeers() call this when needed.

Don't call this unless you need to. See ClientPeerSelector and TunnelPeerSelector selectPeers().

Parameters:

isInbound -

Returns:

null if none

Since:

0.9.17

shouldExclude

public static boolean shouldExclude(RouterContext ctx,
                                    RouterInfo peer)

warning, this is also called by ProfileOrganizer.isSelectable()

filterSlow

protected boolean filterSlow(boolean isInbound,
                             boolean isExploratory)

do we want to skip peers that are slow?

Returns:

true unless configured otherwise

orderPeers

protected void orderPeers(List<net.i2p.data.Hash> rv,
                          net.i2p.data.Hash hash)

see HashComparator

checkTunnel

protected boolean checkTunnel(boolean isInbound,
                              List<net.i2p.data.Hash> tunnel)

Connectivity check. Check that each hop can connect to the next, including us. Check that the OBEP is not IPv6-only, and the IBGW is reachable and not hidden or IPv6-only. Tells the profile manager to blame the hop, and returns false on failure.

Parameters:

tunnel - ENDPOINT FIRST, GATEWAY LAST!!!!, length 2 or greater

Returns:

ok

Since:

0.9.34