source: trunk/libtransmission/session.h @ 8118

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

(trunk) add a did-the-user-do-this flag to the "alt speed toggled" callback

  • Property svn:keywords set to Date Rev Author Id
File size: 5.8 KB
Line 
1/******************************************************************************
2 * $Id: session.h 8118 2009-03-30 17:25:35Z charles $
3 *
4 * Copyright (c) 2005-2008 Transmission authors and contributors
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *****************************************************************************/
24
25#ifndef __TRANSMISSION__
26#error only libtransmission should #include this header.
27#endif
28
29#ifndef TR_INTERNAL_H
30#define TR_INTERNAL_H 1
31
32#define TR_NAME "Transmission"
33
34#ifndef UNUSED
35 #ifdef __GNUC__
36  #define UNUSED __attribute__ ( ( unused ) )
37 #else
38  #define UNUSED
39 #endif
40#endif
41
42
43typedef enum { TR_NET_OK, TR_NET_ERROR, TR_NET_WAIT } tr_tristate_t;
44
45uint8_t*       tr_peerIdNew( void );
46
47const uint8_t* tr_getPeerId( void );
48
49struct tr_metainfo_lookup
50{
51    char    hashString[2 * SHA_DIGEST_LENGTH + 1];
52    char *  filename;
53};
54
55struct tr_address;
56struct tr_bandwidth;
57
58struct tr_session
59{
60    tr_bool                      isPortSet;
61    tr_bool                      isPortRandom;
62    tr_bool                      isPexEnabled;
63    tr_bool                      isBlocklistEnabled;
64    tr_bool                      isProxyEnabled;
65    tr_bool                      isProxyAuthEnabled;
66    tr_bool                      isClosed;
67    tr_bool                      isWaiting;
68    tr_bool                      useLazyBitfield;
69    tr_bool                      isRatioLimited;
70
71   
72    int                          speedLimit[2];
73    tr_bool                      speedLimitEnabled[2];
74
75    int                          altSpeed[2];
76    tr_bool                      altSpeedEnabled;
77
78    int                          altSpeedTimeBegin;
79    int                          altSpeedTimeEnd;
80    tr_bool                      altSpeedTimeEnabled;
81    tr_bool                      altSpeedChangedByUser;
82
83    tr_altSpeedFunc            * altCallback;
84    void                       * altCallbackUserData;
85
86
87    int                          magicNumber;
88
89    tr_encryption_mode           encryptionMode;
90
91    tr_preallocation_mode        preallocationMode;
92
93    struct tr_event_handle *     events;
94
95    uint16_t                     peerLimitPerTorrent;
96    uint16_t                     openFileLimit;
97
98    int                          uploadSlotsPerTorrent;
99
100    tr_port                      peerPort;
101    tr_port                      randomPortLow;
102    tr_port                      randomPortHigh;
103
104    int                          proxyPort;
105    int                          peerSocketTOS;
106
107    int                          torrentCount;
108    tr_torrent *                 torrentList;
109
110    char *                       tag;
111    char *                       configDir;
112    char *                       downloadDir;
113    char *                       resumeDir;
114    char *                       torrentDir;
115
116    tr_proxy_type                proxyType;
117    char *                       proxy;
118    char *                       proxyUsername;
119    char *                       proxyPassword;
120
121    struct tr_list *             blocklists;
122    struct tr_peerMgr *          peerMgr;
123    struct tr_shared *           shared;
124
125    struct tr_lock *             lock;
126
127    struct tr_web *              web;
128
129    struct tr_rpc_server *       rpcServer;
130    tr_rpc_func                  rpc_func;
131    void *                       rpc_func_user_data;
132
133    struct tr_stats_handle *     sessionStats;
134    struct tr_tracker_handle *   tracker;
135
136    struct tr_metainfo_lookup *  metainfoLookup;
137    int                          metainfoLookupCount;
138
139    struct event               * altTimer;
140
141    /* the size of the output buffer for peer connections */
142    int so_sndbuf;
143
144    /* the size of the input buffer for peer connections */
145    int so_rcvbuf;
146
147    /* monitors the "global pool" speeds */
148    struct tr_bandwidth        * bandwidth;
149
150    double                       desiredRatio;
151};
152
153tr_bool      tr_sessionGetActiveSpeedLimit( const tr_session  * session,
154                                            tr_direction        dir,
155                                            int               * setme );
156
157const char * tr_sessionFindTorrentFile( const tr_session * session,
158                                        const char *       hashString );
159
160void         tr_sessionSetTorrentFile( tr_session * session,
161                                       const char * hashString,
162                                       const char * filename );
163
164tr_bool      tr_sessionIsAddressBlocked( const tr_session        * session,
165                                         const struct tr_address * addr );
166
167void         tr_globalLock( tr_session * );
168
169void         tr_globalUnlock( tr_session * );
170
171tr_bool      tr_globalIsLocked( const tr_session * );
172
173enum
174{
175    SESSION_MAGIC_NUMBER = 3845
176};
177
178static inline tr_bool tr_isSession( const tr_session * session )
179{
180    return ( session != NULL ) && ( session->magicNumber == SESSION_MAGIC_NUMBER );
181}
182
183#endif
Note: See TracBrowser for help on using the repository browser.