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

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

(trunk) experimental support for tr_torrentSetPriority()

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