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

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

(trunk libT) more debugging messages

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