/usr/include/libtorrent/alert_types.hpp is in libtorrent-rasterbar-dev 1.0.7-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 | /*
Copyright (c) 2003-2014, Arvid Norberg
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the distribution.
* Neither the name of the author nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef TORRENT_ALERT_TYPES_HPP_INCLUDED
#define TORRENT_ALERT_TYPES_HPP_INCLUDED
#include "libtorrent/alert.hpp"
#include "libtorrent/torrent_handle.hpp"
#include "libtorrent/socket.hpp"
#include "libtorrent/config.hpp"
#include "libtorrent/assert.hpp"
#include "libtorrent/identify_client.hpp"
#include "libtorrent/address.hpp"
#include "libtorrent/stat.hpp"
#include "libtorrent/rss.hpp" // for feed_handle
// lines reserved for future includes
// the type-ids of the alert types
// are derived from the line on which
// they are declared
namespace libtorrent
{
// user defined alerts should use IDs greater than this
const static int user_alert_id = 10000;
// This is a base class for alerts that are associated with a
// specific torrent. It contains a handle to the torrent.
struct TORRENT_EXPORT torrent_alert: alert
{
// internal
torrent_alert(torrent_handle const& h);
// internal
const static int alert_type = 1;
virtual std::string message() const;
// The torrent_handle pointing to the torrent this
// alert is associated with.
torrent_handle handle;
};
// The peer alert is a base class for alerts that refer to a specific peer. It includes all
// the information to identify the peer. i.e. ``ip`` and ``peer-id``.
struct TORRENT_EXPORT peer_alert: torrent_alert
{
// internal
peer_alert(torrent_handle const& h, tcp::endpoint const& i
, peer_id const& pi);
const static int alert_type = 2;
const static int static_category = alert::peer_notification;
virtual int category() const { return static_category; }
virtual std::string message() const;
// The peer's IP address and port.
tcp::endpoint ip;
// the peer ID, if known.
peer_id pid;
};
// This is a base class used for alerts that are associated with a
// specific tracker. It derives from torrent_alert since a tracker
// is also associated with a specific torrent.
struct TORRENT_EXPORT tracker_alert: torrent_alert
{
// internal
tracker_alert(torrent_handle const& h
, std::string const& u);
const static int alert_type = 3;
const static int static_category = alert::tracker_notification;
virtual int category() const { return static_category; }
virtual std::string message() const;
// The tracker URL
std::string url;
};
#define TORRENT_DEFINE_ALERT(name) \
const static int alert_type = __LINE__; \
virtual int type() const { return alert_type; } \
virtual std::auto_ptr<alert> clone() const \
{ return std::auto_ptr<alert>(new name(*this)); } \
virtual int category() const { return static_category; } \
virtual char const* what() const { return #name; }
// The ``torrent_added_alert`` is posted once every time a torrent is successfully
// added. It doesn't contain any members of its own, but inherits the torrent handle
// from its base class.
// It's posted when the ``status_notification`` bit is set in the alert_mask.
struct TORRENT_EXPORT torrent_added_alert: torrent_alert
{
// internal
torrent_added_alert(torrent_handle const& h);
TORRENT_DEFINE_ALERT(torrent_added_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
};
// The ``torrent_removed_alert`` is posted whenever a torrent is removed. Since
// the torrent handle in its baseclass will always be invalid (since the torrent
// is already removed) it has the info hash as a member, to identify it.
// It's posted when the ``status_notification`` bit is set in the alert_mask.
//
// Even though the ``handle`` member doesn't point to an existing torrent anymore,
// it is still useful for comparing to other handles, which may also no
// longer point to existing torrents, but to the same non-existing torrents.
//
// The ``torrent_handle`` acts as a ``weak_ptr``, even though its object no
// longer exists, it can still compare equal to another weak pointer which
// points to the same non-existent object.
struct TORRENT_EXPORT torrent_removed_alert: torrent_alert
{
// internal
torrent_removed_alert(torrent_handle const& h, sha1_hash const& ih);
TORRENT_DEFINE_ALERT(torrent_removed_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
sha1_hash info_hash;
};
// This alert is posted when the asynchronous read operation initiated by
// a call to torrent_handle::read_piece() is completed. If the read failed, the torrent
// is paused and an error state is set and the buffer member of the alert
// is 0. If successful, ``buffer`` points to a buffer containing all the data
// of the piece. ``piece`` is the piece index that was read. ``size`` is the
// number of bytes that was read.
//
// If the operation fails, ec will indicat what went wrong.
struct TORRENT_EXPORT read_piece_alert: torrent_alert
{
// internal
read_piece_alert(torrent_handle const& h
, int p, boost::shared_array<char> d, int s);
read_piece_alert(torrent_handle h, int p, error_code e);
TORRENT_DEFINE_ALERT(read_piece_alert);
const static int static_category = alert::storage_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
error_code ec;
boost::shared_array<char> buffer;
int piece;
int size;
};
// This is posted whenever an individual file completes its download. i.e.
// All pieces overlapping this file have passed their hash check.
struct TORRENT_EXPORT file_completed_alert: torrent_alert
{
// internal
file_completed_alert(torrent_handle const& h
, int idx);
TORRENT_DEFINE_ALERT(file_completed_alert);
const static int static_category = alert::progress_notification;
virtual std::string message() const;
// refers to the index of the file that completed.
int index;
};
// This is posted as a response to a torrent_handle::rename_file() call, if the rename
// operation succeeds.
struct TORRENT_EXPORT file_renamed_alert: torrent_alert
{
// internal
file_renamed_alert(torrent_handle const& h
, std::string const& n
, int idx);
TORRENT_DEFINE_ALERT(file_renamed_alert);
const static int static_category = alert::storage_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
std::string name;
// refers to the index of the file that was renamed,
// ``name`` is the new name of the file.
int index;
};
// This is posted as a response to a torrent_handle::rename_file() call, if the rename
// operation failed.
struct TORRENT_EXPORT file_rename_failed_alert: torrent_alert
{
// internal
file_rename_failed_alert(torrent_handle const& h
, int idx
, error_code ec);
TORRENT_DEFINE_ALERT(file_rename_failed_alert);
const static int static_category = alert::storage_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
// refers to the index of the file that was supposed to be renamed,
// ``error`` is the error code returned from the filesystem.
int index;
error_code error;
};
// This alert is generated when a limit is reached that might have a negative impact on
// upload or download rate performance.
struct TORRENT_EXPORT performance_alert: torrent_alert
{
enum performance_warning_t
{
// This warning means that the number of bytes queued to be written to disk
// exceeds the max disk byte queue setting (``session_settings::max_queued_disk_bytes``).
// This might restrict the download rate, by not queuing up enough write jobs
// to the disk I/O thread. When this alert is posted, peer connections are
// temporarily stopped from downloading, until the queued disk bytes have fallen
// below the limit again. Unless your ``max_queued_disk_bytes`` setting is already
// high, you might want to increase it to get better performance.
outstanding_disk_buffer_limit_reached,
// This is posted when libtorrent would like to send more requests to a peer,
// but it's limited by ``session_settings::max_out_request_queue``. The queue length
// libtorrent is trying to achieve is determined by the download rate and the
// assumed round-trip-time (``session_settings::request_queue_time``). The assumed
// rount-trip-time is not limited to just the network RTT, but also the remote disk
// access time and message handling time. It defaults to 3 seconds. The target number
// of outstanding requests is set to fill the bandwidth-delay product (assumed RTT
// times download rate divided by number of bytes per request). When this alert
// is posted, there is a risk that the number of outstanding requests is too low
// and limits the download rate. You might want to increase the ``max_out_request_queue``
// setting.
outstanding_request_limit_reached,
// This warning is posted when the amount of TCP/IP overhead is greater than the
// upload rate limit. When this happens, the TCP/IP overhead is caused by a much
// faster download rate, triggering TCP ACK packets. These packets eat into the
// rate limit specified to libtorrent. When the overhead traffic is greater than
// the rate limit, libtorrent will not be able to send any actual payload, such
// as piece requests. This means the download rate will suffer, and new requests
// can be sent again. There will be an equilibrium where the download rate, on
// average, is about 20 times the upload rate limit. If you want to maximize the
// download rate, increase the upload rate limit above 5% of your download capacity.
upload_limit_too_low,
// This is the same warning as ``upload_limit_too_low`` but referring to the download
// limit instead of upload. This suggests that your download rate limit is mcuh lower
// than your upload capacity. Your upload rate will suffer. To maximize upload rate,
// make sure your download rate limit is above 5% of your upload capacity.
download_limit_too_low,
// We're stalled on the disk. We want to write to the socket, and we can write
// but our send buffer is empty, waiting to be refilled from the disk.
// This either means the disk is slower than the network connection
// or that our send buffer watermark is too small, because we can
// send it all before the disk gets back to us.
// The number of bytes that we keep outstanding, requested from the disk, is calculated
// as follows::
//
// min(512, max(upload_rate * send_buffer_watermark_factor / 100, send_buffer_watermark))
//
// If you receive this alert, you migth want to either increase your ``send_buffer_watermark``
// or ``send_buffer_watermark_factor``.
send_buffer_watermark_too_low,
// If the half (or more) of all upload slots are set as optimistic unchoke slots, this
// warning is issued. You probably want more regular (rate based) unchoke slots.
too_many_optimistic_unchoke_slots,
// If the disk write queue ever grows larger than half of the cache size, this warning
// is posted. The disk write queue eats into the total disk cache and leaves very little
// left for the actual cache. This causes the disk cache to oscillate in evicting large
// portions of the cache before allowing peers to download any more, onto the disk write
// queue. Either lower ``max_queued_disk_bytes`` or increase ``cache_size``.
too_high_disk_queue_limit,
bittyrant_with_no_uplimit,
// This is generated if outgoing peer connections are failing because of *address in use*
// errors, indicating that ``session_settings::outgoing_ports`` is set and is too small of
// a range. Consider not using the ``outgoing_ports`` setting at all, or widen the range to
// include more ports.
too_few_outgoing_ports,
too_few_file_descriptors,
num_warnings
};
// internal
performance_alert(torrent_handle const& h
, performance_warning_t w);
TORRENT_DEFINE_ALERT(performance_alert);
const static int static_category = alert::performance_warning;
virtual std::string message() const;
performance_warning_t warning_code;
};
// Generated whenever a torrent changes its state.
struct TORRENT_EXPORT state_changed_alert: torrent_alert
{
// internal
state_changed_alert(torrent_handle const& h
, torrent_status::state_t st
, torrent_status::state_t prev_st);
TORRENT_DEFINE_ALERT(state_changed_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
// the new state of the torrent.
torrent_status::state_t state;
// the previous state.
torrent_status::state_t prev_state;
};
// This alert is generated on tracker time outs, premature disconnects,
// invalid response or a HTTP response other than "200 OK". From the alert
// you can get the handle to the torrent the tracker belongs to.
//
// The ``times_in_row`` member says how many times in a row this tracker has
// failed. ``status_code`` is the code returned from the HTTP server. 401
// means the tracker needs authentication, 404 means not found etc. If the
// tracker timed out, the code will be set to 0.
struct TORRENT_EXPORT tracker_error_alert: tracker_alert
{
// internal
tracker_error_alert(torrent_handle const& h
, int times
, int status
, std::string const& u
, error_code const& e
, std::string const& m);
TORRENT_DEFINE_ALERT(tracker_error_alert);
const static int static_category = alert::tracker_notification | alert::error_notification;
virtual std::string message() const;
int times_in_row;
int status_code;
error_code error;
std::string msg;
};
// This alert is triggered if the tracker reply contains a warning field.
// Usually this means that the tracker announce was successful, but the
// tracker has a message to the client.
struct TORRENT_EXPORT tracker_warning_alert: tracker_alert
{
// internal
tracker_warning_alert(torrent_handle const& h
, std::string const& u
, std::string const& m);
TORRENT_DEFINE_ALERT(tracker_warning_alert);
const static int static_category = alert::tracker_notification | alert::error_notification;
virtual std::string message() const;
// contains the warning message from the tracker.
std::string msg;
};
// This alert is generated when a scrape request succeeds.
struct TORRENT_EXPORT scrape_reply_alert: tracker_alert
{
// internal
scrape_reply_alert(torrent_handle const& h
, int incomp
, int comp
, std::string const& u);
TORRENT_DEFINE_ALERT(scrape_reply_alert);
virtual std::string message() const;
// the data returned in the scrape response. These numbers
// may be -1 if the reponse was malformed.
int incomplete;
int complete;
};
// If a scrape request fails, this alert is generated. This might be due
// to the tracker timing out, refusing connection or returning an http response
// code indicating an error.
struct TORRENT_EXPORT scrape_failed_alert: tracker_alert
{
// internal
scrape_failed_alert(torrent_handle const& h
, std::string const& u
, error_code const& e);
scrape_failed_alert(torrent_handle const& h
, std::string const& u
, std::string const& m);
TORRENT_DEFINE_ALERT(scrape_failed_alert);
const static int static_category = alert::tracker_notification | alert::error_notification;
virtual std::string message() const;
// contains a message describing the error.
std::string msg;
};
// This alert is only for informational purpose. It is generated when a tracker announce
// succeeds. It is generated regardless what kind of tracker was used, be it UDP, HTTP or
// the DHT.
struct TORRENT_EXPORT tracker_reply_alert: tracker_alert
{
// internal
tracker_reply_alert(torrent_handle const& h
, int np
, std::string const& u);
TORRENT_DEFINE_ALERT(tracker_reply_alert);
virtual std::string message() const;
// tells how many peers the tracker returned in this response. This is
// not expected to be more thant the ``num_want`` settings. These are not necessarily
// all new peers, some of them may already be connected.
int num_peers;
};
// This alert is generated each time the DHT receives peers from a node. ``num_peers``
// is the number of peers we received in this packet. Typically these packets are
// received from multiple DHT nodes, and so the alerts are typically generated
// a few at a time.
struct TORRENT_EXPORT dht_reply_alert: tracker_alert
{
// internal
dht_reply_alert(torrent_handle const& h
, int np);
TORRENT_DEFINE_ALERT(dht_reply_alert);
virtual std::string message() const;
int num_peers;
};
// This alert is generated each time a tracker announce is sent (or attempted to be sent).
// There are no extra data members in this alert. The url can be found in the base class
// however.
struct TORRENT_EXPORT tracker_announce_alert: tracker_alert
{
// internal
tracker_announce_alert(torrent_handle const& h
, std::string const& u, int e);
TORRENT_DEFINE_ALERT(tracker_announce_alert);
virtual std::string message() const;
// specifies what event was sent to the tracker. It is defined as:
//
// 0. None
// 1. Completed
// 2. Started
// 3. Stopped
int event;
};
// This alert is generated when a finished piece fails its hash check. You can get the handle
// to the torrent which got the failed piece and the index of the piece itself from the alert.
struct TORRENT_EXPORT hash_failed_alert: torrent_alert
{
// internal
hash_failed_alert(
torrent_handle const& h
, int index);
TORRENT_DEFINE_ALERT(hash_failed_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
int piece_index;
};
// This alert is generated when a peer is banned because it has sent too many corrupt pieces
// to us. ``ip`` is the endpoint to the peer that was banned.
struct TORRENT_EXPORT peer_ban_alert: peer_alert
{
// internal
peer_ban_alert(torrent_handle h, tcp::endpoint const& ep
, peer_id const& peer_id);
TORRENT_DEFINE_ALERT(peer_ban_alert);
virtual std::string message() const;
};
// This alert is generated when a peer is unsnubbed. Essentially when it was snubbed for stalling
// sending data, and now it started sending data again.
struct TORRENT_EXPORT peer_unsnubbed_alert: peer_alert
{
// internal
peer_unsnubbed_alert(torrent_handle h, tcp::endpoint const& ep
, peer_id const& peer_id);
TORRENT_DEFINE_ALERT(peer_unsnubbed_alert);
virtual std::string message() const;
};
// This alert is generated when a peer is snubbed, when it stops sending data when we request
// it.
struct TORRENT_EXPORT peer_snubbed_alert: peer_alert
{
// internal
peer_snubbed_alert(torrent_handle h, tcp::endpoint const& ep
, peer_id const& peer_id);
TORRENT_DEFINE_ALERT(peer_snubbed_alert);
virtual std::string message() const;
};
// This alert is generated when a peer sends invalid data over the peer-peer protocol. The peer
// will be disconnected, but you get its ip address from the alert, to identify it.
struct TORRENT_EXPORT peer_error_alert: peer_alert
{
// internal
peer_error_alert(torrent_handle const& h, tcp::endpoint const& ep
, peer_id const& peer_id, error_code const& e);
TORRENT_DEFINE_ALERT(peer_error_alert);
const static int static_category = alert::peer_notification;
virtual std::string message() const;
// tells you what error caused this alert.
error_code error;
#ifndef TORRENT_NO_DEPRECATE
std::string msg;
#endif
};
// This alert is posted every time an outgoing peer connect attempts succeeds.
struct TORRENT_EXPORT peer_connect_alert: peer_alert
{
// internal
peer_connect_alert(torrent_handle h, tcp::endpoint const& ep
, peer_id const& peer_id, int type);
TORRENT_DEFINE_ALERT(peer_connect_alert);
const static int static_category = alert::debug_notification;
virtual std::string message() const;
int socket_type;
};
// This alert is generated when a peer is disconnected for any reason (other than the ones
// covered by peer_error_alert ).
struct TORRENT_EXPORT peer_disconnected_alert: peer_alert
{
// internal
peer_disconnected_alert(torrent_handle const& h, tcp::endpoint const& ep
, peer_id const& peer_id, error_code const& e);
TORRENT_DEFINE_ALERT(peer_disconnected_alert);
const static int static_category = alert::debug_notification;
virtual std::string message() const;
// tells you what error caused peer to disconnect.
error_code error;
#ifndef TORRENT_NO_DEPRECATE
std::string msg;
#endif
};
// This is a debug alert that is generated by an incoming invalid piece request.
// ``ip`` is the address of the peer and the ``request`` is the actual incoming
// request from the peer. See peer_request for more info.
struct TORRENT_EXPORT invalid_request_alert: peer_alert
{
// internal
invalid_request_alert(torrent_handle const& h, tcp::endpoint const& ep
, peer_id const& peer_id, peer_request const& r);
TORRENT_DEFINE_ALERT(invalid_request_alert);
virtual std::string message() const;
peer_request request;
};
// This alert is generated when a torrent switches from being a downloader to a seed.
// It will only be generated once per torrent. It contains a torrent_handle to the
// torrent in question.
struct TORRENT_EXPORT torrent_finished_alert: torrent_alert
{
// internal
torrent_finished_alert(const torrent_handle& h);
TORRENT_DEFINE_ALERT(torrent_finished_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
};
// this alert is posted every time a piece completes downloading
// and passes the hash check. This alert derives from torrent_alert
// which contains the torrent_handle to the torrent the piece belongs to.
struct TORRENT_EXPORT piece_finished_alert: torrent_alert
{
// internal
piece_finished_alert(
const torrent_handle& h
, int piece_num);
TORRENT_DEFINE_ALERT(piece_finished_alert);
const static int static_category = alert::progress_notification;
virtual std::string message() const;
// the index of the piece that finished
int piece_index;
};
// This alert is generated when a peer rejects or ignores a piece request.
struct TORRENT_EXPORT request_dropped_alert: peer_alert
{
// internal
request_dropped_alert(const torrent_handle& h, tcp::endpoint const& ep
, peer_id const& peer_id, int block_num, int piece_num);
TORRENT_DEFINE_ALERT(request_dropped_alert);
const static int static_category = alert::progress_notification
| alert::peer_notification;
virtual std::string message() const;
int block_index;
int piece_index;
};
// This alert is generated when a block request times out.
struct TORRENT_EXPORT block_timeout_alert: peer_alert
{
// internal
block_timeout_alert(const torrent_handle& h, tcp::endpoint const& ep
, peer_id const& peer_id, int block_num, int piece_num);
TORRENT_DEFINE_ALERT(block_timeout_alert);
const static int static_category = alert::progress_notification
| alert::peer_notification;
virtual std::string message() const;
int block_index;
int piece_index;
};
// This alert is generated when a block request receives a response.
struct TORRENT_EXPORT block_finished_alert: peer_alert
{
// internal
block_finished_alert(const torrent_handle& h, tcp::endpoint const& ep
, peer_id const& peer_id, int block_num, int piece_num);
TORRENT_DEFINE_ALERT(block_finished_alert);
const static int static_category = alert::progress_notification;
virtual std::string message() const;
int block_index;
int piece_index;
};
// This alert is generated when a block request is sent to a peer.
struct TORRENT_EXPORT block_downloading_alert: peer_alert
{
// internal
block_downloading_alert(const torrent_handle& h, tcp::endpoint const& ep
, peer_id const& peer_id, char const* speedmsg, int block_num, int piece_num);
TORRENT_DEFINE_ALERT(block_downloading_alert);
const static int static_category = alert::progress_notification;
virtual std::string message() const;
char const* peer_speedmsg;
int block_index;
int piece_index;
};
// This alert is generated when a block is received that was not requested or
// whose request timed out.
struct TORRENT_EXPORT unwanted_block_alert: peer_alert
{
// internal
unwanted_block_alert(const torrent_handle& h, tcp::endpoint const& ep
, peer_id const& peer_id, int block_num, int piece_num);
TORRENT_DEFINE_ALERT(unwanted_block_alert);
virtual std::string message() const;
int block_index;
int piece_index;
};
// The ``storage_moved_alert`` is generated when all the disk IO has completed and the
// files have been moved, as an effect of a call to ``torrent_handle::move_storage``. This
// is useful to synchronize with the actual disk. The ``path`` member is the new path of
// the storage.
struct TORRENT_EXPORT storage_moved_alert: torrent_alert
{
// internal
storage_moved_alert(torrent_handle const& h, std::string const& p);
TORRENT_DEFINE_ALERT(storage_moved_alert);
const static int static_category = alert::storage_notification;
virtual std::string message() const;
std::string path;
};
// The ``storage_moved_failed_alert`` is generated when an attempt to move the storage,
// via torrent_handle::move_storage(), fails.
struct TORRENT_EXPORT storage_moved_failed_alert: torrent_alert
{
// internal
storage_moved_failed_alert(torrent_handle const& h, error_code const& e);
TORRENT_DEFINE_ALERT(storage_moved_failed_alert);
const static int static_category = alert::storage_notification;
virtual std::string message() const;
error_code error;
};
// This alert is generated when a request to delete the files of a torrent complete.
//
// The ``info_hash`` is the info-hash of the torrent that was just deleted. Most of
// the time the torrent_handle in the ``torrent_alert`` will be invalid by the time
// this alert arrives, since the torrent is being deleted. The ``info_hash`` member
// is hence the main way of identifying which torrent just completed the delete.
//
// This alert is posted in the ``storage_notification`` category, and that bit
// needs to be set in the alert_mask.
struct TORRENT_EXPORT torrent_deleted_alert: torrent_alert
{
// internal
torrent_deleted_alert(torrent_handle const& h, sha1_hash const& ih);
TORRENT_DEFINE_ALERT(torrent_deleted_alert);
const static int static_category = alert::storage_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
sha1_hash info_hash;
};
// This alert is generated when a request to delete the files of a torrent fails.
// Just removing a torrent from the session cannot fail
struct TORRENT_EXPORT torrent_delete_failed_alert: torrent_alert
{
// internal
torrent_delete_failed_alert(torrent_handle const& h, error_code const& e
, sha1_hash const& ih);
TORRENT_DEFINE_ALERT(torrent_delete_failed_alert);
const static int static_category = alert::storage_notification
| alert::error_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
// tells you why it failed.
error_code error;
// the info hash of the torrent whose files failed to be deleted
sha1_hash info_hash;
#ifndef TORRENT_NO_DEPRECATE
std::string msg;
#endif
};
// This alert is generated as a response to a ``torrent_handle::save_resume_data`` request.
// It is generated once the disk IO thread is done writing the state for this torrent.
struct TORRENT_EXPORT save_resume_data_alert: torrent_alert
{
// internal
save_resume_data_alert(boost::shared_ptr<entry> const& rd
, torrent_handle const& h);
TORRENT_DEFINE_ALERT(save_resume_data_alert);
const static int static_category = alert::storage_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
// points to the resume data.
boost::shared_ptr<entry> resume_data;
};
// This alert is generated instead of ``save_resume_data_alert`` if there was an error
// generating the resume data. ``error`` describes what went wrong.
struct TORRENT_EXPORT save_resume_data_failed_alert: torrent_alert
{
// internal
save_resume_data_failed_alert(torrent_handle const& h
, error_code const& e);
TORRENT_DEFINE_ALERT(save_resume_data_failed_alert);
const static int static_category = alert::storage_notification
| alert::error_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
error_code error;
#ifndef TORRENT_NO_DEPRECATE
std::string msg;
#endif
};
// This alert is generated as a response to a ``torrent_handle::pause`` request. It is
// generated once all disk IO is complete and the files in the torrent have been closed.
// This is useful for synchronizing with the disk.
struct TORRENT_EXPORT torrent_paused_alert: torrent_alert
{
// internal
torrent_paused_alert(torrent_handle const& h);
TORRENT_DEFINE_ALERT(torrent_paused_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
};
// This alert is generated as a response to a torrent_handle::resume() request. It is
// generated when a torrent goes from a paused state to an active state.
struct TORRENT_EXPORT torrent_resumed_alert: torrent_alert
{
// internal
torrent_resumed_alert(torrent_handle const& h);
TORRENT_DEFINE_ALERT(torrent_resumed_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
};
// This alert is posted when a torrent completes checking. i.e. when it transitions
// out of the ``checking files`` state into a state where it is ready to start downloading
struct TORRENT_EXPORT torrent_checked_alert: torrent_alert
{
// internal
torrent_checked_alert(torrent_handle const& h);
TORRENT_DEFINE_ALERT(torrent_checked_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
};
// This alert is generated when a HTTP seed name lookup fails.
struct TORRENT_EXPORT url_seed_alert: torrent_alert
{
// internal
url_seed_alert(
torrent_handle const& h
, std::string const& u
, error_code const& e);
url_seed_alert(
torrent_handle const& h
, std::string const& u
, std::string const& m);
TORRENT_DEFINE_ALERT(url_seed_alert);
const static int static_category = alert::peer_notification | alert::error_notification;
virtual std::string message() const;
// the HTTP seed that failed
std::string url;
// the error message, potentially from the server
std::string msg;
};
// If the storage fails to read or write files that it needs access to, this alert is
// generated and the torrent is paused.
struct TORRENT_EXPORT file_error_alert: torrent_alert
{
// internal
file_error_alert(
std::string const& f
, torrent_handle const& h
, error_code const& e);
TORRENT_DEFINE_ALERT(file_error_alert);
const static int static_category = alert::status_notification
| alert::error_notification
| alert::storage_notification;
virtual std::string message() const;
// the path to the file that was accessed when the error occurred.
std::string file;
// the error code describing the error.
error_code error;
#ifndef TORRENT_NO_DEPRECATE
std::string msg;
#endif
};
// This alert is generated when the metadata has been completely received and the info-hash
// failed to match it. i.e. the metadata that was received was corrupt. libtorrent will
// automatically retry to fetch it in this case. This is only relevant when running a
// torrent-less download, with the metadata extension provided by libtorrent.
struct TORRENT_EXPORT metadata_failed_alert: torrent_alert
{
// internal
metadata_failed_alert(const torrent_handle& h, error_code e);
TORRENT_DEFINE_ALERT(metadata_failed_alert);
const static int static_category = alert::error_notification;
virtual std::string message() const;
// the error that occurred
error_code error;
};
// This alert is generated when the metadata has been completely received and the torrent
// can start downloading. It is not generated on torrents that are started with metadata, but
// only those that needs to download it from peers (when utilizing the libtorrent extension).
//
// There are no additional data members in this alert.
//
// Typically, when receiving this alert, you would want to save the torrent file in order
// to load it back up again when the session is restarted. Here's an example snippet of
// code to do that::
//
// torrent_handle h = alert->handle();
// if (h.is_valid()) {
// boost::intrusive_ptr<torrent_info const> ti = h.torrent_file();
// create_torrent ct(*ti);
// entry te = ct.generate();
// std::vector<char> buffer;
// bencode(std::back_inserter(buffer), te);
// FILE* f = fopen((to_hex(ti->info_hash().to_string()) + ".torrent").c_str(), "wb+");
// if (f) {
// fwrite(&buffer[0], 1, buffer.size(), f);
// fclose(f);
// }
// }
//
struct TORRENT_EXPORT metadata_received_alert: torrent_alert
{
// internal
metadata_received_alert(
const torrent_handle& h);
TORRENT_DEFINE_ALERT(metadata_received_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
};
// This alert is posted when there is an error on the UDP socket. The
// UDP socket is used for all uTP, DHT and UDP tracker traffic. It's
// global to the session.
struct TORRENT_EXPORT udp_error_alert: alert
{
// internal
udp_error_alert(
udp::endpoint const& ep
, error_code const& ec);
TORRENT_DEFINE_ALERT(udp_error_alert);
const static int static_category = alert::error_notification;
virtual std::string message() const;
// the source address associated with the error (if any)
udp::endpoint endpoint;
// the error code describing the error
error_code error;
};
// Whenever libtorrent learns about the machines external IP, this alert is
// generated. The external IP address can be acquired from the tracker (if it
// supports that) or from peers that supports the extension protocol.
// The address can be accessed through the ``external_address`` member.
struct TORRENT_EXPORT external_ip_alert: alert
{
// internal
external_ip_alert(address const& ip);
TORRENT_DEFINE_ALERT(external_ip_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
// the IP address that is believed to be our external IP
address external_address;
};
// This alert is generated when none of the ports, given in the port range, to
// session can be opened for listening. The ``endpoint`` member is the
// interface and port that failed, ``error`` is the error code describing
// the failure.
//
// libtorrent may sometimes try to listen on port 0, if all other ports failed.
// Port 0 asks the operating system to pick a port that's free). If that fails
// you may see a listen_failed_alert with port 0 even if you didn't ask to
// listen on it.
struct TORRENT_EXPORT listen_failed_alert: alert
{
enum socket_type_t { tcp, tcp_ssl, udp, i2p, socks5 };
// internal
listen_failed_alert(
tcp::endpoint const& ep
, int op
, error_code const& ec
, socket_type_t t);
TORRENT_DEFINE_ALERT(listen_failed_alert);
const static int static_category = alert::status_notification | alert::error_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
// the endpoint libtorrent attempted to listen on
tcp::endpoint endpoint;
// the error the system returned
error_code error;
enum op_t
{
parse_addr, open, bind, listen, get_peer_name, accept
};
// the specific low level operation that failed. See op_t.
int operation;
// the type of listen socket this alert refers to.
socket_type_t sock_type;
};
// This alert is posted when the listen port succeeds to be opened on a
// particular interface. ``endpoint`` is the endpoint that successfully
// was opened for listening.
struct TORRENT_EXPORT listen_succeeded_alert: alert
{
enum socket_type_t { tcp, tcp_ssl, udp };
// internal
listen_succeeded_alert(tcp::endpoint const& ep, socket_type_t t);
TORRENT_DEFINE_ALERT(listen_succeeded_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
// the endpoint libtorrent ended up listening on. The address
// refers to the local interface and the port is the listen port.
tcp::endpoint endpoint;
// the type of listen socket this alert refers to.
socket_type_t sock_type;
};
// This alert is generated when a NAT router was successfully found but some
// part of the port mapping request failed. It contains a text message that
// may help the user figure out what is wrong. This alert is not generated in
// case it appears the client is not running on a NAT:ed network or if it
// appears there is no NAT router that can be remote controlled to add port
// mappings.
struct TORRENT_EXPORT portmap_error_alert: alert
{
// internal
portmap_error_alert(int i, int t, error_code const& e);
TORRENT_DEFINE_ALERT(portmap_error_alert);
const static int static_category = alert::port_mapping_notification
| alert::error_notification;
virtual std::string message() const;
// refers to the mapping index of the port map that failed, i.e.
// the index returned from add_mapping().
int mapping;
// is 0 for NAT-PMP and 1 for UPnP.
int map_type;
// tells you what failed.
error_code error;
#ifndef TORRENT_NO_DEPRECATE
std::string msg;
#endif
};
// This alert is generated when a NAT router was successfully found and
// a port was successfully mapped on it. On a NAT:ed network with a NAT-PMP
// capable router, this is typically generated once when mapping the TCP
// port and, if DHT is enabled, when the UDP port is mapped.
struct TORRENT_EXPORT portmap_alert: alert
{
// internal
portmap_alert(int i, int port, int t);
TORRENT_DEFINE_ALERT(portmap_alert);
const static int static_category = alert::port_mapping_notification;
virtual std::string message() const;
// refers to the mapping index of the port map that failed, i.e.
// the index returned from add_mapping().
int mapping;
// the external port allocated for the mapping.
int external_port;
// 0 for NAT-PMP and 1 for UPnP.
int map_type;
};
// This alert is generated to log informational events related to either
// UPnP or NAT-PMP. They contain a log line and the type (0 = NAT-PMP
// and 1 = UPnP). Displaying these messages to an end user is only useful
// for debugging the UPnP or NAT-PMP implementation.
struct TORRENT_EXPORT portmap_log_alert: alert
{
// internal
portmap_log_alert(int t, std::string const& m);
TORRENT_DEFINE_ALERT(portmap_log_alert);
const static int static_category = alert::port_mapping_notification;
virtual std::string message() const;
int map_type;
std::string msg;
};
// This alert is generated when a fastresume file has been passed to add_torrent() but the
// files on disk did not match the fastresume file. The error_code explains the reason why the
// resume file was rejected.
struct TORRENT_EXPORT fastresume_rejected_alert: torrent_alert
{
// internal
fastresume_rejected_alert(torrent_handle const& h
, error_code const& e);
TORRENT_DEFINE_ALERT(fastresume_rejected_alert);
const static int static_category = alert::status_notification
| alert::error_notification;
virtual std::string message() const;
error_code error;
#ifndef TORRENT_NO_DEPRECATE
std::string msg;
#endif
};
// This alert is posted when an incoming peer connection, or a peer that's about to be added
// to our peer list, is blocked for some reason. This could be any of:
//
// * the IP filter
// * i2p mixed mode restrictions (a normal peer is not allowed on an i2p swarm)
// * the port filter
// * the peer has a low port and ``no_connect_privileged_ports`` is enabled
// * the protocol of the peer is blocked (uTP/TCP blocking)
struct TORRENT_EXPORT peer_blocked_alert: torrent_alert
{
// internal
peer_blocked_alert(torrent_handle const& h, address const& i
, int r);
TORRENT_DEFINE_ALERT(peer_blocked_alert);
const static int static_category = alert::ip_block_notification;
virtual std::string message() const;
// the address that was blocked.
address ip;
enum reason_t
{
ip_filter,
port_filter,
i2p_mixed,
privileged_ports,
utp_disabled,
tcp_disabled
};
int reason;
};
// This alert is generated when a DHT node announces to an info-hash on our
// DHT node. It belongs to the ``dht_notification`` category.
struct TORRENT_EXPORT dht_announce_alert: alert
{
// internal
dht_announce_alert(address const& i, int p
, sha1_hash const& ih);
TORRENT_DEFINE_ALERT(dht_announce_alert);
const static int static_category = alert::dht_notification;
virtual std::string message() const;
address ip;
int port;
sha1_hash info_hash;
};
// This alert is generated when a DHT node sends a ``get_peers`` message to
// our DHT node. It belongs to the ``dht_notification`` category.
struct TORRENT_EXPORT dht_get_peers_alert: alert
{
// internal
dht_get_peers_alert(sha1_hash const& ih);
TORRENT_DEFINE_ALERT(dht_get_peers_alert);
const static int static_category = alert::dht_notification;
virtual std::string message() const;
sha1_hash info_hash;
};
// This alert is posted approximately once every second, and it contains
// byte counters of most statistics that's tracked for torrents. Each active
// torrent posts these alerts regularly.
struct TORRENT_EXPORT stats_alert: torrent_alert
{
// internal
stats_alert(torrent_handle const& h, int interval
, stat const& s);
TORRENT_DEFINE_ALERT(stats_alert);
const static int static_category = alert::stats_notification;
virtual std::string message() const;
enum stats_channel
{
upload_payload,
upload_protocol,
download_payload,
download_protocol,
#ifndef TORRENT_DISABLE_FULL_STATS
upload_ip_protocol,
upload_dht_protocol,
upload_tracker_protocol,
download_ip_protocol,
download_dht_protocol,
download_tracker_protocol,
#endif
num_channels
};
// an array of samples. The enum describes what each sample is a
// measurement of. All of these are raw, and not smoothing is performed.
int transferred[num_channels];
// the number of milliseconds during which these stats were collected.
// This is typically just above 1000, but if CPU is limited, it may be
// higher than that.
int interval;
};
// This alert is posted when the disk cache has been flushed for a specific
// torrent as a result of a call to torrent_handle::flush_cache(). This
// alert belongs to the ``storage_notification`` category, which must be
// enabled to let this alert through. The alert is also posted when removing
// a torrent from the session, once the outstanding cache flush is complete
// and the torrent does no longer have any files open.
struct TORRENT_EXPORT cache_flushed_alert: torrent_alert
{
// internal
cache_flushed_alert(torrent_handle const& h);
TORRENT_DEFINE_ALERT(cache_flushed_alert);
const static int static_category = alert::storage_notification;
};
// This alert is posted when a bittorrent feature is blocked because of the
// anonymous mode. For instance, if the tracker proxy is not set up, no
// trackers will be used, because trackers can only be used through proxies
// when in anonymous mode.
struct TORRENT_EXPORT anonymous_mode_alert: torrent_alert
{
// internal
anonymous_mode_alert(torrent_handle const& h
, int k, std::string const& s);
TORRENT_DEFINE_ALERT(anonymous_mode_alert);
const static int static_category = alert::error_notification;
virtual std::string message() const;
enum kind_t
{
// means that there's no proxy set up for tracker
// communication and the tracker will not be contacted.
// The tracker which this failed for is specified in the ``str`` member.
tracker_not_anonymous = 0
};
// specifies what error this is, see kind_t.
int kind;
std::string str;
};
// This alert is generated when we receive a local service discovery message
// from a peer for a torrent we're currently participating in.
struct TORRENT_EXPORT lsd_peer_alert: peer_alert
{
// internal
lsd_peer_alert(torrent_handle const& h
, tcp::endpoint const& i);
TORRENT_DEFINE_ALERT(lsd_peer_alert);
const static int static_category = alert::peer_notification;
virtual std::string message() const;
};
// This alert is posted whenever a tracker responds with a ``trackerid``.
// The tracker ID is like a cookie. The libtorrent will store the tracker ID
// for this tracker and repeat it in subsequent announces.
struct TORRENT_EXPORT trackerid_alert: tracker_alert
{
// internal
trackerid_alert(torrent_handle const& h
, std::string const& u
, const std::string& id);
TORRENT_DEFINE_ALERT(trackerid_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
// The tracker ID returned by the tracker
std::string trackerid;
};
// This alert is posted when the initial DHT bootstrap is done.
struct TORRENT_EXPORT dht_bootstrap_alert: alert
{
// internal
dht_bootstrap_alert();
TORRENT_DEFINE_ALERT(dht_bootstrap_alert);
const static int static_category = alert::dht_notification;
virtual std::string message() const;
};
// This alert is posted on RSS feed events such as start of RSS feed updates,
// successful completed updates and errors during updates.
//
// This alert is only posted if the ``rss_notifications`` category is enabled
// in the alert_mask.
struct TORRENT_EXPORT rss_alert: alert
{
// internal
rss_alert(feed_handle h, std::string const& u, int s, error_code const& ec);
TORRENT_DEFINE_ALERT(rss_alert);
const static int static_category = alert::rss_notification;
virtual std::string message() const;
enum state_t
{
// An update of this feed was just initiated, it will either succeed
// or fail soon.
state_updating,
// The feed just completed a successful update, there may be new items
// in it. If you're adding torrents manually, you may want to request
// the feed status of the feed and look through the ``items`` vector.
state_updated,
// An error just occurred. See the ``error`` field for information on
// what went wrong.
state_error
};
// the handle to the feed which generated this alert.
feed_handle handle;
// a short cut to access the url of the feed, without
// having to call feed_handle::get_settings().
std::string url;
// one of the values from rss_alert::state_t.
int state;
// an error code used for when an error occurs on the feed.
error_code error;
};
// This is posted whenever a torrent is transitioned into the error state.
struct TORRENT_EXPORT torrent_error_alert: torrent_alert
{
// internal
torrent_error_alert(torrent_handle const& h
, error_code const& e);
TORRENT_DEFINE_ALERT(torrent_error_alert);
const static int static_category = alert::error_notification | alert::status_notification;
virtual std::string message() const;
// specifies which error the torrent encountered.
error_code error;
};
// This is always posted for SSL torrents. This is a reminder to the client that
// the torrent won't work unless torrent_handle::set_ssl_certificate() is called with
// a valid certificate. Valid certificates MUST be signed by the SSL certificate
// in the .torrent file.
struct TORRENT_EXPORT torrent_need_cert_alert: torrent_alert
{
// internal
torrent_need_cert_alert(torrent_handle const& h);
TORRENT_DEFINE_ALERT(torrent_need_cert_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
error_code error;
};
// The incoming connection alert is posted every time we successfully accept
// an incoming connection, through any mean. The most straigh-forward ways
// of accepting incoming connections are through the TCP listen socket and
// the UDP listen socket for uTP sockets. However, connections may also be
// accepted ofer a Socks5 or i2p listen socket, or via a torrent specific
// listen socket for SSL torrents.
struct TORRENT_EXPORT incoming_connection_alert: alert
{
// internal
incoming_connection_alert(int t, tcp::endpoint const& i);
TORRENT_DEFINE_ALERT(incoming_connection_alert);
const static int static_category = alert::peer_notification;
virtual std::string message() const;
// tells you what kind of socket the connection was accepted
// as:
//
// 0. none (no socket instantiated)
// 1. TCP
// 2. Socks5
// 3. HTTP
// 4. uTP
// 5. i2p
// 6. SSL/TCP
// 7. SSL/Socks5
// 8. HTTPS (SSL/HTTP)
// 9. SSL/uTP
//
int socket_type;
// is the IP address and port the connection came from.
tcp::endpoint ip;
};
// This alert is always posted when a torrent was attempted to be added
// and contains the return status of the add operation. The torrent handle of the new
// torrent can be found in the base class' ``handle`` member. If adding
// the torrent failed, ``error`` contains the error code.
struct TORRENT_EXPORT add_torrent_alert : torrent_alert
{
// internal
add_torrent_alert(torrent_handle h, add_torrent_params const& p, error_code ec);
TORRENT_DEFINE_ALERT(add_torrent_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
// a copy of the parameters used when adding the torrent, it can be used
// to identify which invocation to ``async_add_torrent()`` caused this alert.
add_torrent_params params;
// set to the error, if one occurred while adding the torrent.
error_code error;
};
// This alert is only posted when requested by the user, by calling session::post_torrent_updates()
// on the session. It contains the torrent status of all torrents that changed
// since last time this message was posted. Its category is ``status_notification``, but
// it's not subject to filtering, since it's only manually posted anyway.
struct TORRENT_EXPORT state_update_alert : alert
{
TORRENT_DEFINE_ALERT(state_update_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
// contains the torrent status of all torrents that changed since last time
// this message was posted. Note that you can map a torrent status to a specific torrent
// via its ``handle`` member. The receiving end is suggested to have all torrents sorted
// by the torrent_handle or hashed by it, for efficient updates.
std::vector<torrent_status> status;
};
// When a torrent changes its info-hash, this alert is posted. This only happens in very
// specific cases. For instance, when a torrent is downloaded from a URL, the true info
// hash is not known immediately. First the .torrent file must be downloaded and parsed.
//
// Once this download completes, the ``torrent_update_alert`` is posted to notify the client
// of the info-hash changing.
struct TORRENT_EXPORT torrent_update_alert : torrent_alert
{
// internal
torrent_update_alert(torrent_handle h, sha1_hash const& old_hash, sha1_hash const& new_hash);
TORRENT_DEFINE_ALERT(torrent_update_alert);
const static int static_category = alert::status_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
// ``old_ih`` and ``new_ih`` are the previous and new info-hash for the torrent, respectively.
sha1_hash old_ih;
sha1_hash new_ih;
};
// This alert is posted every time a new RSS item (i.e. torrent) is received
// from an RSS feed.
//
// It is only posted if the ``rss_notifications`` category is enabled in the
// alert_mask.
struct TORRENT_EXPORT rss_item_alert : alert
{
// internal
rss_item_alert(feed_handle h, feed_item const& item);
TORRENT_DEFINE_ALERT(rss_item_alert);
const static int static_category = alert::rss_notification;
virtual std::string message() const;
feed_handle handle;
feed_item item;
};
// posted when something fails in the DHT. This is not necessarily a fatal
// error, but it could prevent proper operation
struct TORRENT_EXPORT dht_error_alert: alert
{
// internal
dht_error_alert(int op, error_code const& ec);
TORRENT_DEFINE_ALERT(dht_error_alert);
const static int static_category = alert::error_notification
| alert::dht_notification;
virtual std::string message() const;
// the error code
error_code error;
enum op_t
{
unknown,
hostname_lookup
};
// the operation that failed
op_t operation;
};
// this alert is posted as a response to a call to session::get_item(),
// specifically the overload for looking up immutable items in the DHT.
struct TORRENT_EXPORT dht_immutable_item_alert: alert
{
dht_immutable_item_alert(sha1_hash const& t, entry const& i);
TORRENT_DEFINE_ALERT(dht_immutable_item_alert);
const static int static_category = alert::error_notification
| alert::dht_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
// the target hash of the immutable item. This must
// match the sha-1 hash of the bencoded form of ``item``.
sha1_hash target;
// the data for this item
entry item;
};
// this alert is posted as a response to a call to session::get_item(),
// specifically the overload for looking up mutable items in the DHT.
struct TORRENT_EXPORT dht_mutable_item_alert: alert
{
dht_mutable_item_alert(boost::array<char, 32> k
, boost::array<char, 64> sig
, boost::uint64_t sequence
, std::string const& s
, entry const& i);
TORRENT_DEFINE_ALERT(dht_mutable_item_alert);
const static int static_category = alert::error_notification
| alert::dht_notification;
virtual std::string message() const;
virtual bool discardable() const { return false; }
// the public key that was looked up
boost::array<char, 32> key;
// the signature of the data. This is not the signature of the
// plain encoded form of the item, but it includes the sequence number
// and possibly the hash as well. See the dht_store document for more
// information. This is primarily useful for echoing back in a store
// request.
boost::array<char, 64> signature;
// the sequence number of this item
boost::uint64_t seq;
// the salf, if any, used to lookup and store this item. If no
// salt was used, this is an empty string
std::string salt;
// the data for this item
entry item;
};
// this is posted when a DHT put operation completes. This is useful if the
// client is waiting for a put to complete before shutting down for instance.
struct TORRENT_EXPORT dht_put_alert: alert
{
// internal
dht_put_alert(sha1_hash const& t);
dht_put_alert(boost::array<char, 32> key
, boost::array<char, 64> sig
, std::string s
, boost::uint64_t sequence_number);
TORRENT_DEFINE_ALERT(dht_put_alert);
const static int static_category = alert::dht_notification;
virtual std::string message() const;
// the target hash the item was stored under if this was an *immutable*
// item.
sha1_hash target;
// if a mutable item was stored, these are the public key, signature,
// salt and sequence number the item was stored under.
boost::array<char, 32> public_key;
boost::array<char, 64> signature;
std::string salt;
boost::uint64_t seq;
};
// this alert is used to report errors in the i2p SAM connection
struct TORRENT_EXPORT i2p_alert : alert
{
i2p_alert(error_code const& ec);
TORRENT_DEFINE_ALERT(i2p_alert);
const static int static_category = alert::error_notification;
virtual std::string message() const;
// the error that occurred in the i2p SAM connection
error_code error;
};
#undef TORRENT_DEFINE_ALERT
}
#endif
|