transmission/macosx/Torrent.h

260 lines
7.8 KiB
C
Raw Normal View History

2007-09-16 01:02:06 +00:00
/******************************************************************************
* $Id$
*
2012-01-14 17:12:04 +00:00
* Copyright (c) 2006-2012 Transmission authors and contributors
2007-09-16 01:02:06 +00:00
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*****************************************************************************/
#import <Cocoa/Cocoa.h>
#import <transmission.h>
#import <Quartz/Quartz.h>
2007-09-16 01:02:06 +00:00
@class FileListNode;
typedef enum {
TorrentDeterminationAutomatic = 0,
TorrentDeterminationUserSpecified
} TorrentDeterminationType;
#define kTorrentDidChangeGroupNotification @"TorrentDidChangeGroup"
@interface Torrent : NSObject <NSCopying, QLPreviewItem>
2007-09-16 01:02:06 +00:00
{
2007-09-20 20:24:33 +00:00
tr_torrent * fHandle;
const tr_info * fInfo;
const tr_stat * fStat;
2007-09-16 01:02:06 +00:00
NSUserDefaults * fDefaults;
NSImage * fIcon;
2009-11-26 02:11:00 +00:00
NSString * fHashString;
tr_file_stat * fFileStat;
NSArray * fFileList, * fFlatFileList;
2007-09-16 01:02:06 +00:00
NSIndexSet * fPreviousFinishedIndexes;
NSDate * fPreviousFinishedIndexesDate;
BOOL fRemoveWhenFinishSeeding;
NSInteger fGroupValue;
TorrentDeterminationType fGroupValueDetermination;
TorrentDeterminationType fDownloadFolderDetermination;
2007-09-16 01:02:06 +00:00
BOOL fResumeOnWake;
BOOL fTimeMachineExcludeInitialized;
2007-09-16 01:02:06 +00:00
}
- (id) initWithPath: (NSString *) path location: (NSString *) location deleteTorrentFile: (BOOL) torrentDelete
lib: (tr_session *) lib;
- (id) initWithTorrentStruct: (tr_torrent *) torrentStruct location: (NSString *) location lib: (tr_session *) lib;
- (id) initWithMagnetAddress: (NSString *) address location: (NSString *) location lib: (tr_session *) lib;
- (id) initWithHistory: (NSDictionary *) history lib: (tr_session *) lib forcePause: (BOOL) pause;
2007-09-16 01:02:06 +00:00
- (NSDictionary *) history;
- (void) closeRemoveTorrent: (BOOL) trashFiles;
2007-09-16 01:02:06 +00:00
- (void) changeDownloadFolderBeforeUsing: (NSString *) folder determinationType: (TorrentDeterminationType) determinationType;
- (NSString *) currentDirectory;
2007-09-16 01:02:06 +00:00
2008-11-02 01:07:01 +00:00
- (void) getAvailability: (int8_t *) tab size: (NSInteger) size;
- (void) getAmountFinished: (float *) tab size: (NSInteger) size;
- (NSIndexSet *) previousFinishedPieces;
- (void) setPreviousFinishedPieces: (NSIndexSet *) indexes;
2007-09-16 01:02:06 +00:00
- (void) update;
2011-08-28 00:07:30 +00:00
- (void) startTransferIgnoringQueue: (BOOL) ignoreQueue;
- (void) startTransferNoQueue;
2007-09-16 01:02:06 +00:00
- (void) startTransfer;
- (void) stopTransfer;
- (void) sleep;
- (void) wakeUp;
2011-08-11 01:54:14 +00:00
- (NSInteger) queuePosition;
- (void) setQueuePosition: (NSUInteger) index;
2007-09-16 01:02:06 +00:00
- (void) manualAnnounce;
- (BOOL) canManualAnnounce;
- (void) resetCache;
- (BOOL) isMagnet;
- (NSString *) magnetLink;
2008-11-02 01:07:01 +00:00
- (CGFloat) ratio;
- (tr_ratiolimit) ratioSetting;
- (void) setRatioSetting: (tr_ratiolimit) setting;
2008-11-02 01:07:01 +00:00
- (CGFloat) ratioLimit;
- (void) setRatioLimit: (CGFloat) limit;
- (CGFloat) progressStopRatio;
2007-09-16 01:02:06 +00:00
- (tr_idlelimit) idleSetting;
- (void) setIdleSetting: (tr_idlelimit) setting;
- (NSUInteger) idleLimitMinutes;
- (void) setIdleLimitMinutes: (NSUInteger) limit;
- (BOOL) usesSpeedLimit: (BOOL) upload;
- (void) setUseSpeedLimit: (BOOL) use upload: (BOOL) upload;
2008-11-02 01:07:01 +00:00
- (NSInteger) speedLimit: (BOOL) upload;
- (void) setSpeedLimit: (NSInteger) limit upload: (BOOL) upload;
- (BOOL) usesGlobalSpeedLimit;
- (void) setUseGlobalSpeedLimit: (BOOL) use;
2007-09-16 01:02:06 +00:00
- (void) setMaxPeerConnect: (uint16_t) count;
- (uint16_t) maxPeerConnect;
@property (nonatomic) BOOL removeWhenFinishSeeding;
2007-09-16 01:02:06 +00:00
- (BOOL) waitingToStart;
- (tr_priority_t) priority;
- (void) setPriority: (tr_priority_t) priority;
2012-06-03 23:29:39 +00:00
+ (void) trashFile: (NSString *) path;
2007-09-16 01:02:06 +00:00
- (void) moveTorrentDataFileTo: (NSString *) folder;
- (void) copyTorrentFileTo: (NSString *) path;
- (BOOL) alertForRemainingDiskSpace;
- (NSImage *) icon;
- (NSString *) name;
- (BOOL) isFolder;
2007-09-16 01:02:06 +00:00
- (uint64_t) size;
- (uint64_t) sizeLeft;
2008-02-22 01:36:30 +00:00
- (NSMutableArray *) allTrackerStats;
2009-10-11 17:17:29 +00:00
- (NSArray *) allTrackersFlat; //used by GroupRules
- (BOOL) addTrackerToNewTier: (NSString *) tracker;
- (void) removeTrackers: (NSSet *) trackers;
2007-09-16 01:02:06 +00:00
- (NSString *) comment;
- (NSString *) creator;
- (NSDate *) dateCreated;
2008-11-02 01:07:01 +00:00
- (NSInteger) pieceSize;
- (NSInteger) pieceCount;
2007-09-16 01:02:06 +00:00
- (NSString *) hashString;
- (BOOL) privateTorrent;
- (NSString *) torrentLocation;
- (NSString *) dataLocation;
- (NSString *) fileLocation: (FileListNode *) node;
2007-09-16 01:02:06 +00:00
- (void) renameTorrent: (NSString *) newName completionHandler: (void (^)(BOOL didRename)) completionHandler;
- (void) renameFileNode: (FileListNode *) node withName: (NSString *) newName completionHandler: (void (^)(BOOL didRename)) completionHandler;
2008-11-02 01:07:01 +00:00
- (CGFloat) progress;
- (CGFloat) progressDone;
- (CGFloat) progressLeft;
2008-11-02 01:07:01 +00:00
- (CGFloat) checkingProgress;
- (CGFloat) availableDesired;
2007-09-16 01:02:06 +00:00
- (BOOL) isActive;
- (BOOL) isSeeding;
- (BOOL) isChecking;
- (BOOL) isCheckingWaiting;
2007-09-16 01:02:06 +00:00
- (BOOL) allDownloaded;
- (BOOL) isComplete;
- (BOOL) isFinishedSeeding;
2007-09-16 01:02:06 +00:00
- (BOOL) isError;
- (BOOL) isAnyErrorOrWarning;
2007-09-16 01:02:06 +00:00
- (NSString *) errorMessage;
- (NSArray *) peers;
- (NSUInteger) webSeedCount;
2008-06-08 18:02:16 +00:00
- (NSArray *) webSeeds;
2007-09-16 01:02:06 +00:00
- (NSString *) progressString;
- (NSString *) statusString;
- (NSString *) shortStatusString;
- (NSString *) remainingTimeString;
- (NSString *) stateString;
2008-11-02 01:07:01 +00:00
- (NSInteger) totalPeersConnected;
- (NSInteger) totalPeersTracker;
- (NSInteger) totalPeersIncoming;
- (NSInteger) totalPeersCache;
- (NSInteger) totalPeersPex;
- (NSInteger) totalPeersDHT;
- (NSInteger) totalPeersLocal;
- (NSInteger) totalPeersLTEP;
2007-09-16 01:02:06 +00:00
2008-11-02 01:07:01 +00:00
- (NSInteger) peersSendingToUs;
- (NSInteger) peersGettingFromUs;
2007-09-16 01:02:06 +00:00
2008-11-02 01:07:01 +00:00
- (CGFloat) downloadRate;
- (CGFloat) uploadRate;
- (CGFloat) totalRate;
- (uint64_t) haveVerified;
- (uint64_t) haveTotal;
2008-02-27 19:34:55 +00:00
- (uint64_t) totalSizeSelected;
- (uint64_t) downloadedTotal;
- (uint64_t) uploadedTotal;
- (uint64_t) failedHash;
2007-09-16 01:02:06 +00:00
2008-11-02 01:07:01 +00:00
- (NSInteger) groupValue;
- (void) setGroupValue: (NSInteger) groupValue determinationType: (TorrentDeterminationType) determinationType;;
2008-11-02 01:07:01 +00:00
- (NSInteger) groupOrderValue;
- (void) checkGroupValueForRemoval: (NSNotification *) notification;
2007-12-17 16:06:20 +00:00
2007-09-16 01:02:06 +00:00
- (NSArray *) fileList;
2010-01-02 02:50:22 +00:00
- (NSArray *) flatFileList;
2008-11-02 01:07:01 +00:00
- (NSInteger) fileCount;
2007-09-16 01:02:06 +00:00
- (void) updateFileStat;
//methods require fileStats to have been updated recently to be accurate
2008-11-02 01:07:01 +00:00
- (CGFloat) fileProgress: (FileListNode *) node;
2009-12-26 00:02:20 +00:00
- (BOOL) canChangeDownloadCheckForFile: (NSUInteger) index;
2007-09-16 01:02:06 +00:00
- (BOOL) canChangeDownloadCheckForFiles: (NSIndexSet *) indexSet;
2008-11-02 01:07:01 +00:00
- (NSInteger) checkForFiles: (NSIndexSet *) indexSet;
- (void) setFileCheckState: (NSInteger) state forIndexes: (NSIndexSet *) indexSet;
- (void) setFilePriority: (tr_priority_t) priority forIndexes: (NSIndexSet *) indexSet;
- (BOOL) hasFilePriority: (tr_priority_t) priority forIndexes: (NSIndexSet *) indexSet;
2007-09-16 01:02:06 +00:00
- (NSSet *) filePrioritiesForIndexes: (NSIndexSet *) indexSet;
- (NSDate *) dateAdded;
- (NSDate *) dateCompleted;
- (NSDate *) dateActivity;
- (NSDate *) dateActivityOrAdd;
2007-09-16 01:02:06 +00:00
- (NSInteger) secondsDownloading;
- (NSInteger) secondsSeeding;
2008-11-02 01:07:01 +00:00
- (NSInteger) stalledMinutes;
2007-09-16 01:02:06 +00:00
- (BOOL) isStalled;
- (void) updateTimeMachineExclude;
- (NSInteger) stateSortKey;
- (NSString *) trackerSortKey;
2007-09-16 01:02:06 +00:00
- (tr_torrent *) torrentStruct;
2007-09-16 01:02:06 +00:00
@end