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

Last change on this file since 9532 was 9532, checked in by charles, 12 years ago

(trunk libT) #2575: PEX is not meant to do forwarding

  • Property svn:keywords set to Date Rev Author Id
File size: 6.2 KB
Line 
1/*
2 * This file Copyright (C) 2007-2009 Charles Kerr <charles@transmissionbt.com>
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 9532 2009-11-20 07:47:31Z charles $
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 "net.h"
28#include "peer-common.h" /* struct peer_request */
29#include "publish.h" /* tr_publisher_tag */
30#include "utils.h"
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;
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    struct tr_peerIo       * io;
93    struct peer_atom       * atom;
94
95    struct tr_bitfield     * blame;
96    struct tr_bitfield     * have;
97
98    /** how complete the peer's copy of the torrent is. [0.0...1.0] */
99    float                    progress;
100
101    /* the client name from the `v' string in LTEP's handshake dictionary */
102    char                   * client;
103
104    time_t                   chokeChangedAt;
105
106    struct tr_peermsgs     * msgs;
107    tr_publisher_tag         msgsTag;
108}
109tr_peer;
110
111const tr_address * tr_peerAddress( const tr_peer * );
112
113int tr_pexCompare( const void * a, const void * b );
114
115tr_peerMgr* tr_peerMgrNew( tr_session * );
116
117void tr_peerMgrFree( tr_peerMgr * manager );
118
119tr_bool tr_peerMgrPeerIsSeed( const tr_torrent * tor,
120                              const tr_address * addr );
121
122void tr_peerMgrGetNextRequests( tr_torrent          * torrent,
123                                tr_peer             * peer,
124                                int                   numwant,
125                                tr_block_index_t    * setme,
126                                int                 * numgot );
127
128tr_bool tr_peerMgrDidPeerRequest( const tr_torrent  * torrent,
129                                  const tr_peer     * peer,
130                                  tr_block_index_t    block );
131
132void tr_peerMgrRebuildRequests( tr_torrent * torrent );
133
134void tr_peerMgrAddIncoming( tr_peerMgr  * manager,
135                            tr_address  * addr,
136                            tr_port       port,
137                            int           socket );
138
139tr_pex * tr_peerMgrCompactToPex( const void    * compact,
140                                 size_t          compactLen,
141                                 const uint8_t * added_f,
142                                 size_t          added_f_len,
143                                 size_t        * setme_pex_count );
144
145tr_pex * tr_peerMgrCompact6ToPex( const void    * compact,
146                                  size_t          compactLen,
147                                  const uint8_t * added_f,
148                                  size_t          added_f_len,
149                                  size_t        * pexCount );
150
151tr_pex * tr_peerMgrArrayToPex( const void * array,
152                               size_t       arrayLen,
153                               size_t      * setme_pex_count );
154
155void tr_peerMgrAddPex( tr_torrent     * tor,
156                       uint8_t          from,
157                       const tr_pex   * pex );
158
159void tr_peerMgrSetBlame( tr_torrent        * tor,
160                         tr_piece_index_t    pieceIndex,
161                         int                 success );
162
163enum 
164{
165    TR_PEERS_CONNECTED,
166    TR_PEERS_ALL
167};
168
169int  tr_peerMgrGetPeers( tr_torrent      * tor,
170                         tr_pex         ** setme_pex,
171                         uint8_t           address_type,
172                         uint8_t           peer_list_mode,
173                         int               max_peer_count );
174
175void tr_peerMgrStartTorrent( tr_torrent * tor );
176
177void tr_peerMgrStopTorrent( tr_torrent * tor );
178
179void tr_peerMgrAddTorrent( tr_peerMgr         * manager,
180                           struct tr_torrent  * tor );
181
182void tr_peerMgrRemoveTorrent( tr_torrent * tor );
183
184void tr_peerMgrTorrentAvailability( const tr_torrent * tor,
185                                    int8_t           * tab,
186                                    unsigned int       tabCount );
187
188struct tr_bitfield* tr_peerMgrGetAvailable( const tr_torrent * tor );
189
190void tr_peerMgrTorrentStats( tr_torrent * tor,
191                             int * setmePeersKnown,
192                             int * setmePeersConnected,
193                             int * setmeSeedsConnected,
194                             int * setmeWebseedsSendingToUs,
195                             int * setmePeersSendingToUs,
196                             int * setmePeersGettingFromUs,
197                             int * setmePeersFrom ); /* TR_PEER_FROM__MAX */
198
199struct tr_peer_stat* tr_peerMgrPeerStats( const tr_torrent * tor,
200                                          int              * setmeCount );
201
202float tr_peerMgrGetWebseedSpeed( const tr_torrent * tor, uint64_t now );
203
204float* tr_peerMgrWebSpeeds( const tr_torrent * tor );
205
206
207double tr_peerGetPieceSpeed( const tr_peer    * peer,
208                             uint64_t           now,
209                             tr_direction       direction );
210
211/* @} */
212
213#endif
Note: See TracBrowser for help on using the repository browser.