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

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

(trunk libT) win32 portability patch from Alexey

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