documentation improvements
This commit is contained in:
parent
961417814b
commit
d1e0e8701b
|
@ -281,7 +281,6 @@ TORRENT_VERSION_NAMESPACE_2
|
||||||
// have not received any scrape data.
|
// have not received any scrape data.
|
||||||
int num_complete = -1;
|
int num_complete = -1;
|
||||||
int num_incomplete = -1;
|
int num_incomplete = -1;
|
||||||
|
|
||||||
int num_downloaded = -1;
|
int num_downloaded = -1;
|
||||||
|
|
||||||
// URLs can be added to these two lists to specify additional web
|
// URLs can be added to these two lists to specify additional web
|
||||||
|
|
|
@ -45,6 +45,9 @@ namespace libtorrent {
|
||||||
|
|
||||||
class bt_peer_connection;
|
class bt_peer_connection;
|
||||||
|
|
||||||
|
// the peer_connection_handle class provides a handle to the internal peer
|
||||||
|
// connection object, to be used by plugins. This is a low level interface that
|
||||||
|
// may not be stable across libtorrent versions
|
||||||
struct TORRENT_EXPORT peer_connection_handle
|
struct TORRENT_EXPORT peer_connection_handle
|
||||||
{
|
{
|
||||||
explicit peer_connection_handle(std::weak_ptr<peer_connection> impl)
|
explicit peer_connection_handle(std::weak_ptr<peer_connection> impl)
|
||||||
|
@ -128,6 +131,9 @@ private:
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// The bt_peer_connection_handle provides a handle to the internal bittorrent
|
||||||
|
// peer connection object to plugins. It's low level and may not be a stable API
|
||||||
|
// across libtorrent versions.
|
||||||
struct TORRENT_EXPORT bt_peer_connection_handle : peer_connection_handle
|
struct TORRENT_EXPORT bt_peer_connection_handle : peer_connection_handle
|
||||||
{
|
{
|
||||||
explicit bt_peer_connection_handle(peer_connection_handle pc)
|
explicit bt_peer_connection_handle(peer_connection_handle pc)
|
||||||
|
|
|
@ -66,6 +66,10 @@ namespace libtorrent {
|
||||||
, std::vector<char>&, error_code&)>;
|
, std::vector<char>&, error_code&)>;
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
// this class provides a non-owning handle to a session and a subset of the
|
||||||
|
// interface of the session class. If the underlying session is destructed
|
||||||
|
// any handle to it will no longer be valid. is_valid() will return false and
|
||||||
|
// any operation on it will throw an invalid_session_handle.
|
||||||
struct TORRENT_EXPORT session_handle
|
struct TORRENT_EXPORT session_handle
|
||||||
{
|
{
|
||||||
friend class session;
|
friend class session;
|
||||||
|
@ -452,6 +456,18 @@ namespace libtorrent {
|
||||||
, std::int64_t&, std::string const&)> cb
|
, std::int64_t&, std::string const&)> cb
|
||||||
, std::string salt = std::string());
|
, std::string salt = std::string());
|
||||||
|
|
||||||
|
// ``dht_get_peers()`` will issue a DHT get_peer request to the DHT for the
|
||||||
|
// specified info-hash. The response (the peers) will be posted back in a
|
||||||
|
// dht_get_peers_reply_alert.
|
||||||
|
//
|
||||||
|
// ``dht_announce()`` will issue a DHT announce request to the DHT to the
|
||||||
|
// specified info-hash, advertising the specified port. If the port is
|
||||||
|
// left at its default, 0, the port will be implied by the DHT message's
|
||||||
|
// source port (which may improve connectivity through a NAT).
|
||||||
|
//
|
||||||
|
// Both these functions are exposed for advanced custom use of the DHT.
|
||||||
|
// All torrents eligible to be announce to the DHT will be automatically,
|
||||||
|
// by libtorrent.
|
||||||
void dht_get_peers(sha1_hash const& info_hash);
|
void dht_get_peers(sha1_hash const& info_hash);
|
||||||
void dht_announce(sha1_hash const& info_hash, int port = 0, dht::announce_flags_t flags = {});
|
void dht_announce(sha1_hash const& info_hash, int port = 0, dht::announce_flags_t flags = {});
|
||||||
|
|
||||||
|
@ -939,6 +955,13 @@ namespace libtorrent {
|
||||||
// To control which alerts are posted, set the alert_mask
|
// To control which alerts are posted, set the alert_mask
|
||||||
// (settings_pack::alert_mask).
|
// (settings_pack::alert_mask).
|
||||||
//
|
//
|
||||||
|
// If the alert queue fills up to the point where alerts are dropped, this
|
||||||
|
// will be indicated by a alerts_dropped_alert, which contains a bitmask
|
||||||
|
// of which types of alerts were dropped. Generally it is a good idea to
|
||||||
|
// make sure the alert queue is large enough, the alert_mask doesn't have
|
||||||
|
// unnecessary categories enabled and to call pop_alert() frequently, to
|
||||||
|
// avoid alerts being dropped.
|
||||||
|
//
|
||||||
// the ``set_alert_notify`` function lets the client set a function object
|
// the ``set_alert_notify`` function lets the client set a function object
|
||||||
// to be invoked every time the alert queue goes from having 0 alerts to
|
// to be invoked every time the alert queue goes from having 0 alerts to
|
||||||
// 1 alert. This function is called from within libtorrent, it may be the
|
// 1 alert. This function is called from within libtorrent, it may be the
|
||||||
|
|
|
@ -49,7 +49,12 @@ namespace libtorrent {
|
||||||
// see the session-statistics_ section.
|
// see the session-statistics_ section.
|
||||||
struct TORRENT_EXPORT stats_metric
|
struct TORRENT_EXPORT stats_metric
|
||||||
{
|
{
|
||||||
|
// the name of the counter or gauge
|
||||||
char const* name;
|
char const* name;
|
||||||
|
|
||||||
|
// the index into the session stats array, where the underlying value of
|
||||||
|
// this counter or gauge is found. The session stats array is part of the
|
||||||
|
// session_stats_alert object.
|
||||||
int value_index;
|
int value_index;
|
||||||
#if TORRENT_ABI_VERSION == 1
|
#if TORRENT_ABI_VERSION == 1
|
||||||
static constexpr metric_type_t TORRENT_DEPRECATED_MEMBER type_counter = metric_type_t::counter;
|
static constexpr metric_type_t TORRENT_DEPRECATED_MEMBER type_counter = metric_type_t::counter;
|
||||||
|
|
Loading…
Reference in New Issue