TunnelPoolSettings (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- net.i2p.router.TunnelPoolSettings

public class TunnelPoolSettings
extends Object

Wrap up the settings for a pool of tunnels.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_ALLOW_ZERO_HOP` DEFAULT_ALLOW_ZERO_HOP.
`static int`	`DEFAULT_BACKUP_QUANTITY` DEFAULT_BACKUP_QUANTITY.
`static int`	`DEFAULT_DURATION` DEFAULT_DURATION.
`static int`	`DEFAULT_IP_RESTRICTION` B.
`static int`	`DEFAULT_QUANTITY` DEFAULT_QUANTITY.
`static String`	`PREFIX_INBOUND_EXPLORATORY` Prefix used to configure the inbound exploratory pool
`static String`	`PREFIX_OUTBOUND_EXPLORATORY` Prefix used to configure the outbound exploratory pool
`static String`	`PROP_ALLOW_ZERO_HOP` Config property allowing zero-hop tunnels; unreliable, zero hops are always possible
`static String`	`PROP_BACKUP_QUANTITY` PROP_BACKUP_QUANTITY.
`static String`	`PROP_DURATION` PROP_DURATION.
`static String`	`PROP_IP_RESTRICTION` PROP_IP_RESTRICTION.
`static String`	`PROP_LENGTH` PROP_LENGTH.
`static String`	`PROP_LENGTH_VARIANCE` PROP_LENGTH_VARIANCE.
`static String`	`PROP_NICKNAME` PROP_NICKNAME.
`static String`	`PROP_PRIORITY` PROP_PRIORITY.
`static String`	`PROP_QUANTITY` PROP_QUANTITY.
`static String`	`PROP_RANDOM_KEY`
`static String`	`PROP_SHOULD_TEST` PROP_SHOULD_TEST.

Constructor Summary
Constructors
Constructor and Description
TunnelPoolSettings(boolean isInbound)
Exploratory tunnel
TunnelPoolSettings(Hash dest, boolean isInbound)
Client tunnel unless dest == null

Constructors
Constructor and Description
`TunnelPoolSettings(boolean isInbound)` Exploratory tunnel
`TunnelPoolSettings(Hash dest, boolean isInbound)` Client tunnel unless dest == null

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Set<Hash>`	`getAliases()` Other destinations that use the same tunnel (or null if exploratory).
`Hash`	`getAliasOf()` Other destination that this is an alias of (or null).
`boolean`	`getAllowZeroHop()` If there are no tunnels to build with, will this pool allow 0 hop tunnels? As of 0.9.44, same goes for exploratory: Prior to 0.9.35, generally true for client.
`int`	`getBackupQuantity()` How many backup tunnels should be kept waiting in the wings
`Hash`	`getDestination()` What destination is this a client tunnel for (or null if exploratory)
`String`	`getDestinationNickname()` What user supplied name was given to the client connected (can be null)
`Set<Hash>`	`getFirstPeerExclusions()` First peer exclusions for diversity.
`int`	`getIPRestriction()` How many bytes to match to determine if a router's IP is too close to another's to be in the same tunnel (1-4, 0 to disable) Support removed in the ClientPeerSelector in 0.8.6; restored in 0.9.53
`Set<Hash>`	`getLastPeerExclusions()` Last peer exclusions for diversity.
`int`	`getLength()` How many remote hops should be in the tunnel NOT including us
`int`	`getLengthOverride()` A temporary length to be used due to network conditions.
`int`	`getLengthVariance()` How the length should be varied.
`long`	`getMsgIdBloomXor()` The msg ID bloom xor value used to randomize message IDs.
`int`	`getPriority()` Outbound message priority - for outbound tunnels only
`int`	`getQuantity()` How many tunnels should be available at all times
`SessionKey`	`getRandomKey()` Random key used for peer ordering.
`int`	`getTotalQuantity()` Convenience
`Properties`	`getUnknownOptions()` Options not recognized when reading from properties.
`boolean`	`isExploratory()` Is this an exploratory tunnel (or a client tunnel)
`boolean`	`isInbound()` Is this an inbound tunnel?
`boolean`	`isZeroHop()` Whether the pool is expressly configured for zero-hop tunnels, by length 0 or lengthOverride 0.
`void`	`readFromProperties(String prefix, Properties props)` Defaults in props are NOT honored.
`void`	`setAliasOf(Hash h)` Other destination that this is an alias of (or null).
`void`	`setBackupQuantity(int quantity)` How many backup tunnels should be kept waiting in the wings.
`void`	`setDestinationNickname(String name)` User supplied name given to the connected client.
`void`	`setFirstPeerExclusions(Set<Hash> exclusions)` First peer exclusions for diversity.
`void`	`setLastPeerExclusions(Set<Hash> exclusions)` Last peer exclusions for diversity.
`void`	`setLength(int length)` How many remote hops should be in the tunnel NOT including us
`void`	`setLengthOverride(int length)` A temporary length to be used due to network conditions.
`void`	`setLengthVariance(int variance)` How the length should be varied.
`void`	`setQuantity(int quantity)` How many tunnels should be available at all times.
`boolean`	`shouldTest()` Should tunnels in this pool be tested?
`String`	`toString()` String representation of these settings for debugging.
`void`	`writeToProperties(String prefix, Properties props)` Write the settings into the given properties map.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_ALLOW_ZERO_HOP
```
public static final boolean DEFAULT_ALLOW_ZERO_HOP
```
    DEFAULT_ALLOW_ZERO_HOP.
    See Also:
    Constant Field Values
  - DEFAULT_BACKUP_QUANTITY
```
public static final int DEFAULT_BACKUP_QUANTITY
```
    DEFAULT_BACKUP_QUANTITY.
    See Also:
    Constant Field Values
  - DEFAULT_DURATION
```
public static final int DEFAULT_DURATION
```
    DEFAULT_DURATION.
    See Also:
    Constant Field Values
  - DEFAULT_IP_RESTRICTION
```
public static final int DEFAULT_IP_RESTRICTION
```
    B.
    See Also:
    Constant Field Values
  - DEFAULT_QUANTITY
```
public static final int DEFAULT_QUANTITY
```
    DEFAULT_QUANTITY.
    See Also:
    Constant Field Values
  - PREFIX_INBOUND_EXPLORATORY
```
public static final String PREFIX_INBOUND_EXPLORATORY
```
    Prefix used to configure the inbound exploratory pool
    See Also:
    Constant Field Values
  - PREFIX_OUTBOUND_EXPLORATORY
```
public static final String PREFIX_OUTBOUND_EXPLORATORY
```
    Prefix used to configure the outbound exploratory pool
    See Also:
    Constant Field Values
  - PROP_ALLOW_ZERO_HOP
```
public static final String PROP_ALLOW_ZERO_HOP
```
    Config property allowing zero-hop tunnels; unreliable, zero hops are always possible
    See Also:
    Constant Field Values
  - PROP_BACKUP_QUANTITY
```
public static final String PROP_BACKUP_QUANTITY
```
    PROP_BACKUP_QUANTITY.
    See Also:
    Constant Field Values
  - PROP_DURATION
```
public static final String PROP_DURATION
```
    PROP_DURATION.
    See Also:
    Constant Field Values
  - PROP_IP_RESTRICTION
```
public static final String PROP_IP_RESTRICTION
```
    PROP_IP_RESTRICTION.
    See Also:
    Constant Field Values
  - PROP_LENGTH
```
public static final String PROP_LENGTH
```
    PROP_LENGTH.
    See Also:
    Constant Field Values
  - PROP_LENGTH_VARIANCE
```
public static final String PROP_LENGTH_VARIANCE
```
    PROP_LENGTH_VARIANCE.
    See Also:
    Constant Field Values
  - PROP_NICKNAME
```
public static final String PROP_NICKNAME
```
    PROP_NICKNAME.
    See Also:
    Constant Field Values
  - PROP_PRIORITY
```
public static final String PROP_PRIORITY
```
    PROP_PRIORITY.
    See Also:
    Constant Field Values
  - PROP_QUANTITY
```
public static final String PROP_QUANTITY
```
    PROP_QUANTITY.
    See Also:
    Constant Field Values
  - PROP_RANDOM_KEY
```
public static final String PROP_RANDOM_KEY
```
    See Also:
    Constant Field Values
  - PROP_SHOULD_TEST
```
public static final String PROP_SHOULD_TEST
```
    PROP_SHOULD_TEST.
    See Also:
    Constant Field Values
- Constructor Detail
  - TunnelPoolSettings
```
public TunnelPoolSettings(boolean isInbound)
```
    Exploratory tunnel
  - TunnelPoolSettings
```
public TunnelPoolSettings(Hash dest,
                          boolean isInbound)
```
    Client tunnel unless dest == null
- Method Detail
  - getAliases
```
public Set<Hash> getAliases()
```
    Other destinations that use the same tunnel (or null if exploratory). Modifiable, concurrent, not a copy
    Returns:
    the aliases
  - getAliasOf
```
public Hash getAliasOf()
```
    Other destination that this is an alias of (or null). If non-null, don't build tunnels.
    Returns:
    the alias of
  - getAllowZeroHop
```
public boolean getAllowZeroHop()
```
    If there are no tunnels to build with, will this pool allow 0 hop tunnels? As of 0.9.44, same goes for exploratory: Prior to 0.9.35, generally true for client. As of 0.9.35, generally false for client, but true if getLength() + Math.min(getLengthVariance(), 0) <= 0, OR if getLengthOverride() == 0
    Returns:
    the allow zero hop
  - getBackupQuantity
```
public int getBackupQuantity()
```
    How many backup tunnels should be kept waiting in the wings
  - getDestination
```
public Hash getDestination()
```
    What destination is this a client tunnel for (or null if exploratory)
  - getDestinationNickname
```
public String getDestinationNickname()
```
    What user supplied name was given to the client connected (can be null)
  - getFirstPeerExclusions
```
public Set<Hash> getFirstPeerExclusions()
```
    First peer exclusions for diversity. These are peers that should not be used as the first hop in new tunnels.
    Returns:
    Set of peer hashes to exclude, or null if none set
  - getIPRestriction
```
public int getIPRestriction()
```
    How many bytes to match to determine if a router's IP is too close to another's to be in the same tunnel (1-4, 0 to disable) Support removed in the ClientPeerSelector in 0.8.6; restored in 0.9.53
    Returns:
    0-4 Number of bytes to match to determine if peers in the same IP range should not be in the same tunnel. 0 = disable check; 1 = /8; 2 = /16; 3 = /24; 4 = exact IP match
  - getLastPeerExclusions
```
public Set<Hash> getLastPeerExclusions()
```
    Last peer exclusions for diversity. These are peers that should not be used as the last hop in new tunnels.
    Returns:
    Set of peer hashes to exclude, or null if none set
  - getLength
```
public int getLength()
```
    How many remote hops should be in the tunnel NOT including us
    Returns:
    0 to 7
  - getLengthOverride
```
public int getLengthOverride()
```
    A temporary length to be used due to network conditions. If less than zero, the standard length should be used. Unused until 0.8.11
    Returns:
    the length override
  - getLengthVariance
```
public int getLengthVariance()
```
    How the length should be varied. If negative, this randomly skews from (length - variance) to (length + variance), or if positive, from length to (length + variance), inclusive.
    Returns:
    the length variance
  - getMsgIdBloomXor
```
public long getMsgIdBloomXor()
```
    The msg ID bloom xor value used to randomize message IDs.
    Returns:
    the msg id bloom xor
  - getPriority
```
public int getPriority()
```
    Outbound message priority - for outbound tunnels only
    Returns:
    -25 to +30, default 30 for outbound exploratory and 0 for others
  - getQuantity
```
public int getQuantity()
```
    How many tunnels should be available at all times
  - getRandomKey
```
public SessionKey getRandomKey()
```
    Random key used for peer ordering.
    Returns:
    non-null
  - getTotalQuantity
```
public int getTotalQuantity()
```
    Convenience
    Returns:
    getQuantity() + getBackupQuantity()
  - getUnknownOptions
```
public Properties getUnknownOptions()
```
    Options not recognized when reading from properties.
    Returns:
    non-null
  - isExploratory
```
public boolean isExploratory()
```
    Is this an exploratory tunnel (or a client tunnel)
  - isInbound
```
public boolean isInbound()
```
    Is this an inbound tunnel?
  - isZeroHop
```
public boolean isZeroHop()
```
    Whether the pool is expressly configured for zero-hop tunnels, by length 0 or lengthOverride 0. Excludes the allowZeroHop fallback flag, which permits zero hops only as a last resort.
    Returns:
    true if zero hops are the configured tunnel length
  - readFromProperties
```
public void readFromProperties(String prefix,
                               Properties props)
```
    Defaults in props are NOT honored. In-JVM client side must promote defaults to the primary map.
    Parameters:
    prefix - non-null
  - setAliasOf
```
public void setAliasOf(Hash h)
```
    Other destination that this is an alias of (or null). If non-null, don't build tunnels.
  - setBackupQuantity
```
public void setBackupQuantity(int quantity)
```
    How many backup tunnels should be kept waiting in the wings.
    Parameters:
    quantity - the desired backup quantity
  - setDestinationNickname
```
public void setDestinationNickname(String name)
```
    User supplied name given to the connected client.
    Parameters:
    name - the nickname, or null
  - setFirstPeerExclusions
```
public void setFirstPeerExclusions(Set<Hash> exclusions)
```
    First peer exclusions for diversity.
    Parameters:
    exclusions - Set of peer hashes to exclude, or null to clear
  - setLastPeerExclusions
```
public void setLastPeerExclusions(Set<Hash> exclusions)
```
    Last peer exclusions for diversity.
    Parameters:
    exclusions - Set of peer hashes to exclude, or null to clear
  - setLength
```
public void setLength(int length)
```
    How many remote hops should be in the tunnel NOT including us
    Parameters:
    length - 0 to 7 (not enforced here)
  - setLengthOverride
```
public void setLengthOverride(int length)
```
    A temporary length to be used due to network conditions. If less than zero, the standard length will be used. Unused until 0.8.11
  - setLengthVariance
```
public void setLengthVariance(int variance)
```
    How the length should be varied.
    Parameters:
    variance - the length variance
  - setQuantity
```
public void setQuantity(int quantity)
```
    How many tunnels should be available at all times.
    Parameters:
    quantity - the desired quantity
  - shouldTest
```
public boolean shouldTest()
```
    Should tunnels in this pool be tested?
    Returns:
    true for normal pools, false for hostchecker/ping tunnels
  - toString
```
public String toString()
```
    String representation of these settings for debugging.
    Overrides:
    toString in class Object
  - writeToProperties
```
public void writeToProperties(String prefix,
                              Properties props)
```
    Write the settings into the given properties map.
    Parameters:
    prefix - non-null

Class TunnelPoolSettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ALLOW_ZERO_HOP

DEFAULT_BACKUP_QUANTITY

DEFAULT_DURATION

DEFAULT_IP_RESTRICTION

DEFAULT_QUANTITY

PREFIX_INBOUND_EXPLORATORY

PREFIX_OUTBOUND_EXPLORATORY

PROP_ALLOW_ZERO_HOP

PROP_BACKUP_QUANTITY

PROP_DURATION

PROP_IP_RESTRICTION

PROP_LENGTH

PROP_LENGTH_VARIANCE

PROP_NICKNAME

PROP_PRIORITY

PROP_QUANTITY

PROP_RANDOM_KEY

PROP_SHOULD_TEST

Constructor Detail

TunnelPoolSettings

TunnelPoolSettings

Method Detail

getAliases

getAliasOf

getAllowZeroHop

getBackupQuantity

getDestination

getDestinationNickname

getFirstPeerExclusions

getIPRestriction

getLastPeerExclusions

getLength

getLengthOverride

getLengthVariance

getMsgIdBloomXor

getPriority

getQuantity

getRandomKey

getTotalQuantity

getUnknownOptions

isExploratory

isInbound

isZeroHop

readFromProperties

setAliasOf

setBackupQuantity

setDestinationNickname

setFirstPeerExclusions

setLastPeerExclusions

setLength

setLengthOverride

setLengthVariance

setQuantity

shouldTest

toString

writeToProperties