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

reflowed documentation comments in session_settings.hpp, added missing documentaton. regeneraged html

This commit is contained in:
Arvid Norberg 2014-02-03 02:41:24 +00:00
parent dc987538ee
commit cf16399346
7 changed files with 1950 additions and 1849 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
docs/reference-Core.html
View File

@ -55,10 +55,9 @@
<div class="contents topic" id="table-of-contents">
<p class="topic-title first">Table of contents</p>
<ul class="simple">
<li><a class="reference internal" href="#disk-buffer-holder" id="id165">disk_buffer_holder</a></li>
<li><a class="reference internal" href="#peer-info" id="id166">peer_info</a></li>
<li><a class="reference internal" href="#peer-request" id="id167">peer_request</a></li>
<li><a class="reference internal" href="#piece-block-progress" id="id168">piece_block_progress</a></li>
<li><a class="reference internal" href="#disk-buffer-holder" id="id166">disk_buffer_holder</a></li>
<li><a class="reference internal" href="#peer-info" id="id167">peer_info</a></li>
<li><a class="reference internal" href="#peer-request" id="id168">peer_request</a></li>
<li><a class="reference internal" href="#block-info" id="id169">block_info</a></li>
<li><a class="reference internal" href="#partial-piece-info" id="id170">partial_piece_info</a></li>
<li><a class="reference internal" href="#torrent-handle" id="id171">torrent_handle</a></li>
@ -759,6 +758,13 @@ struct peer_request
int length;
};
</pre>
<a name="operator==()"></a><div class="section" id="operator">
<h2>operator==()</h2>
<pre class="literal-block">
bool <strong>operator==</strong> (peer_request const&amp; r) const;
</pre>
<p>returns true if the right hand side <a class="reference external" href="reference-Core.html#peer_request">peer_request</a> refers to the same
range as this does.</p>
<a name="piece"></a><dl class="docutils">
<dt>piece</dt>
<dd>the index of the piece in which the range starts.</dd>
@ -771,37 +777,8 @@ struct peer_request
<dt>length</dt>
<dd>the size of the range, in bytes.</dd>
</dl>
<a name="piece_block_progress"></a></div>
<div class="section" id="piece-block-progress">
<h1>piece_block_progress</h1>
<p>Declared in &quot;<a class="reference external" href="../include/libtorrent/piece_block_progress.hpp">libtorrent/piece_block_progress.hpp</a>&quot;</p>
<pre class="literal-block">
struct piece_block_progress
{
int piece_index;
int block_index;
int bytes_downloaded;
int full_block_bytes;
};
</pre>
<a name="piece_index"></a>
<a name="block_index"></a><dl class="docutils">
<dt>piece_index block_index</dt>
<dd>the piece and block index
determines exactly which
part of the torrent that
is currently being downloaded</dd>
</dl>
<a name="bytes_downloaded"></a><dl class="docutils">
<dt>bytes_downloaded</dt>
<dd>the number of bytes we have received
of this block</dd>
</dl>
<a name="full_block_bytes"></a><dl class="docutils">
<dt>full_block_bytes</dt>
<dd>the number of bytes in the block</dd>
</dl>
<a name="block_info"></a></div>
</div>
<div class="section" id="block-info">
<h1>block_info</h1>
<p>Declared in &quot;<a class="reference external" href="../include/libtorrent/torrent_handle.hpp">libtorrent/torrent_handle.hpp</a>&quot;</p>
@ -2347,7 +2324,7 @@ struct torrent_status
sha1_hash info_hash;
};
</pre>
<a name="operator==()"></a><div class="section" id="operator">
<a name="operator==()"></a><div class="section" id="id102">
<h2>operator==()</h2>
<pre class="literal-block">
bool <strong>operator==</strong> (torrent_status const&amp; st) const;
@ -2355,7 +2332,7 @@ bool <strong>operator==</strong> (torrent_status const&amp; st) const;
<p>compres if the torrent status objects come from the same torrent. i.e.
only the <a class="reference external" href="reference-Core.html#torrent_handle">torrent_handle</a> field is compared.</p>
<a name="state_t"></a></div>
<div class="section" id="id103">
<div class="section" id="id104">
<h2>enum state_t</h2>
<p>Declared in &quot;<a class="reference external" href="../include/libtorrent/torrent_handle.hpp">libtorrent/torrent_handle.hpp</a>&quot;</p>
<table border="1" class="docutils">
@ -2905,7 +2882,7 @@ allowed to force another tracker update with this tracker.</p>
<p>If the last time this tracker was contacted failed, <tt class="docutils literal">last_error</tt> is the error
code describing what error occurred.</p>
<a name="reset()"></a></div>
<div class="section" id="id124">
<div class="section" id="id125">
<h2>reset()</h2>
<pre class="literal-block">
void <strong>reset</strong> ();
@ -3121,7 +3098,7 @@ class torrent_info : public intrusive_ptr_base&lt;torrent_info&gt;
bool <strong>is_merkle_torrent</strong> () const;
};
</pre>
<a name="torrent_info()"></a><div class="section" id="id128">
<a name="torrent_info()"></a><div class="section" id="id129">
<h2>torrent_info()</h2>
<pre class="literal-block">
<strong>torrent_info</strong> (std::string const&amp; filename, int flags = 0);
@ -3153,7 +3130,7 @@ always throw if an error occurs. These overloads are not available when building
exception support.</p>
<p>The <tt class="docutils literal">flags</tt> argument is currently unused.</p>
<a name="~torrent_info()"></a></div>
<div class="section" id="id136">
<div class="section" id="id137">
<h2>~torrent_info()</h2>
<pre class="literal-block">
<strong>~torrent_info</strong> ();
@ -3178,7 +3155,7 @@ names. Filename may be chaged using <tt class="docutils literal"><span class="pr
<p>For more information on the <a class="reference external" href="reference-Storage.html#file_storage">file_storage</a> object, see the separate document on how
to create torrents.</p>
<a name="rename_file()"></a></div>
<div class="section" id="id142">
<div class="section" id="id143">
<h2>rename_file()</h2>
<pre class="literal-block">
void <strong>rename_file</strong> (int index, std::string const&amp; new_filename);
@ -3263,7 +3240,7 @@ the piece index as argument and gives you the exact size of that piece. It will
be the same as <tt class="docutils literal">piece_length()</tt> except in the case of the last piece, which may
be smaller.</p>
<a name="info_hash()"></a></div>
<div class="section" id="id149">
<div class="section" id="id150">
<h2>info_hash()</h2>
<pre class="literal-block">
const sha1_hash&amp; <strong>info_hash</strong> () const;
@ -3310,7 +3287,7 @@ std::string <strong>ssl_cert</strong> () const;
torrent. Otherwise returns an empty string. The certificate is
the the public certificate in x509 format.</p>
<a name="is_valid()"></a></div>
<div class="section" id="id152">
<div class="section" id="id153">
<h2>is_valid()</h2>
<pre class="literal-block">
bool <strong>is_valid</strong> () const;
@ -3423,7 +3400,7 @@ lazy_entry const* <strong>info</strong> (char const* key) const;
It can be used to access extension values put in the .torrent file. If the specified
key cannot be found, it returns NULL.</p>
<a name="swap()"></a></div>
<div class="section" id="id157">
<div class="section" id="id158">
<h2>swap()</h2>
<pre class="literal-block">
void <strong>swap</strong> (torrent_info&amp; ti);

40
docs/reference-Custom_Storage.html
View File

@ -55,9 +55,9 @@
<div class="contents topic" id="table-of-contents">
<p class="topic-title first">Table of contents</p>
<ul class="simple">
<li><a class="reference internal" href="#file-pool" id="id12">file_pool</a></li>
<li><a class="reference internal" href="#storage-interface" id="id13">storage_interface</a></li>
<li><a class="reference internal" href="#default-storage" id="id14">default_storage</a></li>
<li><a class="reference internal" href="#file-pool" id="id18">file_pool</a></li>
<li><a class="reference internal" href="#storage-interface" id="id19">storage_interface</a></li>
<li><a class="reference internal" href="#default-storage" id="id20">default_storage</a></li>
</ul>
</div>
<p>This is an example storage implementation that stores all pieces in a <tt class="docutils literal"><span class="pre">std::map</span></tt>,
@ -497,8 +497,9 @@ implementing a custom storage.</p>
<pre class="literal-block">
class default_storage : public storage_interface, boost::noncopyable
{
<strong>default_storage</strong> (file_storage const&amp; fs, file_storage const* mapped, std::string const&amp; path
, file_pool&amp; fp, std::vector&lt;boost::uint8_t&gt; const&amp; file_prio);
<strong>default_storage</strong> (file_storage const&amp; fs, file_storage const* mapped
, std::string const&amp; path, file_pool&amp; fp
, std::vector&lt;boost::uint8_t&gt; const&amp; file_prio);
bool <strong>move_slot</strong> (int src_slot, int dst_slot);
bool <strong>rename_file</strong> (int index, std::string const&amp; new_filename);
int <strong>read</strong> (char* buf, int slot, int offset, int size);
@ -520,7 +521,34 @@ class default_storage : public storage_interface, boost::noncopyable
file_storage const&amp; <strong>files</strong> () const;
};
</pre>
<a name="move_flags_t"></a><div class="section" id="enum-move-flags-t">
<a name="default_storage()"></a><div class="section" id="id11">
<h2>default_storage()</h2>
<pre class="literal-block">
<strong>default_storage</strong> (file_storage const&amp; fs, file_storage const* mapped
, std::string const&amp; path, file_pool&amp; fp
, std::vector&lt;boost::uint8_t&gt; const&amp; file_prio);
</pre>
<p>constructs the <a class="reference external" href="reference-Custom_Storage.html#default_storage">default_storage</a> based on the give <a class="reference external" href="reference-Storage.html#file_storage">file_storage</a> (fs).
<tt class="docutils literal">mapped</tt> is an optional argument (it may be NULL). If non-NULL it
represents the file mappsing that have been made to the torrent before
adding it. That's where files are supposed to be saved and looked for
on disk. <tt class="docutils literal">save_path</tt> is the root save folder for this torrent.
<tt class="docutils literal">file_pool</tt> is the cache of file handles that the storage will use.
All files it opens will ask the <a class="reference external" href="reference-Custom_Storage.html#file_pool">file_pool</a> to open them. <tt class="docutils literal">file_prio</tt>
is a vector indicating the priority of files on startup. It may be
an empty vector. Any file whose index is not represented by the vector
(because the vector is too short) are assumed to have priority 1.
this is used to treat files with priority 0 slightly differently.</p>
<a name="files()"></a></div>
<div class="section" id="files">
<h2>files()</h2>
<pre class="literal-block">
file_storage const&amp; <strong>files</strong> () const;
</pre>
<p>if the files in this storage are mapped, returns the mapped
<a class="reference external" href="reference-Storage.html#file_storage">file_storage</a>, otherwise returns the original <a class="reference external" href="reference-Storage.html#file_storage">file_storage</a> object.</p>
<a name="move_flags_t"></a></div>
<div class="section" id="enum-move-flags-t">
<h2>enum move_flags_t</h2>
<p>Declared in &quot;<a class="reference external" href="../include/libtorrent/storage.hpp">libtorrent/storage.hpp</a>&quot;</p>
<table border="1" class="docutils">

26
docs/reference-Session.html
View File

@ -55,14 +55,14 @@
<div class="contents topic" id="table-of-contents">
<p class="topic-title first">Table of contents</p>
<ul class="simple">
<li><a class="reference internal" href="#add-torrent-params" id="id159">add_torrent_params</a></li>
<li><a class="reference internal" href="#cache-status" id="id160">cache_status</a></li>
<li><a class="reference internal" href="#session-proxy" id="id161">session_proxy</a></li>
<li><a class="reference internal" href="#id36" id="id162">session</a></li>
<li><a class="reference internal" href="#dht-lookup" id="id163">dht_lookup</a></li>
<li><a class="reference internal" href="#dht-routing-bucket" id="id164">dht_routing_bucket</a></li>
<li><a class="reference internal" href="#utp-status" id="id165">utp_status</a></li>
<li><a class="reference internal" href="#session-status" id="id166">session_status</a></li>
<li><a class="reference internal" href="#add-torrent-params" id="id164">add_torrent_params</a></li>
<li><a class="reference internal" href="#cache-status" id="id165">cache_status</a></li>
<li><a class="reference internal" href="#session-proxy" id="id166">session_proxy</a></li>
<li><a class="reference internal" href="#id36" id="id167">session</a></li>
<li><a class="reference internal" href="#dht-lookup" id="id168">dht_lookup</a></li>
<li><a class="reference internal" href="#dht-routing-bucket" id="id169">dht_routing_bucket</a></li>
<li><a class="reference internal" href="#utp-status" id="id170">utp_status</a></li>
<li><a class="reference internal" href="#session-status" id="id171">session_status</a></li>
</ul>
</div>
<a name="add_torrent_params"></a><div class="section" id="add-torrent-params">
@ -718,7 +718,7 @@ it to finish. The timeout can be set with <tt class="docutils literal">set_setti
void <strong>load_state</strong> (lazy_entry const&amp; e);
void <strong>save_state</strong> (entry&amp; e, boost::uint32_t flags = 0xffffffff) const;
</pre>
<p>loads and saves all <a class="reference external" href="reference-Session.html#session">session</a> settings, including dht_settings,
<p>loads and saves all <a class="reference external" href="reference-Session.html#session">session</a> settings, including <a class="reference external" href="reference-Settings.html#dht_settings">dht_settings</a>,
encryption settings and proxy settings. <tt class="docutils literal">save_state</tt> writes all keys
to the <tt class="docutils literal">entry</tt> that's passed in, which needs to either not be
initialized, or initialized as a dictionary.</p>
@ -953,7 +953,7 @@ exception is thrown, <tt class="docutils literal"><span class="pre">asio::error<
<p><tt class="docutils literal">add_dht_node</tt> adds a node to the routing table. This can be used if
your client has its own source of bootstrapping nodes.</p>
<p><tt class="docutils literal">set_dht_settings</tt> sets some parameters availavle to the dht node.
See dht_settings for more information.</p>
See <a class="reference external" href="reference-Settings.html#dht_settings">dht_settings</a> for more information.</p>
<p><tt class="docutils literal">is_dht_running()</tt> returns true if the DHT support has been started
and false
otherwise.</p>
@ -1184,7 +1184,7 @@ pe_settings <strong>get_pe_settings</strong> () const;
void <strong>set_pe_settings</strong> (pe_settings const&amp; settings);
</pre>
<p>Sets the <a class="reference external" href="reference-Session.html#session">session</a> settings and the packet encryption settings respectively.
See <a class="reference external" href="reference-Settings.html#session_settings">session_settings</a> and pe_settings for more information on available
See <a class="reference external" href="reference-Settings.html#session_settings">session_settings</a> and <a class="reference external" href="reference-Settings.html#pe_settings">pe_settings</a> for more information on available
options.</p>
<a name="set_proxy()"></a>
<a name="proxy()"></a></div>
@ -1365,7 +1365,7 @@ valid until <tt class="docutils literal">stop_natpmp()</tt> is called. See <a cl
</tr>
<tr><td>save_dht_settings</td>
<td>2</td>
<td>saves dht_settings</td>
<td>saves <a class="reference external" href="reference-Settings.html#dht_settings">dht_settings</a></td>
</tr>
<tr><td>save_dht_state</td>
<td>4</td>
@ -1382,7 +1382,7 @@ joining the DHT if provided at next <a class="reference external" href="referenc
</tr>
<tr><td>save_encryption_settings</td>
<td>32</td>
<td>save pe_settings</td>
<td>save <a class="reference external" href="reference-Settings.html#pe_settings">pe_settings</a></td>
</tr>
<tr><td>save_feeds</td>
<td>128</td>

1924
docs/reference-Settings.html
View File

File diff suppressed because it is too large Load Diff

56
docs/reference-Time.html
View File

@ -90,7 +90,26 @@ struct time_duration
time_duration&amp; <strong>operator*=</strong> (int v);
};
</pre>
<a name="operator+=()"></a>
<a name="time_duration()"></a>
<a name="operator*=()"></a>
<a name="operator-=()"></a>
<a name="operator+()"></a>
<a name="operator/()"></a>
<a name="operator-()"></a><div class="section" id="operator-time-duration-operator-operator-operator-operator-operator">
<h2>operator+=() time_duration() operator*=() operator-=() operator+() operator/() operator-()</h2>
<pre class="literal-block">
time_duration&amp; <strong>operator-=</strong> (time_duration const&amp; c);
time_duration <strong>operator+</strong> (time_duration const&amp; c);
time_duration&amp; <strong>operator+=</strong> (time_duration const&amp; c);
time_duration <strong>operator/</strong> (int rhs) const;
explicit <strong>time_duration</strong> (boost::int64_t d);
time_duration <strong>operator-</strong> (time_duration const&amp; c);
time_duration&amp; <strong>operator*=</strong> (int v);
</pre>
<p>all operators have the same semantics as a 64 bit signed integer</p>
<a name="ptime"></a></div>
</div>
<div class="section" id="ptime">
<h1>ptime</h1>
<p>Declared in &quot;<a class="reference external" href="../include/libtorrent/ptime.hpp">libtorrent/ptime.hpp</a>&quot;</p>
@ -102,23 +121,54 @@ struct ptime
ptime&amp; <strong>operator+=</strong> (time_duration rhs);
};
</pre>
<a name="is_negative()"></a><div class="section" id="is-negative">
<a name="operator+=()"></a>
<a name="operator-=()"></a><div class="section" id="operator-operator">
<h2>operator+=() operator-=()</h2>
<pre class="literal-block">
ptime&amp; <strong>operator-=</strong> (time_duration rhs);
ptime&amp; <strong>operator+=</strong> (time_duration rhs);
</pre>
<p>these operators have the same semantics as signed 64 bit integers</p>
<a name="is_negative()"></a></div>
<div class="section" id="is-negative">
<h2>is_negative()</h2>
<p>Declared in &quot;<a class="reference external" href="../include/libtorrent/ptime.hpp">libtorrent/ptime.hpp</a>&quot;</p>
<pre class="literal-block">
inline bool <strong>is_negative</strong> (time_duration dt);
</pre>
<p>returns true of the time duration is less than 0</p>
<a name="operator*()"></a>
<a name="operator>=()"></a>
<a name="operator!=()"></a>
<a name="operator>()"></a>
<a name="operator<()"></a>
<a name="operator==()"></a>
<a name="operator+()"></a>
<a name="operator<=()"></a>
<a name="operator-()"></a></div>
<div class="section" id="operator-operator">
<h2>operator+() operator-()</h2>
<div class="section" id="operator-operator-operator-operator-operator-operator-operator-operator-operator">
<h2>operator*() operator&gt;=() operator!=() operator&gt;() operator&lt;() operator==() operator+() operator&lt;=() operator-()</h2>
<p>Declared in &quot;<a class="reference external" href="../include/libtorrent/ptime.hpp">libtorrent/ptime.hpp</a>&quot;</p>
<pre class="literal-block">
inline time_duration <strong>operator*</strong> (int lhs, time_duration rhs);
inline bool <strong>operator==</strong> (time_duration lhs, time_duration rhs);
inline bool <strong>operator&lt;=</strong> (time_duration lhs, time_duration rhs);
inline bool <strong>operator==</strong> (ptime lhs, ptime rhs);
inline bool <strong>operator&gt;=</strong> (time_duration lhs, time_duration rhs);
inline bool <strong>operator&lt;</strong> (time_duration lhs, time_duration rhs);
inline bool <strong>operator&gt;</strong> (time_duration lhs, time_duration rhs);
inline bool <strong>operator&gt;</strong> (ptime lhs, ptime rhs);
inline ptime <strong>operator+</strong> (time_duration lhs, ptime rhs);
inline ptime <strong>operator+</strong> (ptime lhs, time_duration rhs);
inline time_duration <strong>operator*</strong> (time_duration lhs, int rhs);
inline time_duration <strong>operator-</strong> (ptime lhs, ptime rhs);
inline bool <strong>operator&lt;=</strong> (ptime lhs, ptime rhs);
inline bool <strong>operator!=</strong> (ptime lhs, ptime rhs);
inline bool <strong>operator&lt;</strong> (ptime lhs, ptime rhs);
inline bool <strong>operator&gt;=</strong> (ptime lhs, ptime rhs);
inline ptime <strong>operator-</strong> (ptime lhs, time_duration rhs);
</pre>
<p>all operators have the same semantics as signed 64 bit integers</p>
<a name="time_now()"></a></div>
<div class="section" id="time-now">
<h2>time_now()</h2>

10
docs/reference.html
View File

@ -58,7 +58,6 @@
<div class="line"><a class="reference external" href="reference-Core.html#disk_buffer_holder">disk_buffer_holder</a></div>
<div class="line"><a class="reference external" href="reference-Core.html#peer_info">peer_info</a></div>
<div class="line"><a class="reference external" href="reference-Core.html#peer_request">peer_request</a></div>
<div class="line"><a class="reference external" href="reference-Core.html#piece_block_progress">piece_block_progress</a></div>
<div class="line"><a class="reference external" href="reference-Core.html#block_info">block_info</a></div>
<div class="line"><a class="reference external" href="reference-Core.html#partial_piece_info">partial_piece_info</a></div>
<div class="line"><a class="reference external" href="reference-Core.html#torrent_handle">torrent_handle</a></div>
@ -77,7 +76,14 @@
<div class="line"><a class="reference external" href="reference-Time.html#time_duration">time_duration</a></div>
<div class="line"><a class="reference external" href="reference-Time.html#ptime">ptime</a></div>
<div class="line"><a class="reference external" href="reference-Time.html#is_negative()">is_negative()</a></div>
<div class="line"><a class="reference external" href="reference-Time.html#operator*()">operator*()</a></div>
<div class="line"><a class="reference external" href="reference-Time.html#operator&gt;=()">operator&gt;=()</a></div>
<div class="line"><a class="reference external" href="reference-Time.html#operator!=()">operator!=()</a></div>
<div class="line"><a class="reference external" href="reference-Time.html#operator&gt;()">operator&gt;()</a></div>
<div class="line"><a class="reference external" href="reference-Time.html#operator&lt;()">operator&lt;()</a></div>
<div class="line"><a class="reference external" href="reference-Time.html#operator==()">operator==()</a></div>
<div class="line"><a class="reference external" href="reference-Time.html#operator+()">operator+()</a></div>
<div class="line"><a class="reference external" href="reference-Time.html#operator&lt;=()">operator&lt;=()</a></div>
<div class="line"><a class="reference external" href="reference-Time.html#operator-()">operator-()</a></div>
<div class="line"><a class="reference external" href="reference-Time.html#time_now()">time_now()</a></div>
<div class="line"><a class="reference external" href="reference-Time.html#time_now_hires()">time_now_hires()</a></div>
@ -125,6 +131,8 @@
<div class="line-block">
<div class="line"><a class="reference external" href="reference-Settings.html#proxy_settings">proxy_settings</a></div>
<div class="line"><a class="reference external" href="reference-Settings.html#session_settings">session_settings</a></div>
<div class="line"><a class="reference external" href="reference-Settings.html#dht_settings">dht_settings</a></div>
<div class="line"><a class="reference external" href="reference-Settings.html#pe_settings">pe_settings</a></div>
<div class="line"><a class="reference external" href="reference-Settings.html#min_memory_usage()">min_memory_usage()</a></div>
<div class="line"><a class="reference external" href="reference-Settings.html#high_performance_seed()">high_performance_seed()</a></div>
</div>

1680
include/libtorrent/session_settings.hpp
View File

File diff suppressed because it is too large Load Diff