1 | /* |
---|
2 | * This file Copyright (C) Mnemosyne LLC |
---|
3 | * |
---|
4 | * This file is licensed by the GPL version 2. Works owned by the |
---|
5 | * Transmission project are granted a special exemption to clause 2(b) |
---|
6 | * so that the bulk of its code can remain under the MIT license. |
---|
7 | * This exemption does not extend to derived works not owned by |
---|
8 | * the Transmission project. |
---|
9 | * |
---|
10 | * $Id: announcer.h 11750 2011-01-22 17:45:54Z jordan $ |
---|
11 | */ |
---|
12 | |
---|
13 | #ifndef __TRANSMISSION__ |
---|
14 | #error only libtransmission should #include this header. |
---|
15 | #endif |
---|
16 | |
---|
17 | #ifndef _TR_ANNOUNCER_H_ |
---|
18 | #define _TR_ANNOUNCER_H_ |
---|
19 | |
---|
20 | #include "transmission.h" |
---|
21 | |
---|
22 | struct tr_announcer; |
---|
23 | struct tr_torrent_tiers; |
---|
24 | |
---|
25 | /** |
---|
26 | * *** Tracker Publish / Subscribe |
---|
27 | * **/ |
---|
28 | |
---|
29 | typedef enum |
---|
30 | { |
---|
31 | TR_TRACKER_WARNING, |
---|
32 | TR_TRACKER_ERROR, |
---|
33 | TR_TRACKER_ERROR_CLEAR, |
---|
34 | TR_TRACKER_PEERS |
---|
35 | } |
---|
36 | TrackerEventType; |
---|
37 | |
---|
38 | struct tr_pex; |
---|
39 | |
---|
40 | /** @brief Notification object to tell listeners about announce or scrape occurences */ |
---|
41 | typedef struct |
---|
42 | { |
---|
43 | /* what type of event this is */ |
---|
44 | TrackerEventType messageType; |
---|
45 | |
---|
46 | /* for TR_TRACKER_WARNING and TR_TRACKER_ERROR */ |
---|
47 | const char * text; |
---|
48 | const char * tracker; |
---|
49 | |
---|
50 | /* for TR_TRACKER_PEERS */ |
---|
51 | const struct tr_pex * pex; |
---|
52 | size_t pexCount; |
---|
53 | |
---|
54 | /* [0...100] for probability a peer is a seed. calculated by the leecher/seeder ratio */ |
---|
55 | int8_t seedProbability; |
---|
56 | } |
---|
57 | tr_tracker_event; |
---|
58 | |
---|
59 | typedef void tr_tracker_callback ( tr_torrent * tor, |
---|
60 | const tr_tracker_event * event, |
---|
61 | void * client_data ); |
---|
62 | |
---|
63 | /** |
---|
64 | *** Session ctor/dtor |
---|
65 | **/ |
---|
66 | |
---|
67 | void tr_announcerInit( tr_session * ); |
---|
68 | |
---|
69 | void tr_announcerClose( tr_session * ); |
---|
70 | |
---|
71 | /** |
---|
72 | *** For torrent customers |
---|
73 | **/ |
---|
74 | |
---|
75 | struct tr_torrent_tiers * tr_announcerAddTorrent( struct tr_announcer *, |
---|
76 | tr_torrent * torrent, |
---|
77 | tr_tracker_callback * cb, |
---|
78 | void * cbdata ); |
---|
79 | |
---|
80 | tr_bool tr_announcerHasBacklog( const struct tr_announcer * ); |
---|
81 | |
---|
82 | void tr_announcerResetTorrent( struct tr_announcer*, tr_torrent* ); |
---|
83 | |
---|
84 | void tr_announcerRemoveTorrent( struct tr_announcer * , |
---|
85 | tr_torrent * ); |
---|
86 | |
---|
87 | void tr_announcerChangeMyPort( tr_torrent * ); |
---|
88 | |
---|
89 | tr_bool tr_announcerCanManualAnnounce( const tr_torrent * ); |
---|
90 | |
---|
91 | void tr_announcerManualAnnounce( tr_torrent * ); |
---|
92 | |
---|
93 | void tr_announcerTorrentStarted( tr_torrent * ); |
---|
94 | void tr_announcerTorrentStopped( tr_torrent * ); |
---|
95 | void tr_announcerTorrentCompleted( tr_torrent * ); |
---|
96 | |
---|
97 | enum { TR_ANN_UP, TR_ANN_DOWN, TR_ANN_CORRUPT }; |
---|
98 | void tr_announcerAddBytes( tr_torrent *, int up_down_or_corrupt, uint32_t byteCount ); |
---|
99 | |
---|
100 | time_t tr_announcerNextManualAnnounce( const tr_torrent * ); |
---|
101 | |
---|
102 | tr_tracker_stat * tr_announcerStats( const tr_torrent * torrent, |
---|
103 | int * setmeTrackerCount ); |
---|
104 | |
---|
105 | void tr_announcerStatsFree( tr_tracker_stat * trackers, |
---|
106 | int trackerCount ); |
---|
107 | |
---|
108 | |
---|
109 | #endif /* _TR_ANNOUNCER_H_ */ |
---|