source: trunk/libtransmission/peer-mgr.h @ 11264

Last change on this file since 11264 was 11264, checked in by Longinus00, 11 years ago

(libT) #3453:Torrent does not stop when set per torrent seed ratio is reached before torrent is completed
(libT) #3578:Interested flag isn't cleared when transitioning from leeching to seeding

  • Property svn:keywords set to Date Rev Author Id
File size: 7.1 KB
Line 
1/*
2 * This file Copyright (C) 2007-2010 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: peer-mgr.h 11264 2010-09-25 00:34:15Z Longinus00 $
11 */
12
13#ifndef __TRANSMISSION__
14#error only libtransmission should #include this header.
15#endif
16
17#ifndef TR_PEER_MGR_H
18#define TR_PEER_MGR_H
19
20#include <inttypes.h> /* uint16_t */
21
22#ifdef WIN32
23 #include <winsock2.h> /* struct in_addr */
24#endif
25
26#include "bitfield.h"
27#include "bitset.h"
28#include "history.h"
29#include "net.h"
30#include "peer-common.h" /* struct peer_request */
31
32/**
33 * @addtogroup peers Peers
34 * @{
35 */
36
37struct tr_peer_stat;
38struct tr_torrent;
39typedef struct tr_peerMgr tr_peerMgr;
40
41enum
42{
43    /* corresponds to ut_pex's added.f flags */
44    ADDED_F_ENCRYPTION_FLAG = 1,
45
46    /* corresponds to ut_pex's added.f flags */
47    ADDED_F_SEED_FLAG = 2,
48};
49
50typedef struct tr_pex
51{
52    tr_address addr;
53    tr_port    port; /* this field is in network byte order */
54    uint8_t    flags;
55}
56tr_pex;
57
58
59struct tr_bandwidth;
60struct tr_peerIo;
61struct tr_peermsgs;
62
63enum
64{
65    ENCRYPTION_PREFERENCE_UNKNOWN,
66    ENCRYPTION_PREFERENCE_YES,
67    ENCRYPTION_PREFERENCE_NO
68};
69
70/* opaque forward declaration */
71struct peer_atom;
72
73/**
74 * State information about a connected peer.
75 *
76 * @see struct peer_atom
77 * @see tr_peermsgs
78 */
79typedef struct tr_peer
80{
81    tr_bool                  peerIsChoked;
82    tr_bool                  peerIsInterested;
83    tr_bool                  clientIsChoked;
84    tr_bool                  clientIsInterested;
85    tr_bool                  doPurge;
86
87    /* number of bad pieces they've contributed to */
88    uint8_t                  strikes;
89
90    uint8_t                  encryption_preference;
91    tr_port                  dht_port;
92
93    /* how many requests the peer has made that we haven't responded to yet */
94    int                      pendingReqsToClient;
95
96    /* how many requests we've made and are currently awaiting a response for */
97    int                      pendingReqsToPeer;
98
99    struct tr_peerIo       * io;
100    struct peer_atom       * atom;
101
102    struct tr_bitfield     * blame;
103    struct tr_bitset         have;
104
105    /** how complete the peer's copy of the torrent is. [0.0...1.0] */
106    float                    progress;
107
108    /* the client name from the `v' string in LTEP's handshake dictionary */
109    char                   * client;
110
111    time_t                   chokeChangedAt;
112
113    time_t                   lastBlocksAtTime;
114    int                      blocksAt[60];
115
116    time_t                   lastCancelTime;
117    int                      cancelAt[60];
118
119    tr_recentHistory       * blocksSentToClient;
120    tr_recentHistory       * blocksSentToPeer;
121
122    tr_recentHistory       * cancelsSentToClient;
123    tr_recentHistory       * cancelsSentToPeer;
124
125    struct tr_peermsgs     * msgs;
126}
127tr_peer;
128
129const tr_address * tr_peerAddress( const tr_peer * );
130
131int tr_pexCompare( const void * a, const void * b );
132
133tr_peerMgr* tr_peerMgrNew( tr_session * );
134
135void tr_peerMgrFree( tr_peerMgr * manager );
136
137tr_bool tr_peerMgrPeerIsSeed( const tr_torrent * tor,
138                              const tr_address * addr );
139
140void tr_peerMgrGetNextRequests( tr_torrent          * torrent,
141                                tr_peer             * peer,
142                                int                   numwant,
143                                tr_block_index_t    * setme,
144                                int                 * numgot );
145
146tr_bool tr_peerMgrDidPeerRequest( const tr_torrent  * torrent,
147                                  const tr_peer     * peer,
148                                  tr_block_index_t    block );
149
150void tr_peerMgrRebuildRequests( tr_torrent * torrent );
151
152void tr_peerMgrAddIncoming( tr_peerMgr  * manager,
153                            tr_address  * addr,
154                            tr_port       port,
155                            int           socket );
156
157tr_pex * tr_peerMgrCompactToPex( const void    * compact,
158                                 size_t          compactLen,
159                                 const uint8_t * added_f,
160                                 size_t          added_f_len,
161                                 size_t        * setme_pex_count );
162
163tr_pex * tr_peerMgrCompact6ToPex( const void    * compact,
164                                  size_t          compactLen,
165                                  const uint8_t * added_f,
166                                  size_t          added_f_len,
167                                  size_t        * pexCount );
168
169tr_pex * tr_peerMgrArrayToPex( const void * array,
170                               size_t       arrayLen,
171                               size_t      * setme_pex_count );
172
173/**
174 * @param seedProbability [0..100] for likelihood that the peer is a seed; -1 for unknown
175 */
176void tr_peerMgrAddPex( tr_torrent     * tor,
177                       uint8_t          from,
178                       const tr_pex   * pex,
179                       int8_t           seedProbability );
180
181void tr_peerMgrMarkAllAsSeeds( tr_torrent * tor );
182
183void tr_peerMgrSetBlame( tr_torrent        * tor,
184                         tr_piece_index_t    pieceIndex,
185                         int                 success );
186
187enum
188{
189    TR_PEERS_CONNECTED,
190    TR_PEERS_ALL
191};
192
193int  tr_peerMgrGetPeers( tr_torrent      * tor,
194                         tr_pex         ** setme_pex,
195                         uint8_t           address_type,
196                         uint8_t           peer_list_mode,
197                         int               max_peer_count );
198
199void tr_peerMgrStartTorrent( tr_torrent * tor );
200
201void tr_peerMgrStopTorrent( tr_torrent * tor );
202
203void tr_peerMgrAddTorrent( tr_peerMgr         * manager,
204                           struct tr_torrent  * tor );
205
206void tr_peerMgrRemoveTorrent( tr_torrent * tor );
207
208void tr_peerMgrTorrentAvailability( const tr_torrent * tor,
209                                    int8_t           * tab,
210                                    unsigned int       tabCount );
211
212struct tr_bitfield* tr_peerMgrGetAvailable( const tr_torrent * tor );
213
214void tr_peerMgrOnBlocklistChanged( tr_peerMgr * manager );
215
216void tr_peerMgrTorrentStats( tr_torrent * tor,
217                             int * setmePeersKnown,
218                             int * setmePeersConnected,
219                             int * setmeSeedsConnected,
220                             int * setmeWebseedsSendingToUs,
221                             int * setmePeersSendingToUs,
222                             int * setmePeersGettingFromUs,
223                             int * setmePeersFrom ); /* TR_PEER_FROM__MAX */
224
225struct tr_peer_stat* tr_peerMgrPeerStats( const tr_torrent * tor,
226                                          int              * setmeCount );
227
228int tr_peerMgrGetWebseedSpeed_Bps( const tr_torrent * tor, uint64_t now );
229
230double* tr_peerMgrWebSpeeds_KBps( const tr_torrent * tor );
231
232
233int tr_peerGetPieceSpeed_Bps( const tr_peer    * peer,
234                              uint64_t           now,
235                              tr_direction       direction );
236
237void tr_peerMgrClearInterest( tr_torrent * tor );
238
239/* @} */
240
241#endif
Note: See TracBrowser for help on using the repository browser.