source: trunk/libtransmission/peer-io.h @ 8433

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

(trunk) #7: DHT support. This is a work in progress... no gui/rpc support yet

  • Property svn:keywords set to Date Rev Author Id
File size: 11.7 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-io.h 8433 2009-05-19 18:38:26Z charles $
11 */
12
13#ifndef __TRANSMISSION__
14#error only libtransmission should #include this header.
15#endif
16
17#ifndef TR_PEER_IO_H
18#define TR_PEER_IO_H
19
20/**
21***
22**/
23
24#include <assert.h>
25
26#include <event.h>
27
28#include "transmission.h"
29#include "bandwidth.h"
30#include "list.h" /* __tr_list */
31#include "net.h" /* tr_address */
32
33struct evbuffer;
34struct tr_bandwidth;
35struct tr_crypto;
36struct tr_peerIo;
37
38typedef enum
39{
40    READ_NOW,
41    READ_LATER,
42    READ_ERR
43}
44ReadState;
45
46typedef ReadState ( *tr_can_read_cb  )( struct tr_peerIo * io,
47                                        void             * user_data,
48                                        size_t           * setme_piece_byte_count );
49
50typedef void      ( *tr_did_write_cb )( struct tr_peerIo * io,
51                                        size_t             bytesWritten,
52                                        int                wasPieceData,
53                                        void             * userData );
54
55typedef void      ( *tr_net_error_cb )( struct tr_peerIo * io,
56                                        short              what,
57                                        void             * userData );
58
59typedef struct tr_peerIo
60{
61    tr_bool               isEncrypted;
62    tr_bool               isIncoming;
63    tr_bool               peerIdIsSet;
64    tr_bool               extendedProtocolSupported;
65    tr_bool               fastExtensionSupported;
66    tr_bool               dhtSupported;
67
68    /* we create the socket in a nonblocking way, so this flag is initially
69     * false and then set to true when libevent says that the socket is ready
70     * for reading or writing */
71    tr_bool               hasFinishedConnecting;
72
73    tr_priority_t         priority;
74
75    int                   pendingEvents;
76
77    int                   magicNumber;
78
79    uint8_t               encryptionMode;
80
81    tr_port               port;
82    int                   socket;
83
84    int                   refCount;
85
86    uint8_t               peerId[SHA_DIGEST_LENGTH];
87    time_t                timeCreated;
88
89    tr_session          * session;
90
91    tr_address            addr;
92
93    tr_can_read_cb        canRead;
94    tr_did_write_cb       didWrite;
95    tr_net_error_cb       gotError;
96    void *                userData;
97
98    struct tr_bandwidth   bandwidth;
99    struct tr_crypto    * crypto;
100
101    struct evbuffer     * inbuf;
102    struct evbuffer     * outbuf;
103    struct __tr_list      outbuf_datatypes; /* struct tr_datatype */
104
105    struct event          event_read;
106    struct event          event_write;
107}
108tr_peerIo;
109
110/**
111***
112**/
113
114tr_peerIo*  tr_peerIoNewOutgoing( tr_session              * session,
115                                  struct tr_bandwidth     * parent,
116                                  const struct tr_address * addr,
117                                  tr_port                   port,
118                                  const  uint8_t          * torrentHash );
119
120tr_peerIo*  tr_peerIoNewIncoming( tr_session              * session,
121                                  struct tr_bandwidth     * parent,
122                                  const struct tr_address * addr,
123                                  tr_port                   port,
124                                  int                       socket );
125
126void tr_peerIoRefImpl           ( const char              * file,
127                                  int                       line,
128                                  tr_peerIo               * io );
129
130#define tr_peerIoRef(io) tr_peerIoRefImpl( __FILE__, __LINE__, (io) );
131
132void tr_peerIoUnrefImpl         ( const char              * file,
133                                  int                       line,
134                                  tr_peerIo               * io );
135
136#define tr_peerIoUnref(io) tr_peerIoUnrefImpl( __FILE__, __LINE__, (io) );
137
138tr_bool     tr_isPeerIo         ( const tr_peerIo         * io );
139
140
141/**
142***
143**/
144
145void        tr_peerIoEnableLTEP( tr_peerIo * io, tr_bool flag );
146
147static TR_INLINE tr_bool tr_peerIoSupportsLTEP( const tr_peerIo * io )
148{
149    assert( tr_isPeerIo( io ) );
150
151    return io->extendedProtocolSupported;
152}
153
154void        tr_peerIoEnableFEXT( tr_peerIo * io, tr_bool flag );
155
156static TR_INLINE tr_bool tr_peerIoSupportsFEXT( const tr_peerIo * io )
157{
158    assert( tr_isPeerIo( io ) );
159
160    return io->fastExtensionSupported;
161}
162
163void        tr_peerIoEnableDHT( tr_peerIo * io, tr_bool flag );
164
165static TR_INLINE tr_bool tr_peerIoSupportsDHT( const tr_peerIo * io )
166{
167    assert( tr_isPeerIo( io ) );
168
169    return io->dhtSupported;
170}
171
172/**
173***
174**/
175
176static TR_INLINE tr_session* tr_peerIoGetSession ( tr_peerIo * io )
177{
178    assert( tr_isPeerIo( io ) );
179    assert( io->session );
180
181    return io->session;
182}
183
184const char* tr_peerIoAddrStr( const struct tr_address * addr,
185                              tr_port                   port );
186
187static TR_INLINE const char* tr_peerIoGetAddrStr( const tr_peerIo * io )
188{
189    return tr_isPeerIo( io ) ? tr_peerIoAddrStr( &io->addr, io->port ) : "error";
190}
191
192const struct tr_address * tr_peerIoGetAddress( const tr_peerIo * io,
193                                               tr_port         * port );
194
195const uint8_t*       tr_peerIoGetTorrentHash( tr_peerIo * io );
196
197int                  tr_peerIoHasTorrentHash( const tr_peerIo * io );
198
199void                 tr_peerIoSetTorrentHash( tr_peerIo *     io,
200                                              const uint8_t * hash );
201
202int                  tr_peerIoReconnect( tr_peerIo * io );
203
204static TR_INLINE tr_bool tr_peerIoIsIncoming( const tr_peerIo * io )
205{
206    return io->isIncoming;
207}
208
209static TR_INLINE int    tr_peerIoGetAge( const tr_peerIo * io )
210{
211    return time( NULL ) - io->timeCreated;
212}
213
214
215/**
216***
217**/
218
219void                 tr_peerIoSetPeersId( tr_peerIo *     io,
220                                          const uint8_t * peer_id );
221
222static TR_INLINE const uint8_t* tr_peerIoGetPeersId( const tr_peerIo * io )
223{
224    assert( tr_isPeerIo( io ) );
225    assert( io->peerIdIsSet );
226
227    return io->peerId;
228}
229
230/**
231***
232**/
233
234void    tr_peerIoSetIOFuncs      ( tr_peerIo        * io,
235                                   tr_can_read_cb     readcb,
236                                   tr_did_write_cb    writecb,
237                                   tr_net_error_cb    errcb,
238                                   void             * user_data );
239
240void    tr_peerIoClear           ( tr_peerIo        * io );
241
242/**
243***
244**/
245
246void    tr_peerIoWrite          ( tr_peerIo         * io,
247                                  const void        * writeme,
248                                  size_t              writemeLen,
249                                  tr_bool             isPieceData );
250
251void    tr_peerIoWriteBuf       ( tr_peerIo         * io,
252                                  struct evbuffer   * buf,
253                                  tr_bool             isPieceData );
254
255/**
256***
257**/
258
259static TR_INLINE struct tr_crypto * tr_peerIoGetCrypto( tr_peerIo * io )
260{
261    return io->crypto;
262}
263
264typedef enum
265{
266    /* these match the values in MSE's crypto_select */
267    PEER_ENCRYPTION_NONE  = ( 1 << 0 ),
268    PEER_ENCRYPTION_RC4   = ( 1 << 1 )
269}
270EncryptionMode;
271
272void      tr_peerIoSetEncryption( tr_peerIo * io,
273                                  int         encryptionMode );
274
275static TR_INLINE tr_bool tr_peerIoIsEncrypted( const tr_peerIo * io )
276{
277    return ( io != NULL ) && ( io->encryptionMode == PEER_ENCRYPTION_RC4 );
278}
279
280static TR_INLINE void tr_peerIoWriteBytes( tr_peerIo        * io UNUSED,
281                                           struct evbuffer  * outbuf,
282                                           const void       * bytes,
283                                           size_t             byteCount )
284{
285    evbuffer_add( outbuf, bytes, byteCount );
286}
287
288static TR_INLINE void  tr_peerIoWriteUint8( tr_peerIo        * io,
289                                            struct evbuffer  * outbuf,
290                                            uint8_t            writeme )
291{
292    tr_peerIoWriteBytes( io, outbuf, &writeme, sizeof( uint8_t ) );
293}
294
295static TR_INLINE void tr_peerIoWriteUint16( tr_peerIo        * io,
296                                            struct evbuffer  * outbuf,
297                                            uint16_t           writeme )
298{
299    const uint16_t tmp = htons( writeme );
300    tr_peerIoWriteBytes( io, outbuf, &tmp, sizeof( uint16_t ) );
301}
302
303static TR_INLINE void tr_peerIoWriteUint32( tr_peerIo        * io,
304                                            struct evbuffer  * outbuf,
305                                            uint32_t           writeme )
306{
307    const uint32_t tmp = htonl( writeme );
308    tr_peerIoWriteBytes( io, outbuf, &tmp, sizeof( uint32_t ) );
309}
310
311void tr_peerIoReadBytes( tr_peerIo        * io,
312                         struct evbuffer  * inbuf,
313                         void             * bytes,
314                         size_t             byteCount );
315
316static TR_INLINE void tr_peerIoReadUint8( tr_peerIo        * io,
317                                          struct evbuffer  * inbuf,
318                                          uint8_t          * setme )
319{
320    tr_peerIoReadBytes( io, inbuf, setme, sizeof( uint8_t ) );
321}
322
323static TR_INLINE void tr_peerIoReadUint16( tr_peerIo        * io,
324                                           struct evbuffer  * inbuf,
325                                           uint16_t         * setme )
326{
327    uint16_t tmp;
328    tr_peerIoReadBytes( io, inbuf, &tmp, sizeof( uint16_t ) );
329    *setme = ntohs( tmp );
330}
331
332static TR_INLINE void tr_peerIoReadUint32( tr_peerIo        * io,
333                                           struct evbuffer  * inbuf,
334                                           uint32_t         * setme )
335{
336    uint32_t tmp;
337    tr_peerIoReadBytes( io, inbuf, &tmp, sizeof( uint32_t ) );
338    *setme = ntohl( tmp );
339}
340
341void      tr_peerIoDrain( tr_peerIo        * io,
342                          struct evbuffer  * inbuf,
343                          size_t             byteCount );
344
345/**
346***
347**/
348
349size_t    tr_peerIoGetWriteBufferSpace( const tr_peerIo * io, uint64_t now );
350
351static TR_INLINE void tr_peerIoSetParent( tr_peerIo            * io,
352                                          struct tr_bandwidth  * parent )
353{
354    assert( tr_isPeerIo( io ) );
355
356    tr_bandwidthSetParent( &io->bandwidth, parent );
357}
358
359void      tr_peerIoBandwidthUsed( tr_peerIo           * io,
360                                  tr_direction          direction,
361                                  size_t                byteCount,
362                                  int                   isPieceData );
363
364static TR_INLINE tr_bool tr_peerIoHasBandwidthLeft( const tr_peerIo  * io,
365                                                    tr_direction       dir )
366{
367    assert( tr_isPeerIo( io ) );
368
369    return !io->hasFinishedConnecting
370        || ( tr_bandwidthClamp( &io->bandwidth, dir, 1024 ) > 0 );
371}
372
373static TR_INLINE double tr_peerIoGetPieceSpeed( const tr_peerIo * io, uint64_t now, tr_direction dir )
374{
375    assert( tr_isPeerIo( io ) );
376    assert( tr_isDirection( dir ) );
377
378    return tr_bandwidthGetPieceSpeed( &io->bandwidth, now, dir );
379}
380
381/**
382***
383**/
384
385void      tr_peerIoSetEnabled( tr_peerIo    * io,
386                               tr_direction   dir,
387                               tr_bool        isEnabled );
388                       
389int       tr_peerIoFlush( tr_peerIo     * io,
390                          tr_direction    dir,
391                          size_t          byteLimit );
392
393int       tr_peerIoFlushOutgoingProtocolMsgs( tr_peerIo * io );
394
395/**
396***
397**/
398
399static TR_INLINE struct evbuffer * tr_peerIoGetReadBuffer( tr_peerIo * io )
400{
401    return io->inbuf;
402}
403
404
405#endif
Note: See TracBrowser for help on using the repository browser.