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

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

(trunk libT) undo today's earlier commit r9381 for #2508 -- looks like I introduced a bug into the patch.

  • Property svn:keywords set to Date Rev Author Id
File size: 5.5 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 9383 2009-10-22 19:08:45Z 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 "publish.h" /* tr_publisher_tag */
29#include "utils.h"
30
31/**
32 * @addtogroup peers Peers
33 * @{
34 */
35
36struct tr_peer_stat;
37struct tr_torrent;
38typedef struct tr_peerMgr tr_peerMgr;
39
40enum
41{
42    /* corresponds to ut_pex's added.f flags */
43    ADDED_F_ENCRYPTION_FLAG = 1,
44
45    /* corresponds to ut_pex's added.f flags */
46    ADDED_F_SEED_FLAG = 2,
47};
48
49typedef struct tr_pex
50{
51    tr_address addr;
52    tr_port    port;
53    uint8_t    flags;
54}
55tr_pex;
56
57
58struct tr_bandwidth;
59struct tr_peerIo;
60struct tr_peermsgs;
61
62enum
63{
64    ENCRYPTION_PREFERENCE_UNKNOWN,
65    ENCRYPTION_PREFERENCE_YES,
66    ENCRYPTION_PREFERENCE_NO
67};
68
69/* opaque forward declaration */
70struct peer_atom;
71
72/**
73 * State information about a connected peer.
74 *
75 * @see struct peer_atom
76 * @see tr_peermsgs
77 */
78typedef struct tr_peer
79{
80    tr_bool                  peerIsChoked;
81    tr_bool                  peerIsInterested;
82    tr_bool                  clientIsChoked;
83    tr_bool                  clientIsInterested;
84    tr_bool                  doPurge;
85
86    /* number of bad pieces they've contributed to */
87    uint8_t                  strikes;
88
89    uint8_t                  encryption_preference;
90    tr_port                  port;
91    tr_port                  dht_port;
92    tr_address               addr;
93    struct tr_peerIo       * io;
94    struct peer_atom       * atom;
95
96    struct tr_bitfield     * blame;
97    struct tr_bitfield     * have;
98
99    /** how complete the peer's copy of the torrent is. [0.0...1.0] */
100    float                    progress;
101
102    /* the client name from the `v' string in LTEP's handshake dictionary */
103    char                   * client;
104
105    time_t                   chokeChangedAt;
106
107    struct tr_peermsgs     * msgs;
108    tr_publisher_tag         msgsTag;
109}
110tr_peer;
111
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_peerMgrAddIncoming( tr_peerMgr  * manager,
123                            tr_address  * addr,
124                            tr_port       port,
125                            int           socket );
126
127tr_pex * tr_peerMgrCompactToPex( const void    * compact,
128                                 size_t          compactLen,
129                                 const uint8_t * added_f,
130                                 size_t          added_f_len,
131                                 size_t        * setme_pex_count );
132
133tr_pex * tr_peerMgrCompact6ToPex( const void    * compact,
134                                  size_t          compactLen,
135                                  const uint8_t * added_f,
136                                  size_t          added_f_len,
137                                  size_t        * pexCount );
138
139tr_pex * tr_peerMgrArrayToPex( const void * array,
140                               size_t       arrayLen,
141                               size_t      * setme_pex_count );
142
143void tr_peerMgrAddPex( tr_torrent     * tor,
144                       uint8_t          from,
145                       const tr_pex   * pex );
146
147void tr_peerMgrSetBlame( tr_torrent        * tor,
148                         tr_piece_index_t    pieceIndex,
149                         int                 success );
150
151int  tr_peerMgrGetPeers( tr_torrent      * tor,
152                         tr_pex         ** setme_pex,
153                         uint8_t           af,
154                         int               maxPeerCount );
155
156void tr_peerMgrStartTorrent( tr_torrent * tor );
157
158void tr_peerMgrStopTorrent( tr_torrent * tor );
159
160void tr_peerMgrAddTorrent( tr_peerMgr         * manager,
161                           struct tr_torrent  * tor );
162
163void tr_peerMgrRemoveTorrent( tr_torrent * tor );
164
165void tr_peerMgrTorrentAvailability( const tr_torrent * tor,
166                                    int8_t           * tab,
167                                    unsigned int       tabCount );
168
169struct tr_bitfield* tr_peerMgrGetAvailable( const tr_torrent * tor );
170
171void tr_peerMgrTorrentStats( tr_torrent * tor,
172                             int * setmePeersKnown,
173                             int * setmePeersConnected,
174                             int * setmeSeedsConnected,
175                             int * setmeWebseedsSendingToUs,
176                             int * setmePeersSendingToUs,
177                             int * setmePeersGettingFromUs,
178                             int * setmePeersFrom ); /* TR_PEER_FROM__MAX */
179
180struct tr_peer_stat* tr_peerMgrPeerStats( const tr_torrent * tor,
181                                          int              * setmeCount );
182
183float tr_peerMgrGetWebseedSpeed( const tr_torrent * tor, uint64_t now );
184
185float* tr_peerMgrWebSpeeds( const tr_torrent * tor );
186
187
188double tr_peerGetPieceSpeed( const tr_peer    * peer,
189                             uint64_t           now,
190                             tr_direction       direction );
191
192/* @} */
193
194#endif
Note: See TracBrowser for help on using the repository browser.