*** empty log message ***

docs/index.html

@@ -56,6 +56,7 @@ The current state includes the following features:
 	<li>queues torrents for file check, instead of checking all of them in parallel.
 	<li>uses separate threads for checking files and for main downloader, with a fool-proof
 	thread-safe library interface. (i.e. There's no way for the user to cause a deadlock).
+	<li>can limit the upload bandwidth usage
 </ul>
 
 <p>
@@ -64,12 +65,12 @@ Functions that are yet to be implemented:
 
 <ul>
 	<li>optimistic unchoke
-	<li>upload speed cap
 	<li>Snubbing
 	<li>end game mode
 	<li>new allocation model
 	<li>fast resume
 	<li>file-level piece priority
+	<li>a good upload speed cap
 </ul>
 
 <p>
@@ -159,6 +160,7 @@ class session: public boost::noncopyable
 	void remove_torrent(const torrent_handle&amp; h);
 
 	void set_http_settings(const http_settings&amp; settings);
+	void set_upload_rate_limit(int bytes_per_second);
 };
 </pre>
 
@@ -188,6 +190,20 @@ identify the client. If the string is longer than 7 characters it will
 be trimmed down to 7 characters. The default is an empty string.
 </p>
 
+<p>
+<tt>set_upload_rate_limit()</tt> set the maximum number of bytes allowed to be
+sent to peers per second. This bandwidth is distributed among all the peers. If
+you don't want to limit upload rate, you can set this to -1 (the default).
+</p>
+
+<p>
+The destructor of session will notify all trackers that our torrents has been shut down.
+If some trackers are down, they will timout. All this before the destructor of session
+returns. So, it's adviced that any kind of interface (such as windows) are closed before
+destructing the sessoin object. Because it can take a few second for it to finish. The
+timeout can be set with <tt>set_http_settings()</tt>.
+</p>
+
 <p>
 How to parse a torrent file and create a <tt>torrent_info</tt> object is described below.
 </p>
@@ -655,6 +671,7 @@ struct peer_info
 	unsigned int total_upload;
 	peer_id id;
 	std::vector&lt;bool&gt; pieces;
+	int upload_limit;
 };
 </pre>
 
@@ -695,6 +712,11 @@ in the torrent. Each boolean tells you if the peer has that piece (if it's set t
 or if the peer miss that piece (set to false).
 </p>
 
+<p>
+<tt>upload_limit</tt> is the number of bytes per second we are allowed to send to this
+peer every second. It may be -1 if there's no limit.
+</p>
+
 <p>
 TODO: address
 </p>
@@ -724,7 +746,7 @@ struct http_settings
 
 <p>
 <tt>tracker_timeout</tt> is the number of seconds the tracker connection will
-wait until it considers the tracker to have timed-out. Default value is 30
+wait until it considers the tracker to have timed-out. Default value is 10
 seconds.
 </p>