premiere
/
premiere-libtorrent
2
2
Fork 1
Code Issues Pull Requests Releases Wiki Activity

removed supports_sparse_files documentation since it's not in libtorrent anymore

This commit is contained in:
Arvid Norberg 2008-04-07 00:09:10 +00:00
parent d10205057e
commit e8f2ee8b37
2 changed files with 71 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

157
docs/manual.html
View File

@ -138,77 +138,76 @@
<li><a class="reference internal" href="#identify-client" id="id117">identify_client()</a></li> <li><a class="reference internal" href="#identify-client" id="id117">identify_client()</a></li>
<li><a class="reference internal" href="#client-fingerprint" id="id118">client_fingerprint()</a></li> <li><a class="reference internal" href="#client-fingerprint" id="id118">client_fingerprint()</a></li>
<li><a class="reference internal" href="#bdecode-bencode" id="id119">bdecode() bencode()</a></li> <li><a class="reference internal" href="#bdecode-bencode" id="id119">bdecode() bencode()</a></li>
<li><a class="reference internal" href="#supports-sparse-files" id="id120">supports_sparse_files()</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#alerts" id="id121">alerts</a><ul> <li><a class="reference internal" href="#alerts" id="id120">alerts</a><ul>
<li><a class="reference internal" href="#external-ip-alert" id="id122">external_ip_alert</a></li> <li><a class="reference internal" href="#external-ip-alert" id="id121">external_ip_alert</a></li>
<li><a class="reference internal" href="#listen-failed-alert" id="id123">listen_failed_alert</a></li> <li><a class="reference internal" href="#listen-failed-alert" id="id122">listen_failed_alert</a></li>
<li><a class="reference internal" href="#portmap-error-alert" id="id124">portmap_error_alert</a></li> <li><a class="reference internal" href="#portmap-error-alert" id="id123">portmap_error_alert</a></li>
<li><a class="reference internal" href="#portmap-alert" id="id125">portmap_alert</a></li> <li><a class="reference internal" href="#portmap-alert" id="id124">portmap_alert</a></li>
<li><a class="reference internal" href="#file-error-alert" id="id126">file_error_alert</a></li> <li><a class="reference internal" href="#file-error-alert" id="id125">file_error_alert</a></li>
<li><a class="reference internal" href="#tracker-announce-alert" id="id127">tracker_announce_alert</a></li> <li><a class="reference internal" href="#tracker-announce-alert" id="id126">tracker_announce_alert</a></li>
<li><a class="reference internal" href="#tracker-alert" id="id128">tracker_alert</a></li> <li><a class="reference internal" href="#tracker-alert" id="id127">tracker_alert</a></li>
<li><a class="reference internal" href="#tracker-reply-alert" id="id129">tracker_reply_alert</a></li> <li><a class="reference internal" href="#tracker-reply-alert" id="id128">tracker_reply_alert</a></li>
<li><a class="reference internal" href="#tracker-warning-alert" id="id130">tracker_warning_alert</a></li> <li><a class="reference internal" href="#tracker-warning-alert" id="id129">tracker_warning_alert</a></li>
<li><a class="reference internal" href="#scrape-reply-alert" id="id131">scrape_reply_alert</a></li> <li><a class="reference internal" href="#scrape-reply-alert" id="id130">scrape_reply_alert</a></li>
<li><a class="reference internal" href="#scrape-failed-alert" id="id132">scrape_failed_alert</a></li> <li><a class="reference internal" href="#scrape-failed-alert" id="id131">scrape_failed_alert</a></li>
<li><a class="reference internal" href="#url-seed-alert" id="id133">url_seed_alert</a></li> <li><a class="reference internal" href="#url-seed-alert" id="id132">url_seed_alert</a></li>
<li><a class="reference internal" href="#hash-failed-alert" id="id134">hash_failed_alert</a></li> <li><a class="reference internal" href="#hash-failed-alert" id="id133">hash_failed_alert</a></li>
<li><a class="reference internal" href="#peer-ban-alert" id="id135">peer_ban_alert</a></li> <li><a class="reference internal" href="#peer-ban-alert" id="id134">peer_ban_alert</a></li>
<li><a class="reference internal" href="#peer-error-alert" id="id136">peer_error_alert</a></li> <li><a class="reference internal" href="#peer-error-alert" id="id135">peer_error_alert</a></li>
<li><a class="reference internal" href="#invalid-request-alert" id="id137">invalid_request_alert</a></li> <li><a class="reference internal" href="#invalid-request-alert" id="id136">invalid_request_alert</a></li>
<li><a class="reference internal" href="#torrent-finished-alert" id="id138">torrent_finished_alert</a></li> <li><a class="reference internal" href="#torrent-finished-alert" id="id137">torrent_finished_alert</a></li>
<li><a class="reference internal" href="#metadata-failed-alert" id="id139">metadata_failed_alert</a></li> <li><a class="reference internal" href="#metadata-failed-alert" id="id138">metadata_failed_alert</a></li>
<li><a class="reference internal" href="#metadata-received-alert" id="id140">metadata_received_alert</a></li> <li><a class="reference internal" href="#metadata-received-alert" id="id139">metadata_received_alert</a></li>
<li><a class="reference internal" href="#fastresume-rejected-alert" id="id141">fastresume_rejected_alert</a></li> <li><a class="reference internal" href="#fastresume-rejected-alert" id="id140">fastresume_rejected_alert</a></li>
<li><a class="reference internal" href="#peer-blocked-alert" id="id142">peer_blocked_alert</a></li> <li><a class="reference internal" href="#peer-blocked-alert" id="id141">peer_blocked_alert</a></li>
<li><a class="reference internal" href="#storage-moved-alert" id="id143">storage_moved_alert</a></li> <li><a class="reference internal" href="#storage-moved-alert" id="id142">storage_moved_alert</a></li>
<li><a class="reference internal" href="#torrent-paused-alert" id="id144">torrent_paused_alert</a></li> <li><a class="reference internal" href="#torrent-paused-alert" id="id143">torrent_paused_alert</a></li>
<li><a class="reference internal" href="#dispatcher" id="id145">dispatcher</a></li> <li><a class="reference internal" href="#dispatcher" id="id144">dispatcher</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#exceptions" id="id146">exceptions</a><ul> <li><a class="reference internal" href="#exceptions" id="id145">exceptions</a><ul>
<li><a class="reference internal" href="#invalid-handle" id="id147">invalid_handle</a></li> <li><a class="reference internal" href="#invalid-handle" id="id146">invalid_handle</a></li>
<li><a class="reference internal" href="#duplicate-torrent" id="id148">duplicate_torrent</a></li> <li><a class="reference internal" href="#duplicate-torrent" id="id147">duplicate_torrent</a></li>
<li><a class="reference internal" href="#invalid-encoding" id="id149">invalid_encoding</a></li> <li><a class="reference internal" href="#invalid-encoding" id="id148">invalid_encoding</a></li>
<li><a class="reference internal" href="#type-error" id="id150">type_error</a></li> <li><a class="reference internal" href="#type-error" id="id149">type_error</a></li>
<li><a class="reference internal" href="#invalid-torrent-file" id="id151">invalid_torrent_file</a></li> <li><a class="reference internal" href="#invalid-torrent-file" id="id150">invalid_torrent_file</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#storage-interface" id="id152">storage_interface</a><ul> <li><a class="reference internal" href="#storage-interface" id="id151">storage_interface</a><ul>
<li><a class="reference internal" href="#initialize" id="id153">initialize()</a></li> <li><a class="reference internal" href="#initialize" id="id152">initialize()</a></li>
<li><a class="reference internal" href="#read" id="id154">read()</a></li> <li><a class="reference internal" href="#read" id="id153">read()</a></li>
<li><a class="reference internal" href="#write" id="id155">write()</a></li> <li><a class="reference internal" href="#write" id="id154">write()</a></li>
<li><a class="reference internal" href="#id11" id="id156">move_storage()</a></li> <li><a class="reference internal" href="#id11" id="id155">move_storage()</a></li>
<li><a class="reference internal" href="#verify-resume-data" id="id157">verify_resume_data()</a></li> <li><a class="reference internal" href="#verify-resume-data" id="id156">verify_resume_data()</a></li>
<li><a class="reference internal" href="#id12" id="id158">write_resume_data( )</a></li> <li><a class="reference internal" href="#id12" id="id157">write_resume_data( )</a></li>
<li><a class="reference internal" href="#move-slot" id="id159">move_slot()</a></li> <li><a class="reference internal" href="#move-slot" id="id158">move_slot()</a></li>
<li><a class="reference internal" href="#swap-slots" id="id160">swap_slots()</a></li> <li><a class="reference internal" href="#swap-slots" id="id159">swap_slots()</a></li>
<li><a class="reference internal" href="#swap-slots3" id="id161">swap_slots3()</a></li> <li><a class="reference internal" href="#swap-slots3" id="id160">swap_slots3()</a></li>
<li><a class="reference internal" href="#hash-for-slot" id="id162">hash_for_slot()</a></li> <li><a class="reference internal" href="#hash-for-slot" id="id161">hash_for_slot()</a></li>
<li><a class="reference internal" href="#release-files" id="id163">release_files()</a></li> <li><a class="reference internal" href="#release-files" id="id162">release_files()</a></li>
<li><a class="reference internal" href="#delete-files" id="id164">delete_files()</a></li> <li><a class="reference internal" href="#delete-files" id="id163">delete_files()</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#fast-resume" id="id165">fast resume</a><ul> <li><a class="reference internal" href="#fast-resume" id="id164">fast resume</a><ul>
<li><a class="reference internal" href="#file-format" id="id166">file format</a></li> <li><a class="reference internal" href="#file-format" id="id165">file format</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#threads" id="id167">threads</a></li> <li><a class="reference internal" href="#threads" id="id166">threads</a></li>
<li><a class="reference internal" href="#storage-allocation" id="id168">storage allocation</a><ul> <li><a class="reference internal" href="#storage-allocation" id="id167">storage allocation</a><ul>
<li><a class="reference internal" href="#sparse-allocation" id="id169">sparse allocation</a></li> <li><a class="reference internal" href="#sparse-allocation" id="id168">sparse allocation</a></li>
<li><a class="reference internal" href="#full-allocation" id="id170">full allocation</a></li> <li><a class="reference internal" href="#full-allocation" id="id169">full allocation</a></li>
<li><a class="reference internal" href="#compact-allocation" id="id171">compact allocation</a></li> <li><a class="reference internal" href="#compact-allocation" id="id170">compact allocation</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#extensions" id="id172">extensions</a><ul> <li><a class="reference internal" href="#extensions" id="id171">extensions</a><ul>
<li><a class="reference internal" href="#metadata-from-peers" id="id173">metadata from peers</a></li> <li><a class="reference internal" href="#metadata-from-peers" id="id172">metadata from peers</a></li>
<li><a class="reference internal" href="#http-seeding" id="id174">HTTP seeding</a></li> <li><a class="reference internal" href="#http-seeding" id="id173">HTTP seeding</a></li>
</ul> </ul>
</li> </li>
<li><a class="reference internal" href="#filename-checks" id="id175">filename checks</a></li> <li><a class="reference internal" href="#filename-checks" id="id174">filename checks</a></li>
<li><a class="reference internal" href="#acknowledgments" id="id176">acknowledgments</a></li> <li><a class="reference internal" href="#acknowledgments" id="id175">acknowledgments</a></li>
</ul> </ul>
</div> </div>
<div class="section" id="overview"> <div class="section" id="overview">
@ -219,7 +218,7 @@ the <tt class="docutils literal"><span class="pre">session</span></tt>, it conta
<ul> <ul>
<li><p class="first">construct a session</p> <li><p class="first">construct a session</p>
</li> </li>
<li><p class="first">start DHT, LSD, UPnP, NAT-PMP etc (see <a href="#id177"><span class="problematic" id="id178">start_dht_</span></a>, <a href="#id179"><span class="problematic" id="id180">start_lsd_</span></a>, <a href="#id181"><span class="problematic" id="id182">start_upnp_</span></a> and <a href="#id183"><span class="problematic" id="id184">start_natpmp_</span></a>)</p> <li><p class="first">start DHT, LSD, UPnP, NAT-PMP etc (see <a href="#id176"><span class="problematic" id="id177">start_dht_</span></a>, <a href="#id178"><span class="problematic" id="id179">start_lsd_</span></a>, <a href="#id180"><span class="problematic" id="id181">start_upnp_</span></a> and <a href="#id182"><span class="problematic" id="id183">start_natpmp_</span></a>)</p>
</li> </li>
<li><p class="first">parse .torrent-files and add them to the session (see <a class="reference internal" href="#bdecode-bencode">bdecode() bencode()</a> and <a class="reference internal" href="#add-torrent">add_torrent()</a>)</p> <li><p class="first">parse .torrent-files and add them to the session (see <a class="reference internal" href="#bdecode-bencode">bdecode() bencode()</a> and <a class="reference internal" href="#add-torrent">add_torrent()</a>)</p>
</li> </li>
@ -1020,7 +1019,7 @@ port are attempted to be forwarded on local UPnP router devices.</p>
<p>The upnp object returned by <tt class="docutils literal"><span class="pre">start_upnp()</span></tt> can be used to add and remove <p>The upnp object returned by <tt class="docutils literal"><span class="pre">start_upnp()</span></tt> can be used to add and remove
arbitrary port mappings. Mapping status is returned through the arbitrary port mappings. Mapping status is returned through the
<a class="reference internal" href="#portmap-alert">portmap_alert</a> and the <a class="reference internal" href="#portmap-error-alert">portmap_error_alert</a>. The object will be valid until <a class="reference internal" href="#portmap-alert">portmap_alert</a> and the <a class="reference internal" href="#portmap-error-alert">portmap_error_alert</a>. The object will be valid until
<a href="#id185"><span class="problematic" id="id186">stop_upnp_</span></a> is called. See <a class="reference internal" href="#upnp-and-nat-pmp">UPnP and NAT-PMP</a>.</p> <a href="#id184"><span class="problematic" id="id185">stop_upnp_</span></a> is called. See <a class="reference internal" href="#upnp-and-nat-pmp">UPnP and NAT-PMP</a>.</p>
<p>It is off by default.</p> <p>It is off by default.</p>
</div> </div>
<div class="section" id="start-natpmp-stop-natpmp"> <div class="section" id="start-natpmp-stop-natpmp">
@ -1036,7 +1035,7 @@ port are attempted to be forwarded on the router through NAT-PMP.</p>
<p>The natpmp object returned by <tt class="docutils literal"><span class="pre">start_natpmp()</span></tt> can be used to add and remove <p>The natpmp object returned by <tt class="docutils literal"><span class="pre">start_natpmp()</span></tt> can be used to add and remove
arbitrary port mappings. Mapping status is returned through the arbitrary port mappings. Mapping status is returned through the
<a class="reference internal" href="#portmap-alert">portmap_alert</a> and the <a class="reference internal" href="#portmap-error-alert">portmap_error_alert</a>. The object will be valid until <a class="reference internal" href="#portmap-alert">portmap_alert</a> and the <a class="reference internal" href="#portmap-error-alert">portmap_error_alert</a>. The object will be valid until
<a href="#id187"><span class="problematic" id="id188">stop_upnp_</span></a> is called. See <a class="reference internal" href="#upnp-and-nat-pmp">UPnP and NAT-PMP</a>.</p> <a href="#id186"><span class="problematic" id="id187">stop_upnp_</span></a> is called. See <a class="reference internal" href="#upnp-and-nat-pmp">UPnP and NAT-PMP</a>.</p>
<p>It is off by default.</p> <p>It is off by default.</p>
</div> </div>
</div> </div>
@ -3353,20 +3352,6 @@ entry e = bdecode(buf, buf + data_size);
<p>If <tt class="docutils literal"><span class="pre">bdecode()</span></tt> encounters invalid encoded data in the range given to it <p>If <tt class="docutils literal"><span class="pre">bdecode()</span></tt> encounters invalid encoded data in the range given to it
it will throw <a class="reference internal" href="#invalid-encoding">invalid_encoding</a>.</p> it will throw <a class="reference internal" href="#invalid-encoding">invalid_encoding</a>.</p>
</div> </div>
<div class="section" id="supports-sparse-files">
<h2>supports_sparse_files()</h2>
<blockquote>
<pre class="literal-block">
bool supports_sparse_files(boost::filesystem::path const&amp;);
</pre>
</blockquote>
<p>The path is expected to be the path to the directory where you will want to
store sparse files. The return value is true if the file system supports
sparse files or if it supports automatic zero filling of files. The main
characteristics that is tested by this function is not the storage aspects
of sparse files, but rather the support for seeking passed end of file and
write data there, with expected behavior.</p>
</div>
</div> </div>
<div class="section" id="alerts"> <div class="section" id="alerts">
<h1>alerts</h1> <h1>alerts</h1>
@ -4563,23 +4548,23 @@ scripts.</p>
</div> </div>
<div class="system-messages section"> <div class="system-messages section">
<h1>Docutils System Messages</h1> <h1>Docutils System Messages</h1>
<div class="system-message" id="id177"> <div class="system-message" id="id176">
<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 21); <em><a href="#id178">backlink</a></em></p> <p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 21); <em><a href="#id177">backlink</a></em></p>
Unknown target name: &quot;start_dht&quot;.</div> Unknown target name: &quot;start_dht&quot;.</div>
<div class="system-message" id="id179"> <div class="system-message" id="id178">
<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 21); <em><a href="#id180">backlink</a></em></p> <p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 21); <em><a href="#id179">backlink</a></em></p>
Unknown target name: &quot;start_lsd&quot;.</div> Unknown target name: &quot;start_lsd&quot;.</div>
<div class="system-message" id="id181"> <div class="system-message" id="id180">
<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 21); <em><a href="#id182">backlink</a></em></p> <p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 21); <em><a href="#id181">backlink</a></em></p>
Unknown target name: &quot;start_upnp&quot;.</div> Unknown target name: &quot;start_upnp&quot;.</div>
<div class="system-message" id="id183"> <div class="system-message" id="id182">
<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 21); <em><a href="#id184">backlink</a></em></p> <p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 21); <em><a href="#id183">backlink</a></em></p>
Unknown target name: &quot;start_natpmp&quot;.</div> Unknown target name: &quot;start_natpmp&quot;.</div>
<div class="system-message" id="id185"> <div class="system-message" id="id184">
<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 893); <em><a href="#id186">backlink</a></em></p> <p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 893); <em><a href="#id185">backlink</a></em></p>
Unknown target name: &quot;stop_upnp&quot;.</div> Unknown target name: &quot;stop_upnp&quot;.</div>
<div class="system-message" id="id187"> <div class="system-message" id="id186">
<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 911); <em><a href="#id188">backlink</a></em></p> <p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">manual.rst</tt>, line 911); <em><a href="#id187">backlink</a></em></p>
Unknown target name: &quot;stop_upnp&quot;.</div> Unknown target name: &quot;stop_upnp&quot;.</div>
</div> </div>
</div> </div>

15
docs/manual.rst
View File

@ -3433,21 +3433,6 @@ If ``bdecode()`` encounters invalid encoded data in the range given to it
it will throw invalid_encoding_. it will throw invalid_encoding_.
supports_sparse_files()
-----------------------
::
bool supports_sparse_files(boost::filesystem::path const&);
The path is expected to be the path to the directory where you will want to
store sparse files. The return value is true if the file system supports
sparse files or if it supports automatic zero filling of files. The main
characteristics that is tested by this function is not the storage aspects
of sparse files, but rather the support for seeking passed end of file and
write data there, with expected behavior.
alerts alerts
====== ======