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

Last change on this file since 8050 was 7712, checked in by charles, 13 years ago

(trunk libT) Remove tr_peerMgrHasConnections, it isn't used anywhere

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