wornvirtue
/
premiere-libtorrent
forked from premiere/premiere-libtorrent
1
0
Fork 0
Code Pull Requests Activity

Clarify documentation (#1368) 

clarify documentation of private torrents
This commit is contained in:
Markus 2016-11-30 15:11:16 +01:00 committed by Arvid Norberg
parent 6267984e5e
commit c0f00499b1
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/libtorrent/create_torrent.hpp
View File

@ -256,9 +256,9 @@ namespace libtorrent
void set_root_cert(string_view pem); void set_root_cert(string_view pem);
// Sets and queries the private flag of the torrent. // Sets and queries the private flag of the torrent.
// Torrents with the private flag set ask clients to not use any other // Torrents with the private flag set ask the client to not use any other
// sources than the tracker for peers, and to not advertise itself publicly, // sources than the tracker for peers, and to not use DHT to advertise itself publicly,
// apart from the tracker. // only the tracker.
void set_priv(bool p) { m_private = p; } void set_priv(bool p) { m_private = p; }
bool priv() const { return m_private; } bool priv() const { return m_private; }
@ -347,8 +347,8 @@ namespace libtorrent
// and they have the same name. // and they have the same name.
bool m_multifile:1; bool m_multifile:1;
// this is true if the torrent is private. i.e., is should not // this is true if the torrent is private. i.e., the client should not
// be announced on the dht // advertise itself on the DHT for this torrent
bool m_private:1; bool m_private:1;
// if set to one, a merkle torrent will be generated // if set to one, a merkle torrent will be generated

4
include/libtorrent/torrent_info.hpp
View File

@ -397,8 +397,8 @@ namespace libtorrent
// metadata resolved yet or not. // metadata resolved yet or not.
bool is_valid() const { return m_files.is_valid(); } bool is_valid() const { return m_files.is_valid(); }
// returns true if this torrent is private. i.e., it should not be // returns true if this torrent is private. i.e., the client should not
// distributed on the trackerless network (the kademlia DHT). // advertise itself on the trackerless network (the Kademlia DHT) for this torrent.
bool priv() const { return (m_flags & private_torrent) != 0; } bool priv() const { return (m_flags & private_torrent) != 0; }
// returns true if this is an i2p torrent. This is determined by whether // returns true if this is an i2p torrent. This is determined by whether