source: trunk/libtransmission/session.h @ 9891

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

(trunk libT) more documentation and doxygen markup

  • Property svn:keywords set to Date Rev Author Id
File size: 5.7 KB
Line 
1/*
2 * This file Copyright (C) 2008-2010 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: session.h 9891 2010-01-06 00:18:33Z charles $
11 */
12
13#ifndef __TRANSMISSION__
14 #error only libtransmission should #include this header.
15#endif
16
17#ifndef TR_INTERNAL_H
18#define TR_INTERNAL_H 1
19
20#define TR_NAME "Transmission"
21
22#ifndef UNUSED
23 #ifdef __GNUC__
24  #define UNUSED __attribute__ ( ( unused ) )
25 #else
26  #define UNUSED
27 #endif
28#endif
29
30#include "bencode.h"
31
32typedef enum { TR_NET_OK, TR_NET_ERROR, TR_NET_WAIT } tr_tristate_t;
33
34uint8_t*       tr_peerIdNew( void );
35
36const uint8_t* tr_getPeerId( void );
37
38struct tr_address;
39struct tr_announcer;
40struct tr_bandwidth;
41struct tr_bindsockets;
42struct tr_fdInfo;
43
44/** @brief handle to an active libtransmission session */
45struct tr_session
46{
47    tr_bool                      isPortRandom;
48    tr_bool                      isPexEnabled;
49    tr_bool                      isDHTEnabled;
50    tr_bool                      isBlocklistEnabled;
51    tr_bool                      isProxyEnabled;
52    tr_bool                      isProxyAuthEnabled;
53    tr_bool                      isClosed;
54    tr_bool                      useLazyBitfield;
55    tr_bool                      isIncompleteFileNamingEnabled;
56    tr_bool                      isRatioLimited;
57    tr_bool                      isIncompleteDirEnabled;
58
59    tr_benc                      removedTorrents;
60
61    int                          umask;
62
63    int                          speedLimit[2];
64    tr_bool                      speedLimitEnabled[2];
65
66    int                          altSpeed[2];
67    tr_bool                      altSpeedEnabled;
68
69    int                          altSpeedTimeBegin;
70    int                          altSpeedTimeEnd;
71    tr_sched_day                 altSpeedTimeDay;
72    tr_bool                      altSpeedTimeEnabled;
73    tr_bool                      altSpeedChangedByUser;
74
75    tr_altSpeedFunc            * altCallback;
76    void                       * altCallbackUserData;
77
78    struct tr_fdInfo           * fdInfo;
79
80    int                          magicNumber;
81
82    tr_encryption_mode           encryptionMode;
83
84    tr_preallocation_mode        preallocationMode;
85
86    struct tr_event_handle *     events;
87
88    uint16_t                     peerLimitPerTorrent;
89
90    int                          uploadSlotsPerTorrent;
91
92    tr_port                      peerPort;
93    tr_port                      randomPortLow;
94    tr_port                      randomPortHigh;
95
96    int                          proxyPort;
97    int                          peerSocketTOS;
98
99    int                          torrentCount;
100    tr_torrent *                 torrentList;
101
102    char *                       tag;
103    char *                       configDir;
104    char *                       downloadDir;
105    char *                       resumeDir;
106    char *                       torrentDir;
107    char *                       incompleteDir;
108
109    tr_proxy_type                proxyType;
110    char *                       proxy;
111    char *                       proxyUsername;
112    char *                       proxyPassword;
113
114    struct tr_list *             blocklists;
115    struct tr_peerMgr *          peerMgr;
116    struct tr_shared *           shared;
117
118    struct tr_lock *             lock;
119
120    struct tr_web *              web;
121
122    struct tr_rpc_server *       rpcServer;
123    tr_rpc_func                  rpc_func;
124    void *                       rpc_func_user_data;
125
126    struct tr_stats_handle     * sessionStats;
127
128    struct tr_announcer        * announcer;
129
130    tr_benc                    * metainfoLookup;
131
132    struct event               * altTimer;
133    struct event               * nowTimer;
134    struct event               * saveTimer;
135
136    /* monitors the "global pool" speeds */
137    struct tr_bandwidth        * bandwidth;
138
139    double                       desiredRatio;
140
141    struct tr_bindinfo         * public_ipv4;
142    struct tr_bindinfo         * public_ipv6;
143};
144
145tr_bool      tr_sessionAllowsDHT( const tr_session * session );
146
147const char * tr_sessionFindTorrentFile( const tr_session * session,
148                                        const char *       hashString );
149
150void         tr_sessionSetTorrentFile( tr_session * session,
151                                       const char * hashString,
152                                       const char * filename );
153
154tr_bool      tr_sessionIsAddressBlocked( const tr_session        * session,
155                                         const struct tr_address * addr );
156
157void         tr_sessionLock( tr_session * );
158
159void         tr_sessionUnlock( tr_session * );
160
161tr_bool      tr_sessionIsLocked( const tr_session * );
162
163const struct tr_address*  tr_sessionGetPublicAddress( const tr_session *, int tr_af_type );
164
165struct tr_bindsockets * tr_sessionGetBindSockets( tr_session * );
166
167enum
168{
169    SESSION_MAGIC_NUMBER = 3845
170};
171
172static inline tr_bool tr_isSession( const tr_session * session )
173{
174    return ( session != NULL ) && ( session->magicNumber == SESSION_MAGIC_NUMBER );
175}
176
177static inline tr_bool tr_isPreallocationMode( tr_preallocation_mode m  )
178{
179    return ( m == TR_PREALLOCATE_NONE )
180        || ( m == TR_PREALLOCATE_SPARSE )
181        || ( m == TR_PREALLOCATE_FULL );
182}
183
184static inline tr_bool tr_isEncryptionMode( tr_encryption_mode m )
185{
186    return ( m == TR_CLEAR_PREFERRED )
187        || ( m == TR_ENCRYPTION_PREFERRED )
188        || ( m == TR_ENCRYPTION_REQUIRED );
189}
190
191static inline tr_bool tr_isPriority( tr_priority_t p )
192{
193    return ( p == TR_PRI_LOW )
194        || ( p == TR_PRI_NORMAL )
195        || ( p == TR_PRI_HIGH );
196}
197
198#endif
Note: See TracBrowser for help on using the repository browser.