public class TunnelPoolSettings extends Object
Modifier and Type | Field and Description |
---|---|
static boolean |
DEFAULT_ALLOW_ZERO_HOP |
static int |
DEFAULT_BACKUP_QUANTITY |
static int |
DEFAULT_DURATION |
static int |
DEFAULT_IP_RESTRICTION |
static int |
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
don't trust this, always true
|
static String |
PROP_BACKUP_QUANTITY |
static String |
PROP_DURATION |
static String |
PROP_IP_RESTRICTION |
static String |
PROP_LENGTH |
static String |
PROP_LENGTH_VARIANCE |
static String |
PROP_NICKNAME |
static String |
PROP_PRIORITY |
static String |
PROP_QUANTITY |
static String |
PROP_RANDOM_KEY |
Constructor and Description |
---|
TunnelPoolSettings(boolean isInbound)
Exploratory tunnel
|
TunnelPoolSettings(Hash dest,
boolean isInbound)
Client tunnel unless dest == null
|
Modifier and Type | Method and Description |
---|---|
Set<Hash> |
getAliases()
Other destinations that use the same tunnel (or null if exploratory)
Modifiable, concurrent, not a copy
|
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?
Always true for exploratory.
|
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)
|
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)
|
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 should the length be varied.
|
int |
getPriority()
Outbound message priority - for outbound tunnels only
|
int |
getQuantity()
how many tunnels should be available at all times
|
Hash |
getRandomKey()
random key used for peer ordering
|
int |
getTotalQuantity()
Convenience
|
Properties |
getUnknownOptions() |
boolean |
isExploratory()
is this an exploratory tunnel (or a client tunnel)
|
boolean |
isInbound()
is this an inbound tunnel?
|
void |
readFromProperties(String prefix,
Properties props)
Defaults in props are NOT honored.
|
void |
setAliasOf(Hash h)
Set other destination that this is an alias of (or null).
|
void |
setAllowZeroHop(boolean ok)
If there are no tunnels to build with, will this pool allow 0 hop tunnels?
No effect on exploratory (always true)
|
void |
setBackupQuantity(int quantity) |
void |
setDestinationNickname(String name) |
void |
setIPRestriction(int b) |
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) |
void |
setQuantity(int quantity) |
String |
toString() |
void |
writeToProperties(String prefix,
Properties props) |
public static final String PREFIX_INBOUND_EXPLORATORY
public static final String PREFIX_OUTBOUND_EXPLORATORY
public static final String PROP_NICKNAME
public static final String PROP_QUANTITY
public static final String PROP_BACKUP_QUANTITY
public static final String PROP_DURATION
public static final String PROP_LENGTH
public static final String PROP_LENGTH_VARIANCE
public static final String PROP_ALLOW_ZERO_HOP
public static final String PROP_IP_RESTRICTION
public static final String PROP_PRIORITY
public static final String PROP_RANDOM_KEY
public static final int DEFAULT_QUANTITY
public static final int DEFAULT_BACKUP_QUANTITY
public static final int DEFAULT_DURATION
public static final boolean DEFAULT_ALLOW_ZERO_HOP
public static final int DEFAULT_IP_RESTRICTION
public TunnelPoolSettings(boolean isInbound)
public TunnelPoolSettings(Hash dest, boolean isInbound)
public int getQuantity()
public void setQuantity(int quantity)
public int getBackupQuantity()
public void setBackupQuantity(int quantity)
public int getTotalQuantity()
public int getLength()
public void setLength(int length)
length
- 0 to 7 (not enforced here)public boolean getAllowZeroHop()
public void setAllowZeroHop(boolean ok)
public int getLengthVariance()
public void setLengthVariance(int variance)
public int getLengthOverride()
public void setLengthOverride(int length)
public boolean isInbound()
public boolean isExploratory()
public Hash getDestination()
public Set<Hash> getAliases()
public Hash getAliasOf()
public void setAliasOf(Hash h)
public Hash getRandomKey()
public String getDestinationNickname()
public void setDestinationNickname(String name)
public int getIPRestriction()
public void setIPRestriction(int b)
public int getPriority()
public Properties getUnknownOptions()
public void readFromProperties(String prefix, Properties props)
prefix
- non-nullpublic void writeToProperties(String prefix, Properties props)
prefix
- non-null