mirror
/
transmission
mirror of https://github.com/transmission/transmission
1
0
Fork 0
Code Issues Releases Wiki Activity
transmission/libtransmission/announcer.h

109 lines
2.3 KiB
C
Raw Normal View History

(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
/*
(trunk) restore copyright year as suggested in email by rms
2014-01-18 20:56:57 +00:00
* This file Copyright (C) 2010-2014 Mnemosyne LLC
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
*
Copyedit the license's revised text: (1) remove unnecessary repitition use of the word 'license' from the top of the header and source files (2) add the standard 'we hope it's useful, but no warranty' clause to COPYING (3) make explicit that linking OpenSSL is allowed (see https://people.gnome.org/~markmc/openssl-and-the-gpl.html for background) (4) sync the Qt and GTK+ clients' license popups with COPYING's revised text
2014-01-21 03:10:30 +00:00
* It may be used under the GNU GPL versions 2 or 3
Licensing changes: 1. add the option the code to be used under GPLv2 or GPLv3; previously only GPLv2 was allowed 2. add the "proxy option" as described in GPLv3 so we can add future licenses without having to bulk-edit everything again :) 3. remove the awkward "exception for MIT code in Mac client" clause; it was unnecessary and confusing.
2014-01-19 01:09:44 +00:00
* or any future license endorsed by Mnemosyne LLC.
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
*
*/
Ensure include guard is the first non-comment line
2017-11-14 20:21:28 +00:00
#pragma once
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
#ifndef __TRANSMISSION__
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
#error only libtransmission should #include this header.
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
#endif
#include "transmission.h"
perf: intern the announcer module's URL strings (#2085) * perf: intern the announcer module's internal URLs
2021-11-02 23:00:01 +00:00
#include "quark.h"
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
struct tr_announcer;
refactor: add tr_announce_list (#2308) * refactor: add tr_announce_list (#2308)
2021-12-14 20:59:40 +00:00
struct tr_announcer_tiers;
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
/**
* *** Tracker Publish / Subscribe
* **/
refactor: prefer "using" over "typedef" (#1883) * refactor: prefer "using" over "typedef"
2021-10-06 14:26:07 +00:00
enum TrackerEventType
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
{
TR_TRACKER_WARNING,
TR_TRACKER_ERROR,
TR_TRACKER_ERROR_CLEAR,
perf: use scrape to know when a private swarm is all-seeds (#1780) * perf: use scrape to know when a swarm is all-seeds For private torrents, the tracker is the sole source of peers. So when a private torrent's tracker responds that there are 0 leechers, we can use that information to mark the entire swarm as seeders and to not initiate connections to those peers if we are seeding. This can help seedboxes to more efficiently pick which swarms to prioritize. This strategy is not used on public torrents, since new seeder-to-seeder connections can be useful there for pex. This PR changes tr_peerMgrAddPex() to (1) remove tr_atom.seedProbability field (which was not as robust as intended) and (2) add batches of peers instead of a single peer. * fix: only use all-seeds check for private torrents
2021-09-09 20:25:30 +00:00
TR_TRACKER_PEERS,
TR_TRACKER_COUNTS,
refactor: prefer "using" over "typedef" (#1883) * refactor: prefer "using" over "typedef"
2021-10-06 14:26:07 +00:00
};
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
(trunk libT) #3933 "announcer.c peer parsing could be simpler" -- fixed. Remove redundant code by using tr_peerMgrCompactToPex() and tr_peerMgrCompact6ToPex() to parse compact ipv4 and ipv6 peer lists. Simplify the old-style benc peer list parsing and fix a bug that returned too few bytes in the old-style peer array.
2011-01-22 17:45:54 +00:00
struct tr_pex;
(trunk) No code changes here... filling in some of the blanks in the "peers" and "utils" doxygen groups' documentation.
2010-01-19 19:37:00 +00:00
/** @brief Notification object to tell listeners about announce or scrape occurences */
refactor: prefer "using" over "typedef" (#1883) * refactor: prefer "using" over "typedef"
2021-10-06 14:26:07 +00:00
struct tr_tracker_event
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
{
/* what type of event this is */
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
TrackerEventType messageType;
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
/* for TR_TRACKER_WARNING and TR_TRACKER_ERROR */
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
char const* text;
perf: intern the announcer module's URL strings (#2085) * perf: intern the announcer module's internal URLs
2021-11-02 23:00:01 +00:00
tr_quark announce_url;
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
/* for TR_TRACKER_PEERS */
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
struct tr_pex const* pex;
(trunk libT) #3933 "announcer.c peer parsing could be simpler" -- fixed. Remove redundant code by using tr_peerMgrCompactToPex() and tr_peerMgrCompact6ToPex() to parse compact ipv4 and ipv6 peer lists. Simplify the old-style benc peer list parsing and fix a bug that returned too few bytes in the old-style peer array.
2011-01-22 17:45:54 +00:00
size_t pexCount;
(trunk libT) #3159 "better decision-making when choosing which peers to initiate new connections with" -- experimental commit
2010-04-20 21:54:03 +00:00
perf: use scrape to know when a private swarm is all-seeds (#1780) * perf: use scrape to know when a swarm is all-seeds For private torrents, the tracker is the sole source of peers. So when a private torrent's tracker responds that there are 0 leechers, we can use that information to mark the entire swarm as seeders and to not initiate connections to those peers if we are seeding. This can help seedboxes to more efficiently pick which swarms to prioritize. This strategy is not used on public torrents, since new seeder-to-seeder connections can be useful there for pex. This PR changes tr_peerMgrAddPex() to (1) remove tr_atom.seedProbability field (which was not as robust as intended) and (2) add batches of peers instead of a single peer. * fix: only use all-seeds check for private torrents
2021-09-09 20:25:30 +00:00
/* for TR_TRACKER_PEERS and TR_TRACKER_COUNTS */
int leechers;
int seeders;
refactor: prefer "using" over "typedef" (#1883) * refactor: prefer "using" over "typedef"
2021-10-06 14:26:07 +00:00
};
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
refactor: prefer "using" over "typedef" (#1883) * refactor: prefer "using" over "typedef"
2021-10-06 14:26:07 +00:00
using tr_tracker_callback = void (*)(tr_torrent* tor, tr_tracker_event const* event, void* client_data);
(trunk) #3256 "libtransmission/publish.[ch] should be replaced" -- apply publish.diff for 2.10
2010-06-19 14:33:10 +00:00
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
/**
*** Session ctor/dtor
**/
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
void tr_announcerInit(tr_session*);
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
void tr_announcerClose(tr_session*);
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
/**
*** For torrent customers
**/
refactor: add tr_announce_list (#2308) * refactor: add tr_announce_list (#2308)
2021-12-14 20:59:40 +00:00
struct tr_announcer_tiers* tr_announcerAddTorrent(tr_torrent* torrent, tr_tracker_callback cb, void* cbdata);
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
void tr_announcerResetTorrent(struct tr_announcer*, tr_torrent*);
(trunk libT) #2471: added/removed trackers aren't applied until restart
2009-10-02 04:54:02 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
void tr_announcerRemoveTorrent(struct tr_announcer*, tr_torrent*);
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
void tr_announcerChangeMyPort(tr_torrent*);
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
bool tr_announcerCanManualAnnounce(tr_torrent const*);
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
void tr_announcerManualAnnounce(tr_torrent*);
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
void tr_announcerTorrentStarted(tr_torrent*);
void tr_announcerTorrentStopped(tr_torrent*);
void tr_announcerTorrentCompleted(tr_torrent*);
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
enum
{
TR_ANN_UP,
TR_ANN_DOWN,
TR_ANN_CORRUPT
};
void tr_announcerAddBytes(tr_torrent*, int up_down_or_corrupt, uint32_t byteCount);
(trunk) per-tier up/down/corrupt byte counts for announcing to trackers
2010-02-08 16:47:30 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
time_t tr_announcerNextManualAnnounce(tr_torrent const*);
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
refactor: add tr_torrentTrackers() (#2282) * refactor: add tr_torrentTrackers()
2021-12-08 16:55:52 +00:00
tr_tracker_view tr_announcerTracker(tr_torrent const* torrent, size_t i);
(trunk) #1699: Announce to multiple trackers at once #2424: Tracker address is not listed in GTK client.
2009-09-25 21:05:59 +00:00
fixup! refactor: add tr_torrentTrackers() (#2282) (#2294) ensure announcer tracker count is correct
2021-12-10 02:03:26 +00:00
size_t tr_announcerTrackerCount(tr_torrent const* tor);
(trunk libT) better shutdown management of libutp and UDP trackers in tr_sessionClose(). This is a little overlapping since the utp code can be closed more-or-less immediately, but the udp manager needs to stay open in order to process the udp tracker connection requests before sending out event=stopped. Moreover DNS resolver can be shut down after the UDP tracker is shutdown.
2011-03-17 18:51:31 +00:00
/***
****
***/
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
void tr_tracker_udp_upkeep(tr_session* session);
(trunk libT) better shutdown management of libutp and UDP trackers in tr_sessionClose(). This is a little overlapping since the utp code can be closed more-or-less immediately, but the udp manager needs to stay open in order to process the udp tracker connection requests before sending out event=stopped. Moreover DNS resolver can be shut down after the UDP tracker is shutdown.
2011-03-17 18:51:31 +00:00
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes.
2017-04-19 12:04:45 +00:00
void tr_tracker_udp_close(tr_session* session);
(trunk libT) better shutdown management of libutp and UDP trackers in tr_sessionClose(). This is a little overlapping since the utp code can be closed more-or-less immediately, but the udp manager needs to stay open in order to process the udp tracker connection requests before sending out event=stopped. Moreover DNS resolver can be shut down after the UDP tracker is shutdown.
2011-03-17 18:51:31 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
bool tr_tracker_udp_is_idle(tr_session const* session);