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

Last change on this file since 12096 was 12096, checked in by jordan, 11 years ago

(trunk) copyediting: remove trailing spaces from source code lines in daemon/ gtk/ libtransmission/ and utils/

  • Property svn:keywords set to Date Rev Author Id
File size: 7.7 KB
Line 
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: peer-mgr.h 12096 2011-03-04 23:26:10Z jordan $
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 UTPSocket;
38struct tr_peer_stat;
39struct tr_torrent;
40typedef struct tr_peerMgr tr_peerMgr;
41
42/* added_f's bitwise-or'ed flags */
43enum
44{
45    /* true if the peer supports encryption */
46    ADDED_F_ENCRYPTION_FLAG = 1,
47
48    /* true if the peer is a seed or partial seed */
49    ADDED_F_SEED_FLAG = 2,
50
51    /* true if the peer supports uTP */
52    ADDED_F_UTP_FLAGS = 4,
53
54    /* true if the peer has holepunch support */
55    ADDED_F_HOLEPUNCH = 8,
56
57    /* true if the peer telling us about this peer
58     * initiated the connection (implying that it is connectible) */
59    ADDED_F_CONNECTABLE = 16
60};
61
62typedef struct tr_pex
63{
64    tr_address addr;
65    tr_port    port; /* this field is in network byte order */
66    uint8_t    flags;
67}
68tr_pex;
69
70
71struct tr_peerIo;
72struct tr_peermsgs;
73
74enum
75{
76    ENCRYPTION_PREFERENCE_UNKNOWN,
77    ENCRYPTION_PREFERENCE_YES,
78    ENCRYPTION_PREFERENCE_NO
79};
80
81/* opaque forward declaration */
82struct peer_atom;
83
84/**
85 * State information about a connected peer.
86 *
87 * @see struct peer_atom
88 * @see tr_peermsgs
89 */
90typedef struct tr_peer
91{
92    tr_bool                  peerIsChoked;
93    tr_bool                  peerIsInterested;
94    tr_bool                  clientIsChoked;
95    tr_bool                  clientIsInterested;
96    tr_bool                  doPurge;
97
98    /* number of bad pieces they've contributed to */
99    uint8_t                  strikes;
100
101    uint8_t                  encryption_preference;
102    tr_port                  dht_port;
103
104    /* how many requests the peer has made that we haven't responded to yet */
105    int                      pendingReqsToClient;
106
107    /* how many requests we've made and are currently awaiting a response for */
108    int                      pendingReqsToPeer;
109
110    struct tr_peerIo       * io;
111    struct peer_atom       * atom;
112
113    struct tr_bitfield     * blame;
114    struct tr_bitset         have;
115
116    /** how complete the peer's copy of the torrent is. [0.0...1.0] */
117    float                    progress;
118
119    /* the client name from the `v' string in LTEP's handshake dictionary */
120    char                   * client;
121
122    time_t                   chokeChangedAt;
123
124    tr_recentHistory         blocksSentToClient;
125    tr_recentHistory         blocksSentToPeer;
126
127    tr_recentHistory         cancelsSentToClient;
128    tr_recentHistory         cancelsSentToPeer;
129
130    struct tr_peermsgs     * msgs;
131}
132tr_peer;
133
134void tr_peerConstruct( struct tr_peer * peer );
135
136void tr_peerDestruct( tr_torrent * tor, struct tr_peer * peer );
137
138
139static inline tr_bool
140tr_isPex( const tr_pex * pex )
141{
142    return pex && tr_isAddress( &pex->addr );
143}
144
145const tr_address * tr_peerAddress( const tr_peer * );
146
147int tr_pexCompare( const void * a, const void * b );
148
149tr_peerMgr* tr_peerMgrNew( tr_session * );
150
151void tr_peerMgrFree( tr_peerMgr * manager );
152
153tr_bool tr_peerMgrPeerIsSeed( const tr_torrent * tor,
154                              const tr_address * addr );
155
156void tr_peerMgrSetUtpSupported( tr_torrent       * tor,
157                                const tr_address * addr );
158
159void tr_peerMgrSetUtpFailed( tr_torrent *tor,
160                             const tr_address *addr,
161                             tr_bool failed );
162
163void tr_peerMgrGetNextRequests( tr_torrent          * torrent,
164                                tr_peer             * peer,
165                                int                   numwant,
166                                tr_block_index_t    * setme,
167                                int                 * numgot );
168
169tr_bool tr_peerMgrDidPeerRequest( const tr_torrent  * torrent,
170                                  const tr_peer     * peer,
171                                  tr_block_index_t    block );
172
173void tr_peerMgrRebuildRequests( tr_torrent * torrent );
174
175void tr_peerMgrAddIncoming( tr_peerMgr  * manager,
176                            tr_address  * addr,
177                            tr_port       port,
178                            int           socket,
179                            struct UTPSocket *utp_socket );
180
181tr_pex * tr_peerMgrCompactToPex( const void    * compact,
182                                 size_t          compactLen,
183                                 const uint8_t * added_f,
184                                 size_t          added_f_len,
185                                 size_t        * setme_pex_count );
186
187tr_pex * tr_peerMgrCompact6ToPex( const void    * compact,
188                                  size_t          compactLen,
189                                  const uint8_t * added_f,
190                                  size_t          added_f_len,
191                                  size_t        * pexCount );
192
193tr_pex * tr_peerMgrArrayToPex( const void * array,
194                               size_t       arrayLen,
195                               size_t      * setme_pex_count );
196
197/**
198 * @param seedProbability [0..100] for likelihood that the peer is a seed; -1 for unknown
199 */
200void tr_peerMgrAddPex( tr_torrent     * tor,
201                       uint8_t          from,
202                       const tr_pex   * pex,
203                       int8_t           seedProbability );
204
205void tr_peerMgrMarkAllAsSeeds( tr_torrent * tor );
206
207void tr_peerMgrSetBlame( tr_torrent        * tor,
208                         tr_piece_index_t    pieceIndex,
209                         int                 success );
210
211enum
212{
213    TR_PEERS_CONNECTED,
214    TR_PEERS_ALL
215};
216
217int  tr_peerMgrGetPeers( tr_torrent      * tor,
218                         tr_pex         ** setme_pex,
219                         uint8_t           address_type,
220                         uint8_t           peer_list_mode,
221                         int               max_peer_count );
222
223void tr_peerMgrStartTorrent( tr_torrent * tor );
224
225void tr_peerMgrStopTorrent( tr_torrent * tor );
226
227void tr_peerMgrAddTorrent( tr_peerMgr         * manager,
228                           struct tr_torrent  * tor );
229
230void tr_peerMgrRemoveTorrent( tr_torrent * tor );
231
232void tr_peerMgrTorrentAvailability( const tr_torrent * tor,
233                                    int8_t           * tab,
234                                    unsigned int       tabCount );
235
236struct tr_bitfield* tr_peerMgrGetAvailable( const tr_torrent * tor );
237
238void tr_peerMgrOnTorrentGotMetainfo( tr_torrent * tor );
239
240void tr_peerMgrOnBlocklistChanged( tr_peerMgr * manager );
241
242void tr_peerMgrTorrentStats( tr_torrent * tor,
243                             int * setmePeersConnected,
244                             int * setmeSeedsConnected,
245                             int * setmeWebseedsSendingToUs,
246                             int * setmePeersSendingToUs,
247                             int * setmePeersGettingFromUs,
248                             int * setmePeersFrom ); /* TR_PEER_FROM__MAX */
249
250struct tr_peer_stat* tr_peerMgrPeerStats( const tr_torrent * tor,
251                                          int              * setmeCount );
252
253double* tr_peerMgrWebSpeeds_KBps( const tr_torrent * tor );
254
255
256int tr_peerGetPieceSpeed_Bps( const tr_peer    * peer,
257                              uint64_t           now,
258                              tr_direction       direction );
259
260void tr_peerMgrClearInterest( tr_torrent * tor );
261
262/* @} */
263
264#endif
Note: See TracBrowser for help on using the repository browser.