Config (Bt 1.10 API)

java.lang.Object
- bt.runtime.Config

```
public class Config
extends Object
```
Provides runtime configuration parameters.

Since:

1.0

Constructor Summary

Constructors
Constructor and Description

Config()
Create a config with default parameters.

Config(Config config)
Clone the provided config.

Constructors
Constructor and Description
`Config()` Create a config with default parameters.
`Config(Config config)` Clone the provided config.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InetAddress`	`getAcceptorAddress()`
`int`	`getAcceptorPort()`
`EncryptionPolicy`	`getEncryptionPolicy()`
`int`	`getHashingBufferSize()` Get the digest buffer size
`int`	`getMaxConcurrentlyActivePeerConnectionsPerTorrent()`
`int`	`getMaxIOQueueSize()`
`Duration`	`getMaxMessageProcessingInterval()`
`int`	`getMaxOutstandingRequests()`
`int`	`getMaxPeerConnections()`
`int`	`getMaxPeerConnectionsPerTorrent()`
`int`	`getMaxPendingConnectionRequests()`
`Duration`	`getMaxPieceReceivingTime()`
`int`	`getMaxSimultaneouslyAssignedPieces()`
`int`	`getMaxTransferBlockSize()`
`int`	`getMetadataExchangeBlockSize()`
`int`	`getMetadataExchangeMaxSize()`
`int`	`getMsePrivateKeySize()`
`Duration`	`getMseWaitBetweenReads()`
`int`	`getNetworkBufferSize()`
`int`	`getNumberOfPeersToRequestFromTracker()`
`int`	`getNumOfHashingThreads()`
`Optional<InetAddress>`	`getPeerAddress()`
`Duration`	`getPeerConnectionInactivityThreshold()`
`int`	`getPeerConnectionRetryCount()`
`Duration`	`getPeerConnectionRetryInterval()`
`Duration`	`getPeerConnectionTimeout()`
`Duration`	`getPeerDiscoveryInterval()`
`Duration`	`getPeerHandshakeTimeout()`
`Duration`	`getShutdownHookTimeout()`
`Duration`	`getTimeoutedAssignmentPeerBanDuration()`
`Duration`	`getTrackerQueryInterval()`
`Duration`	`getTrackerTimeout()` Tracker/peer source timeout See `setTrackerTimeout(Duration)` for the explanation on how this is used
`int`	`getTransferBlockSize()`
`Duration`	`getUnreachablePeerBanDuration()`
`boolean`	`isMseDisabled()`
`void`	`setAcceptorAddress(InetAddress acceptorAddress)`
`void`	`setAcceptorPort(int acceptorPort)`
`void`	`setEncryptionPolicy(EncryptionPolicy encryptionPolicy)`
`void`	`setHashingBufferSize(int hashingBufferSize)` Set the size of the io buffer used for reading from files to verify their digest.
`void`	`setMaxConcurrentlyActivePeerConnectionsPerTorrent(int maxConcurrentlyActivePeerConnectionsPerTorrent)` Maximum number of peer connections that are allowed to request and receive pieces.
`void`	`setMaxIOQueueSize(int maxIOQueueSize)`
`void`	`setMaxMessageProcessingInterval(Duration maxMessageProcessingInterval)` This option is related to the adaptive message processing interval feature in the message dispatcher.
`void`	`setMaxOutstandingRequests(int maxOutstandingRequests)`
`void`	`setMaxPeerConnections(int maxPeerConnections)`
`void`	`setMaxPeerConnectionsPerTorrent(int maxPeerConnectionsPerTorrent)`
`void`	`setMaxPendingConnectionRequests(int maxPendingConnectionRequests)`
`void`	`setMaxPieceReceivingTime(Duration maxPieceReceivingTime)`
`void`	`setMaxSimultaneouslyAssignedPieces(int maxSimultaneouslyAssignedPieces)` Set the number of pieces that are assigned to a single peer
`void`	`setMaxTransferBlockSize(int maxTransferBlockSize)`
`void`	`setMetadataExchangeBlockSize(int metadataExchangeBlockSize)`
`void`	`setMetadataExchangeMaxSize(int metadataExchangeMaxSize)`
`void`	`setMseDisabled(boolean mseDisabled)`
`void`	`setMsePrivateKeySize(int msePrivateKeySize)`
`void`	`setMseWaitBetweenReads(Duration mseWaitBetweenReads)`
`void`	`setNetworkBufferSize(int networkBufferSize)`
`void`	`setNumberOfPeersToRequestFromTracker(int numberOfPeersToRequestFromTracker)`
`void`	`setNumOfHashingThreads(int numOfHashingThreads)`
`void`	`setPeerAddress(InetAddress peerAddress)` Set the address to send to the tracker.
`void`	`setPeerConnectionInactivityThreshold(Duration peerConnectionInactivityThreshold)`
`void`	`setPeerConnectionRetryCount(int peerConnectionRetryCount)`
`void`	`setPeerConnectionRetryInterval(Duration peerConnectionRetryInterval)`
`void`	`setPeerConnectionTimeout(Duration peerConnectionTimeout)`
`void`	`setPeerDiscoveryInterval(Duration peerDiscoveryInterval)`
`void`	`setPeerHandshakeTimeout(Duration peerHandshakeTimeout)`
`void`	`setShutdownHookTimeout(Duration shutdownHookTimeout)`
`void`	`setTimeoutedAssignmentPeerBanDuration(Duration timeoutedAssignmentPeerBanDuration)`
`void`	`setTrackerQueryInterval(Duration trackerQueryInterval)`
`void`	`setTrackerTimeout(Duration trackerTimeout)` Set the tracker/peer source timeout Currently used in the following contexts: - HTTP trackers: used as connection timeout and SO_TIMEOUT; default is 30 seconds - UDP trackers: used as an additional limit on maximal BEP-0015 timeout; formula is Math.min(3840 seconds, trackerTimeout) - all ScheduledPeerSources (HTTP, UDP, DHT): used during the first (initial) peer collection as a limit on the time to wait for the collection to finish before querying the next peer source; default is 10 seconds
`void`	`setTransferBlockSize(int transferBlockSize)`
`void`	`setUnreachablePeerBanDuration(Duration unreachablePeerBanDuration)`

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

- Constructor Detail
  - Config
```
public Config()
```
    Create a config with default parameters.
    
    Since:
    
    1.0
  - Config
```
public Config(Config config)
```
    Clone the provided config.
    
    Parameters:
    
    config - Config to take parameters from.
    
    Since:
    
    1.0
- Method Detail
  - setAcceptorAddress
```
public void setAcceptorAddress(InetAddress acceptorAddress)
```
    Parameters:
    
    acceptorAddress - Local link that will be used by the incoming connection acceptor.
    
    Since:
    
    1.0
  - getAcceptorAddress
```
public InetAddress getAcceptorAddress()
```
    Since:
    
    1.0
  - getPeerAddress
```
public Optional<InetAddress> getPeerAddress()
```
    Returns:
    
    the address to send to the tracker
    
    Since:
    
    1.10
  - setPeerAddress
```
public void setPeerAddress(InetAddress peerAddress)
```
    Set the address to send to the tracker. Useful if the local address to accept new connections differs from the remote address a user should connect to this client with for example in the case of NAT. Only supported for http trackers currently. Defaults to getAcceptorAddress()
    
    Parameters:
    
    peerAddress - the address to send to the tracker.
    
    Since:
    
    1.10
  - setAcceptorPort
```
public void setAcceptorPort(int acceptorPort)
```
    Parameters:
    
    acceptorPort - Local port that will be used by the incoming connection acceptor.
    
    Since:
    
    1.0
  - getAcceptorPort
```
public int getAcceptorPort()
```
    Since:
    
    1.0
  - setPeerDiscoveryInterval
```
public void setPeerDiscoveryInterval(Duration peerDiscoveryInterval)
```
    Parameters:
    
    peerDiscoveryInterval - Interval at which peer sources should be queried for new peers.
    
    Since:
    
    1.0
  - getPeerDiscoveryInterval
```
public Duration getPeerDiscoveryInterval()
```
    Since:
    
    1.0
  - setPeerHandshakeTimeout
```
public void setPeerHandshakeTimeout(Duration peerHandshakeTimeout)
```
    Parameters:
    
    peerHandshakeTimeout - Time to wait for a peer's handshake.
    
    Since:
    
    1.0
  - getPeerHandshakeTimeout
```
public Duration getPeerHandshakeTimeout()
```
    Since:
    
    1.0
  - setPeerConnectionRetryInterval
```
public void setPeerConnectionRetryInterval(Duration peerConnectionRetryInterval)
```
    Parameters:
    
    peerConnectionRetryInterval - Interval at which attempts to connect to a peer will be performed
    
    Since:
    
    1.0
  - getPeerConnectionRetryInterval
```
public Duration getPeerConnectionRetryInterval()
```
    Since:
    
    1.0
  - setPeerConnectionRetryCount
```
public void setPeerConnectionRetryCount(int peerConnectionRetryCount)
```
    Parameters:
    
    peerConnectionRetryCount - Max number of attempts to connect to a peer
    
    Since:
    
    1.0
  - getPeerConnectionRetryCount
```
public int getPeerConnectionRetryCount()
```
    Since:
    
    1.0
  - setPeerConnectionTimeout
```
public void setPeerConnectionTimeout(Duration peerConnectionTimeout)
```
    Parameters:
    
    peerConnectionTimeout - Amount of time to wait for establishing of a peer connection
    
    Since:
    
    1.0
  - getPeerConnectionTimeout
```
public Duration getPeerConnectionTimeout()
```
    Since:
    
    1.0
  - setPeerConnectionInactivityThreshold
```
public void setPeerConnectionInactivityThreshold(Duration peerConnectionInactivityThreshold)
```
    Parameters:
    
    peerConnectionInactivityThreshold - Amount of time after which an inactive peer connection will be dropped
    
    Since:
    
    1.0
  - getPeerConnectionInactivityThreshold
```
public Duration getPeerConnectionInactivityThreshold()
```
    Since:
    
    1.0
  - setTrackerQueryInterval
```
public void setTrackerQueryInterval(Duration trackerQueryInterval)
```
    Parameters:
    
    trackerQueryInterval - Interval at which trackers will be queried for peers.
    
    Since:
    
    1.0
  - getTrackerQueryInterval
```
public Duration getTrackerQueryInterval()
```
    Since:
    
    1.0
  - setTrackerTimeout
```
public void setTrackerTimeout(Duration trackerTimeout)
```
    Set the tracker/peer source timeout Currently used in the following contexts: - HTTP trackers: used as connection timeout and SO_TIMEOUT; default is 30 seconds - UDP trackers: used as an additional limit on maximal BEP-0015 timeout; formula is Math.min(3840 seconds, trackerTimeout) - all ScheduledPeerSources (HTTP, UDP, DHT): used during the first (initial) peer collection as a limit on the time to wait for the collection to finish before querying the next peer source; default is 10 seconds
    
    Parameters:
    
    trackerTimeout - the amount of time to wait for a response from the tracker
  - getTrackerTimeout
```
public Duration getTrackerTimeout()
```
    Tracker/peer source timeout See setTrackerTimeout(Duration) for the explanation on how this is used
    
    Since:
    
    1.10
  - setMaxPeerConnections
```
public void setMaxPeerConnections(int maxPeerConnections)
```
    Parameters:
    
    maxPeerConnections - Maximum amount of established peer connections per runtime (all torrent processing sessions combined).
    
    Since:
    
    1.0
  - getMaxPeerConnections
```
public int getMaxPeerConnections()
```
    Since:
    
    1.0
  - setMaxPeerConnectionsPerTorrent
```
public void setMaxPeerConnectionsPerTorrent(int maxPeerConnectionsPerTorrent)
```
    Parameters:
    
    maxPeerConnectionsPerTorrent - Maximum number of established peer connections within a torrent processing session.
    
    Since:
    
    1.0
  - getMaxPeerConnectionsPerTorrent
```
public int getMaxPeerConnectionsPerTorrent()
```
    Since:
    
    1.0
  - setTransferBlockSize
```
public void setTransferBlockSize(int transferBlockSize)
```
    Parameters:
    
    transferBlockSize - Network transfer block size
    
    Since:
    
    1.0
  - getTransferBlockSize
```
public int getTransferBlockSize()
```
    Since:
    
    1.0
  - setMaxTransferBlockSize
```
public void setMaxTransferBlockSize(int maxTransferBlockSize)
```
    Parameters:
    
    maxTransferBlockSize - Maximum supported transfer block size.
    
    Since:
    
    1.0
  - getMaxTransferBlockSize
```
public int getMaxTransferBlockSize()
```
    Since:
    
    1.0
  - setMaxIOQueueSize
```
public void setMaxIOQueueSize(int maxIOQueueSize)
```
    Parameters:
    
    maxIOQueueSize - Maximum depth of I/O operations queue (read/write blocks).
  - getMaxIOQueueSize
```
public int getMaxIOQueueSize()
```
    Since:
    
    1.0
  - setShutdownHookTimeout
```
public void setShutdownHookTimeout(Duration shutdownHookTimeout)
```
    Parameters:
    
    shutdownHookTimeout - Amount of time to wait for a shutdown hook to execute before killing it
    
    Since:
    
    1.0
  - getShutdownHookTimeout
```
public Duration getShutdownHookTimeout()
```
    Since:
    
    1.0
  - setNumOfHashingThreads
```
public void setNumOfHashingThreads(int numOfHashingThreads)
```
    Parameters:
    
    numOfHashingThreads - Set this value to 2 or greater, if verification of the torrent data should be parallelized
    
    Since:
    
    1.1
  - getNumOfHashingThreads
```
public int getNumOfHashingThreads()
```
    Since:
    
    1.1
  - setMaxConcurrentlyActivePeerConnectionsPerTorrent
```
public void setMaxConcurrentlyActivePeerConnectionsPerTorrent(int maxConcurrentlyActivePeerConnectionsPerTorrent)
```
    Maximum number of peer connections that are allowed to request and receive pieces. Affects performance (too few or too many is bad).
    Note that this value implicitly affects when the torrent processing session enters the so-called "endgame" mode. By default it's assumed that the endgame mode should be activated when the number of remaining (incomplete) pieces is smaller than the number of pending requests, which in its' turn is no greater than this value.
    E.g. if the limit for concurrently active connections is 20, and there are in fact 20 peers that we are downloading from at the moment, then the endgame will begin as soon as there are 20 pieces left to download. At the same time if there are only 15 active connections, than the endgame will begin when there are 15 pieces left. Thus this value affects only the lower bound on the number of pieces to be left to trigger the beginning of an endgame.
    
    Parameters:
    
    maxConcurrentlyActivePeerConnectionsPerTorrent - Maximum number of peer connections that are allowed to request and receive pieces.
    
    Since:
    
    1.1
  - getMaxConcurrentlyActivePeerConnectionsPerTorrent
```
public int getMaxConcurrentlyActivePeerConnectionsPerTorrent()
```
    Since:
    
    1.1
  - setMaxSimultaneouslyAssignedPieces
```
public void setMaxSimultaneouslyAssignedPieces(int maxSimultaneouslyAssignedPieces)
```
    Set the number of pieces that are assigned to a single peer
    
    Parameters:
    
    maxSimultaneouslyAssignedPieces - the max number of pieces assigned to a single peer
    
    Since:
    
    1.10
  - getMaxSimultaneouslyAssignedPieces
```
public int getMaxSimultaneouslyAssignedPieces()
```
    Since:
    
    1.10
  - setMaxPieceReceivingTime
```
public void setMaxPieceReceivingTime(Duration maxPieceReceivingTime)
```
    Parameters:
    
    maxPieceReceivingTime - Limit on the amount of time it takes to receive all blocks in a piece from a peer until this peer is considered timeouted and banned for a short amount of time (with the piece being unassigned from this peer).
    
    Since:
    
    1.1
  - getMaxPieceReceivingTime
```
public Duration getMaxPieceReceivingTime()
```
    Since:
    
    1.1
  - setMaxMessageProcessingInterval
```
public void setMaxMessageProcessingInterval(Duration maxMessageProcessingInterval)
```
    This option is related to the adaptive message processing interval feature in the message dispatcher. The lower this value the higher the ingoing/outgoing message processing rate but also higher the CPU load. Reasonable value (in 100..1000 ms range) greatly reduces the CPU load when there is little network activity without compromising the overall message exchange rates.
    
    Parameters:
    
    maxMessageProcessingInterval - Maximum time to sleep between message processing loop iterations, in millis.
    
    Since:
    
    1.1
    
    See Also:
    
    MessageDispatcher
  - getMaxMessageProcessingInterval
```
public Duration getMaxMessageProcessingInterval()
```
    Since:
    
    1.1
  - setUnreachablePeerBanDuration
```
public void setUnreachablePeerBanDuration(Duration unreachablePeerBanDuration)
```
    Parameters:
    
    unreachablePeerBanDuration - If a peer is not reachable (i.e. some kind of I/O error happens when a connection attempt is made), then new requests to connect to this peer will be ignored for this amount of time.
    
    Since:
    
    1.1
  - getUnreachablePeerBanDuration
```
public Duration getUnreachablePeerBanDuration()
```
    Since:
    
    1.1
  - setMaxPendingConnectionRequests
```
public void setMaxPendingConnectionRequests(int maxPendingConnectionRequests)
```
    Parameters:
    
    maxPendingConnectionRequests - Maximum allowed number of simultaneous connection requests (both inbound and outbound). All subsequent requests will be queued until some of the currently pending/processed requests is completed.
    
    Since:
    
    1.1
  - getMaxPendingConnectionRequests
```
public int getMaxPendingConnectionRequests()
```
    Since:
    
    1.1
  - setTimeoutedAssignmentPeerBanDuration
```
public void setTimeoutedAssignmentPeerBanDuration(Duration timeoutedAssignmentPeerBanDuration)
```
    Parameters:
    
    timeoutedAssignmentPeerBanDuration - Amount of time to keep the torrent processing session from requesting a peer for new pieces if this peer's previous assignment was cancelled due to a timeout.
    
    Since:
    
    1.1
    
    See Also:
    
    setMaxPieceReceivingTime(Duration)
  - getTimeoutedAssignmentPeerBanDuration
```
public Duration getTimeoutedAssignmentPeerBanDuration()
```
    Since:
    
    1.1
  - setEncryptionPolicy
```
public void setEncryptionPolicy(EncryptionPolicy encryptionPolicy)
```
    Parameters:
    
    encryptionPolicy - Message Stream Encryption policy
    
    Since:
    
    1.2
  - getEncryptionPolicy
```
public EncryptionPolicy getEncryptionPolicy()
```
    Since:
    
    1.2
  - setMetadataExchangeBlockSize
```
public void setMetadataExchangeBlockSize(int metadataExchangeBlockSize)
```
    Parameters:
    
    metadataExchangeBlockSize - BEP-9 transfer block size
    
    Since:
    
    1.3
  - getMetadataExchangeBlockSize
```
public int getMetadataExchangeBlockSize()
```
    Since:
    
    1.3
  - setMetadataExchangeMaxSize
```
public void setMetadataExchangeMaxSize(int metadataExchangeMaxSize)
```
    Parameters:
    
    metadataExchangeMaxSize - Maximum allowed metadata size for BEP-9 transfer
    
    Since:
    
    1.3
  - getMetadataExchangeMaxSize
```
public int getMetadataExchangeMaxSize()
```
    Since:
    
    1.3
  - setMsePrivateKeySize
```
public void setMsePrivateKeySize(int msePrivateKeySize)
```
    Parameters:
    
    msePrivateKeySize - MSE private key size in bytes. Allowed values are 16..512 bytes (128..4096 bits). Default is 20 bytes (160 bit).
    
    Since:
    
    1.3
  - getMsePrivateKeySize
```
public int getMsePrivateKeySize()
```
    Since:
    
    1.3
  - setMseDisabled
```
public void setMseDisabled(boolean mseDisabled)
```
    Parameters:
    
    mseDisabled - set true to disable mse, see MSEHandshakeProcessor
    
    Since:
    
    1.10
  - isMseDisabled
```
public boolean isMseDisabled()
```
    Since:
    
    1.10
  - setMseWaitBetweenReads
```
public void setMseWaitBetweenReads(Duration mseWaitBetweenReads)
```
    Parameters:
    
    mseWaitBetweenReads - Read timeout when doing mse handshake. In good network environment, turning down this value may decrease mse handshake time cost.
    
    Since:
    
    1.10
  - getMseWaitBetweenReads
```
public Duration getMseWaitBetweenReads()
```
    Since:
    
    1.10
  - setNumberOfPeersToRequestFromTracker
```
public void setNumberOfPeersToRequestFromTracker(int numberOfPeersToRequestFromTracker)
```
    Parameters:
    
    numberOfPeersToRequestFromTracker - Number of peers to request from a tracker
    
    Since:
    
    1.5
  - getNumberOfPeersToRequestFromTracker
```
public int getNumberOfPeersToRequestFromTracker()
```
    Since:
    
    1.5
  - setMaxOutstandingRequests
```
public void setMaxOutstandingRequests(int maxOutstandingRequests)
```
    Parameters:
    
    maxOutstandingRequests - Limit on the number of outstanding requests to a peer
    
    Since:
    
    1.9
  - getMaxOutstandingRequests
```
public int getMaxOutstandingRequests()
```
    Since:
    
    1.9
  - setNetworkBufferSize
```
public void setNetworkBufferSize(int networkBufferSize)
```
    Parameters:
    
    networkBufferSize - Size of send and receive network buffers (in bytes)
    
    Since:
    
    1.9
  - getNetworkBufferSize
```
public int getNetworkBufferSize()
```
    Since:
    
    1.9
  - getHashingBufferSize
```
public int getHashingBufferSize()
```
    Get the digest buffer size
    
    Returns:
    
    the size of the digest buffer
    
    Since:
    
    1.10
  - setHashingBufferSize
```
public void setHashingBufferSize(int hashingBufferSize)
```
    Set the size of the io buffer used for reading from files to verify their digest.
    
    Parameters:
    
    hashingBufferSize - the size of the digest buffer
    
    Since:
    
    1.10

Class Config

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Config

Config

Method Detail

setAcceptorAddress

getAcceptorAddress

getPeerAddress

setPeerAddress

setAcceptorPort

getAcceptorPort

setPeerDiscoveryInterval

getPeerDiscoveryInterval

setPeerHandshakeTimeout

getPeerHandshakeTimeout

setPeerConnectionRetryInterval

getPeerConnectionRetryInterval

setPeerConnectionRetryCount

getPeerConnectionRetryCount

setPeerConnectionTimeout

getPeerConnectionTimeout

setPeerConnectionInactivityThreshold

getPeerConnectionInactivityThreshold

setTrackerQueryInterval

getTrackerQueryInterval

setTrackerTimeout

getTrackerTimeout

setMaxPeerConnections

getMaxPeerConnections

setMaxPeerConnectionsPerTorrent

getMaxPeerConnectionsPerTorrent

setTransferBlockSize

getTransferBlockSize

setMaxTransferBlockSize

getMaxTransferBlockSize

setMaxIOQueueSize

getMaxIOQueueSize

setShutdownHookTimeout

getShutdownHookTimeout

setNumOfHashingThreads

getNumOfHashingThreads

setMaxConcurrentlyActivePeerConnectionsPerTorrent

getMaxConcurrentlyActivePeerConnectionsPerTorrent

setMaxSimultaneouslyAssignedPieces

getMaxSimultaneouslyAssignedPieces

setMaxPieceReceivingTime

getMaxPieceReceivingTime

setMaxMessageProcessingInterval

getMaxMessageProcessingInterval

setUnreachablePeerBanDuration

getUnreachablePeerBanDuration

setMaxPendingConnectionRequests

getMaxPendingConnectionRequests

setTimeoutedAssignmentPeerBanDuration

getTimeoutedAssignmentPeerBanDuration

setEncryptionPolicy

getEncryptionPolicy

setMetadataExchangeBlockSize

getMetadataExchangeBlockSize

setMetadataExchangeMaxSize

getMetadataExchangeMaxSize

setMsePrivateKeySize

getMsePrivateKeySize

setMseDisabled

isMseDisabled

setMseWaitBetweenReads

getMseWaitBetweenReads

setNumberOfPeersToRequestFromTracker

getNumberOfPeersToRequestFromTracker

setMaxOutstandingRequests

getMaxOutstandingRequests

setNetworkBufferSize

getNetworkBufferSize

getHashingBufferSize

setHashingBufferSize