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

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

(trunk) remove unnecessary #includes

  • Property svn:keywords set to Date Rev Author Id
File size: 6.5 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 10031 2010-01-28 13:33:40Z 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 "bitset.h"
28#include "net.h"
29#include "peer-common.h" /* struct peer_request */
30#include "publish.h" /* tr_publisher_tag */
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    struct tr_peermsgs     * msgs;
114    tr_publisher_tag         msgsTag;
115}
116tr_peer;
117
118const tr_address * tr_peerAddress( const tr_peer * );
119
120int tr_pexCompare( const void * a, const void * b );
121
122tr_peerMgr* tr_peerMgrNew( tr_session * );
123
124void tr_peerMgrFree( tr_peerMgr * manager );
125
126tr_bool tr_peerMgrPeerIsSeed( const tr_torrent * tor,
127                              const tr_address * addr );
128
129void tr_peerMgrGetNextRequests( tr_torrent          * torrent,
130                                tr_peer             * peer,
131                                int                   numwant,
132                                tr_block_index_t    * setme,
133                                int                 * numgot );
134
135tr_bool tr_peerMgrDidPeerRequest( const tr_torrent  * torrent,
136                                  const tr_peer     * peer,
137                                  tr_block_index_t    block );
138
139void tr_peerMgrRebuildRequests( tr_torrent * torrent );
140
141void tr_peerMgrAddIncoming( tr_peerMgr  * manager,
142                            tr_address  * addr,
143                            tr_port       port,
144                            int           socket );
145
146tr_pex * tr_peerMgrCompactToPex( const void    * compact,
147                                 size_t          compactLen,
148                                 const uint8_t * added_f,
149                                 size_t          added_f_len,
150                                 size_t        * setme_pex_count );
151
152tr_pex * tr_peerMgrCompact6ToPex( const void    * compact,
153                                  size_t          compactLen,
154                                  const uint8_t * added_f,
155                                  size_t          added_f_len,
156                                  size_t        * pexCount );
157
158tr_pex * tr_peerMgrArrayToPex( const void * array,
159                               size_t       arrayLen,
160                               size_t      * setme_pex_count );
161
162void tr_peerMgrAddPex( tr_torrent     * tor,
163                       uint8_t          from,
164                       const tr_pex   * pex );
165
166void tr_peerMgrSetBlame( tr_torrent        * tor,
167                         tr_piece_index_t    pieceIndex,
168                         int                 success );
169
170enum
171{
172    TR_PEERS_CONNECTED,
173    TR_PEERS_ALL
174};
175
176int  tr_peerMgrGetPeers( tr_torrent      * tor,
177                         tr_pex         ** setme_pex,
178                         uint8_t           address_type,
179                         uint8_t           peer_list_mode,
180                         int               max_peer_count );
181
182void tr_peerMgrStartTorrent( tr_torrent * tor );
183
184void tr_peerMgrStopTorrent( tr_torrent * tor );
185
186void tr_peerMgrAddTorrent( tr_peerMgr         * manager,
187                           struct tr_torrent  * tor );
188
189void tr_peerMgrRemoveTorrent( tr_torrent * tor );
190
191void tr_peerMgrTorrentAvailability( const tr_torrent * tor,
192                                    int8_t           * tab,
193                                    unsigned int       tabCount );
194
195struct tr_bitfield* tr_peerMgrGetAvailable( const tr_torrent * tor );
196
197void tr_peerMgrTorrentStats( tr_torrent * tor,
198                             int * setmePeersKnown,
199                             int * setmePeersConnected,
200                             int * setmeSeedsConnected,
201                             int * setmeWebseedsSendingToUs,
202                             int * setmePeersSendingToUs,
203                             int * setmePeersGettingFromUs,
204                             int * setmePeersFrom ); /* TR_PEER_FROM__MAX */
205
206struct tr_peer_stat* tr_peerMgrPeerStats( const tr_torrent * tor,
207                                          int              * setmeCount );
208
209float tr_peerMgrGetWebseedSpeed( const tr_torrent * tor, uint64_t now );
210
211float* tr_peerMgrWebSpeeds( const tr_torrent * tor );
212
213
214double tr_peerGetPieceSpeed( const tr_peer    * peer,
215                             uint64_t           now,
216                             tr_direction       direction );
217
218/* @} */
219
220#endif
Note: See TracBrowser for help on using the repository browser.