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

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

(trunk libT) avoid some unnecessary memory fragmentation... for composited objects that have a tr_bandwidth, contain the it directly rather than a pointer to one allocated elsewhere on the heap.

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