com.frostwire.jlibtorrent

Class DhtSettings

java.lang.Object

com.frostwire.jlibtorrent.DhtSettings

public final class DhtSettings
extends java.lang.Object

Structure used to hold configuration options for the DHT.

Constructor Summary

Constructors

Constructor and Description
DhtSettings()
DhtSettings(dht_settings s)

Method Summary

Modifier and Type	Method and Description
int	blockRatelimit() The max number of packets per second a DHT node is allowed to send without getting banned.
void	blockRatelimit(int value) The max number of packets per second a DHT node is allowed to send without getting banned.
int	blockTimeout() The number of seconds a DHT node is banned if it exceeds the rate limit.
void	blockTimeout(int value) The number of seconds a DHT node is banned if it exceeds the rate limit.
void	getAggressiveLookups(boolean value) slightly changes the lookup behavior in terms of how many outstanding requests we keep.
int	getMaxFailCount() the maximum number of failed tries to contact a node before it is removed from the routing table.
int	getMaxTorrentSearchReply() the max number of torrents to return in a torrent search query to the DHT.
int	getSearchBranching() the number of concurrent search request the node will send when announcing and refreshing the routing table.
boolean	isAggressiveLookups() slightly changes the lookup behavior in terms of how many outstanding requests we keep.
boolean	isEnforceNodeId() when set, node's whose IDs that are not correctly generated based on its external IP are ignored.
boolean	isExtendedRoutingTable() makes the first buckets in the DHT routing table fit 128, 64, 32 and 16 nodes respectively, as opposed to the standard size of 8.
boolean	isIgnoreDarkInternet() ignore DHT messages from parts of the internet we wouldn't expect to see any traffic from
boolean	isPrivacyLookups() when set, perform lookups in a way that is slightly more expensive, but which minimizes the amount of information leaked about you.
boolean	isRestrictRoutingIPs() determines if the routing table entries should restrict entries to one per IP.
boolean	isRestrictSearchIPs() determines if DHT searches should prevent adding nodes with IPs with very close CIDR distance.
int	itemLifetime() The number of seconds a immutable/mutable item will be expired.
void	itemLifetime(int value) The number of seconds a immutable/mutable item will be expired.
int	maxDhtItems() max number of items the DHT will store.
void	maxDhtItems(int value) max number of items the DHT will store.
int	maxPeers() The max number of peers to store per torrent (for the DHT).
void	maxPeers(int value) The max number of peers to store per torrent (for the DHT).
int	maxPeersReply() the maximum number of peers to send in a reply to ``get_peers``.
void	maxPeersReply(int value) the maximum number of peers to send in a reply to ``get_peers``.
int	maxTorrents() the total number of torrents to track from the DHT.
void	maxTorrents(int value) the total number of torrents to track from the DHT.
boolean	readOnly() When set, the other nodes won't keep this node in their routing tables, it's meant for low-power and/or ephemeral devices that cannot support the DHT, it is also useful for mobile devices which are sensitive to network traffic and battery life.
void	readOnly(boolean value) When set, the other nodes won't keep this node in their routing tables, it's meant for low-power and/or ephemeral devices that cannot support the DHT, it is also useful for mobile devices which are sensitive to network traffic and battery life.
void	setEnforceNodeId(boolean value) when set, node's whose IDs that are not correctly generated based on its external IP are ignored.
void	setExtendedRoutingTable(boolean value) makes the first buckets in the DHT routing table fit 128, 64, 32 and 16 nodes respectively, as opposed to the standard size of 8.
void	setIgnoreDarkInternet(boolean value) ignore DHT messages from parts of the internet we wouldn't expect to see any traffic from
void	setMaxFailCount(int value) the maximum number of failed tries to contact a node before it is removed from the routing table.
void	setMaxTorrentSearchReply(int value) the max number of torrents to return in a torrent search query to the DHT.
void	setPrivacyLookups(boolean value) when set, perform lookups in a way that is slightly more expensive, but which minimizes the amount of information leaked about you.
void	setRestrictRoutingIPs(boolean value) determines if the routing table entries should restrict entries to one per IP.
void	setRestrictSearchIPs(boolean value) determines if DHT searches should prevent adding nodes with IPs with very close CIDR distance.
void	setSearchBranching(int value) the number of concurrent search request the node will send when announcing and refreshing the routing table.
dht_settings	swig()
int	uploadRateLimit() The number of bytes per second (on average) the DHT is allowed to send.
void	uploadRateLimit(int value) The number of bytes per second (on average) the DHT is allowed to send.

Methods inherited from class java.lang.Object

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

Constructor Detail

DhtSettings

public DhtSettings(dht_settings s)

DhtSettings

public DhtSettings()

Method Detail

swig

public dht_settings swig()

maxPeersReply

public int maxPeersReply()

the maximum number of peers to send in a reply to ``get_peers``.

Returns:

maxPeersReply

public void maxPeersReply(int value)

the maximum number of peers to send in a reply to ``get_peers``.

Parameters:

value -

getSearchBranching

public int getSearchBranching()

the number of concurrent search request the node will send when announcing and refreshing the routing table. This parameter is called alpha in the kademlia paper.

Returns:

setSearchBranching

public void setSearchBranching(int value)

the number of concurrent search request the node will send when announcing and refreshing the routing table. This parameter is called alpha in the kademlia paper.

Parameters:

value -

getMaxFailCount

public int getMaxFailCount()

the maximum number of failed tries to contact a node before it is removed from the routing table. If there are known working nodes that are ready to replace a failing node, it will be replaced immediately, this limit is only used to clear out nodes that don't have any node that can replace them.

Returns:

setMaxFailCount

public void setMaxFailCount(int value)

the maximum number of failed tries to contact a node before it is removed from the routing table. If there are known working nodes that are ready to replace a failing node, it will be replaced immediately, this limit is only used to clear out nodes that don't have any node that can replace them.

Parameters:

value -

maxTorrents

public int maxTorrents()

the total number of torrents to track from the DHT. This is simply an upper limit to make sure malicious DHT nodes cannot make us allocate an unbounded amount of memory.

Returns:

maxTorrents

public void maxTorrents(int value)

the total number of torrents to track from the DHT. This is simply an upper limit to make sure malicious DHT nodes cannot make us allocate an unbounded amount of memory.

Parameters:

value -

maxDhtItems

public int maxDhtItems()

max number of items the DHT will store.

Returns:

maxDhtItems

public void maxDhtItems(int value)

max number of items the DHT will store.

Parameters:

value -

maxPeers

public int maxPeers()

The max number of peers to store per torrent (for the DHT).

Returns:

maxPeers

public void maxPeers(int value)

The max number of peers to store per torrent (for the DHT).

Parameters:

value -

getMaxTorrentSearchReply

public int getMaxTorrentSearchReply()

the max number of torrents to return in a torrent search query to the DHT.

Returns:

setMaxTorrentSearchReply

public void setMaxTorrentSearchReply(int value)

the max number of torrents to return in a torrent search query to the DHT.

Parameters:

value -

isRestrictRoutingIPs

public boolean isRestrictRoutingIPs()

determines if the routing table entries should restrict entries to one per IP. This defaults to true, which helps mitigate some attacks on the DHT. It prevents adding multiple nodes with IPs with a very close CIDR distance.

when set, nodes whose IP address that's in the same /24 (or /64 for IPv6) range in the same routing table bucket. This is an attempt to mitigate node ID spoofing attacks also restrict any IP to only have a single entry in the whole routing table.

Returns:

setRestrictRoutingIPs

public void setRestrictRoutingIPs(boolean value)

determines if the routing table entries should restrict entries to one per IP. This defaults to true, which helps mitigate some attacks on the DHT. It prevents adding multiple nodes with IPs with a very close CIDR distance.

when set, nodes whose IP address that's in the same /24 (or /64 for IPv6) range in the same routing table bucket. This is an attempt to mitigate node ID spoofing attacks also restrict any IP to only have a single entry in the whole routing table.

Parameters:

value -

isRestrictSearchIPs

public boolean isRestrictSearchIPs()

determines if DHT searches should prevent adding nodes with IPs with very close CIDR distance. This also defaults to true and helps mitigate certain attacks on the DHT.

Returns:

setRestrictSearchIPs

public void setRestrictSearchIPs(boolean value)

determines if DHT searches should prevent adding nodes with IPs with very close CIDR distance. This also defaults to true and helps mitigate certain attacks on the DHT.

Parameters:

value -

isExtendedRoutingTable

public boolean isExtendedRoutingTable()

makes the first buckets in the DHT routing table fit 128, 64, 32 and 16 nodes respectively, as opposed to the standard size of 8. All other buckets have size 8 still.

Returns:

setExtendedRoutingTable

public void setExtendedRoutingTable(boolean value)

makes the first buckets in the DHT routing table fit 128, 64, 32 and 16 nodes respectively, as opposed to the standard size of 8. All other buckets have size 8 still.

Parameters:

value -

isAggressiveLookups

public boolean isAggressiveLookups()

slightly changes the lookup behavior in terms of how many outstanding requests we keep. Instead of having branch factor be a hard limit, we always keep *branch factor* outstanding requests to the closest nodes. i.e. every time we get results back with closer nodes, we query them right away. It lowers the lookup times at the cost of more outstanding queries.

Returns:

getAggressiveLookups

public void getAggressiveLookups(boolean value)

slightly changes the lookup behavior in terms of how many outstanding requests we keep. Instead of having branch factor be a hard limit, we always keep *branch factor* outstanding requests to the closest nodes. i.e. every time we get results back with closer nodes, we query them right away. It lowers the lookup times at the cost of more outstanding queries.

Parameters:

value -

isPrivacyLookups

public boolean isPrivacyLookups()

when set, perform lookups in a way that is slightly more expensive, but which minimizes the amount of information leaked about you.

Returns:

setPrivacyLookups

public void setPrivacyLookups(boolean value)

when set, perform lookups in a way that is slightly more expensive, but which minimizes the amount of information leaked about you.

Parameters:

value -

isEnforceNodeId

public boolean isEnforceNodeId()

when set, node's whose IDs that are not correctly generated based on its external IP are ignored. When a query arrives from such node, an error message is returned with a message saying "invalid node ID".

Returns:

setEnforceNodeId

public void setEnforceNodeId(boolean value)

when set, node's whose IDs that are not correctly generated based on its external IP are ignored. When a query arrives from such node, an error message is returned with a message saying "invalid node ID".

Parameters:

value -

isIgnoreDarkInternet

public boolean isIgnoreDarkInternet()

ignore DHT messages from parts of the internet we wouldn't expect to see any traffic from

Returns:

setIgnoreDarkInternet

public void setIgnoreDarkInternet(boolean value)

ignore DHT messages from parts of the internet we wouldn't expect to see any traffic from

Parameters:

value -

blockTimeout

public int blockTimeout()

The number of seconds a DHT node is banned if it exceeds the rate limit. The rate limit is averaged over 10 seconds to allow for bursts above the limit.

Returns:

blockTimeout

public void blockTimeout(int value)

The number of seconds a DHT node is banned if it exceeds the rate limit. The rate limit is averaged over 10 seconds to allow for bursts above the limit.

Parameters:

value -

blockRatelimit

public int blockRatelimit()

The max number of packets per second a DHT node is allowed to send without getting banned.

Returns:

blockRatelimit

public void blockRatelimit(int value)

The max number of packets per second a DHT node is allowed to send without getting banned.

Parameters:

value -

readOnly

public boolean readOnly()

When set, the other nodes won't keep this node in their routing tables, it's meant for low-power and/or ephemeral devices that cannot support the DHT, it is also useful for mobile devices which are sensitive to network traffic and battery life. this node no longer responds to 'query' messages, and will place a 'ro' key (value = 1) in the top-level message dictionary of outgoing query messages.

Returns:

readOnly

public void readOnly(boolean value)

When set, the other nodes won't keep this node in their routing tables, it's meant for low-power and/or ephemeral devices that cannot support the DHT, it is also useful for mobile devices which are sensitive to network traffic and battery life. this node no longer responds to 'query' messages, and will place a 'ro' key (value = 1) in the top-level message dictionary of outgoing query messages.

Parameters:

value -

itemLifetime

public int itemLifetime()

The number of seconds a immutable/mutable item will be expired. default is 0, means never expires.

Returns:

itemLifetime

public void itemLifetime(int value)

The number of seconds a immutable/mutable item will be expired. default is 0, means never expires.

Parameters:

value -

uploadRateLimit

public int uploadRateLimit()

The number of bytes per second (on average) the DHT is allowed to send. If the incoming requests causes to many bytes to be sent in responses, incoming requests will be dropped until the quota has been replenished.

Returns:

uploadRateLimit

public void uploadRateLimit(int value)

The number of bytes per second (on average) the DHT is allowed to send. If the incoming requests causes to many bytes to be sent in responses, incoming requests will be dropped until the quota has been replenished.

Parameters:

value -