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

Last change on this file since 12229 was 12229, checked in by jordan, 11 years ago

(trunk libT) API cleanup of the tr_address functions to make them more consistent.

This is loosely related to #2910, but only in the sense of laying the groundwork for #2910's fix...

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