SettingsPack (jlibtorrent 1.2.0.16-RC2 API)

java.lang.Object
- com.frostwire.jlibtorrent.SettingsPack

```
public final class SettingsPack
extends java.lang.Object
```
The ``settings_pack`` struct, contains the names of all settings as enum values. These values are passed in to the ``set_str()``, ``set_int()``, ``set_bool()`` functions, to specify the setting to change.

Constructor Summary

Constructors
Constructor and Description

SettingsPack()
Example, how to turn on the DHT using SettingsPack.

SettingsPack(settings_pack sp)

Constructors
Constructor and Description
`SettingsPack()` Example, how to turn on the DHT using SettingsPack.
`SettingsPack(settings_pack sp)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`activeChecking()` `active_checking` is the limit of number of simultaneous checking torrents.
`SettingsPack`	`activeChecking(int value)`
`int`	`activeDhtLimit()` `active_dht_limit` is the max number of torrents to announce to the DHT.
`SettingsPack`	`activeDhtLimit(int value)`
`int`	`activeDownloads()` `active_downloads` controls how many active downloading torrents the queuing mechanism allows.
`SettingsPack`	`activeDownloads(int value)`
`int`	`activeLimit()` `active_limit` is a hard limit on the number of active (auto managed) torrents.
`SettingsPack`	`activeLimit(int value)` `active_limit` is a hard limit on the number of active (auto managed) torrents.
`int`	`activeLsdLimit()` `active_lsd_limit` is the max number of torrents to announce to the local network over the local service discovery protocol.
`SettingsPack`	`activeLsdLimit(int value)`
`int`	`activeSeeds()` `active_seeds` controls how many active seeding torrents the queuing mechanism allows.
`SettingsPack`	`activeSeeds(int value)`
`int`	`activeTrackerLimit()` `active_tracker_limit` is the max number of torrents to announce to their trackers.
`SettingsPack`	`activeTrackerLimit(int value)`
`int`	`alertQueueSize()`
`SettingsPack`	`alertQueueSize(int value)` `alert_queue_size` is the maximum number of alerts queued up internally.
`boolean`	`anonymousMode()`
`SettingsPack`	`anonymousMode(boolean value)` defaults to false.
`boolean`	`broadcastLSD()`
`SettingsPack`	`broadcastLSD(boolean value)`
`int`	`cacheSize()` Sets the disk write and read cache.
`SettingsPack`	`cacheSize(int value)` Sets the disk write and read cache.
`void`	`clear()`
`void`	`clear(int name)`
`int`	`connectionsLimit()`
`SettingsPack`	`connectionsLimit(int value)` Sets a global limit on the number of connections opened.
`int`	`downloadRateLimit()`
`SettingsPack`	`downloadRateLimit(int value)` Sets the session-global limits of download rate limit, in bytes per second.
`boolean`	`enableDht()`
`SettingsPack`	`enableDht(boolean value)` Starts the dht node and makes the trackerless service available to torrents.
`boolean`	`getBoolean(int name)`
`int`	`getInteger(int name)`
`java.lang.String`	`getString(int name)`
`int`	`inactivityTimeout()`
`SettingsPack`	`inactivityTimeout(int value)` if a peer is uninteresting and uninterested for longer than this number of seconds, it will be disconnected.
`java.lang.String`	`listenInterfaces()`
`SettingsPack`	`listenInterfaces(java.lang.String value)`
`int`	`maxPeerlistSize()`
`SettingsPack`	`maxPeerlistSize(int value)` Sets the maximum number of peers in the list of known peers.
`int`	`maxQueuedDiskBytes()`
`SettingsPack`	`maxQueuedDiskBytes(int value)` Sets the maximum number of bytes a connection may have pending in the disk write queue before its download rate is being throttled.
`boolean`	`seedingOutgoingConnections()`
`SettingsPack`	`seedingOutgoingConnections(boolean value)` Determines if seeding (and finished) torrents should attempt to make outgoing connections or not.
`int`	`sendBufferWatermark()`
`SettingsPack`	`sendBufferWatermark(int value)` Sets the upper limit of the send buffer low-watermark.
`SettingsPack`	`setBoolean(int name, boolean value)`
`SettingsPack`	`setInteger(int name, int value)`
`SettingsPack`	`setString(int name, java.lang.String value)`
`int`	`stopTrackerTimeout()`
`SettingsPack`	`stopTrackerTimeout(int value)` `stop_tracker_timeout` is the number of seconds to wait when sending a stopped message before considering a tracker to have timed out.
`settings_pack`	`swig()`
`int`	`tickInterval()`
`SettingsPack`	`tickInterval(int value)` Specifies the number of milliseconds between internal ticks.
`int`	`uploadRateLimit()`
`SettingsPack`	`uploadRateLimit(int value)` Sets the session-global limits of upload rate limit, in bytes per second.
`boolean`	`upnpIgnoreNonRouters()` Indicates whether or not the UPnP implementation should ignore any broadcast response from a device whose address is not the configured router for this machine.
`SettingsPack`	`upnpIgnoreNonRouters(boolean value)` Indicates whether or not the UPnP implementation should ignore any broadcast response from a device whose address is not the configured router for this machine.

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

- Constructor Detail
  - SettingsPack
```
public SettingsPack(settings_pack sp)
```
  - SettingsPack
```
public SettingsPack()
```
    Example, how to turn on the DHT using SettingsPack.
```
 SettingsPack pack = new SettingsPack();
 pack.setBoolean(settings_pack.bool_types.enable_dht.swigValue(), on);
 s.applySettings(pack);
 
```
- Method Detail
  - swig
```
public settings_pack swig()
```
    Returns:
  - getBoolean
```
public boolean getBoolean(int name)
```
    Parameters:
    
    name -
    
    Returns:
  - setBoolean
```
public SettingsPack setBoolean(int name,
                               boolean value)
```
    Parameters:
    
    name -
    
    value -
  - getInteger
```
public int getInteger(int name)
```
    Parameters:
    
    name -
    
    Returns:
  - setInteger
```
public SettingsPack setInteger(int name,
                               int value)
```
    Parameters:
    
    name -
    
    value -
  - getString
```
public java.lang.String getString(int name)
```
    Parameters:
    
    name -
    
    Returns:
  - setString
```
public SettingsPack setString(int name,
                              java.lang.String value)
```
    Parameters:
    
    name -
    
    value -
  - clear
```
public void clear()
```
  - clear
```
public void clear(int name)
```
  - downloadRateLimit
```
public int downloadRateLimit()
```
    Returns:
    
    the session-global download rate limit in bytes per second. (0 for unlimited)
  - downloadRateLimit
```
public SettingsPack downloadRateLimit(int value)
```
    Sets the session-global limits of download rate limit, in bytes per second.
    A value of 0 means unlimited.
    
    Parameters:
    
    value -
  - uploadRateLimit
```
public int uploadRateLimit()
```
    Returns:
    
    the session-global upload rate limit in bytes per second. (0 for unlimited)
  - uploadRateLimit
```
public SettingsPack uploadRateLimit(int value)
```
    Sets the session-global limits of upload rate limit, in bytes per second.
    A value of 0 means unlimited.
    
    Parameters:
    
    value -
  - activeDownloads
```
public int activeDownloads()
```
    active_downloads controls how many active downloading torrents the queuing mechanism allows.
    The target number of active torrents is min(active_downloads + active_seeds, active_limit). active_downloads and active_seeds are upper limits on the number of downloading torrents and seeding torrents respectively. Setting the value to -1 means unlimited.
    For auto managed torrents, these are the limits they are subject to. If there are too many torrents some of the auto managed ones will be paused until some slots free up.
    You can have more torrents *active*, even though they are not announced to the DHT, lsd or their tracker. If some peer knows about you for any reason and tries to connect, it will still be accepted, unless the torrent is paused, which means it won't accept any connections.
    For example if there are 10 seeding torrents and 10 downloading torrents, and ``active_downloads`` is 4 and ``active_seeds`` is 4, there will be 4 seeds active and 4 downloading torrents. If the settings are ``active_downloads`` = 2 and ``active_seeds`` = 4, then there will be 2 downloading torrents and 4 seeding torrents active. Torrents that are not auto managed are also counted against these limits. If there are non-auto managed torrents that use up all the slots, no auto managed torrent will be activated.
    
    Returns:
  - activeDownloads
```
public SettingsPack activeDownloads(int value)
```
    Parameters:
    
    value -
    
    See Also:
    
    activeDownloads()
  - activeSeeds
```
public int activeSeeds()
```
    active_seeds controls how many active seeding torrents the queuing mechanism allows.
    
    Returns:
    
    See Also:
    
    activeDownloads()
  - activeSeeds
```
public SettingsPack activeSeeds(int value)
```
    Parameters:
    
    value -
    
    See Also:
    
    activeSeeds()
  - activeChecking
```
public int activeChecking()
```
    active_checking is the limit of number of simultaneous checking torrents.
    
    Returns:
    
    See Also:
    
    activeDownloads()
  - activeChecking
```
public SettingsPack activeChecking(int value)
```
    Parameters:
    
    value -
    
    See Also:
    
    activeChecking()
  - activeDhtLimit
```
public int activeDhtLimit()
```
    active_dht_limit is the max number of torrents to announce to the DHT. By default this is set to 88, which is no more than one DHT announce every 10 seconds.
    
    Returns:
    
    See Also:
    
    activeDownloads()
  - activeDhtLimit
```
public SettingsPack activeDhtLimit(int value)
```
    Parameters:
    
    value -
    
    See Also:
    
    activeDhtLimit()
  - activeTrackerLimit
```
public int activeTrackerLimit()
```
    active_tracker_limit is the max number of torrents to announce to their trackers. By default this is 360, which is no more than one announce every 5 seconds.
    
    Returns:
    
    See Also:
    
    activeDownloads()
  - activeTrackerLimit
```
public SettingsPack activeTrackerLimit(int value)
```
    Parameters:
    
    value -
    
    See Also:
    
    activeTrackerLimit()
  - activeLsdLimit
```
public int activeLsdLimit()
```
    active_lsd_limit is the max number of torrents to announce to the local network over the local service discovery protocol. By default this is 80, which is no more than one announce every 5 seconds (assuming the default announce interval of 5 minutes).
    
    Returns:
    
    See Also:
    
    activeDownloads()
  - activeLsdLimit
```
public SettingsPack activeLsdLimit(int value)
```
    Parameters:
    
    value -
    
    See Also:
    
    activeLsdLimit()
  - activeLimit
```
public int activeLimit()
```
    active_limit is a hard limit on the number of active (auto managed) torrents. This limit also applies to slow torrents.
    
    Returns:
    
    the value
    
    See Also:
    
    activeDownloads()
  - activeLimit
```
public SettingsPack activeLimit(int value)
```
    active_limit is a hard limit on the number of active (auto managed) torrents. This limit also applies to slow torrents.
    
    Parameters:
    
    value - the value
    
    See Also:
    
    activeLimit()
  - connectionsLimit
```
public int connectionsLimit()
```
    Returns:
    
    global limit on the number of connections opened.
  - connectionsLimit
```
public SettingsPack connectionsLimit(int value)
```
    Sets a global limit on the number of connections opened. The number of connections is set to a hard minimum of at least two per torrent, so if you set a too low connections limit, and open too many torrents, the limit will not be met.
    
    Parameters:
    
    value -
  - maxPeerlistSize
```
public int maxPeerlistSize()
```
    Returns:
    
    the maximum number of peers in the list of known peers. (0 for unlimited)
  - maxPeerlistSize
```
public SettingsPack maxPeerlistSize(int value)
```
    Sets the maximum number of peers in the list of known peers. These peers are not necessarily connected, so this number should be much greater than the maximum number of connected peers. Peers are evicted from the cache when the list grows passed 90% of this limit, and once the size hits the limit, peers are no longer added to the list. If this limit is set to 0, there is no limit on how many peers we'll keep in the peer list.
    
    Parameters:
    
    value -
  - maxQueuedDiskBytes
```
public int maxQueuedDiskBytes()
```
    Returns:
    
    the maximum number of bytes a connection may have pending in the disk write queue before its download rate is being throttled.
  - maxQueuedDiskBytes
```
public SettingsPack maxQueuedDiskBytes(int value)
```
    Sets the maximum number of bytes a connection may have pending in the disk write queue before its download rate is being throttled. This prevents fast downloads to slow medias to allocate more memory indefinitely. This should be set to at least 16 kB to not completely disrupt normal downloads. If it's set to 0, you will be starving the disk thread and nothing will be written to disk. this is a per session setting.
    When this limit is reached, the peer connections will stop reading data from their sockets, until the disk thread catches up. Setting this too low will severely limit your download rate.
    
    Parameters:
    
    value -
  - sendBufferWatermark
```
public int sendBufferWatermark()
```
    Returns:
    
    the upper limit of the send buffer low-watermark.
  - sendBufferWatermark
```
public SettingsPack sendBufferWatermark(int value)
```
    Sets the upper limit of the send buffer low-watermark.
    if the send buffer has fewer bytes than this, we'll read another 16kB block onto it. If set too small, upload rate capacity will suffer. If set too high, memory will be wasted. The actual watermark may be lower than this in case the upload rate is low, this is the upper limit.
    
    Parameters:
    
    value -
  - cacheSize
```
public int cacheSize()
```
    Sets the disk write and read cache. It is specified in units of 16 KiB blocks. Buffers that are part of a peer's send or receive buffer also count against this limit. Send and receive buffers will never be denied to be allocated, but they will cause the actual cached blocks to be flushed or evicted. If this is set to -1, the cache size is automatically set to the amount of physical RAM available in the machine divided by 8. If the amount of physical RAM cannot be determined, it's set to 1024 (= 16 MiB).
    
    Returns:
    
    the current value
  - cacheSize
```
public SettingsPack cacheSize(int value)
```
    Sets the disk write and read cache. It is specified in units of 16 KiB blocks. Buffers that are part of a peer's send or receive buffer also count against this limit. Send and receive buffers will never be denied to be allocated, but they will cause the actual cached blocks to be flushed or evicted. If this is set to -1, the cache size is automatically set to the amount of physical RAM available in the machine divided by 8. If the amount of physical RAM cannot be determined, it's set to 1024 (= 16 MiB).
    
    Parameters:
    
    value - the new value
    
    Returns:
    
    this
  - tickInterval
```
public int tickInterval()
```
    Returns:
  - tickInterval
```
public SettingsPack tickInterval(int value)
```
    Specifies the number of milliseconds between internal ticks. This is the frequency with which bandwidth quota is distributed to peers. It should not be more than one second (i.e. 1000 ms). Setting this to a low value (around 100) means higher resolution bandwidth quota distribution, setting it to a higher value saves CPU cycles.
    
    Parameters:
    
    value -
  - inactivityTimeout
```
public int inactivityTimeout()
```
    Returns:
  - inactivityTimeout
```
public SettingsPack inactivityTimeout(int value)
```
    if a peer is uninteresting and uninterested for longer than this number of seconds, it will be disconnected. default is 10 minutes
    
    Parameters:
    
    value -
  - seedingOutgoingConnections
```
public boolean seedingOutgoingConnections()
```
    Returns:
  - seedingOutgoingConnections
```
public SettingsPack seedingOutgoingConnections(boolean value)
```
    Determines if seeding (and finished) torrents should attempt to make outgoing connections or not. By default this is true. It may be set to false in very specific applications where the cost of making outgoing connections is high, and there are no or small benefits of doing so. For instance, if no nodes are behind a firewall or a NAT, seeds don't need to make outgoing connections.
    
    Parameters:
    
    value -
  - anonymousMode
```
public boolean anonymousMode()
```
    Returns:
  - anonymousMode
```
public SettingsPack anonymousMode(boolean value)
```
    defaults to false. When set to true, the client tries to hide its identity to a certain degree. The peer-ID will no longer include the client's fingerprint. The user-agent will be reset to an empty string. It will also try to not leak other identifying information, such as your local listen port, your IP etc.
    If you're using I2P, a VPN or a proxy, it might make sense to enable anonymous mode.
    
    Parameters:
    
    value -
  - broadcastLSD
```
public boolean broadcastLSD()
```
  - broadcastLSD
```
public SettingsPack broadcastLSD(boolean value)
```
  - enableDht
```
public boolean enableDht()
```
    Returns:
  - enableDht
```
public SettingsPack enableDht(boolean value)
```
    Starts the dht node and makes the trackerless service available to torrents.
    
    Parameters:
    
    value -
    
    Returns:
    
    this
  - listenInterfaces
```
public java.lang.String listenInterfaces()
```
    Returns:
  - listenInterfaces
```
public SettingsPack listenInterfaces(java.lang.String value)
```
    Parameters:
    
    value -
    
    Returns:
    
    this
  - stopTrackerTimeout
```
public int stopTrackerTimeout()
```
    Returns:
    
    the current value
    
    See Also:
    
    stopTrackerTimeout(int)
  - stopTrackerTimeout
```
public SettingsPack stopTrackerTimeout(int value)
```
    stop_tracker_timeout is the number of seconds to wait when sending a stopped message before considering a tracker to have timed out. This is usually shorter, to make the client quit faster. If the value is set to 0, the connections to trackers with the stopped event are suppressed.
    
    Parameters:
    
    value - the new value
    
    Returns:
    
    this
  - alertQueueSize
```
public int alertQueueSize()
```
    Returns:
    
    the current value
    
    See Also:
    
    alertQueueSize(int)
  - alertQueueSize
```
public SettingsPack alertQueueSize(int value)
```
    alert_queue_size is the maximum number of alerts queued up internally. If alerts are not popped, the queue will eventually fill up to this level.
    
    Parameters:
    
    value - the new value
    
    Returns:
    
    this
  - upnpIgnoreNonRouters
```
public boolean upnpIgnoreNonRouters()
```
    Indicates whether or not the UPnP implementation should ignore any broadcast response from a device whose address is not the configured router for this machine. i.e. it's a way to not talk to other people's routers by mistake.
    
    Returns:
    
    the current value
  - upnpIgnoreNonRouters
```
public SettingsPack upnpIgnoreNonRouters(boolean value)
```
    Indicates whether or not the UPnP implementation should ignore any broadcast response from a device whose address is not the configured router for this machine. i.e. it's a way to not talk to other people's routers by mistake.
    
    Parameters:
    
    value - the new value
    
    Returns:
    
    this

Class SettingsPack

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SettingsPack

SettingsPack

Method Detail

swig

getBoolean

setBoolean

getInteger

setInteger

getString

setString

clear

clear

downloadRateLimit

downloadRateLimit

uploadRateLimit

uploadRateLimit

activeDownloads

activeDownloads

activeSeeds

activeSeeds

activeChecking

activeChecking

activeDhtLimit

activeDhtLimit

activeTrackerLimit

activeTrackerLimit

activeLsdLimit

activeLsdLimit

activeLimit

activeLimit

connectionsLimit

connectionsLimit

maxPeerlistSize

maxPeerlistSize

maxQueuedDiskBytes

maxQueuedDiskBytes

sendBufferWatermark

sendBufferWatermark

cacheSize

cacheSize

tickInterval

tickInterval

inactivityTimeout

inactivityTimeout

seedingOutgoingConnections

seedingOutgoingConnections

anonymousMode

anonymousMode

broadcastLSD

broadcastLSD

enableDht

enableDht

listenInterfaces

listenInterfaces

stopTrackerTimeout

stopTrackerTimeout

alertQueueSize

alertQueueSize

upnpIgnoreNonRouters

upnpIgnoreNonRouters