diff --git a/docs/manual-ref.html b/docs/manual-ref.html index aa9a8b40b..565990d5f 100644 --- a/docs/manual-ref.html +++ b/docs/manual-ref.html @@ -3,7 +3,7 @@ - + libtorrent API Documentation diff --git a/docs/reference-Alerts.html b/docs/reference-Alerts.html index fe3fc3ea6..96fad8676 100644 --- a/docs/reference-Alerts.html +++ b/docs/reference-Alerts.html @@ -3,7 +3,7 @@ - + Alerts @@ -55,100 +55,98 @@

Table of contents

-

The pop_alert() function on session is the interface for retrieving -alerts, warnings, messages and errors from libtorrent. If no alerts have -been posted by libtorrent pop_alert() will return a default initialized -std::auto_ptr object. If there is an alert in libtorrent's queue, the alert -from the front of the queue is popped and returned. -You can then use the alert object and query

-

By default, only errors are reported. set_alert_mask() can be -used to specify which kinds of events should be reported. The alert mask -is comprised by bits from the category_t enum.

-

Every alert belongs to one or more category. There is a small cost involved in posting alerts. Only -alerts that belong to an enabled category are posted. Setting the alert bitmask to 0 will disable -all alerts (except those that are non-discardable).

+

The pop_alerts() function on session is the main interface for retrieving +alerts (warnings, messages and errors from libtorrent). If no alerts have +been posted by libtorrent pop_alert() will return an empty list.

+

By default, only errors are reported. set_alert_mask() can be used to +specify which kinds of events should be reported. The alert mask is +comprised by bits from the category_t enum.

+

Every alert belongs to one or more category. There is a small cost involved +in posting alerts. Only alerts that belong to an enabled category are +posted. Setting the alert bitmask to 0 will disable all alerts (except those +that are non-discardable).

There are other alert base classes that some alerts derive from, all the -alerts that are generated for a specific torrent are derived from torrent_alert, -and tracker events derive from tracker_alert.

+alerts that are generated for a specific torrent are derived from +torrent_alert, and tracker events derive from tracker_alert.

alert

Declared in "libtorrent/alert.hpp"

@@ -1570,7 +1568,7 @@ struct listen_succeeded_alert: alert socket_type_t sock_type; }; -
+

enum socket_type_t

Declared in "libtorrent/alert_types.hpp"

@@ -2319,7 +2317,7 @@ struct dht_error_alert: alert op_t operation; }; -
+

enum op_t

Declared in "libtorrent/alert_types.hpp"

diff --git a/docs/reference-Bencoding.html b/docs/reference-Bencoding.html index 9091aae5f..6e9bdc071 100644 --- a/docs/reference-Bencoding.html +++ b/docs/reference-Bencoding.html @@ -3,7 +3,7 @@ - +Bencoding diff --git a/docs/reference-Core.html b/docs/reference-Core.html index 16ffe8a25..2c7e68357 100644 --- a/docs/reference-Core.html +++ b/docs/reference-Core.html @@ -3,7 +3,7 @@ - +Core diff --git a/docs/reference-Create_Torrents.html b/docs/reference-Create_Torrents.html index fab844c72..38fece097 100644 --- a/docs/reference-Create_Torrents.html +++ b/docs/reference-Create_Torrents.html @@ -3,7 +3,7 @@ - +Create Torrents diff --git a/docs/reference-Custom_Storage.html b/docs/reference-Custom_Storage.html index d13e37ae7..7b4bdb956 100644 --- a/docs/reference-Custom_Storage.html +++ b/docs/reference-Custom_Storage.html @@ -3,7 +3,7 @@ - +Custom Storage diff --git a/docs/reference-Error_Codes.html b/docs/reference-Error_Codes.html index d223f622c..9b621ad67 100644 --- a/docs/reference-Error_Codes.html +++ b/docs/reference-Error_Codes.html @@ -3,7 +3,7 @@ - +Error Codes diff --git a/docs/reference-Filter.html b/docs/reference-Filter.html index 92a7ccfc4..5c5e956ae 100644 --- a/docs/reference-Filter.html +++ b/docs/reference-Filter.html @@ -3,7 +3,7 @@ - +Filter diff --git a/docs/reference-Plugins.html b/docs/reference-Plugins.html index 4d3a2f84a..1ac2b8bd7 100644 --- a/docs/reference-Plugins.html +++ b/docs/reference-Plugins.html @@ -3,7 +3,7 @@ - + diff --git a/docs/reference-RSS.html b/docs/reference-RSS.html index ae879218d..69a7f7d9a 100644 --- a/docs/reference-RSS.html +++ b/docs/reference-RSS.html @@ -3,7 +3,7 @@ - +RSS diff --git a/docs/reference-Session.html b/docs/reference-Session.html index 9d0e0a0c8..d9f6d0008 100644 --- a/docs/reference-Session.html +++ b/docs/reference-Session.html @@ -3,7 +3,7 @@ - +Session diff --git a/docs/reference-Settings.html b/docs/reference-Settings.html index 7b759e6fa..587b09636 100644 --- a/docs/reference-Settings.html +++ b/docs/reference-Settings.html @@ -3,7 +3,7 @@ - +Settings diff --git a/docs/reference-Storage.html b/docs/reference-Storage.html index b9e9b0065..efda81984 100644 --- a/docs/reference-Storage.html +++ b/docs/reference-Storage.html @@ -3,7 +3,7 @@ - +Storage diff --git a/docs/reference-String.html b/docs/reference-String.html index 5b37b5100..e5b7f4347 100644 --- a/docs/reference-String.html +++ b/docs/reference-String.html @@ -3,7 +3,7 @@ - +String diff --git a/docs/reference-Time.html b/docs/reference-Time.html index 43d44ab45..f17bbfc15 100644 --- a/docs/reference-Time.html +++ b/docs/reference-Time.html @@ -3,7 +3,7 @@ - +Time diff --git a/docs/reference-Utility.html b/docs/reference-Utility.html index 8f12a9b47..dc26d86de 100644 --- a/docs/reference-Utility.html +++ b/docs/reference-Utility.html @@ -3,7 +3,7 @@ - +Utility @@ -99,7 +99,7 @@ struct bitfield

constructs a new bitfield. The default constructor creates an empty bitfield. bits is the size of the bitfield (specified in bits). -`` val`` is the value to initialize the bits to. If not specified +val is the value to initialize the bits to. If not specified all bits are initialized to 0.

The constructor taking a pointer b and bits copies a bitfield from the specified buffer, and bits number of bits (rounded up to @@ -384,9 +384,9 @@ It's still a binary string with 20 binary characters.

 std::string identify_client (const peer_id& p);
-

This function is declared in the header <libtorrent/identify_client.hpp>. It can can be used -to extract a string describing a client version from its peer-id. It will recognize most clients -that have this kind of identification in the peer-id.

+

This function can can be used to extract a string describing a client +version from its peer-id. It will recognize most clients that have this +kind of identification in the peer-id.

client_fingerprint()

@@ -394,10 +394,10 @@ that have this kind of identification in the peer-id.

 boost::optional<fingerprint> client_fingerprint (peer_id const& p);
-

Returns an optional fingerprint if any can be identified from the peer id. This can be used -to automate the identification of clients. It will not be able to identify peers with non- -standard encodings. Only Azureus style, Shadow's style and Mainline style. This function is -declared in the header <libtorrent/identify_client.hpp>.

+

Returns an optional fingerprint if any can be identified from the peer +id. This can be used to automate the identification of clients. It will +not be able to identify peers with non- standard encodings. Only Azureus +style, Shadow's style and Mainline style.

operator<<()

diff --git a/docs/reference.html b/docs/reference.html index 1f5453f52..4760db30f 100644 --- a/docs/reference.html +++ b/docs/reference.html @@ -3,7 +3,7 @@ - + libtorrent reference documentation