mirror
/
transmission
mirror of https://github.com/transmission/transmission
1
0
Fork 0
Code Issues Releases Wiki Activity

(libt) more janitorial work on cleaning up tr_session*() and tr_torrent*() functions: session stats, torrent count, and manual update.

This commit is contained in:
Charles Kerr 2008-05-22 20:44:41 +00:00
parent b59be62bb5
commit 26b5a16630
14 changed files with 207 additions and 153 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
beos/TRWindow.cpp
View File

@ -120,12 +120,6 @@ TRWindow::TRWindow() : BWindow(BRect(10, 40, 350, 110), "Transmission", B_TITLED
}
TRWindow::~TRWindow() {
const int MAX_EXIT_WAIT_SECS = 10;
const time_t deadline = time(0) + MAX_EXIT_WAIT_SECS;
while (tr_torrentCount(engine) && time(NULL) < deadline) {
snooze(100000);
}
/* XXX there's no way to make sure the torrent threads are running so this might crash */
tr_sessionClose(engine);
stop_watching(this);
delete quitter;

2
cli/transmissioncli.c
View File

@ -298,7 +298,7 @@ main( int argc, char ** argv )
fprintf( stderr, "\rReceived SIGHUP, but can't send a manual update now\n" );
else {
fprintf( stderr, "\rReceived SIGHUP: manual update scheduled\n" );
tr_manualUpdate( tor );
tr_torrentManualUpdate( tor );
}
}

2
gtk/main.c
View File

@ -1022,7 +1022,7 @@ updateTrackerForeach (GtkTreeModel * model,
{
TrTorrent * tor = NULL;
gtk_tree_model_get( model, iter, MC_TORRENT, &tor, -1 );
tr_manualUpdate( tr_torrent_handle( tor ) );
tr_torrentManualUpdate( tr_torrent_handle( tor ) );
g_object_unref( G_OBJECT( tor ) );
}

6
gtk/stats.c
View File

@ -57,8 +57,8 @@ updateStats( gpointer gdata )
struct stat_ui * ui = gdata;
tr_session_stats one, all;
tr_getSessionStats( tr_core_handle( ui->core ), &one );
tr_getCumulativeSessionStats( tr_core_handle( ui->core ), &all );
tr_sessionGetStats( tr_core_handle( ui->core ), &one );
tr_sessionGetCumulativeStats( tr_core_handle( ui->core ), &all );
setLabel( ui->one_up_lb, tr_strlsize( buf, one.uploadedBytes, sizeof(buf) ) );
setLabel( ui->one_down_lb, tr_strlsize( buf, one.downloadedBytes, sizeof(buf) ) );
@ -84,7 +84,7 @@ dialogResponse( GtkDialog * dialog, gint response, gpointer gdata )
if( response == TR_RESPONSE_CLEAR )
{
tr_handle * handle = tr_core_handle( ui->core );
tr_clearSessionStats( handle );
tr_sessionClearStats( handle );
updateStats( ui );
}

8
gtk/tr-window.c
View File

@ -614,11 +614,11 @@ updateStats( PrivateData * p )
/* update the stats */
pch = pref_string_get( PREF_KEY_STATUSBAR_STATS );
if( !strcmp( pch, "session-ratio" ) ) {
tr_getSessionStats( handle, &stats );
tr_sessionGetStats( handle, &stats );
tr_strlratio( ratio, stats.ratio, sizeof( ratio ) );
g_snprintf( buf, sizeof(buf), _("Ratio: %s"), ratio );
} else if( !strcmp( pch, "session-transfer" ) ) {
tr_getSessionStats( handle, &stats );
tr_sessionGetStats( handle, &stats );
tr_strlsize( up, stats.uploadedBytes, sizeof( up ) );
tr_strlsize( down, stats.downloadedBytes, sizeof( down ) );
/* Translators: do not translate the "size|" disambiguation prefix.
@ -626,7 +626,7 @@ updateStats( PrivateData * p )
%2$s is the size of the data we've uploaded */
g_snprintf( buf, sizeof( buf ), Q_( "size|Down: %1$s, Up: %2$s" ), down, up );
} else if( !strcmp( pch, "total-transfer" ) ) {
tr_getCumulativeSessionStats( handle, &stats );
tr_sessionGetCumulativeStats( handle, &stats );
tr_strlsize( up, stats.uploadedBytes, sizeof( up ) );
tr_strlsize( down, stats.downloadedBytes, sizeof( down ) );
/* Translators: do not translate the "size|" disambiguation prefix.
@ -634,7 +634,7 @@ updateStats( PrivateData * p )
%2$s is the size of the data we've uploaded */
g_snprintf( buf, sizeof( buf ), Q_( "size|Down: %1$s, Up: %2$s" ), down, up );
} else { /* default is total-ratio */
tr_getCumulativeSessionStats( handle, &stats );
tr_sessionGetCumulativeStats( handle, &stats );
tr_strlratio( ratio, stats.ratio, sizeof( ratio ) );
g_snprintf( buf, sizeof(buf), _("Ratio: %s"), ratio );
}

2
libtransmission/rpc.c
View File

@ -80,7 +80,7 @@ getTorrents( tr_handle * handle, tr_benc * args, int * setmeCount )
else /* all of them */
{
tr_torrent * tor = NULL;
const int n = tr_torrentCount( handle );
const int n = tr_sessionCountTorrents( handle );
torrents = tr_new0( tr_torrent*, n );
while(( tor = tr_torrentNext( handle, tor )))
torrents[torrentCount++] = tor;

2
libtransmission/session.c
View File

@ -397,7 +397,7 @@ tr_torrentRates( tr_handle * h, float * toClient, float * toPeer )
}
int
tr_torrentCount( const tr_handle * h )
tr_sessionCountTorrents( const tr_handle * h )
{
return h->torrentCount;
}

10
libtransmission/stats.c
View File

@ -103,7 +103,7 @@ void
tr_statsClose( tr_handle * handle )
{
tr_session_stats cumulative;
tr_getCumulativeSessionStats( handle, &cumulative );
tr_sessionGetCumulativeStats( handle, &cumulative );
saveCumulativeStats( handle, &cumulative );
tr_free( handle->sessionStats );
@ -145,7 +145,7 @@ addStats( tr_session_stats * setme,
}
void
tr_getSessionStats( const tr_handle * handle,
tr_sessionGetStats( const tr_handle * handle,
tr_session_stats * setme )
{
const struct tr_stats_handle * stats = getStats( handle );
@ -155,16 +155,16 @@ tr_getSessionStats( const tr_handle * handle,
}
void
tr_getCumulativeSessionStats( const tr_handle * handle,
tr_sessionGetCumulativeStats( const tr_handle * handle,
tr_session_stats * setme )
{
tr_session_stats current;
tr_getSessionStats( handle, &current );
tr_sessionGetStats( handle, &current );
addStats( setme, &getStats(handle)->old, &current );
}
void
tr_clearSessionStats( tr_handle * handle )
tr_sessionClearStats( tr_handle * handle )
{
tr_session_stats zero;
zero.uploadedBytes = 0;

6
libtransmission/torrent.c
View File

@ -614,16 +614,16 @@ tr_torrentAllowsPex( const tr_torrent * tor )
}
static void
tr_manualUpdateImpl( void * vtor )
tr_torrentManualUpdateImpl( void * vtor )
{
tr_torrent * tor = vtor;
if( tor->isRunning )
tr_trackerReannounce( tor->tracker );
}
void
tr_manualUpdate( tr_torrent * tor )
tr_torrentManualUpdate( tr_torrent * tor )
{
tr_runInEventThread( tor->handle, tr_manualUpdateImpl, tor );
tr_runInEventThread( tor->handle, tr_torrentManualUpdateImpl, tor );
}
int
tr_torrentCanManualUpdate( const tr_torrent * tor )

296
libtransmission/transmission.h
View File

@ -52,29 +52,22 @@ typedef uint32_t tr_file_index_t;
typedef uint32_t tr_piece_index_t;
typedef uint64_t tr_block_index_t;
enum
{
TR_PEER_FROM_INCOMING = 0, /* connections made to the listening port */
TR_PEER_FROM_TRACKER = 1, /* peers received from a tracker */
TR_PEER_FROM_CACHE = 2, /* peers read from the peer cache */
TR_PEER_FROM_PEX = 3, /* peers discovered via PEX */
TR_PEER_FROM__MAX
};
/***********************************************************************
* tr_sessionInit
***********************************************************************
* Initializes and returns an opaque libtransmission handle
* to be passed to functions below. The tag argument is a short string
* unique to the program invoking tr_sessionInit(), it is currently used
* as part of saved torrent files' names to prevent one frontend from
* deleting a torrent used by another. The following tags are used:
* beos cli daemon gtk macosx wx
**********************************************************************/
const char* tr_getDefaultConfigDir( void );
typedef struct tr_handle tr_handle;
typedef struct tr_torrent tr_torrent;
typedef struct tr_ctor tr_ctor;
const char* tr_getDefaultConfigDir( void );
/**
* @addtogroup tr_session Session
*
* A libtransmission session is created by calling either tr_sessionInitFull()
* or tr_sessionInit(). libtransmission creates a thread for itself so that
* it can operate independently of the caller's event loop. The session will
* continue until tr_sessionClose() is called.
*
* @{
*/
#define TR_DEFAULT_CONFIG_DIR tr_getDefaultConfigDir()
#define TR_DEFAULT_PEX_ENABLED 1
@ -88,6 +81,47 @@ const char* tr_getDefaultConfigDir( void );
#define TR_DEFAULT_RPC_PORT_STR "9091"
#define TR_DEFAULT_RPC_ACL "+127.0.0.1"
/**
* Create and return a Transmission session handle.
*
* @param configDir the config directory where libtransmission config
* subdirectories will be found, such as "torrents",
* "resume", and "blocklists".
* TR_DEFAULT_CONFIG_DIR can be used as a default.
* @param downloadDir the default directory to save torrents that are added.
* This can be changed per-session with tr_sessionSetDownloadDir()
* and per-torrent with tr_ctorSetDownloadDir().
* @param tag currently only used for locating legacy versions of
* fastresume files. valid tags: beos, cli, daemon, gtk, macos, wx
* @param isPexEnabled whether or not PEX is allowed for non-private torrents.
* This can be changed per-session with tr_sessionSetPexEnabled().
* TR_DEFAULT_PEX_ENABLED can be used as a default.
* @param isPortForwardingEnabled If true, libtransmission will attempt to find a local
* UPnP-enabled or NATPMP-enabled router and forward a
* port from there to the local machine. This is so that
* remote peers can initiate connections with us.
* TR_DEFAULT_PORT_FORWARDING_ENABLED can be used as a default.
* @param publicPort Port number to open for listening to incoming peer connections.
* TR_DEFAULT_PORT can be used as a default.
* @param encryptionMode must be one of TR_PLAINTEXT_PREFERRED,
* TR_ENCRYPTION_PREFERRED, or TR_ENCRYPTION_REQUIRED.
* @param isUploadLimitEnabled If true, libtransmission will limit the entire
* session's upload speed based on `uploadLimit'.
* @param uploadLimit The speed limit to use for the entire session when
* isUploadLimitEnabled is true.
* @param isDownloadLimitEnabled If true, libtransmission will limit the entire
* session's download speed based on `downloadLimit'.
* @param downloadLimit The speed limit to use for the entire session when
* isDownloadLimitEnabled is true.
* @param peerLimit The maximum number of peer connections allowed in a session.
* TR_DEFAULT_GLOBAL_PEER_LIMIT can be used as a default.
*
* @see TR_DEFAULT_PEER_SOCKET_TOS
* @see TR_DEFAULT_BLOCKLIST_ENABLED
* @see TR_DEFAULT_RPC_ENABLED
* @see TR_DEFAULT_RPC_PORT
* @see TR_DEFAULT_RPC_ACL
*/
tr_handle * tr_sessionInitFull( const char * configDir,
const char * downloadDir,
const char * tag,
@ -99,7 +133,7 @@ tr_handle * tr_sessionInitFull( const char * configDir,
int uploadLimit,
int isDownloadLimitEnabled,
int downloadLimit,
int globalPeerLimit,
int peerLimit,
int messageLevel,
int isMessageQueueingEnabled,
int isBlocklistEnabled,
@ -120,6 +154,11 @@ tr_handle * tr_sessionInit( const char * configDir,
*/
void tr_sessionClose( tr_handle * );
/**
* Set the per-session default download folder for torrents that haven't been added yet.
* @see tr_sessionInitFull()
* @see tr_ctorSetDownloadDir()
*/
void tr_sessionSetDownloadDir( tr_handle *, const char * downloadDir );
const char * tr_sessionGetDownloadDir( const tr_handle * );
@ -189,14 +228,14 @@ typedef struct tr_session_stats
tr_session_stats;
/* stats from the current session. */
void tr_getSessionStats( const tr_handle * handle,
void tr_sessionGetStats( const tr_handle * handle,
tr_session_stats * setme );
/* stats from the current and past sessions. */
void tr_getCumulativeSessionStats( const tr_handle * handle,
void tr_sessionGetCumulativeStats( const tr_handle * handle,
tr_session_stats * setme );
void tr_clearSessionStats( tr_handle * handle );
void tr_sessionClearStats( tr_handle * handle );
/**
* Set whether or not torrents are allowed to do peer exchanges.
@ -252,8 +291,43 @@ tr_port_forwarding;
tr_port_forwarding tr_sessionGetPortForwarding( const tr_handle * );
int tr_sessionCountTorrents( const tr_handle * h );
void tr_sessionSetSpeedLimitEnabled( tr_handle * session,
int up_or_down,
int isEnabled );
enum { TR_UP, TR_DOWN };
int tr_sessionIsSpeedLimitEnabled( const tr_handle * session,
int up_or_down );
void tr_sessionSetSpeedLimit( tr_handle * session,
int up_or_down,
int KiB_sec );
int tr_sessionGetSpeedLimit( const tr_handle * session,
int up_or_down );
void tr_sessionSetPeerLimit( tr_handle * handle,
uint16_t maxGlobalPeers );
uint16_t tr_sessionGetPeerLimit( const tr_handle * handle );
/**
* Load all the torrents in tr_getTorrentDir().
* This can be used at startup to kickstart all the torrents
* from the previous session.
*/
tr_torrent ** tr_sessionLoadTorrents ( tr_handle * h,
tr_ctor * ctor,
int * setmeCount );
/** @} */
//ccccccc
/**
***
@ -279,6 +353,9 @@ typedef struct tr_msg_list
/* TR_MSG_ERR, TR_MSG_INF, or TR_MSG_DBG */
uint8_t level;
/* The line number in the source file where this message originated */
int line;
/* Time the message was generated */
time_t when;
@ -293,9 +370,6 @@ typedef struct tr_msg_list
/* The source file where this message originated */
const char * file;
/* The line number in the source file where this message originated */
int line;
/* linked list of messages */
struct tr_msg_list * next;
}
@ -306,80 +380,9 @@ void tr_setMessageQueuing( int enable );
tr_msg_list * tr_getQueuedMessages( void );
void tr_freeMessageList( tr_msg_list * freeme );
/***********************************************************************
***
*** TORRENTS
**/
typedef struct tr_torrent tr_torrent;
int tr_torrentCount( const tr_handle * h );
/**
* Iterate through the torrents.
* Pass in in a NULL pointer to get the first torrent.
*/
tr_torrent* tr_torrentNext( tr_handle *, tr_torrent * );
/***********************************************************************
*** Speed Limits
**/
enum { TR_UP, TR_DOWN };
typedef enum
{
TR_SPEEDLIMIT_GLOBAL, /* only follow the overall speed limit */
TR_SPEEDLIMIT_SINGLE, /* only follow the per-torrent limit */
TR_SPEEDLIMIT_UNLIMITED /* no limits at all */
}
tr_speedlimit;
void tr_torrentSetSpeedMode( tr_torrent * tor,
int up_or_down,
tr_speedlimit mode );
tr_speedlimit tr_torrentGetSpeedMode( const tr_torrent * tor,
int up_or_down);
void tr_torrentSetSpeedLimit( tr_torrent * tor,
int up_or_down,
int KiB_sec );
int tr_torrentGetSpeedLimit( const tr_torrent * tor,
int up_or_down );
void tr_sessionSetSpeedLimitEnabled( tr_handle * session,
int up_or_down,
int isEnabled );
int tr_sessionIsSpeedLimitEnabled( const tr_handle * session,
int up_or_down );
void tr_sessionSetSpeedLimit( tr_handle * session,
int up_or_down,
int KiB_sec );
int tr_sessionGetSpeedLimit( const tr_handle * session,
int up_or_down );
/***********************************************************************
*** Peer Limits
**/
void tr_torrentSetPeerLimit( tr_torrent * tor,
uint16_t peerLimit );
uint16_t tr_torrentGetPeerLimit( const tr_torrent * tor );
void tr_sessionSetPeerLimit( tr_handle * handle,
uint16_t maxGlobalPeers );
uint16_t tr_sessionGetPeerLimit( const tr_handle * handle );
/** @addtogroup Blocklists
@{ */
/**
* Specify a range of IPs for Transmission to block.
*
@ -414,6 +417,60 @@ struct in_addr;
int tr_blocklistHasAddress( tr_handle * handle,
const struct in_addr * addr);
/** @} */
/***********************************************************************
***
*** TORRENTS
**/
/** @addtogroup tr_torrent Torrents
@{ */
/**
* Iterate through the torrents.
* Pass in in a NULL pointer to get the first torrent.
*/
tr_torrent* tr_torrentNext( tr_handle *, tr_torrent * );
/***********************************************************************
*** Speed Limits
**/
typedef enum
{
TR_SPEEDLIMIT_GLOBAL, /* only follow the overall speed limit */
TR_SPEEDLIMIT_SINGLE, /* only follow the per-torrent limit */
TR_SPEEDLIMIT_UNLIMITED /* no limits at all */
}
tr_speedlimit;
void tr_torrentSetSpeedMode( tr_torrent * tor,
int up_or_down,
tr_speedlimit mode );
tr_speedlimit tr_torrentGetSpeedMode( const tr_torrent * tor,
int up_or_down);
void tr_torrentSetSpeedLimit( tr_torrent * tor,
int up_or_down,
int KiB_sec );
int tr_torrentGetSpeedLimit( const tr_torrent * tor,
int up_or_down );
/***********************************************************************
*** Peer Limits
**/
void tr_torrentSetPeerLimit( tr_torrent * tor,
uint16_t peerLimit );
uint16_t tr_torrentGetPeerLimit( const tr_torrent * tor );
/***********************************************************************
* Torrent Priorities
@ -498,7 +555,6 @@ typedef enum
}
tr_ctorMode;
typedef struct tr_ctor tr_ctor;
struct tr_benc;
tr_ctor* tr_ctorNew ( const tr_handle * handle);
@ -525,6 +581,11 @@ void tr_ctorSetPeerLimit ( tr_ctor * ctor,
tr_ctorMode mode,
uint16_t peerLimit );
/**
* Set the download folder for the torrent being added with this ctor.
* @see tr_ctorSetDownloadDir()
* @see tr_sessionInitFull()
*/
void tr_ctorSetDownloadDir ( tr_ctor * ctor,
tr_ctorMode mode,
const char * directory );
@ -591,17 +652,6 @@ tr_torrent * tr_torrentNew( tr_handle * handle,
int * setmeError );
/**
* Load all the torrents in tr_getTorrentDir().
* This can be used at startup to kickstart all the torrents
* from the previous session.
*/
tr_torrent ** tr_sessionLoadTorrents ( tr_handle * h,
tr_ctor * ctor,
int * setmeCount );
const tr_info * tr_torrentInfo( const tr_torrent * );
void tr_torrentSetDownloadDir( tr_torrent *, const char * );
@ -673,15 +723,15 @@ void tr_torrentClearActiveCallback( tr_torrent * torrent );
*
* Trackers usually set an announce interval of 15 or 30 minutes.
* Users can send one-time announce requests that override this
* interval by calling tr_manualUpdate().
* interval by calling tr_torrentManualUpdate().
*
* The wait interval for tr_manualUpdate() is much smaller.
* The wait interval for tr_torrentManualUpdate() is much smaller.
* You can test whether or not a manual update is possible
* (for example, to desensitize the button) by calling
* tr_torrentCanManualUpdate().
*/
void tr_manualUpdate( tr_torrent * );
void tr_torrentManualUpdate( tr_torrent * );
int tr_torrentCanManualUpdate( const tr_torrent * );
@ -890,13 +940,22 @@ struct tr_tracker_stat
* This value is 0 when the torrent is stopped.
* This value is ~(time_t)0 if the tracker returned a serious error.
* Otherwise, the value is a valid time.
* @see tr_manualUpdate( tr_torrent * );
* @see tr_torrentManualUpdate( tr_torrent * );
* @see tr_torrentCanManualUpdate( const tr_torrent * ); */
time_t nextManualAnnounceTime;
};
tr_torrent_status tr_torrentGetStatus( tr_torrent * );
enum
{
TR_PEER_FROM_INCOMING = 0, /* connections made to the listening port */
TR_PEER_FROM_TRACKER = 1, /* peers received from a tracker */
TR_PEER_FROM_CACHE = 2, /* peers read from the peer cache */
TR_PEER_FROM_PEX = 3, /* peers discovered via PEX */
TR_PEER_FROM__MAX
};
struct tr_stat
{
int id;
@ -1021,6 +1080,7 @@ struct tr_peer_stat
float uploadToRate;
};
/** @} */
#ifdef __TRANSMISSION__
# include "session.h"

8
macosx/Controller.m
View File

@ -1453,9 +1453,9 @@ static void sleepCallback(void * controller, io_service_t y, natural_t messageTy
{
tr_session_stats stats;
if (total)
tr_getCumulativeSessionStats(fLib, &stats);
tr_sessionGetCumulativeStats(fLib, &stats);
else
tr_getSessionStats(fLib, &stats);
tr_sessionGetStats(fLib, &stats);
statusString = [NSString stringWithFormat: @"%@: %@", NSLocalizedString(@"Ratio", "status bar -> status label"),
[NSString stringForRatio: stats.ratio]];
@ -1466,9 +1466,9 @@ static void sleepCallback(void * controller, io_service_t y, natural_t messageTy
tr_session_stats stats;
if (total)
tr_getCumulativeSessionStats(fLib, &stats);
tr_sessionGetCumulativeStats(fLib, &stats);
else
tr_getSessionStats(fLib, &stats);
tr_sessionGetStats(fLib, &stats);
statusString = [NSString stringWithFormat: @"%@: %@ %@: %@",
NSLocalizedString(@"DL", "status bar -> status label"), [NSString stringForFileSize: stats.downloadedBytes],

6
macosx/StatsWindowController.m
View File

@ -163,8 +163,8 @@ tr_handle * fLib;
- (void) updateStats
{
tr_session_stats statsAll, statsSession;
tr_getCumulativeSessionStats(fLib, &statsAll);
tr_getSessionStats(fLib, &statsSession);
tr_sessionGetCumulativeStats(fLib, &statsAll);
tr_sessionGetStats(fLib, &statsSession);
[fUploadedField setStringValue: [NSString stringForFileSize: statsSession.uploadedBytes]];
[fUploadedField setToolTip: [NSString stringWithFormat: NSLocalizedString(@"%u bytes", "stats -> bytes"),
@ -202,7 +202,7 @@ tr_handle * fLib;
- (void) performResetStats
{
tr_clearSessionStats(fLib);
tr_sessionClearStats(fLib);
[self updateStats];
}

4
macosx/Torrent.m
View File

@ -334,7 +334,7 @@ void completenessChangeCallback(tr_torrent * torrent, cp_status_t status, void *
- (void) manualAnnounce
{
tr_manualUpdate(fHandle);
tr_torrentManualUpdate(fHandle);
}
- (BOOL) canManualAnnounce
@ -1630,7 +1630,7 @@ void completenessChangeCallback(tr_torrent * torrent, cp_status_t status, void *
fWaitToStart = waitToStart && [waitToStart boolValue];
fResumeOnWake = NO;
fOrderValue = orderValue ? [orderValue intValue] : tr_torrentCount(lib) - 1;
fOrderValue = orderValue ? [orderValue intValue] : tr_sessionCountTorrents(lib) - 1;
fGroupValue = groupValue ? [groupValue intValue] : -1;
[self createFileList];

2
wx/xmission.cc
View File

@ -455,7 +455,7 @@ void
MyFrame :: OnPulse(wxTimerEvent& WXUNUSED(event) )
{
if( myExitTime ) {
if ( !tr_torrentCount(handle) || myExitTime<time(0) ) {
if ( !tr_sessionCountTorrents(handle) || myExitTime<time(0) ) {
delete myTrayIcon;
myTrayIcon = 0;
Destroy( );