jiigen666/libtorrent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

*** empty log message ***

Browse Source
This commit is contained in:
Arvid Norberg
2004-03-21 02:03:37 +00:00
parent aa7055c212
commit bb52b74a9e
17 changed files with 356 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
docs/manual.html
View File

@@ -45,32 +45,33 @@
<li><a class="reference" href="#file-error-alert" id="id37" name="id37">file_error_alert</a></li>
<li><a class="reference" href="#tracker-alert" id="id38" name="id38">tracker_alert</a></li>
<li><a class="reference" href="#hash-failed-alert" id="id39" name="id39">hash_failed_alert</a></li>
<li><a class="reference" href="#peer-error-alert" id="id40" name="id40">peer_error_alert</a></li>
<li><a class="reference" href="#invalid-request-alert" id="id41" name="id41">invalid_request_alert</a></li>
<li><a class="reference" href="#torrent-finished-alert" id="id42" name="id42">torrent_finished_alert</a></li>
<li><a class="reference" href="#dispatcher" id="id43" name="id43">dispatcher</a></li>
<li><a class="reference" href="#peer-ban-alert" id="id40" name="id40">peer_ban_alert</a></li>
<li><a class="reference" href="#peer-error-alert" id="id41" name="id41">peer_error_alert</a></li>
<li><a class="reference" href="#invalid-request-alert" id="id42" name="id42">invalid_request_alert</a></li>
<li><a class="reference" href="#torrent-finished-alert" id="id43" name="id43">torrent_finished_alert</a></li>
<li><a class="reference" href="#dispatcher" id="id44" name="id44">dispatcher</a></li>
</ul>
</li>
<li><a class="reference" href="#exceptions" id="id44" name="id44">exceptions</a><ul>
<li><a class="reference" href="#invalid-handle" id="id45" name="id45">invalid_handle</a></li>
<li><a class="reference" href="#duplicate-torrent" id="id46" name="id46">duplicate_torrent</a></li>
<li><a class="reference" href="#invalid-encoding" id="id47" name="id47">invalid_encoding</a></li>
<li><a class="reference" href="#type-error" id="id48" name="id48">type_error</a></li>
<li><a class="reference" href="#invalid-torrent-file" id="id49" name="id49">invalid_torrent_file</a></li>
<li><a class="reference" href="#exceptions" id="id45" name="id45">exceptions</a><ul>
<li><a class="reference" href="#invalid-handle" id="id46" name="id46">invalid_handle</a></li>
<li><a class="reference" href="#duplicate-torrent" id="id47" name="id47">duplicate_torrent</a></li>
<li><a class="reference" href="#invalid-encoding" id="id48" name="id48">invalid_encoding</a></li>
<li><a class="reference" href="#type-error" id="id49" name="id49">type_error</a></li>
<li><a class="reference" href="#invalid-torrent-file" id="id50" name="id50">invalid_torrent_file</a></li>
</ul>
</li>
<li><a class="reference" href="#examples" id="id50" name="id50">examples</a><ul>
<li><a class="reference" href="#dump-torrent" id="id51" name="id51">dump_torrent</a></li>
<li><a class="reference" href="#simple-client" id="id52" name="id52">simple client</a></li>
<li><a class="reference" href="#examples" id="id51" name="id51">examples</a><ul>
<li><a class="reference" href="#dump-torrent" id="id52" name="id52">dump_torrent</a></li>
<li><a class="reference" href="#simple-client" id="id53" name="id53">simple client</a></li>
</ul>
</li>
<li><a class="reference" href="#fast-resume" id="id53" name="id53">fast resume</a><ul>
<li><a class="reference" href="#file-format" id="id54" name="id54">file format</a></li>
<li><a class="reference" href="#fast-resume" id="id54" name="id54">fast resume</a><ul>
<li><a class="reference" href="#file-format" id="id55" name="id55">file format</a></li>
</ul>
</li>
<li><a class="reference" href="#extensions" id="id55" name="id55">extensions</a></li>
<li><a class="reference" href="#filenames-checks" id="id56" name="id56">filenames checks</a></li>
<li><a class="reference" href="#aknowledgements" id="id57" name="id57">aknowledgements</a></li>
<li><a class="reference" href="#extensions" id="id56" name="id56">extensions</a></li>
<li><a class="reference" href="#filenames-checks" id="id57" name="id57">filenames checks</a></li>
<li><a class="reference" href="#aknowledgements" id="id58" name="id58">aknowledgements</a></li>
</ul>
</div>
<div class="section" id="introduction">
@@ -584,6 +585,10 @@ struct torrent_handle
void connect_peer(const address&amp; adr) const;
void set_ratio(float ratio);
void pause();
void resume();
bool is_paused() const;
void set_tracker_login(std::string const&amp; username, std::string const&amp; password);
void use_interface(const char* net_interface);
@@ -620,6 +625,11 @@ in return. With this setting it will work much like the standard clients.</p>
attempt to upload in return for each download. e.g. if set to 2, the client will try to upload
2 bytes for every byte received. The default setting for this is 0, which will make it work
as a standard client.</p>
<p><tt class="literal"><span class="pre">pause()</span></tt>, and <tt class="literal"><span class="pre">resume()</span></tt> will disconnect all peers and reconnect all peers respectively.
When a torrent is paused, it will however remember all share ratios to all peers and remember
all potential (not connected) peers. You can use <tt class="literal"><span class="pre">is_paused()</span></tt> to determine if a torrent
is currently paused. Torrents may be paused automatically if there is a file error (eg. disk full)
or something similar. See <a class="reference" href="#file-error-alert">file_error_alert</a>.</p>
<p><tt class="literal"><span class="pre">set_tracker_login()</span></tt> sets a username and password that will be sent along in the HTTP-request
of the tracker announce. Set this if the tracker requires authorization.</p>
<p><tt class="literal"><span class="pre">use_interface()</span></tt> sets the network interface this torrent will use when it opens outgoing
@@ -1162,7 +1172,7 @@ struct listen_failed_alert: alert
<div class="section" id="file-error-alert">
<h2><a name="file-error-alert">file_error_alert</a></h2>
<p>If the storage fails to read or write files that it needs access to, this alert is
generated and the torrent is aborted. It is generated as severity level <tt class="literal"><span class="pre">fatal</span></tt>.</p>
generated and the torrent is paused. It is generated as severity level <tt class="literal"><span class="pre">fatal</span></tt>.</p>
<pre class="literal-block">
struct file_error_alert: alert
{
@@ -1211,6 +1221,26 @@ struct hash_failed_alert: alert
};
</pre>
</div>
<div class="section" id="peer-ban-alert">
<h2><a name="peer-ban-alert">peer_ban_alert</a></h2>
<p>This alert is generated when a peer is banned because it has sent too many corrupt pieces
to us. It is generated at severity level <tt class="literal"><span class="pre">info</span></tt>. The <tt class="literal"><span class="pre">handle</span></tt> member is a <a class="reference" href="#torrent-handle">torrent_handle</a>
to the torrent that this peer was a member of.</p>
<pre class="literal-block">
struct peer_ban_alert: alert
{
peer_error_alert(
address const&amp; pip
, torrent_handle h
, const std::string&amp; msg);
virtual std::auto_ptr&lt;alert&gt; clone() const;
address ip;
torrent_handle handle;
};
</pre>
</div>
<div class="section" id="peer-error-alert">
<h2><a name="peer-error-alert">peer_error_alert</a></h2>
<p>This alert is generated when a peer sends invalid data over the peer-peer protocol. The peer