2006-04-25 23:04:48 +02:00
|
|
|
/*
|
|
|
|
|
2012-10-02 05:16:33 +02:00
|
|
|
Copyright (c) 2003-2012, Arvid Norberg
|
2006-04-25 23:04:48 +02:00
|
|
|
All rights reserved.
|
|
|
|
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
|
|
modification, are permitted provided that the following conditions
|
|
|
|
are met:
|
|
|
|
|
|
|
|
* Redistributions of source code must retain the above copyright
|
|
|
|
notice, this list of conditions and the following disclaimer.
|
|
|
|
* Redistributions in binary form must reproduce the above copyright
|
|
|
|
notice, this list of conditions and the following disclaimer in
|
|
|
|
the documentation and/or other materials provided with the distribution.
|
|
|
|
* Neither the name of the author nor the names of its
|
|
|
|
contributors may be used to endorse or promote products derived
|
|
|
|
from this software without specific prior written permission.
|
|
|
|
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
|
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
|
|
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
|
|
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
|
|
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
|
|
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
|
|
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
|
|
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
|
|
POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef TORRENT_SESSION_SETTINGS_HPP_INCLUDED
|
|
|
|
#define TORRENT_SESSION_SETTINGS_HPP_INCLUDED
|
|
|
|
|
2006-05-21 01:24:19 +02:00
|
|
|
#include "libtorrent/version.hpp"
|
2007-04-25 20:26:35 +02:00
|
|
|
#include "libtorrent/config.hpp"
|
2010-07-15 03:14:36 +02:00
|
|
|
#include "libtorrent/version.hpp"
|
2006-05-21 01:24:19 +02:00
|
|
|
|
2013-12-02 05:24:10 +01:00
|
|
|
#include <boost/cstdint.hpp>
|
2010-10-10 04:22:57 +02:00
|
|
|
#include <string>
|
|
|
|
|
2006-04-25 23:04:48 +02:00
|
|
|
namespace libtorrent
|
|
|
|
{
|
|
|
|
|
2013-08-08 03:03:54 +02:00
|
|
|
// The ``proxy_settings`` structs contains the information needed to
|
|
|
|
// direct certain traffic to a proxy.
|
2007-04-25 20:26:35 +02:00
|
|
|
struct TORRENT_EXPORT proxy_settings
|
|
|
|
{
|
2013-12-02 05:24:10 +01:00
|
|
|
proxy_settings() : type(none)
|
|
|
|
, port(0), proxy_hostnames(true)
|
2011-01-24 04:24:28 +01:00
|
|
|
, proxy_peer_connections(true)
|
|
|
|
{}
|
2007-04-25 20:26:35 +02:00
|
|
|
|
2013-08-08 03:03:54 +02:00
|
|
|
// the name or IP of the proxy server. ``port`` is the
|
|
|
|
// port number the proxy listens to. If required, ``username`` and ``password``
|
|
|
|
// can be set to authenticate with the proxy.
|
2007-04-25 20:26:35 +02:00
|
|
|
std::string hostname;
|
|
|
|
|
|
|
|
std::string username;
|
|
|
|
std::string password;
|
|
|
|
|
|
|
|
enum proxy_type
|
|
|
|
{
|
2013-08-08 03:03:54 +02:00
|
|
|
// This is the default, no proxy server is used, all other fields
|
|
|
|
// are ignored.
|
2007-04-25 20:26:35 +02:00
|
|
|
none,
|
2013-08-08 03:03:54 +02:00
|
|
|
|
|
|
|
// The server is assumed to be a `SOCKS4 server`_ that
|
|
|
|
// requires a username.
|
|
|
|
//
|
|
|
|
// .. _`SOCKS4 server`: http://www.ufasoft.com/doc/socks4_protocol.htm
|
2007-05-31 01:35:14 +02:00
|
|
|
socks4,
|
2013-08-08 03:03:54 +02:00
|
|
|
// The server is assumed to be a SOCKS5 server (`RFC 1928`_) that
|
|
|
|
// does not require any authentication. The username and password are ignored.
|
|
|
|
//
|
|
|
|
// .. _`RFC 1928`: http://www.faqs.org/rfcs/rfc1928.html
|
2007-04-25 20:26:35 +02:00
|
|
|
socks5,
|
2013-08-08 03:03:54 +02:00
|
|
|
|
|
|
|
// The server is assumed to be a SOCKS5 server that supports
|
|
|
|
// plain text username and password authentication (`RFC 1929`_). The username
|
|
|
|
// and password specified may be sent to the proxy if it requires.
|
|
|
|
//
|
|
|
|
// .. _`RFC 1929`: http://www.faqs.org/rfcs/rfc1929.html
|
2007-04-25 20:26:35 +02:00
|
|
|
socks5_pw,
|
2013-08-08 03:03:54 +02:00
|
|
|
// The server is assumed to be an HTTP proxy. If the transport used
|
|
|
|
// for the connection is non-HTTP, the server is assumed to support the
|
|
|
|
// CONNECT_ method. i.e. for web seeds and HTTP trackers, a plain proxy will
|
|
|
|
// suffice. The proxy is assumed to not require authorization. The username
|
|
|
|
// and password will not be used.
|
|
|
|
//
|
|
|
|
// .. _CONNECT: http://tools.ietf.org/html/draft-luotonen-web-proxy-tunneling-01
|
2007-04-25 20:26:35 +02:00
|
|
|
http,
|
2013-08-08 03:03:54 +02:00
|
|
|
// The server is assumed to be an HTTP proxy that requires
|
|
|
|
// user authorization. The username and password will be sent to the proxy.
|
2009-08-20 05:19:12 +02:00
|
|
|
http_pw,
|
|
|
|
// route through a i2p SAM proxy
|
|
|
|
i2p_proxy
|
2007-04-25 20:26:35 +02:00
|
|
|
};
|
|
|
|
|
2013-08-08 03:03:54 +02:00
|
|
|
// tells libtorrent what kind of proxy server it is. See proxy_type
|
|
|
|
// enum for options
|
2013-12-02 05:24:10 +01:00
|
|
|
boost::uint8_t type;
|
|
|
|
|
|
|
|
// the port the proxy server is running on
|
|
|
|
boost::uint16_t port;
|
2010-08-03 11:08:37 +02:00
|
|
|
|
2013-08-08 03:03:54 +02:00
|
|
|
// defaults to true. It means that hostnames should be
|
|
|
|
// attempted to be resolved through the proxy instead of using the local DNS
|
|
|
|
// service. This is only supported by SOCKS5 and HTTP.
|
2010-08-03 11:08:37 +02:00
|
|
|
bool proxy_hostnames;
|
2011-01-24 04:24:28 +01:00
|
|
|
|
2013-08-08 03:03:54 +02:00
|
|
|
// determines whether or not to excempt peer and
|
|
|
|
// web seed connections from using the proxy. This defaults to true, i.e. peer
|
|
|
|
// connections are proxied by default.
|
2011-01-24 04:24:28 +01:00
|
|
|
bool proxy_peer_connections;
|
2007-04-25 20:26:35 +02:00
|
|
|
};
|
|
|
|
|
2006-04-25 23:04:48 +02:00
|
|
|
struct TORRENT_EXPORT session_settings
|
|
|
|
{
|
2013-08-06 04:50:57 +02:00
|
|
|
session_settings(std::string const& user_agent = "libtorrent/"
|
2012-03-19 07:06:52 +01:00
|
|
|
LIBTORRENT_VERSION);
|
|
|
|
~session_settings();
|
2006-04-25 23:04:48 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// automatically set to the libtorrent version you're using
|
|
|
|
// in order to be forward binary compatible. This field should not be changed.
|
2010-07-15 03:14:36 +02:00
|
|
|
int version;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the client identification to the tracker.
|
|
|
|
// The recommended format of this string is:
|
|
|
|
// "ClientName/ClientVersion libtorrent/libtorrentVersion".
|
|
|
|
// This name will not only be used when making HTTP requests, but also when
|
|
|
|
// sending extended headers to peers that support that extension.
|
2006-05-21 01:24:19 +02:00
|
|
|
std::string user_agent;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of seconds the tracker
|
|
|
|
// connection will wait from when it sent the request until it considers the
|
|
|
|
// tracker to have timed-out. Default value is 60 seconds.
|
2006-05-21 01:24:19 +02:00
|
|
|
int tracker_completion_timeout;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of seconds to wait to receive
|
|
|
|
// any data from the tracker. If no data is received for this number of
|
|
|
|
// seconds, the tracker will be considered as having timed out. If a tracker
|
|
|
|
// is down, this is the kind of timeout that will occur. The default value
|
|
|
|
// is 20 seconds.
|
2006-05-21 01:24:19 +02:00
|
|
|
int tracker_receive_timeout;
|
|
|
|
|
|
|
|
// the time 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
|
2013-08-11 00:15:02 +02:00
|
|
|
//
|
|
|
|
// This is given in seconds. Default is
|
|
|
|
// 10 seconds.
|
2006-05-21 01:24:19 +02:00
|
|
|
int stop_tracker_timeout;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the maximum number of bytes in a
|
|
|
|
// tracker response. If a response size passes this number it will be rejected
|
|
|
|
// and the connection will be closed. On gzipped responses this size is measured
|
|
|
|
// on the uncompressed data. So, if you get 20 bytes of gzip response that'll
|
|
|
|
// expand to 2 megs, it will be interrupted before the entire response has been
|
|
|
|
// uncompressed (given your limit is lower than 2 megs). Default limit is
|
|
|
|
// 1 megabyte.
|
2006-05-21 01:24:19 +02:00
|
|
|
int tracker_maximum_response_length;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// controls the number of seconds from a request is sent until
|
2006-04-25 23:04:48 +02:00
|
|
|
// it times out if no piece response is returned.
|
|
|
|
int piece_timeout;
|
|
|
|
|
2008-06-29 11:50:42 +02:00
|
|
|
// the number of seconds one block (16kB) is expected
|
|
|
|
// to be received within. If it's not, the block is
|
|
|
|
// requested from a different peer
|
|
|
|
int request_timeout;
|
|
|
|
|
2006-04-25 23:04:48 +02:00
|
|
|
// the length of the request queue given in the number
|
|
|
|
// of seconds it should take for the other end to send
|
|
|
|
// all the pieces. i.e. the actual number of requests
|
|
|
|
// depends on the download rate and this number.
|
2009-07-19 06:59:27 +02:00
|
|
|
int request_queue_time;
|
2006-04-25 23:04:48 +02:00
|
|
|
|
2006-04-30 02:39:18 +02:00
|
|
|
// the number of outstanding block requests a peer is
|
|
|
|
// allowed to queue up in the client. If a peer sends
|
|
|
|
// more requests than this (before the first one has
|
|
|
|
// been sent) the last request will be dropped.
|
|
|
|
// the higher this is, the faster upload speeds the
|
|
|
|
// client can get to a single peer.
|
2006-05-15 00:30:05 +02:00
|
|
|
int max_allowed_in_request_queue;
|
|
|
|
|
|
|
|
// the maximum number of outstanding requests to
|
|
|
|
// send to a peer. This limit takes precedence over
|
|
|
|
// request_queue_time.
|
2013-08-11 00:15:02 +02:00
|
|
|
// i.e. no matter the download speed, the number of outstanding requests will never
|
|
|
|
// exceed this limit.
|
2006-05-15 00:30:05 +02:00
|
|
|
int max_out_request_queue;
|
2006-05-21 01:24:19 +02:00
|
|
|
|
2006-05-15 00:30:05 +02:00
|
|
|
// if a whole piece can be downloaded in this number
|
|
|
|
// of seconds, or less, the peer_connection will prefer
|
|
|
|
// to request whole pieces at a time from this peer.
|
|
|
|
// The benefit of this is to better utilize disk caches by
|
|
|
|
// doing localized accesses and also to make it easier
|
|
|
|
// to identify bad peers if a piece fails the hash check.
|
|
|
|
int whole_pieces_threshold;
|
2006-06-29 01:27:44 +02:00
|
|
|
|
|
|
|
// the number of seconds to wait for any activity on
|
|
|
|
// the peer wire before closing the connectiong due
|
|
|
|
// to time out.
|
2013-08-11 00:15:02 +02:00
|
|
|
// This defaults to 120 seconds, since that's what's specified
|
|
|
|
// in the protocol specification. After half the time out, a keep alive message
|
|
|
|
// is sent.
|
2006-06-29 01:27:44 +02:00
|
|
|
int peer_timeout;
|
|
|
|
|
|
|
|
// same as peer_timeout, but only applies to url-seeds.
|
|
|
|
// this is usually set lower, because web servers are
|
|
|
|
// expected to be more reliable.
|
2013-08-11 00:15:02 +02:00
|
|
|
// This value defaults to 20 seconds.
|
2006-06-29 01:27:44 +02:00
|
|
|
int urlseed_timeout;
|
2006-08-01 17:27:08 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// controls the pipelining with the web server. When
|
|
|
|
// using persistent connections to HTTP 1.1 servers, the client is allowed to
|
|
|
|
// send more requests before the first response is received. This number controls
|
|
|
|
// the number of outstanding requests to use with url-seeds. Default is 5.
|
2006-08-01 17:27:08 +02:00
|
|
|
int urlseed_pipeline_size;
|
2007-11-27 04:37:47 +01:00
|
|
|
|
|
|
|
// time to wait until a new retry takes place
|
|
|
|
int urlseed_wait_retry;
|
2006-11-14 16:53:38 +01:00
|
|
|
|
|
|
|
// sets the upper limit on the total number of files this
|
|
|
|
// session will keep open. The reason why files are
|
|
|
|
// left open at all is that some anti virus software
|
|
|
|
// hooks on every file close, and scans the file for
|
|
|
|
// viruses. deferring the closing of the files will
|
|
|
|
// be the difference between a usable system and
|
|
|
|
// a completely hogged down system. Most operating
|
|
|
|
// systems also has a limit on the total number of
|
|
|
|
// file descriptors a process may have open. It is
|
|
|
|
// usually a good idea to find this limit and set the
|
|
|
|
// number of connections and the number of files
|
|
|
|
// limits so their sum is slightly below it.
|
|
|
|
int file_pool_size;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// determines if connections from the
|
|
|
|
// same IP address as existing connections should be rejected or not. Multiple
|
|
|
|
// connections from the same IP address is not allowed by default, to prevent
|
|
|
|
// abusive behavior by peers. It may be useful to allow such connections in
|
|
|
|
// cases where simulations are run on the same machie, and all peers in a
|
|
|
|
// swarm has the same IP address.
|
2006-11-14 16:53:38 +01:00
|
|
|
bool allow_multiple_connections_per_ip;
|
2007-02-12 10:20:49 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the maximum times we try to connect to a peer before
|
|
|
|
// stop connecting again. If a peer succeeds, its failcounter is reset. If
|
|
|
|
// a peer is retrieved from a peer source (other than DHT) the failcount is
|
|
|
|
// decremented by one, allowing another try.
|
2007-04-14 23:47:07 +02:00
|
|
|
int max_failcount;
|
|
|
|
|
|
|
|
// the number of seconds to wait to reconnect to a peer.
|
|
|
|
// this time is multiplied with the failcount.
|
|
|
|
int min_reconnect_time;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of seconds to wait after a connection
|
|
|
|
// attempt is initiated to a peer until it is considered as having timed out.
|
|
|
|
// The default is 10 seconds. This setting is especially important in case
|
|
|
|
// the number of half-open connections are limited, since stale half-open
|
|
|
|
// connection may delay the connection of other peers considerably.
|
2007-05-05 02:29:33 +02:00
|
|
|
int peer_connect_timeout;
|
|
|
|
|
2007-05-25 19:06:30 +02:00
|
|
|
// if set to true, upload, download and unchoke limits
|
2007-05-25 23:00:35 +02:00
|
|
|
// are ignored for peers on the local network.
|
2007-05-25 19:06:30 +02:00
|
|
|
bool ignore_limits_on_local_network;
|
|
|
|
|
2007-05-25 23:00:35 +02:00
|
|
|
// the number of connection attempts that
|
2013-08-11 00:15:02 +02:00
|
|
|
// are made per second. If a number < 0 is specified, it will default to
|
|
|
|
// 200 connections per second. If 0 is specified, it means don't make
|
|
|
|
// outgoing connections at all.
|
2007-05-25 23:00:35 +02:00
|
|
|
int connection_speed;
|
|
|
|
|
2007-05-25 23:19:14 +02:00
|
|
|
// if this is set to true, have messages will be sent
|
|
|
|
// to peers that already have the piece. This is
|
|
|
|
// typically not necessary, but it might be necessary
|
|
|
|
// for collecting statistics in some cases. Default is false.
|
|
|
|
bool send_redundant_have;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// prevents outgoing bitfields from being full. If the
|
|
|
|
// client is seed, a few bits will be set to 0, and later filled in with
|
|
|
|
// have-messages. This is an old attempt to prevent certain ISPs
|
2007-05-27 00:27:40 +02:00
|
|
|
// from stopping people from seeding.
|
|
|
|
bool lazy_bitfields;
|
|
|
|
|
2007-05-31 21:57:15 +02:00
|
|
|
// if a peer is uninteresting and uninterested for longer
|
|
|
|
// than this number of seconds, it will be disconnected.
|
|
|
|
// default is 10 minutes
|
|
|
|
int inactivity_timeout;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of seconds between chokes/unchokes.
|
|
|
|
// On this interval, peers are re-evaluated for being choked/unchoked. This
|
|
|
|
// is defined as 30 seconds in the protocol, and it should be significantly
|
|
|
|
// longer than what it takes for TCP to ramp up to it's max rate.
|
2007-06-08 00:37:58 +02:00
|
|
|
int unchoke_interval;
|
|
|
|
|
2008-10-19 00:35:10 +02:00
|
|
|
// the number of seconds between
|
2013-08-11 00:15:02 +02:00
|
|
|
// each *optimistic* unchoke. On this timer, the currently optimistically
|
|
|
|
// unchoked peer will change.
|
2008-10-19 00:35:10 +02:00
|
|
|
int optimistic_unchoke_interval;
|
2007-08-16 14:41:46 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the ip address passed along to trackers as the ``&ip=`` parameter.
|
|
|
|
// If left as the default (an empty string), that parameter is omitted.
|
|
|
|
// Most trackers ignore this argument. This is here for completeness
|
|
|
|
// for edge-cases where it may be useful.
|
2009-11-23 09:38:50 +01:00
|
|
|
std::string announce_ip;
|
2007-06-13 02:20:06 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of peers we want from each tracker request. It defines
|
|
|
|
// what is sent as the ``&num_want=`` parameter to the tracker.
|
|
|
|
// Stopped messages always send num_want=0. This setting control what
|
|
|
|
// to say in the case where we actually want peers.
|
2007-07-02 20:44:33 +02:00
|
|
|
int num_want;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// specifies the number of pieces we need before we
|
|
|
|
// switch to rarest first picking. This defaults to 4, which means the 4 first
|
|
|
|
// pieces in any torrent are picked at random, the following pieces are picked
|
|
|
|
// in rarest first order.
|
2007-07-07 03:26:30 +02:00
|
|
|
int initial_picker_threshold;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of allowed pieces to send to choked peers
|
2007-08-14 19:47:48 +02:00
|
|
|
// that supports the fast extensions
|
|
|
|
int allowed_fast_set_size;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// options for session_settings::suggest_mode.
|
|
|
|
enum suggest_mode_t
|
|
|
|
{
|
|
|
|
// the default. will not send out suggest messages.
|
|
|
|
no_piece_suggestions = 0,
|
|
|
|
|
|
|
|
// send out suggest messages for the most
|
|
|
|
// recent pieces that are in the read cache.
|
|
|
|
suggest_read_cache = 1
|
|
|
|
};
|
|
|
|
|
2010-01-15 17:45:42 +01:00
|
|
|
// this determines which pieces will be suggested to peers
|
|
|
|
// suggest read cache will make libtorrent suggest pieces
|
|
|
|
// that are fresh in the disk read cache, to potentially
|
|
|
|
// lower disk access and increase the cache hit ratio
|
2013-08-11 00:15:02 +02:00
|
|
|
//
|
|
|
|
// for options, see suggest_mode_t.
|
2010-01-15 17:45:42 +01:00
|
|
|
int suggest_mode;
|
|
|
|
|
2007-08-01 07:22:34 +02:00
|
|
|
// 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
|
2013-08-11 00:15:02 +02:00
|
|
|
// to slow medias to allocate more memory
|
2009-05-12 19:57:52 +02:00
|
|
|
// indefinitely. This should be set to at least 16 kB
|
2009-06-10 10:30:55 +02:00
|
|
|
// 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.
|
2013-08-11 00:15:02 +02:00
|
|
|
//
|
|
|
|
// 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 severly limit your download rate.
|
2009-06-10 10:30:55 +02:00
|
|
|
int max_queued_disk_bytes;
|
2007-08-01 07:22:34 +02:00
|
|
|
|
2011-02-04 04:02:23 +01:00
|
|
|
// this is the low watermark for the disk buffer queue.
|
|
|
|
// whenever the number of queued bytes exceed the
|
|
|
|
// max_queued_disk_bytes, libtorrent will wait for
|
|
|
|
// it to drop below this value before issuing more
|
|
|
|
// reads from the sockets. If set to 0, the
|
|
|
|
// low watermark will be half of the max queued disk bytes
|
|
|
|
int max_queued_disk_bytes_low_watermark;
|
|
|
|
|
2007-10-23 02:19:28 +02:00
|
|
|
// the number of seconds to wait for a handshake
|
|
|
|
// response from a peer. If no response is received
|
|
|
|
// within this time, the peer is disconnected.
|
|
|
|
int handshake_timeout;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// determines how the DHT is used. If this is true,
|
|
|
|
// the DHT will only be used for torrents where all trackers in its tracker
|
|
|
|
// list has failed. Either by an explicit error message or a time out. This
|
|
|
|
// is false by default, which means the DHT is used by default regardless of
|
|
|
|
// if the trackers fail or not.
|
2007-02-12 10:20:49 +01:00
|
|
|
bool use_dht_as_fallback;
|
2007-11-19 05:58:52 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// determines whether or not the torrent's piece hashes
|
|
|
|
// are kept in memory after the torrent becomes a seed or not. If it is set to
|
|
|
|
// ``true`` the hashes are freed once the torrent is a seed (they're not
|
|
|
|
// needed anymore since the torrent won't download anything more). If it's set
|
2013-08-11 08:04:24 +02:00
|
|
|
// to false they are not freed. If they are freed, the torrent_info returned
|
2013-08-11 00:15:02 +02:00
|
|
|
// by get_torrent_info() will return an object that may be incomplete, that
|
2013-08-11 08:04:24 +02:00
|
|
|
// cannot be passed back to async_add_torrent() and add_torrent() for instance.
|
2007-11-19 05:58:52 +01:00
|
|
|
bool free_torrent_hashes;
|
2008-01-07 06:48:28 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// 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.
|
2008-01-07 06:48:28 +01:00
|
|
|
bool upnp_ignore_nonrouters;
|
2008-01-08 02:16:30 +01:00
|
|
|
|
2012-03-07 03:59:50 +01:00
|
|
|
// This is the minimum send buffer target size (send buffer
|
|
|
|
// includes bytes pending being read from disk). For good
|
|
|
|
// and snappy seeding performance, set this fairly high, to
|
|
|
|
// at least fit a few blocks. This is essentially the initial
|
|
|
|
// window size which will determine how fast we can ramp up
|
|
|
|
// the send rate
|
2013-08-11 00:15:02 +02:00
|
|
|
int send_buffer_low_watermark;
|
|
|
|
|
|
|
|
// 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.
|
|
|
|
int send_buffer_watermark;
|
2008-01-13 12:18:18 +01:00
|
|
|
|
2010-03-12 03:36:55 +01:00
|
|
|
// the current upload rate to a peer is multiplied by
|
2011-09-23 23:12:28 +02:00
|
|
|
// this factor to get the send buffer watermark. The
|
2013-08-11 00:15:02 +02:00
|
|
|
// factor is specified as a percentage. i.e. 50 indicates
|
|
|
|
// a factor of 0.5.
|
|
|
|
//
|
2011-09-23 23:12:28 +02:00
|
|
|
// This product is clamped to the send_buffer_watermark
|
2010-03-12 03:36:55 +01:00
|
|
|
// setting to not exceed the max. For high speed
|
|
|
|
// upload, this should be set to a greater value than
|
2011-09-23 23:12:28 +02:00
|
|
|
// 100. The default is 50.
|
2013-08-11 00:15:02 +02:00
|
|
|
//
|
|
|
|
// For high capacity connections, setting this
|
|
|
|
// higher can improve upload performance and disk throughput. Setting it too
|
|
|
|
// high may waste RAM and create a bias towards read jobs over write jobs.
|
2010-03-12 03:36:55 +01:00
|
|
|
int send_buffer_watermark_factor;
|
|
|
|
|
2010-02-09 04:04:41 +01:00
|
|
|
#ifndef TORRENT_NO_DEPRECATE
|
|
|
|
// deprecated in 0.16
|
2013-08-11 00:15:02 +02:00
|
|
|
// defaults to true. When true, if there is a global upload
|
|
|
|
// limit set and the current upload rate is less than 90% of that, another upload
|
|
|
|
// slot is opened. If the upload rate has been saturated for an extended period
|
|
|
|
// of time, on upload slot is closed. The number of upload slots will never be
|
|
|
|
// less than what has been set by ``session::set_max_uploads()``. To query the
|
|
|
|
// current number of upload slots, see ``session_status::allowed_upload_slots``.
|
2008-01-13 12:18:18 +01:00
|
|
|
bool auto_upload_slots;
|
2013-08-11 00:15:02 +02:00
|
|
|
|
|
|
|
// When set, and ``auto_upload_slots`` is set,
|
|
|
|
// the max upload slots setting is used as a minimum number of unchoked slots.
|
|
|
|
// This algorithm is designed to prevent the peer from spreading its upload
|
|
|
|
// capacity too thin, but still open more slots in order to utilize the full capacity.
|
2009-04-04 09:55:34 +02:00
|
|
|
bool auto_upload_slots_rate_based;
|
2010-02-09 04:04:41 +01:00
|
|
|
#endif
|
|
|
|
|
|
|
|
enum choking_algorithm_t
|
|
|
|
{
|
2013-08-11 00:15:02 +02:00
|
|
|
// the traditional choker with a fixed number of unchoke
|
|
|
|
// slots, as specified by session::set_max_uploads()..
|
2010-02-09 04:04:41 +01:00
|
|
|
fixed_slots_choker,
|
2013-08-11 00:15:02 +02:00
|
|
|
|
|
|
|
// opens at least the number of slots as specified by
|
|
|
|
// session::set_max_uploads() but opens up more slots if the upload capacity
|
|
|
|
// is not saturated. This unchoker will work just like the ``fixed_slot_choker``
|
|
|
|
// if there's no global upload rate limit set.
|
2010-02-09 04:04:41 +01:00
|
|
|
auto_expand_choker,
|
2013-08-11 00:15:02 +02:00
|
|
|
|
|
|
|
// opens up unchoke slots based on the upload rate
|
|
|
|
// achieved to peers. The more slots that are opened, the marginal upload
|
|
|
|
// rate required to open up another slot increases.
|
2010-02-09 04:04:41 +01:00
|
|
|
rate_based_choker,
|
2013-08-11 00:15:02 +02:00
|
|
|
// attempts to optimize download rate by finding the
|
|
|
|
// reciprocation rate of each peer individually and prefers peers that gives
|
|
|
|
// the highest *return on investment*. It still allocates all upload capacity,
|
|
|
|
// but shuffles it around to the best peers first. For this choker to be
|
|
|
|
// efficient, you need to set a global upload rate limit
|
|
|
|
// session_settings::upload_rate_limit. For more information about this
|
|
|
|
// choker, see the paper_.
|
|
|
|
//
|
|
|
|
// .. _paper: http://bittyrant.cs.washington.edu/#papers
|
2010-02-09 04:04:41 +01:00
|
|
|
bittyrant_choker
|
|
|
|
};
|
2009-04-04 09:55:34 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// specifies which algorithm to use to determine which peers
|
|
|
|
// to unchoke. This setting replaces the deprecated settings ``auto_upload_slots``
|
|
|
|
// and ``auto_upload_slots_rate_based``. For options, see choking_algorithm_t.
|
2010-02-09 04:04:41 +01:00
|
|
|
int choking_algorithm;
|
2010-10-09 23:11:03 +02:00
|
|
|
|
|
|
|
enum seed_choking_algorithm_t
|
|
|
|
{
|
2013-08-11 00:15:02 +02:00
|
|
|
// round-robins the peers that are unchoked when seeding. This
|
|
|
|
// distributes the upload bandwidht uniformly and fairly. It minimizes the ability
|
|
|
|
// for a peer to download everything without redistributing it.
|
2010-10-09 23:11:03 +02:00
|
|
|
round_robin,
|
2013-08-11 00:15:02 +02:00
|
|
|
|
|
|
|
// unchokes the peers we can send to the fastest. This might be
|
|
|
|
// a bit more reliable in utilizing all available capacity.
|
2010-10-21 07:53:13 +02:00
|
|
|
fastest_upload,
|
2013-08-11 00:15:02 +02:00
|
|
|
|
|
|
|
// prioritizes peers who have just started or are just about to finish
|
|
|
|
// the download. The intention is to force peers in the middle of the download to
|
|
|
|
// trade with each other.
|
2010-10-21 07:53:13 +02:00
|
|
|
anti_leech
|
2010-10-09 23:11:03 +02:00
|
|
|
};
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// controls the seeding unchoke behavior. For options, see seed_choking_algorithm_t.
|
2010-10-09 23:11:03 +02:00
|
|
|
int seed_choking_algorithm;
|
2010-02-09 04:04:41 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// specifies if parole mode should be used. Parole mode means
|
|
|
|
// that peers that participate in pieces that fail the hash check are put in a mode
|
|
|
|
// where they are only allowed to download whole pieces. If the whole piece a peer
|
|
|
|
// in parole mode fails the hash check, it is banned. If a peer participates in a
|
|
|
|
// piece that passes the hash check, it is taken out of parole mode.
|
2008-07-11 11:23:22 +02:00
|
|
|
bool use_parole_mode;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// 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).
|
|
|
|
//
|
|
|
|
// Disk buffers are allocated using a pool allocator, the number of blocks that
|
|
|
|
// are allocated at a time when the pool needs to grow can be specified in
|
|
|
|
// ``cache_buffer_chunk_size``. This defaults to 16 blocks. Lower numbers
|
|
|
|
// saves memory at the expense of more heap allocations. It must be at least 1.
|
2008-02-08 11:22:05 +01:00
|
|
|
int cache_size;
|
2008-02-10 01:58:25 +01:00
|
|
|
|
2009-05-12 20:52:05 +02:00
|
|
|
// this is the number of disk buffer blocks (16 kiB)
|
|
|
|
// that should be allocated at a time. It must be
|
|
|
|
// at least 1. Lower number saves memory at the expense
|
|
|
|
// of more heap allocations
|
|
|
|
int cache_buffer_chunk_size;
|
|
|
|
|
2008-02-10 01:58:25 +01:00
|
|
|
// the number of seconds a write cache entry sits
|
|
|
|
// idle in the cache before it's forcefully flushed
|
2013-08-11 00:15:02 +02:00
|
|
|
// to disk.
|
2008-02-10 01:58:25 +01:00
|
|
|
int cache_expiry;
|
2008-02-28 08:34:07 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// when set to true (default), the disk cache is also used to
|
|
|
|
// cache pieces read from disk. Blocks for writing pieces takes presedence.
|
2009-01-10 06:46:02 +01:00
|
|
|
bool use_read_cache;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// defaults to 0. If set to something greater than 0, the
|
|
|
|
// disk read cache will not be evicted by cache misses and will explicitly be
|
|
|
|
// controlled based on the rarity of pieces. Rare pieces are more likely to be
|
|
|
|
// cached. This would typically be used together with ``suggest_mode`` set to
|
|
|
|
// ``suggest_read_cache``. The value is the number of pieces to keep in the read
|
|
|
|
// cache. If the actual read cache can't fit as many, it will essentially be clamped.
|
2010-01-15 17:45:42 +01:00
|
|
|
bool explicit_read_cache;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of seconds in between each refresh of
|
|
|
|
// a part of the explicit read cache. Torrents take turns in refreshing and this
|
|
|
|
// is the time in between each torrent refresh. Refreshing a torrent's explicit
|
|
|
|
// read cache means scanning all pieces and picking a random set of the rarest ones.
|
|
|
|
// There is an affinity to pick pieces that are already in the cache, so that
|
|
|
|
// subsequent refreshes only swaps in pieces that are rarer than whatever is in
|
|
|
|
// the cache at the time.
|
2010-01-15 17:45:42 +01:00
|
|
|
int explicit_cache_interval;
|
|
|
|
|
2009-01-21 08:31:49 +01:00
|
|
|
enum io_buffer_mode_t
|
|
|
|
{
|
2013-08-11 00:15:02 +02:00
|
|
|
// This is the default and files are opened normally, with the OS caching
|
|
|
|
// reads and writes.
|
2009-01-21 08:31:49 +01:00
|
|
|
enable_os_cache = 0,
|
2013-08-11 00:15:02 +02:00
|
|
|
// This will open files in unbuffered mode for files where every read and
|
|
|
|
// write would be sector aligned. Using aligned disk offsets is a requirement
|
|
|
|
// on some operating systems.
|
2009-01-21 08:31:49 +01:00
|
|
|
disable_os_cache_for_aligned_files = 1,
|
2013-08-11 00:15:02 +02:00
|
|
|
// This opens all files in unbuffered mode (if allowed by the operating system).
|
|
|
|
// Linux and Windows, for instance, require disk offsets to be sector aligned,
|
|
|
|
// and in those cases, this option is the same as ``disable_os_caches_for_aligned_files``.
|
2009-01-21 08:31:49 +01:00
|
|
|
disable_os_cache = 2
|
|
|
|
};
|
2013-08-11 00:15:02 +02:00
|
|
|
|
|
|
|
// determines how files are
|
|
|
|
// opened when they're in read only mode versus read and write mode. For options,
|
|
|
|
// see io_buffer_mode_t.
|
|
|
|
//
|
|
|
|
// One reason to disable caching is that it may help the operating system from growing
|
|
|
|
// its file cache indefinitely. Since some OSes only allow aligned files to be opened
|
|
|
|
// in unbuffered mode, It is recommended to make the largest file in a torrent the first
|
|
|
|
// file (with offset 0) or use pad files to align all files to piece boundries.
|
2009-06-03 11:02:43 +02:00
|
|
|
int disk_io_write_mode;
|
|
|
|
int disk_io_read_mode;
|
2009-01-21 08:31:49 +01:00
|
|
|
|
|
|
|
bool coalesce_reads;
|
|
|
|
bool coalesce_writes;
|
2009-01-11 03:02:34 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// if set to something other than (0, 0) is a range of ports
|
|
|
|
// used to bind outgoing sockets to. This may be useful for users whose router
|
|
|
|
// allows them to assign QoS classes to traffic based on its local port. It is
|
|
|
|
// a range instead of a single port because of the problems with failing to reconnect
|
|
|
|
// to peers if a previous socket to that peer and port is in ``TIME_WAIT`` state.
|
|
|
|
//
|
|
|
|
//.. warning:: setting outgoing ports will limit the ability to keep multiple
|
|
|
|
// connections to the same client, even for different torrents. It is not
|
|
|
|
// recommended to change this setting. Its main purpose is to use as an
|
|
|
|
// escape hatch for cheap routers with QoS capability but can only classify
|
|
|
|
// flows based on port numbers.
|
2008-02-28 08:34:07 +01:00
|
|
|
std::pair<int, int> outgoing_ports;
|
2008-03-12 17:58:23 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// determines the TOS byte set in the IP header of every packet
|
|
|
|
// sent to peers (including web seeds). The default value for this is ``0x0``
|
|
|
|
// (no marking). One potentially useful TOS mark is ``0x20``, this represents
|
|
|
|
// the *QBone scavenger service*. For more details, see QBSS_.
|
|
|
|
//
|
|
|
|
// .. _`QBSS`: http://qbone.internet2.edu/qbss/
|
2008-03-12 17:58:23 +01:00
|
|
|
char peer_tos;
|
2008-04-24 05:28:48 +02:00
|
|
|
|
|
|
|
// 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.
|
2013-08-11 00:15:02 +02:00
|
|
|
//
|
|
|
|
// ``active_dht_limit`` and ``active_tracker_limit`` limits the
|
2010-03-29 02:34:04 +02:00
|
|
|
// number of torrents that will be active on the DHT
|
2013-08-11 00:15:02 +02:00
|
|
|
// and their tracker. If the active limit is set higher
|
2010-03-29 02:34:04 +02:00
|
|
|
// than these numbers, some torrents will be "active" in
|
|
|
|
// the sense that they will accept incoming connections,
|
2013-08-11 00:15:02 +02:00
|
|
|
// but not announce on the DHT or their trackers.
|
|
|
|
//
|
|
|
|
// ``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).
|
|
|
|
//
|
|
|
|
// ``active_limit`` is a hard limit on the number of active torrents. This applies even to
|
|
|
|
// slow torrents.
|
|
|
|
//
|
|
|
|
// 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.
|
|
|
|
//
|
|
|
|
// ``active_downloads`` and ``active_seeds`` controls how many active seeding and
|
|
|
|
// 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 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.
|
2008-04-24 05:28:48 +02:00
|
|
|
int active_downloads;
|
|
|
|
int active_seeds;
|
2010-03-29 02:34:04 +02:00
|
|
|
int active_dht_limit;
|
|
|
|
int active_tracker_limit;
|
|
|
|
int active_lsd_limit;
|
2008-06-21 14:31:28 +02:00
|
|
|
int active_limit;
|
2008-04-24 05:28:48 +02:00
|
|
|
|
2009-05-27 21:27:12 +02:00
|
|
|
// prefer seeding torrents when determining which torrents to give
|
|
|
|
// active slots to, the default is false which gives preference to
|
|
|
|
// downloading torrents
|
|
|
|
bool auto_manage_prefer_seeds;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// if true, torrents without any payload transfers are
|
|
|
|
// not subject to the ``active_seeds`` and ``active_downloads`` limits. This is intended
|
|
|
|
// to make it more likely to utilize all available bandwidth, and avoid having torrents
|
|
|
|
// that don't transfer anything block the active slots.
|
2008-06-21 14:31:28 +02:00
|
|
|
bool dont_count_slow_torrents;
|
2008-06-21 11:15:29 +02:00
|
|
|
|
2008-04-24 05:28:48 +02:00
|
|
|
// the number of seconds in between recalculating which
|
|
|
|
// torrents to activate and which ones to queue
|
|
|
|
int auto_manage_interval;
|
2006-08-01 17:27:08 +02:00
|
|
|
|
2012-12-05 07:11:02 +01:00
|
|
|
// when a seeding torrent reaches either the share ratio
|
2008-04-24 05:28:48 +02:00
|
|
|
// (bytes up / bytes down) or the seed time ratio
|
|
|
|
// (seconds as seed / seconds as downloader) or the seed
|
|
|
|
// time limit (seconds as seed) it is considered
|
|
|
|
// done, and it will leave room for other torrents
|
|
|
|
// the default value for share ratio is 2
|
|
|
|
// the default seed time ratio is 7, because that's a common
|
|
|
|
// asymmetry ratio on connections
|
2013-08-11 00:15:02 +02:00
|
|
|
//
|
|
|
|
//.. note::
|
|
|
|
// This is an out-dated option that doesn't make much sense.
|
|
|
|
// It will be removed in future versions of libtorrent
|
2008-04-24 05:28:48 +02:00
|
|
|
float share_ratio_limit;
|
2013-08-11 00:15:02 +02:00
|
|
|
|
|
|
|
// the seeding time / downloading time ratio limit
|
|
|
|
// for considering a seeding torrent to have met the seed limit criteria. See queuing_.
|
2008-04-24 05:28:48 +02:00
|
|
|
float seed_time_ratio_limit;
|
2013-08-11 00:15:02 +02:00
|
|
|
|
|
|
|
// the limit on the time a torrent has been an active seed
|
|
|
|
// (specified in seconds) before it is considered having met the seed limit criteria.
|
|
|
|
// See queuing_.
|
2008-04-24 05:28:48 +02:00
|
|
|
int seed_time_limit;
|
2008-05-12 07:17:11 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// controls a feature where libtorrent periodically can disconnect
|
|
|
|
// the least useful peers in the hope of connecting to better ones. ``peer_turnover_interval`` controls
|
|
|
|
// the interval of this optimistic disconnect. It defaults to every 5 minutes, and
|
|
|
|
// is specified in seconds.
|
|
|
|
//
|
|
|
|
// ``peer_turnover`` Is the fraction of the peers that are disconnected. This is
|
|
|
|
// a float where 1.f represents all peers an 0 represents no peers. It defaults to
|
|
|
|
// 4% (i.e. 0.04f)
|
|
|
|
//
|
|
|
|
// ``peer_turnover_cutoff`` is the cut off trigger for optimistic unchokes. If a torrent
|
|
|
|
// has more than this fraction of its connection limit, the optimistic unchoke is
|
|
|
|
// triggered. This defaults to 90% (i.e. 0.9f).
|
2010-10-30 17:59:57 +02:00
|
|
|
int peer_turnover_interval;
|
2008-05-12 07:17:11 +02:00
|
|
|
float peer_turnover;
|
|
|
|
float peer_turnover_cutoff;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// specifies whether libtorrent should close
|
|
|
|
// connections where both ends have no utility in keeping the connection open.
|
|
|
|
// For instance if both ends have completed their downloads, there's no point
|
|
|
|
// in keeping it open. This defaults to ``true``.
|
2008-05-12 07:17:11 +02:00
|
|
|
bool close_redundant_connections;
|
2008-05-19 06:06:25 +02:00
|
|
|
|
|
|
|
// the number of seconds between scrapes of
|
2013-08-11 00:15:02 +02:00
|
|
|
// queued torrents (auto managed and paused torrents). Auto managed
|
|
|
|
// torrents that are paused, are scraped regularly in order to keep
|
|
|
|
// track of their downloader/seed ratio. This ratio is used to determine
|
|
|
|
// which torrents to seed and which to pause.
|
2008-05-19 06:06:25 +02:00
|
|
|
int auto_scrape_interval;
|
|
|
|
|
|
|
|
// the minimum number of seconds between any
|
2013-08-11 00:15:02 +02:00
|
|
|
// automatic scrape (regardless of torrent). In case there are a large number
|
|
|
|
// of paused auto managed torrents, this puts a limit on how often a scrape
|
|
|
|
// request is sent.
|
2008-05-19 06:06:25 +02:00
|
|
|
int auto_scrape_min_interval;
|
2008-05-28 20:25:48 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// 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.
|
2008-05-28 20:25:48 +02:00
|
|
|
int max_peerlist_size;
|
2008-08-02 00:34:37 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the max peer list size used for torrents
|
|
|
|
// that are paused. This default to the same as ``max_peerlist_size``, but
|
|
|
|
// can be used to save memory for paused torrents, since it's not as
|
|
|
|
// important for them to keep a large peer list.
|
2009-05-13 03:34:10 +02:00
|
|
|
int max_paused_peerlist_size;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the minimum allowed announce interval
|
|
|
|
// for a tracker. This is specified in seconds, defaults to 5 minutes and
|
|
|
|
// is used as a sanity check on what is returned from a tracker. It
|
|
|
|
// mitigates hammering misconfigured trackers.
|
2008-08-02 00:34:37 +02:00
|
|
|
int min_announce_interval;
|
2008-09-06 23:04:57 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// If true, partial pieces are picked
|
|
|
|
// before pieces that are more rare. If false, rare pieces are always
|
|
|
|
// prioritized, unless the number of partial pieces is growing out of
|
|
|
|
// proportion.
|
2008-09-06 23:04:57 +02:00
|
|
|
bool prioritize_partial_pieces;
|
2008-10-01 07:25:18 +02:00
|
|
|
|
|
|
|
// the number of seconds a torrent is considered
|
|
|
|
// active after it was started, regardless of
|
|
|
|
// upload and download speed. This is so that
|
|
|
|
// newly started torrents are not considered
|
|
|
|
// inactive until they have a fair chance to
|
|
|
|
// start downloading.
|
|
|
|
int auto_manage_startup;
|
2008-11-18 12:14:44 +01:00
|
|
|
|
|
|
|
// if set to true, the estimated TCP/IP overhead is
|
|
|
|
// drained from the rate limiters, to avoid exceeding
|
|
|
|
// the limits with the total traffic
|
|
|
|
bool rate_limit_ip_overhead;
|
2008-11-29 09:38:40 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// controls how multi tracker torrents are
|
|
|
|
// treated. If this is set to true, all trackers in the same tier are
|
|
|
|
// announced to in parallel. If all trackers in tier 0 fails, all trackers
|
|
|
|
// in tier 1 are announced as well. If it's set to false, the behavior is as
|
|
|
|
// defined by the multi tracker specification. It defaults to false, which
|
|
|
|
// is the same behavior previous versions of libtorrent has had as well.
|
2009-06-28 22:21:55 +02:00
|
|
|
bool announce_to_all_trackers;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// controls how multi tracker torrents are
|
|
|
|
// treated. When this is set to true, one tracker from each tier is announced
|
|
|
|
// to. This is the uTorrent behavior. This is false by default in order
|
|
|
|
// to comply with the multi-tracker specification.
|
2009-06-28 22:21:55 +02:00
|
|
|
bool announce_to_all_tiers;
|
2008-12-08 10:13:21 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// true by default. It means that trackers may
|
|
|
|
// be rearranged in a way that udp trackers are always tried before http
|
|
|
|
// trackers for the same hostname. Setting this to fails means that the
|
|
|
|
// trackers' tier is respected and there's no preference of one protocol
|
|
|
|
// over another.
|
2008-12-08 10:13:21 +01:00
|
|
|
bool prefer_udp_trackers;
|
2008-12-09 08:56:37 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// when this is set to true, a piece has to
|
|
|
|
// have been forwarded to a third peer before another one is handed out.
|
|
|
|
// This is the traditional definition of super seeding.
|
2008-12-09 08:56:37 +01:00
|
|
|
bool strict_super_seeding;
|
2008-12-11 00:07:44 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of pieces to send to a peer,
|
|
|
|
// when seeding, before rotating in another peer to the unchoke set.
|
|
|
|
// It defaults to 3 pieces, which means that when seeding, any peer we've
|
|
|
|
// sent more than this number of pieces to will be unchoked in favour of
|
|
|
|
// a choked peer.
|
2008-12-11 00:07:44 +01:00
|
|
|
int seeding_piece_quota;
|
2009-01-05 02:08:09 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// is a limit of the number of *sparse regions* in
|
|
|
|
// a torrent. A sparse region is defined as a hole of pieces we have not
|
|
|
|
// yet downloaded, in between pieces that have been downloaded. This is
|
|
|
|
// used as a hack for windows vista which has a bug where you cannot
|
|
|
|
// write files with more than a certain number of sparse regions. This
|
|
|
|
// limit is not hard, it will be exceeded. Once it's exceeded, pieces
|
|
|
|
// that will maintain or decrease the number of sparse regions are
|
|
|
|
// prioritized. To disable this functionality, set this to 0. It defaults
|
|
|
|
// to 0 on all platforms except windows.
|
2009-01-05 02:08:09 +01:00
|
|
|
int max_sparse_regions;
|
2009-02-06 10:46:13 +01:00
|
|
|
|
2013-08-11 08:04:24 +02:00
|
|
|
// if lock disk cache is set to true the disk cache
|
2013-08-11 00:15:02 +02:00
|
|
|
// that's in use, will be locked in physical memory, preventing it from
|
|
|
|
// being swapped out.
|
2009-02-06 10:46:13 +01:00
|
|
|
bool lock_disk_cache;
|
2009-03-12 18:06:41 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of piece requests we will reject in a row
|
|
|
|
// while a peer is choked before the peer is considered abusive and is
|
|
|
|
// disconnected.
|
2009-03-12 18:06:41 +01:00
|
|
|
int max_rejects;
|
2009-05-01 06:59:15 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// specifies
|
|
|
|
// the buffer sizes set on peer sockets. 0 (which is the default) means
|
|
|
|
// the OS default (i.e. don't change the buffer sizes). The socket buffer
|
|
|
|
// sizes are changed using setsockopt() with SOL_SOCKET/SO_RCVBUF and
|
|
|
|
// SO_SNDBUFFER.
|
2009-05-01 06:59:15 +02:00
|
|
|
int recv_socket_buffer_size;
|
|
|
|
int send_socket_buffer_size;
|
2009-05-03 21:09:06 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// chooses between two ways of reading back
|
|
|
|
// piece data from disk when its complete and needs to be verified against
|
|
|
|
// the piece hash. This happens if some blocks were flushed to the disk
|
|
|
|
// out of order. Everything that is flushed in order is hashed as it goes
|
|
|
|
// along. Optimizing for speed will allocate space to fit all the the
|
|
|
|
// remaingin, unhashed, part of the piece, reads the data into it in a single
|
|
|
|
// call and hashes it. This is the default. If ``optimizing_hashing_for_speed``
|
|
|
|
// is false, a single block will be allocated (16 kB), and the unhashed parts
|
|
|
|
// of the piece are read, one at a time, and hashed in this single block. This
|
|
|
|
// is appropriate on systems that are memory constrained.
|
2009-05-03 21:09:06 +02:00
|
|
|
bool optimize_hashing_for_speed;
|
2009-05-22 08:32:39 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of milliseconds to sleep
|
|
|
|
// in between disk read operations when checking torrents. This defaults
|
|
|
|
// to 0, but can be set to higher numbers to slow down the rate at which
|
|
|
|
// data is read from the disk while checking. This may be useful for
|
|
|
|
// background tasks that doesn't matter if they take a bit longer, as long
|
|
|
|
// as they leave disk I/O time for other processes.
|
2009-05-22 08:32:39 +02:00
|
|
|
int file_checks_delay_per_block;
|
2009-05-23 09:35:45 +02:00
|
|
|
|
|
|
|
enum disk_cache_algo_t
|
2013-08-11 00:15:02 +02:00
|
|
|
{
|
|
|
|
// This
|
|
|
|
// flushes the entire piece, in the write cache, that was least recently
|
|
|
|
// written to.
|
|
|
|
lru,
|
|
|
|
|
|
|
|
// will flush the largest
|
|
|
|
// sequences of contiguous blocks from the write cache, regarless of the
|
|
|
|
// piece's last use time.
|
|
|
|
largest_contiguous,
|
|
|
|
|
|
|
|
// will prioritize
|
|
|
|
// flushing blocks that will avoid having to read them back in to verify
|
|
|
|
// the hash of the piece once it's done. This is especially useful for high
|
|
|
|
// throughput setups, where reading from the disk is especially expensive.
|
|
|
|
avoid_readback
|
|
|
|
};
|
2009-05-23 09:35:45 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// tells the disk I/O thread which cache flush
|
|
|
|
// algorithm to use. The default algorithm is largest_contiguous. This is
|
|
|
|
// specified by the disk_cache_algo_t enum.
|
2009-05-23 09:35:45 +02:00
|
|
|
disk_cache_algo_t disk_cache_algorithm;
|
2009-05-23 21:27:27 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of blocks to read into the read
|
|
|
|
// cache when a read cache miss occurs. Setting this to 0 is essentially
|
|
|
|
// the same thing as disabling read cache. The number of blocks read
|
|
|
|
// into the read cache is always capped by the piece boundry.
|
|
|
|
//
|
|
|
|
// When a piece in the write cache has ``write_cache_line_size`` contiguous
|
|
|
|
// blocks in it, they will be flushed. Setting this to 1 effectively
|
|
|
|
// disables the write cache.
|
2009-05-23 21:27:27 +02:00
|
|
|
int read_cache_line_size;
|
2009-05-24 02:12:53 +02:00
|
|
|
|
|
|
|
// whenever a contiguous range of this many
|
|
|
|
// blocks is found in the write cache, it
|
|
|
|
// is flushed immediately
|
|
|
|
int write_cache_line_size;
|
2009-06-10 11:20:55 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of seconds from a disk write
|
|
|
|
// errors occur on a torrent until libtorrent will take it out of the
|
|
|
|
// upload mode, to test if the error condition has been fixed.
|
|
|
|
//
|
|
|
|
// libtorrent will only do this automatically for auto managed torrents.
|
|
|
|
//
|
|
|
|
// You can explicitly take a torrent out of upload only mode using
|
|
|
|
// set_upload_mode().
|
2009-06-19 00:32:55 +02:00
|
|
|
int optimistic_disk_retry;
|
2009-08-02 08:40:45 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// controls if downloaded pieces are verified against
|
|
|
|
// the piece hashes in the torrent file or not. The default is false, i.e.
|
|
|
|
// to verify all downloaded data. It may be useful to turn this off for performance
|
|
|
|
// profiling and simulation scenarios. Do not disable the hash check for regular
|
|
|
|
// bittorrent clients.
|
2009-08-02 08:40:45 +02:00
|
|
|
bool disable_hash_checks;
|
2009-08-20 05:19:12 +02:00
|
|
|
|
2009-09-05 09:21:10 +02:00
|
|
|
// if this is true, disk read operations may
|
|
|
|
// be re-ordered based on their physical disk
|
|
|
|
// read offset. This greatly improves throughput
|
|
|
|
// when uploading to many peers. This assumes
|
|
|
|
// a traditional hard drive with a read head
|
|
|
|
// and spinning platters. If your storage medium
|
|
|
|
// is a solid state drive, this optimization
|
|
|
|
// doesn't give you an benefits
|
|
|
|
bool allow_reordered_disk_operations;
|
|
|
|
|
2009-08-20 05:19:12 +02:00
|
|
|
// if this is true, i2p torrents are allowed
|
|
|
|
// to also get peers from other sources than
|
|
|
|
// the tracker, and connect to regular IPs,
|
|
|
|
// not providing any anonymization. This may
|
|
|
|
// be useful if the user is not interested in
|
|
|
|
// the anonymization of i2p, but still wants to
|
|
|
|
// be able to connect to i2p peers.
|
|
|
|
bool allow_i2p_mixed;
|
2009-09-01 06:41:50 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the max number of suggested piece indices received
|
|
|
|
// from a peer that's remembered. If a peer floods suggest messages, this limit
|
|
|
|
// prevents libtorrent from using too much RAM. It defaults to 10.
|
2009-09-01 06:41:50 +02:00
|
|
|
int max_suggest_pieces;
|
2010-01-14 03:16:23 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// If set to true (it defaults to false), piece
|
|
|
|
// requests that have been skipped enough times when piece messages
|
|
|
|
// are received, will be considered lost. Requests are considered skipped
|
|
|
|
// when the returned piece messages are re-ordered compared to the order
|
|
|
|
// of the requests. This was an attempt to get out of dead-locks caused by
|
|
|
|
// BitComet peers silently ignoring some requests. It may cause problems
|
|
|
|
// at high rates, and high level of reordering in the uploading peer, that's
|
|
|
|
// why it's disabled by default.
|
2010-01-14 03:16:23 +01:00
|
|
|
bool drop_skipped_requests;
|
2010-01-23 04:02:32 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// determines if the disk I/O should use a normal
|
|
|
|
// or low priority policy. This defaults to true, which means that
|
|
|
|
// it's low priority by default. Other processes doing disk I/O will
|
|
|
|
// normally take priority in this mode. This is meant to improve the
|
|
|
|
// overall responsiveness of the system while downloading in the
|
|
|
|
// background. For high-performance server setups, this might not
|
|
|
|
// be desirable.
|
2010-01-23 04:02:32 +01:00
|
|
|
bool low_prio_disk;
|
2010-01-30 04:50:17 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the time between local
|
|
|
|
// network announces for a torrent. By default, when local service
|
|
|
|
// discovery is enabled a torrent announces itself every 5 minutes.
|
|
|
|
// This interval is specified in seconds.
|
2010-02-05 09:23:17 +01:00
|
|
|
int local_service_announce_interval;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of seconds between announcing
|
|
|
|
// torrents to the distributed hash table (DHT). This is specified to
|
|
|
|
// be 15 minutes which is its default.
|
2010-02-14 02:39:55 +01:00
|
|
|
int dht_announce_interval;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of seconds libtorrent
|
|
|
|
// will keep UDP tracker connection tokens around for. This is specified
|
|
|
|
// to be 60 seconds, and defaults to that. The higher this value is, the
|
|
|
|
// fewer packets have to be sent to the UDP tracker. In order for higher
|
|
|
|
// values to work, the tracker needs to be configured to match the
|
|
|
|
// expiration time for tokens.
|
2010-02-06 09:14:18 +01:00
|
|
|
int udp_tracker_token_expiry;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// if this is set to true, read cache blocks
|
|
|
|
// that are hit by peer read requests are removed from the disk cache
|
|
|
|
// to free up more space. This is useful if you don't expect the disk
|
|
|
|
// cache to create any cache hits from other peers than the one who
|
|
|
|
// triggered the cache line to be read into the cache in the first place.
|
2010-01-30 04:50:17 +01:00
|
|
|
bool volatile_read_cache;
|
2010-01-31 20:14:00 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// enables the disk cache to adjust the size
|
|
|
|
// of a cache line generated by peers to depend on the upload rate
|
|
|
|
// you are sending to that peer. The intention is to optimize the RAM
|
|
|
|
// usage of the cache, to read ahead further for peers that you're
|
|
|
|
// sending faster to.
|
2010-01-31 20:14:00 +01:00
|
|
|
bool guided_read_cache;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the minimum number of seconds any read
|
|
|
|
// cache line is kept in the cache. This defaults to one second but
|
|
|
|
// may be greater if ``guided_read_cache`` is enabled. Having a lower
|
|
|
|
// bound on the time a cache line stays in the cache is an attempt
|
|
|
|
// to avoid swapping the same pieces in and out of the cache in case
|
|
|
|
// there is a shortage of spare cache space.
|
2010-01-31 20:14:00 +01:00
|
|
|
int default_cache_min_age;
|
2010-02-02 19:39:32 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of optimistic unchoke
|
|
|
|
// slots to use. It defaults to 0, which means automatic. Having a higher
|
|
|
|
// number of optimistic unchoke slots mean you will find the good peers
|
|
|
|
// faster but with the trade-off to use up more bandwidth. When this is
|
|
|
|
// set to 0, libtorrent opens up 20% of your allowed upload slots as
|
|
|
|
// optimistic unchoke slots.
|
2010-02-02 19:39:32 +01:00
|
|
|
int num_optimistic_unchoke_slots;
|
2010-02-02 20:44:52 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// this is a linux-only option and passes in the
|
|
|
|
// ``O_NOATIME`` to ``open()`` when opening files. This may lead to
|
|
|
|
// some disk performance improvements.
|
2010-02-02 20:44:52 +01:00
|
|
|
bool no_atime_storage;
|
2010-02-09 04:04:41 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the assumed reciprocation rate
|
|
|
|
// from peers when using the BitTyrant choker. This defaults to 14 kiB/s.
|
|
|
|
// If set too high, you will over-estimate your peers and be more altruistic
|
|
|
|
// while finding the true reciprocation rate, if it's set too low, you'll
|
|
|
|
// be too stingy and waste finding the true reciprocation rate.
|
2010-02-09 04:04:41 +01:00
|
|
|
int default_est_reciprocation_rate;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// specifies how many percent the
|
|
|
|
// extimated reciprocation rate should be increased by each unchoke
|
|
|
|
// interval a peer is still choking us back. This defaults to 20%.
|
|
|
|
// This only applies to the BitTyrant choker.
|
2010-02-09 04:04:41 +01:00
|
|
|
int increase_est_reciprocation_rate;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// specifies how many percent the
|
|
|
|
// estimated reciprocation rate should be decreased by each unchoke
|
|
|
|
// interval a peer unchokes us. This default to 3%.
|
|
|
|
// This only applies to the BitTyrant choker.
|
2010-02-09 04:04:41 +01:00
|
|
|
int decrease_est_reciprocation_rate;
|
2010-02-11 05:39:04 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// defaults to false. If a torrent
|
|
|
|
// has been paused by the auto managed feature in libtorrent, i.e.
|
|
|
|
// the torrent is paused and auto managed, this feature affects whether
|
|
|
|
// or not it is automatically started on an incoming connection. The
|
|
|
|
// main reason to queue torrents, is not to make them unavailable, but
|
|
|
|
// to save on the overhead of announcing to the trackers, the DHT and to
|
|
|
|
// avoid spreading one's unchoke slots too thin. If a peer managed to
|
|
|
|
// find us, even though we're no in the torrent anymore, this setting
|
|
|
|
// can make us start the torrent and serve it.
|
2010-02-11 05:39:04 +01:00
|
|
|
bool incoming_starts_queued_torrents;
|
2010-02-18 07:45:07 +01:00
|
|
|
|
|
|
|
// when set to true, the downloaded counter sent to trackers
|
|
|
|
// will include the actual number of payload bytes donwnloaded
|
|
|
|
// including redundant bytes. If set to false, it will not include
|
|
|
|
// any redundany bytes
|
|
|
|
bool report_true_downloaded;
|
2010-02-18 20:25:15 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// defaults to true, and controls when a block
|
|
|
|
// may be requested twice. If this is ``true``, a block may only be requested
|
|
|
|
// twice when there's ay least one request to every piece that's left to
|
|
|
|
// download in the torrent. This may slow down progress on some pieces
|
|
|
|
// sometimes, but it may also avoid downloading a lot of redundant bytes.
|
|
|
|
// If this is ``false``, libtorrent attempts to use each peer connection
|
|
|
|
// to its max, by always requesting something, even if it means requesting
|
|
|
|
// something that has been requested from another peer already.
|
2010-02-18 20:25:15 +01:00
|
|
|
bool strict_end_game_mode;
|
2010-03-03 02:31:31 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// if set to true, the local peer discovery
|
|
|
|
// (or Local Service Discovery) will not only use IP multicast, but also
|
|
|
|
// broadcast its messages. This can be useful when running on networks
|
|
|
|
// that don't support multicast. Since broadcast messages might be
|
|
|
|
// expensive and disruptive on networks, only every 8th announce uses
|
|
|
|
// broadcast.
|
2010-03-26 18:45:16 +01:00
|
|
|
bool broadcast_lsd;
|
2010-04-11 23:02:43 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// these all determines if libtorrent should attempt to make
|
|
|
|
// outgoing connections of the specific type, or allow incoming connection. By
|
|
|
|
// default all of them are enabled.
|
2010-11-29 02:33:05 +01:00
|
|
|
bool enable_outgoing_utp;
|
|
|
|
bool enable_incoming_utp;
|
|
|
|
bool enable_outgoing_tcp;
|
|
|
|
bool enable_incoming_tcp;
|
|
|
|
|
|
|
|
// the max number of peers we accept from pex messages from a single peer.
|
|
|
|
// this limits the number of concurrent peers any of our peers claims to
|
|
|
|
// be connected to. If they clain to be connected to more than this, we'll
|
|
|
|
// ignore any peer that exceeds this limit
|
|
|
|
int max_pex_peers;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// determines if the storage, when loading
|
|
|
|
// resume data files, should verify that the file modification time
|
|
|
|
// with the timestamps in the resume data. This defaults to false, which
|
|
|
|
// means timestamps are taken into account, and resume data is less likely
|
|
|
|
// to accepted (torrents are more likely to be fully checked when loaded).
|
|
|
|
// It might be useful to set this to true if your network is faster than your
|
|
|
|
// disk, and it would be faster to redownload potentially missed pieces than
|
|
|
|
// to go through the whole storage to look for them.
|
2010-04-11 23:02:43 +02:00
|
|
|
bool ignore_resume_timestamps;
|
2010-04-13 06:30:34 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// determines if the storage should check
|
|
|
|
// the whole files when resume data is incomplete or missing or whether
|
|
|
|
// it should simply assume we don't have any of the data. By default, this
|
|
|
|
// is determined by the existance of any of the files. By setting this setting
|
|
|
|
// to true, the files won't be checked, but will go straight to download
|
|
|
|
// mode.
|
2011-02-06 01:50:12 +01:00
|
|
|
bool no_recheck_incomplete_resume;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// 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.
|
2010-04-13 06:30:34 +02:00
|
|
|
bool anonymous_mode;
|
2010-05-03 10:54:03 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// disables any communication that's not going over a proxy.
|
|
|
|
// Enabling this requires a proxy to be configured as well, see ``set_proxy_settings``.
|
|
|
|
// The listen sockets are closed, and incoming connections will
|
|
|
|
// only be accepted through a SOCKS5 or I2P proxy (if a peer proxy is set up and
|
|
|
|
// is run on the same machine as the tracker proxy). This setting also
|
|
|
|
// disabled peer country lookups, since those are done via DNS lookups that
|
|
|
|
// aren't supported by proxies.
|
2013-02-19 07:48:53 +01:00
|
|
|
bool force_proxy;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// 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.
|
2010-05-03 10:54:03 +02:00
|
|
|
int tick_interval;
|
2010-07-15 08:27:44 +02:00
|
|
|
|
|
|
|
// specifies whether downloads from web seeds is reported to the
|
|
|
|
// tracker or not. Defaults to on
|
|
|
|
bool report_web_seed_downloads;
|
2010-09-05 18:01:36 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// specifies the target share ratio for share mode torrents.
|
|
|
|
// This defaults to 3, meaning we'll try to upload 3 times as much as we download.
|
|
|
|
// Setting this very high, will make it very conservative and you might end up
|
|
|
|
// not downloading anything ever (and not affecting your share ratio). It does
|
|
|
|
// not make any sense to set this any lower than 2. For instance, if only 3 peers
|
|
|
|
// need to download the rarest piece, it's impossible to download a single piece
|
|
|
|
// and upload it more than 3 times. If the share_mode_target is set to more than 3,
|
|
|
|
// nothing is downloaded.
|
2010-09-05 18:01:36 +02:00
|
|
|
int share_mode_target;
|
2010-10-09 21:09:38 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// sets the session-global limits of upload
|
|
|
|
// and download rate limits, in bytes per second. The local rates refer to peers
|
|
|
|
// on the local network. By default peers on the local network are not rate limited.
|
|
|
|
//
|
|
|
|
// These rate limits are only used for local peers (peers within the same subnet as
|
|
|
|
// the client itself) and it is only used when ``session_settings::ignore_limits_on_local_network``
|
|
|
|
// is set to true (which it is by default). These rate limits default to unthrottled,
|
|
|
|
// but can be useful in case you want to treat local peers preferentially, but not
|
|
|
|
// quite unthrottled.
|
|
|
|
//
|
|
|
|
// A value of 0 means unlimited.
|
2010-10-09 21:09:38 +02:00
|
|
|
int upload_rate_limit;
|
|
|
|
int download_rate_limit;
|
|
|
|
int local_upload_rate_limit;
|
|
|
|
int local_download_rate_limit;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// sets the rate limit on the DHT. This is specified in
|
|
|
|
// bytes per second and defaults to 4000. For busy boxes with lots of torrents
|
|
|
|
// that requires more DHT traffic, this should be raised.
|
2011-03-14 08:47:24 +01:00
|
|
|
int dht_upload_rate_limit;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the max number of unchoked peers in the session. The
|
|
|
|
// number of unchoke slots may be ignored depending on what ``choking_algorithm``
|
|
|
|
// is set to. A value of -1 means infinite.
|
2010-10-09 21:09:38 +02:00
|
|
|
int unchoke_slots_limit;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// sets the maximum number of half-open connections
|
|
|
|
// libtorrent will have when connecting to peers. A half-open connection is one
|
|
|
|
// where connect() has been called, but the connection still hasn't been established
|
|
|
|
// (nor failed). Windows XP Service Pack 2 sets a default, system wide, limit of
|
|
|
|
// the number of half-open connections to 10. So, this limit can be used to work
|
|
|
|
// nicer together with other network applications on that system. The default is
|
|
|
|
// to have no limit, and passing -1 as the limit, means to have no limit. When
|
|
|
|
// limiting the number of simultaneous connection attempts, peers will be put in
|
|
|
|
// a queue waiting for their turn to get connected.
|
2010-10-09 21:09:38 +02:00
|
|
|
int half_open_limit;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// 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.
|
2010-10-09 21:09:38 +02:00
|
|
|
int connections_limit;
|
2010-10-29 10:10:12 +02:00
|
|
|
|
2012-12-31 07:54:54 +01:00
|
|
|
// the number of extra incoming connections allowed
|
|
|
|
// temporarily, in order to support replacing peers
|
|
|
|
int connections_slack;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the target delay for uTP sockets in milliseconds. A high
|
|
|
|
// value will make uTP connections more aggressive and cause longer queues in the upload
|
|
|
|
// bottleneck. It cannot be too low, since the noise in the measurements would cause
|
|
|
|
// it to send too slow. The default is 50 milliseconds.
|
2010-11-29 02:33:05 +01:00
|
|
|
int utp_target_delay;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of bytes the uTP congestion window can increase
|
|
|
|
// at the most in one RTT. This defaults to 300 bytes. If this is set too high,
|
|
|
|
// the congestion controller reacts too hard to noise and will not be stable, if it's
|
|
|
|
// set too low, it will react slow to congestion and not back off as fast.
|
2010-11-29 02:33:05 +01:00
|
|
|
int utp_gain_factor;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the shortest allowed uTP socket timeout, specified in milliseconds.
|
|
|
|
// This defaults to 500 milliseconds. The timeout depends on the RTT of the connection, but
|
|
|
|
// is never smaller than this value. A connection times out when every packet in a window
|
|
|
|
// is lost, or when a packet is lost twice in a row (i.e. the resent packet is lost as well).
|
|
|
|
//
|
|
|
|
// The shorter the timeout is, the faster the connection will recover from this situation,
|
|
|
|
// assuming the RTT is low enough.
|
2010-11-29 02:33:05 +01:00
|
|
|
int utp_min_timeout;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of SYN packets that are sent (and timed out) before
|
|
|
|
// giving up and closing the socket.
|
2010-11-29 02:33:05 +01:00
|
|
|
int utp_syn_resends;
|
|
|
|
|
|
|
|
// the number of resent packets sent on a closed socket before giving up
|
|
|
|
int utp_fin_resends;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of times a packet is sent (and lossed or timed out)
|
|
|
|
// before giving up and closing the connection.
|
2010-11-29 02:33:05 +01:00
|
|
|
int utp_num_resends;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of milliseconds of timeout for the initial SYN
|
|
|
|
// packet for uTP connections. For each timed out packet (in a row), the timeout is doubled.
|
2010-11-29 02:33:05 +01:00
|
|
|
int utp_connect_timeout;
|
|
|
|
|
2012-06-21 17:05:57 +02:00
|
|
|
#ifndef TORRENT_NO_DEPRECATE
|
2010-11-29 02:33:05 +01:00
|
|
|
// number of milliseconds of delaying ACKing packets the most
|
|
|
|
int utp_delayed_ack;
|
2012-06-21 17:05:57 +02:00
|
|
|
#endif
|
2010-11-29 02:33:05 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// controls if the uTP socket manager is allowed to increase
|
|
|
|
// the socket buffer if a network interface with a large MTU is used (such as loopback
|
|
|
|
// or ethernet jumbo frames). This defaults to true and might improve uTP throughput.
|
|
|
|
// For RAM constrained systems, disabling this typically saves around 30kB in user space
|
|
|
|
// and probably around 400kB in kernel socket buffers (it adjusts the send and receive
|
|
|
|
// buffer size on the kernel socket, both for IPv4 and IPv6).
|
2010-11-29 02:33:05 +01:00
|
|
|
bool utp_dynamic_sock_buf;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// controls how the congestion window is changed when a packet
|
|
|
|
// loss is experienced. It's specified as a percentage multiplier for ``cwnd``. By default
|
|
|
|
// it's set to 50 (i.e. cut in half). Do not change this value unless you know what
|
|
|
|
// you're doing. Never set it higher than 100.
|
2012-03-11 06:46:15 +01:00
|
|
|
int utp_loss_multiplier;
|
|
|
|
|
2010-11-29 02:33:05 +01:00
|
|
|
enum bandwidth_mixed_algo_t
|
|
|
|
{
|
|
|
|
// disables the mixed mode bandwidth balancing
|
|
|
|
prefer_tcp = 0,
|
|
|
|
|
|
|
|
// does not throttle uTP, throttles TCP to the same proportion
|
|
|
|
// of throughput as there are TCP connections
|
|
|
|
peer_proportional = 1
|
|
|
|
|
|
|
|
};
|
2013-08-11 00:15:02 +02:00
|
|
|
|
|
|
|
// determines how to treat TCP connections when there are
|
|
|
|
// uTP connections. Since uTP is designed to yield to TCP, there's an inherent problem
|
|
|
|
// when using swarms that have both TCP and uTP connections. If nothing is done, uTP
|
|
|
|
// connections would often be starved out for bandwidth by the TCP connections. This mode
|
|
|
|
// is ``prefer_tcp``. The ``peer_proportional`` mode simply looks at the current throughput
|
|
|
|
// and rate limits all TCP connections to their proportional share based on how many of
|
|
|
|
// the connections are TCP. This works best if uTP connections are not rate limited by
|
|
|
|
// the global rate limiter (which they aren't by default).
|
|
|
|
//
|
|
|
|
// see bandwidth_mixed_algo_t for options.
|
2010-11-29 02:33:05 +01:00
|
|
|
int mixed_mode_algorithm;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// determines if uTP connections should be throttled by the global rate
|
|
|
|
// limiter or not. By default they are.
|
2010-11-29 02:33:05 +01:00
|
|
|
bool rate_limit_utp;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the value passed in to listen() for the listen socket.
|
|
|
|
// It is the number of outstanding incoming connections to queue up while we're not
|
|
|
|
// actively waiting for a connection to be accepted. The default is 5 which should
|
|
|
|
// be sufficient for any normal client. If this is a high performance server which
|
|
|
|
// expects to receive a lot of connections, or used in a simulator or test, it
|
|
|
|
// might make sense to raise this number. It will not take affect until listen_on()
|
|
|
|
// is called again (or for the first time).
|
2010-10-29 10:10:12 +02:00
|
|
|
int listen_queue_size;
|
2010-12-05 21:40:28 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// if true, the ``&ip=`` argument in tracker requests
|
|
|
|
// (unless otherwise specified) will be set to the intermediate IP address, if the
|
|
|
|
// user is double NATed. If ther user is not double NATed, this option has no affect.
|
2010-12-05 21:40:28 +01:00
|
|
|
bool announce_double_nat;
|
2010-12-17 04:10:56 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the number of peers to try to connect to immediately
|
|
|
|
// when the first tracker response is received for a torrent. This is a boost to
|
|
|
|
// given to new torrents to accelerate them starting up. The normal connect scheduler
|
|
|
|
// is run once every second, this allows peers to be connected immediately instead
|
|
|
|
// of waiting for the session tick to trigger connections.
|
2010-12-17 04:10:56 +01:00
|
|
|
int torrent_connect_boost;
|
2010-12-17 04:20:36 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// 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.
|
2010-12-17 04:20:36 +01:00
|
|
|
bool seeding_outgoing_connections;
|
2010-12-31 01:33:23 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// if true (which is the default), libtorrent
|
|
|
|
// will not connect to any peers on priviliged ports (<= 1023). This can mitigate
|
|
|
|
// using bittorrent swarms for certain DDoS attacks.
|
2010-12-31 01:33:23 +01:00
|
|
|
bool no_connect_privileged_ports;
|
2011-01-23 19:00:52 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the maximum number of alerts queued up internally. If
|
|
|
|
// alerts are not popped, the queue will eventually fill up to this level. This
|
|
|
|
// defaults to 1000.
|
2011-01-23 19:00:52 +01:00
|
|
|
int alert_queue_size;
|
2011-01-29 11:37:21 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// the maximum allowed size (in bytes) to be received
|
|
|
|
// by the metadata extension, i.e. magnet links. It defaults to 1 MiB.
|
2011-01-29 11:37:21 +01:00
|
|
|
int max_metadata_size;
|
2011-02-16 04:11:55 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// true by default, which means the number of connection
|
|
|
|
// attempts per second may be limited to below the ``connection_speed``, in case
|
|
|
|
// we're close to bump up against the limit of number of connections. The intention
|
|
|
|
// of this setting is to more evenly distribute our connection attempts over time,
|
|
|
|
// instead of attempting to connectin in batches, and timing them out in batches.
|
2011-02-16 04:11:55 +01:00
|
|
|
bool smooth_connects;
|
2011-02-26 19:17:55 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// defaults to false. When set to true, web connections
|
|
|
|
// will include a user-agent with every request, as opposed to just the first
|
|
|
|
// request in a connection.
|
2011-02-26 19:17:55 +01:00
|
|
|
bool always_send_user_agent;
|
2011-03-04 07:55:39 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// defaults to true. It determines whether the
|
|
|
|
// IP filter applies to trackers as well as peers. If this is set to false,
|
|
|
|
// trackers are exempt from the IP filter (if there is one). If no IP filter
|
|
|
|
// is set, this setting is irrelevant.
|
2011-03-04 07:55:39 +01:00
|
|
|
bool apply_ip_filter_to_trackers;
|
2011-03-20 20:17:59 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// used to avoid starvation of read jobs in the disk I/O
|
|
|
|
// thread. By default, read jobs are deferred, sorted by physical disk location
|
|
|
|
// and serviced once all write jobs have been issued. In scenarios where the
|
|
|
|
// download rate is enough to saturate the disk, there's a risk the read jobs will
|
|
|
|
// never be serviced. With this setting, every *x* write job, issued in a row, will
|
|
|
|
// instead pick one read job off of the sorted queue, where *x* is ``read_job_every``.
|
2011-03-20 20:17:59 +01:00
|
|
|
int read_job_every;
|
2011-04-26 09:03:05 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// defaults to true and will attempt to optimize disk reads
|
|
|
|
// by giving the operating system heads up of disk read requests as they are queued
|
|
|
|
// in the disk job queue. This gives a significant performance boost for seeding.
|
2011-04-26 09:03:05 +02:00
|
|
|
bool use_disk_read_ahead;
|
2011-06-09 08:08:24 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// determines whether or not to lock files which libtorrent is downloading
|
|
|
|
// to or seeding from. This is implemented using ``fcntl(F_SETLK)`` on unix systems and
|
|
|
|
// by not passing in ``SHARE_READ`` and ``SHARE_WRITE`` on windows. This might prevent
|
|
|
|
// 3rd party processes from corrupting the files under libtorrent's feet.
|
2011-06-09 08:08:24 +02:00
|
|
|
bool lock_files;
|
2012-01-14 17:04:25 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// sets the listen port for SSL connections. If this is set to 0,
|
|
|
|
// no SSL listen port is opened. Otherwise a socket is opened on this port. This
|
|
|
|
// setting is only taken into account when opening the regular listen port, and
|
|
|
|
// won't re-open the listen socket simply by changing this setting.
|
|
|
|
//
|
2013-07-28 17:06:28 +02:00
|
|
|
// if this is 0, outgoing SSL connections are disabled
|
2013-08-11 00:15:02 +02:00
|
|
|
//
|
|
|
|
// It defaults to port 4433.
|
2012-01-14 17:04:25 +01:00
|
|
|
int ssl_listen;
|
2012-03-29 05:51:22 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// ``tracker_backoff`` determines how aggressively to back off from retrying
|
|
|
|
// failing trackers. This value determines *x* in the following formula, determining
|
|
|
|
// the number of seconds to wait until the next retry:
|
|
|
|
//
|
|
|
|
// delay = 5 + 5 * x / 100 * fails^2
|
|
|
|
//
|
|
|
|
// It defaults to 250.
|
|
|
|
//
|
|
|
|
// This setting may be useful to make libtorrent more or less aggressive in hitting
|
|
|
|
// trackers.
|
|
|
|
//
|
2012-03-29 05:51:22 +02:00
|
|
|
int tracker_backoff;
|
2012-04-11 05:25:09 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// enables banning web seeds. By default, web seeds that send
|
|
|
|
// corrupt data are banned.
|
2012-04-11 05:25:09 +02:00
|
|
|
bool ban_web_seeds;
|
2012-10-19 03:28:47 +02:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// specifies the max number of bytes to receive into
|
|
|
|
// RAM buffers when downloading stuff over HTTP. Specifically when specifying a
|
|
|
|
// URL to a .torrent file when adding a torrent or when announcing to an HTTP
|
|
|
|
// tracker. The default is 2 MiB.
|
2012-10-19 03:28:47 +02:00
|
|
|
int max_http_recv_buffer_size;
|
2013-02-23 23:13:25 +01:00
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// enables or disables the share mode extension. This is
|
|
|
|
// enabled by default.
|
2013-02-23 23:13:25 +01:00
|
|
|
bool support_share_mode;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// enables or disables the merkle tree torrent support.
|
|
|
|
// This is enabled by default.
|
2013-02-23 23:13:25 +01:00
|
|
|
bool support_merkle_torrents;
|
|
|
|
|
2013-08-11 00:15:02 +02:00
|
|
|
// enables or disables reporting redundant bytes to the tracker.
|
|
|
|
// This is enabled by default.
|
2013-02-23 23:13:25 +01:00
|
|
|
bool report_redundant_bytes;
|
|
|
|
|
|
|
|
// the version string to advertise for this client
|
|
|
|
// in the peer protocol handshake. If this is empty
|
|
|
|
// the user_agent is used
|
|
|
|
std::string handshake_client_version;
|
2013-03-21 02:18:39 +01:00
|
|
|
|
|
|
|
// if this is true, the disk cache uses a pool allocator
|
|
|
|
// for disk cache blocks. Enabling this improves
|
|
|
|
// performance of the disk cache with the side effect
|
|
|
|
// that the disk cache is less likely and slower at
|
|
|
|
// returning memory to the kernel when cache pressure
|
|
|
|
// is low.
|
|
|
|
bool use_disk_cache_pool;
|
2008-04-24 05:28:48 +02:00
|
|
|
};
|
|
|
|
|
2013-07-24 18:27:17 +02:00
|
|
|
// structure used to hold configuration options for the DHT
|
|
|
|
//
|
|
|
|
// The ``dht_settings`` struct used to contain a ``service_port`` member to control
|
|
|
|
// which port the DHT would listen on and send messages from. This field is deprecated
|
|
|
|
// and ignored. libtorrent always tries to open the UDP socket on the same port
|
|
|
|
// as the TCP socket.
|
2006-08-01 17:27:08 +02:00
|
|
|
struct dht_settings
|
|
|
|
{
|
|
|
|
dht_settings()
|
2009-10-26 23:44:49 +01:00
|
|
|
: max_peers_reply(100)
|
2006-08-01 17:27:08 +02:00
|
|
|
, search_branching(5)
|
2010-11-29 02:33:05 +01:00
|
|
|
#ifndef TORRENT_NO_DEPRECATE
|
2007-03-15 23:03:56 +01:00
|
|
|
, service_port(0)
|
2010-11-29 02:33:05 +01:00
|
|
|
#endif
|
2006-08-01 17:27:08 +02:00
|
|
|
, max_fail_count(20)
|
2011-05-23 07:07:52 +02:00
|
|
|
, max_torrents(2000)
|
|
|
|
, max_dht_items(700)
|
2009-09-27 05:38:41 +02:00
|
|
|
, max_torrent_search_reply(20)
|
2011-01-08 09:54:51 +01:00
|
|
|
, restrict_routing_ips(true)
|
|
|
|
, restrict_search_ips(true)
|
2012-09-22 23:40:16 +02:00
|
|
|
, extended_routing_table(true)
|
2013-01-20 08:54:54 +01:00
|
|
|
, aggressive_lookups(true)
|
2013-09-09 09:08:02 +02:00
|
|
|
, privacy_lookups(false)
|
2013-10-14 03:03:43 +02:00
|
|
|
, enforce_node_id(false)
|
2006-08-01 17:27:08 +02:00
|
|
|
{}
|
|
|
|
|
|
|
|
// the maximum number of peers to send in a
|
2013-07-24 18:27:17 +02:00
|
|
|
// reply to ``get_peers``
|
2006-08-01 17:27:08 +02:00
|
|
|
int max_peers_reply;
|
|
|
|
|
2013-07-24 18:27:17 +02:00
|
|
|
// 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
|
2006-08-01 17:27:08 +02:00
|
|
|
int search_branching;
|
|
|
|
|
2010-11-29 02:33:05 +01:00
|
|
|
#ifndef TORRENT_NO_DEPRECATE
|
2006-08-01 17:27:08 +02:00
|
|
|
// the listen port for the dht. This is a UDP port.
|
2007-03-15 23:03:56 +01:00
|
|
|
// zero means use the same as the tcp interface
|
2006-08-01 17:27:08 +02:00
|
|
|
int service_port;
|
2010-11-29 02:33:05 +01:00
|
|
|
#endif
|
2006-08-01 17:27:08 +02:00
|
|
|
|
2013-07-24 18:27:17 +02:00
|
|
|
// 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.
|
2006-08-01 17:27:08 +02:00
|
|
|
int max_fail_count;
|
2009-09-27 05:38:41 +02:00
|
|
|
|
2013-07-24 18:27:17 +02:00
|
|
|
// 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.
|
2011-01-19 06:57:44 +01:00
|
|
|
int max_torrents;
|
|
|
|
|
2011-05-23 07:07:52 +02:00
|
|
|
// max number of items the DHT will store
|
|
|
|
int max_dht_items;
|
2011-01-19 06:57:44 +01:00
|
|
|
|
2009-09-27 05:38:41 +02:00
|
|
|
// the max number of torrents to return in a
|
|
|
|
// torrent search query to the DHT
|
|
|
|
int max_torrent_search_reply;
|
2011-01-08 09:54:51 +01:00
|
|
|
|
2013-07-24 18:27:17 +02:00
|
|
|
// 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.
|
|
|
|
//
|
2011-01-08 09:54:51 +01:00
|
|
|
// 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
|
|
|
|
bool restrict_routing_ips;
|
|
|
|
|
2013-07-24 18:27:17 +02:00
|
|
|
// 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.
|
2011-01-08 09:54:51 +01:00
|
|
|
bool restrict_search_ips;
|
2012-09-22 23:40:16 +02:00
|
|
|
|
2013-07-24 18:27:17 +02:00
|
|
|
// 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.
|
2012-09-22 23:40:16 +02:00
|
|
|
bool extended_routing_table;
|
2013-01-20 08:54:54 +01:00
|
|
|
|
2013-07-24 18:27:17 +02:00
|
|
|
// 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.
|
2013-01-20 08:54:54 +01:00
|
|
|
bool aggressive_lookups;
|
2013-09-09 09:08:02 +02:00
|
|
|
|
|
|
|
// when set, perform lookups in a way that is slightly more expensive, but which
|
|
|
|
// minimizes the amount of information leaked about you.
|
|
|
|
bool privacy_lookups;
|
2013-10-14 03:03:43 +02:00
|
|
|
|
|
|
|
// 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".
|
|
|
|
bool enforce_node_id;
|
2006-04-25 23:04:48 +02:00
|
|
|
};
|
2006-08-01 17:27:08 +02:00
|
|
|
|
2007-06-06 02:41:20 +02:00
|
|
|
#ifndef TORRENT_DISABLE_ENCRYPTION
|
|
|
|
|
2013-08-08 03:03:54 +02:00
|
|
|
// The ``pe_settings`` structure is used to control the settings related
|
|
|
|
// to peer protocol encryption.
|
2007-06-06 02:41:20 +02:00
|
|
|
struct pe_settings
|
|
|
|
{
|
|
|
|
pe_settings()
|
|
|
|
: out_enc_policy(enabled)
|
|
|
|
, in_enc_policy(enabled)
|
|
|
|
, allowed_enc_level(both)
|
|
|
|
, prefer_rc4(false)
|
|
|
|
{}
|
|
|
|
|
|
|
|
enum enc_policy
|
|
|
|
{
|
2013-08-08 03:03:54 +02:00
|
|
|
// Only encrypted connections are allowed. Incoming connections
|
|
|
|
// that are not encrypted are closed and if the encrypted outgoing connection
|
|
|
|
// fails, a non-encrypted retry will not be made.
|
|
|
|
forced,
|
|
|
|
|
|
|
|
// encrypted connections are enabled, but non-encrypted
|
|
|
|
// connections are allowed. An incoming non-encrypted connection will
|
|
|
|
// be accepted, and if an outgoing encrypted connection fails, a non-
|
|
|
|
// encrypted connection will be tried.
|
|
|
|
enabled,
|
|
|
|
|
|
|
|
// only non-encrypted connections are allowed.
|
|
|
|
disabled
|
2007-06-06 02:41:20 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
enum enc_level
|
|
|
|
{
|
2011-08-29 04:00:17 +02:00
|
|
|
plaintext = 1, // use only plaintext encryption
|
|
|
|
rc4 = 2, // use only rc4 encryption
|
|
|
|
both = 3 // allow both
|
2007-06-06 02:41:20 +02:00
|
|
|
};
|
|
|
|
|
2013-08-08 03:03:54 +02:00
|
|
|
// control the settings for incoming
|
|
|
|
// and outgoing connections respectively.
|
|
|
|
// see enc_policy enum for the available options.
|
2013-12-02 05:24:10 +01:00
|
|
|
boost::uint8_t out_enc_policy;
|
|
|
|
boost::uint8_t in_enc_policy;
|
2007-06-06 02:41:20 +02:00
|
|
|
|
2013-08-08 03:03:54 +02:00
|
|
|
// determines the encryption level of the
|
|
|
|
// connections. This setting will adjust which encryption scheme is
|
|
|
|
// offered to the other peer, as well as which encryption scheme is
|
|
|
|
// selected by the client. See enc_level enum for options.
|
2013-12-02 05:24:10 +01:00
|
|
|
boost::uint8_t allowed_enc_level;
|
2013-08-08 03:03:54 +02:00
|
|
|
|
2007-06-06 02:41:20 +02:00
|
|
|
// if the allowed encryption level is both, setting this to
|
|
|
|
// true will prefer rc4 if both methods are offered, plaintext
|
|
|
|
// otherwise
|
|
|
|
bool prefer_rc4;
|
|
|
|
};
|
|
|
|
#endif
|
|
|
|
|
2006-04-25 23:04:48 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|