source: trunk/libtransmission/peer-io.h

Last change on this file was 14724, checked in by jordan, 5 years ago

use '#pragma once' instead of #ifndef..#define..#endif guards

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