Class DownloadManagerImpl

java.lang.Object

com.biglybt.core.logging.LogRelation

com.biglybt.core.download.impl.DownloadManagerImpl

All Implemented Interfaces:

DiskManagerUtil.MoveTaskAapter, DownloadManager, Taggable, DataSourceResolver.ExportableDataSource, Taggable

public class DownloadManagerImpl
extends LogRelation
implements DownloadManager, Taggable, DataSourceResolver.ExportableDataSource, DiskManagerUtil.MoveTaskAapter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	DownloadManagerImpl.NoStackException

Field Summary

Fields

Modifier and Type	Field	Description
private TRTrackerAnnouncer	_tracker_client
private TRTrackerAnnouncer	_tracker_client_for_queued_download
private final CopyOnWriteList<DownloadManagerActivationListener>	activation_listeners
private static final AllTrackersManager.AllTrackers	all_trackers
private boolean	assumedComplete	Pretend this download is complete while not running, even if it has no data.
private File	cached_save_location
private File	cached_save_location_result
private static final String	CFG_MOVE_COMPLETED_TOP
private static final ClientIDManagerImpl	client_id_manager
private boolean	constructed
(package private) final DownloadManagerController	controller
private long	creation_time
private int	crypto_level
(package private) final Map<PEPeer,String>	current_peers
private final Map<PEPeer,Long>	current_peers_unmatched_removal
private final List<PEPiece>	current_pieces
private int	current_upload_when_busy_bps
private Map<Object,Object>	data
private boolean	data_already_allocated
private static int	default_light_seeding_status
private static final Download.SeedingRank	defaultSeedingRank
private boolean	destroyed
private String	display_name
private byte[]	dl_identity
private int	dl_identity_hashcode
private boolean	dl_identity_obtained
static String	dnd_alt_loc
static String	dnd_subfolder
(package private) DownloadManagerState	download_manager_state
private static final DownloadManagerListener	global_dm_listener
(package private) static final CopyOnWriteList<DownloadManagerListener>	global_dm_listeners
(package private) final GlobalManager	globalManager
private Object	init_lock
private boolean	initialised
private String	internal_name
private int	last_informed_state	forceStarted torrents can't/shouldn't be automatically stopped
private long	last_upload_when_busy_dec_time
private long	last_upload_when_busy_update
private boolean	latest_informed_force_start
private static final int	LDT_COMPLETIONCHANGED
private static final int	LDT_DOWNLOADCOMPLETE
private static final int	LDT_FILELOCATIONCHANGED
private static final int	LDT_FILEPRIORITYCHANGED
private static final int	LDT_PE_PEER_ADDED
private static final int	LDT_PE_PEER_REMOVED
private static final int	LDT_PE_PIECE_ADDED
private static final int	LDT_PE_PIECE_REMOVED
private static final int	LDT_PE_PM_ADDED
private static final int	LDT_PE_PM_REMOVED
private static final int	LDT_POSITIONCHANGED
private static final int	LDT_STATECHANGED
private static final int	LDT_TL_ANNOUNCERESULT
private static final int	LDT_TL_SCRAPERESULT
private int	light_seeding_status
private static final ThreadLocal<Boolean>	links_changing
private final ListenerManager<DownloadManagerListener>	listeners
(package private) static final ListenerManager<DownloadManagerListener>	listeners_aggregator
private final AEMonitor	listeners_mon
private int	max_connections
private static int	max_connections_npp_extra
private int	max_connections_when_seeding
private boolean	max_connections_when_seeding_enabled
private int	max_seed_connections
private int	max_upload_when_busy_bps
private int	max_uploads
private int	max_uploads_when_seeding
private boolean	max_uploads_when_seeding_enabled
private int	message_mode
private long[]	move_progress
private int	move_state
private String	move_subtask
private boolean	open_for_seeding
private final ListenerManager<DownloadManagerPeerListener>	peer_listeners
(package private) static final ListenerManager<DownloadManagerPeerListener>	peer_listeners_aggregator
(package private) final AEMonitor	peer_listeners_mon
private final boolean	persistent
private final ListenerManager<DownloadManagerPieceListener>	piece_listeners
(package private) static final ListenerManager<DownloadManagerPieceListener>	piece_listeners_aggregator
private final AEMonitor	piece_listeners_mon
private static Object	port_init_lock
private int	position
private List<Runnable>	post_init_tasks
private Object[]	read_torrent_state
private boolean	removing
private long	resume_time
private static Map<String,Boolean>	save_dir_check_cache
private static TimerEventPeriodic	save_dir_check_timer
private static final long	SCRAPE_DELAY_ERROR_TORRENTS
private static final long	SCRAPE_DELAY_STOPPED_TORRENTS
private static final long	SCRAPE_INITDELAY_ERROR_TORRENTS
private static final long	SCRAPE_INITDELAY_STOPPED_TORRENTS
private final long	scrape_random_seed
private Download.SeedingRank	seedingRank
private int	set_file_priority_high_percent_rem
private int	set_file_priority_high_pieces_rem
private final DownloadManagerStatsImpl	stats
private AtomicLong	tagMutationCounter
private int	tcp_port_override
protected final AEMonitor	this_mon
private TOTorrent	torrent
private String	torrent_comment
private String	torrent_created_by
private File	torrent_save_location
private boolean	torrentFileExplicitlyDeleted
private String	torrentFileName
(package private) static final Object	TPS_Key
private List<DownloadManagerTPSListener>	tps_listeners
private final TRTrackerAnnouncerListener	tracker_client_listener
private final TRTrackerAnnouncerListener	tracker_client_stats_listener
(package private) final ListenerManager<DownloadManagerTrackerListener>	tracker_listeners
private static Object	TTP_KEY
private int	upload_priority_auto
private int	upload_priority_manual
private static int	upload_when_busy_min_secs
private Map<String,Object[]>	url_group_map
private long	url_group_map_uid

Fields inherited from interface DataSourceResolver.ExportableDataSource

OPT_CAN_MINIMIZE, OPT_ON_TOP

Fields inherited from interface DownloadManager

EF_WAS_FORCE_START, ET_FILE_MISSING, ET_INSUFFICIENT_SPACE, ET_NONE, ET_OTHER, ET_STOP_DURING_INIT, STATE_ALLOCATING, STATE_CHECKING, STATE_CLOSED, STATE_DOWNLOADING, STATE_ERROR, STATE_FINISHING, STATE_INITIALIZED, STATE_INITIALIZING, STATE_QUEUED, STATE_READY, STATE_SEEDING, STATE_START_OF_DAY, STATE_STOPPED, STATE_STOPPING, STATE_WAITING, UD_KEY_QUEUE_REASON, UD_KEY_START_REASON, UD_KEY_STOP_REASON, WEALTH_ERROR, WEALTH_KO, WEALTH_NO_REMOTE, WEALTH_NO_TRACKER, WEALTH_OK, WEALTH_STOPPED

Fields inherited from interface Taggable

TT_DOWNLOAD, TT_NONE, TT_PEER

Constructor Summary

Constructors

Constructor	Description
DownloadManagerImpl(GlobalManager _gm, byte[] _torrent_hash, String _torrentFileName, String _torrent_save_dir, String _torrent_save_file, int _initialState, boolean _persistent, boolean _recovered, boolean _open_for_seeding, boolean _has_ever_been_started, List _file_priorities)

Method Summary

Modifier and Type	Method	Description
protected boolean	activateRequest(int count)
void	addActivationListener(DownloadManagerActivationListener listener)
void	addDiskListener(DownloadManagerDiskListener listener)
static void	addGlobalDownloadListener(DownloadManagerListener listener)
void	addListener(DownloadManagerListener listener)
void	addListener(DownloadManagerListener listener, boolean triggerStateChange)
void	addPeer(PEPeer peer)
void	addPeerListener(DownloadManagerPeerListener listener)
void	addPeerListener(DownloadManagerPeerListener listener, boolean bDispatchForExisting)
void	addPiece(PEPiece piece)
void	addPieceListener(DownloadManagerPieceListener listener)
void	addPieceListener(DownloadManagerPieceListener listener, boolean bDispatchForExisting)
void	addRateLimiter(LimitedRateGroup group, boolean upload)
void	addTPSListener(DownloadManagerTPSListener listener)
void	addTrackerListener(DownloadManagerTrackerListener listener)
private void	buildURLGroupMap(TOTorrent torrent)
private void	calcFilePriorityStats()
boolean	canExportDownload()
boolean	canForceRecheck()
boolean	canMoveDataFiles()
private void	checkFilePriorities(boolean global_change)
void	checkLightSeeding(boolean full_sync)
private boolean	checkResuming()
protected void	clearFileLinks()
void	copyDataFiles(File dest_parent_dir, CoreOperationTask.ProgressCallback cb)
private void	copyTorrentFile(File parent_dir)
protected void	deleteDataFiles()
private void	deleteDNDAltLoc()
protected void	deletePartialDataFiles()
protected void	deleteTorrentFile()
void	destroy(boolean is_duplicate)	Indicates that the download manager is no longer needed
protected void	downloadEnded(boolean never_downloaded)	Is called when a download is finished.
boolean	equals(Object obj)
DataSourceResolver.ExportedDataSource	exportDataSource()
void	exportDownload(File parent_dir)
protected void	fileLinksUpdated()
boolean	filesExist(boolean expected_to_be_allocated, boolean test_only)
void	fireGlobalManagerEvent(int eventType, Object eventData)
void	forceRecheck()
void	generateEvidence(IndentWriter writer, boolean full)
File	getAbsoluteSaveLocation()	Returns the file location where we save the torrent, this includes the parent directory and the actual file name.
int	getActivationCount()
protected Object[]	getActiveScrapeResponse()	Returns the "first" online scrape response found, and its active URL, otherwise one of the failing scrapes
boolean	getAssumedComplete()	Retrieve whether this download is assumed complete.
long	getAutoResumeTime()
long	getCreationTime()	gives the time this download was created (not the torrent but the download itself)
int	getCryptoLevel()
PEPeer[]	getCurrentPeers()
PEPiece[]	getCurrentPieces()
DiskManager	getDiskManager()
DiskManagerFileInfo[]	getDiskManagerFileInfo()	Deprecated. use getDiskManagerFileInfoSet() instead
DiskManagerFileInfoSet	getDiskManagerFileInfoSet()
DiskManagerPiece[]	getDiskManagerPiecesSnapshot()
String	getDisplayName()
DownloadManagerState	getDownloadState()
int	getEffectiveMaxUploads()	Returns the max uploads depending on whether the download is seeding and it has a separate rate for this
int	getEffectiveUploadPriority()
int	getEffectiveUploadRateLimitBytesPerSecond()	returns the currently in force upload speed limit which may vary from the stats.
String	getErrorDetails()
int	getErrorFlags()
int	getErrorType()
int	getExtendedMessagingMode()
GlobalManager	getGlobalManager()
List<TRTrackerScraperResponse>	getGoodTrackerScrapeResponses()
int	getHealthStatus()
private byte[]	getIdentity()
String	getInternalName()	returns a name based on the torrent hash or an empty string if torrent invalid
private int	getLightSeedTrackerStatus(String name)
protected int[]	getMaxConnections(boolean mixed)
protected int[]	getMaxConnectionsWhenSeeding(boolean mixed)
protected int[]	getMaxSeedConnections(boolean mixed)
int	getMaxUploads()
protected int	getMaxUploadsWhenSeeding()
long[]	getMoveProgress()	Progress of a move operation
String	getMoveSubTask()
Object[]	getNATStatus()	See plugin ConnectionManager.NAT_ constants for return values
int	getNbPeers()
int	getNbPieces()
int	getNbSeeds()
int	getNumFileInfos()
PEPeerManager	getPeerManager()
String	getPieceLength()
int	getPosition()
Object[]	getQueryableInterfaces()	Query this class for a reference to another class that it may hold
String	getQueueReason()
LimitedRateGroup[]	getRateLimiters(boolean upload)
String	getRelationText()	A short description of what your class holds that can be printed by the logger
File	getSaveLocation()
Download.SeedingRank	getSeedingRank()
long	getSize()
String	getStartReason()
int	getState()
DownloadManagerStats	getStats()
String	getStopReason()
int[]	getStorageType(DiskManagerFileInfo[] info)
int	getSubState()	For stopping this returns the target state after stopping (stopped/queued)
String	getSwarmMergingInfo()
String	getTaggableID()
String	getTaggableName()
TaggableResolver	getTaggableResolver()
Object	getTaggableTransientProperty(String key)
int	getTaggableType()
long	getTagMutationCount()
int	getTCPListeningPortNumber()
protected int	getTCPPortOverride(boolean only_if_allocated)
TOTorrent	getTorrent()
String	getTorrentComment()
String	getTorrentCreatedBy()
long	getTorrentCreationDate()
String	getTorrentFileName()	This includes the full path to the torrent file.
protected HashWrapper	getTorrentHashOverride()
TRTrackerAnnouncer	getTrackerClient()
List<TrackerPeerSource>	getTrackerPeerSources()
TRTrackerScraperResponse	getTrackerScrapeResponse()
String	getTrackerStatus()
int	getTrackerTime()	When the next call to the tracker will occur (in seconds)
protected int	getTrackerURLGroup(String key)
Object	getUserData(Object key)	To retreive arbitrary objects against a download.
int	hashCode()
protected void	informDownloadEnded()
protected void	informFileCompletionChange(DiskManagerFileInfo file)
protected void	informLocationChange(int file_index)
protected void	informLocationChange(DiskManagerFileInfo file)
protected void	informPieceDoneChanged(DiskManagerPiece piece)
protected void	informPositionChanged(int new_position)
protected void	informPrioritiesChange(List files)
protected void	informPriorityChange(List<DiskManagerFileInfo> files)
protected void	informStarted(PEPeerManager pm)
protected void	informStateChanged()	Doesn't not inform if state didn't change from last inform call
protected void	informStopped(PEPeerManager pm, boolean for_queue)
void	informTPSChanged()
protected void	informWillBeStarted(PEPeerManager pm)
void	initialize()
boolean	isConstructed()
boolean	isDataAlreadyAllocated()	Determine whether disk allocation has already been done.
boolean	isDestroyed()
boolean	isDownloadComplete(boolean bIncludeDND)	Retrieves whether the download is complete
boolean	isForceRechecking()
boolean	isForceStart()
boolean	isInDefaultSaveDir()	Returns true if the download is being saved to one of the default save directories.
protected boolean	isLightSeedTracker(InetSocketAddress isa)
protected boolean	isMaxConnectionsWhenSeedingEnabled()
protected boolean	isMaxUploadsWhenSeedingEnabled()
boolean	isPaused()
boolean	isPersistent()
boolean	isSwarmMerging()
boolean	isTrackerError()
boolean	isUnauthorisedOnTracker()
void	moveDataFiles(File new_parent_dir)	Move data files to new location.
void	moveDataFiles(File destination, String new_name)	Move the files and rename a download in one go.
void	moveDataFiles(File destination, String new_name, boolean live)
void	moveDataFilesLive(File new_parent_dir)	At some point someone made the file-move operations stop+restart the download when it was designed to work without doing this (see move-on-complete for example).
(package private) void	moveDataFilesSupport(File new_parent_dir, String new_filename)
(package private) void	moveDataFilesSupport0(File new_parent_dir, String new_filename)
void	moveTorrentFile(File new_parent_dir)	Move torrent file to new location.
void	moveTorrentFile(File new_parent_dir, String new_name)
private void	moveTorrentFile0(File new_parent_dir, String new_name)
boolean	pause(boolean only_if_active)
boolean	pause(boolean only_if_active, long _resume_time)
protected void	rateLimitChanged()
private void	readFilePriorityConfig(boolean init, boolean global_change)
protected void	readParameters()
protected void	readTorrent()
private void	readTorrent(String torrent_save_dir, String torrent_save_file, byte[] torrent_hash, boolean new_torrent, boolean for_seeding, boolean has_ever_been_started, int initial_state)
void	recheckFile(DiskManagerFileInfo file)	Recheck a particular file.
void	removeActivationListener(DownloadManagerActivationListener listener)
void	removeDiskListener(DownloadManagerDiskListener listener)
static void	removeGlobalDownloadListener(DownloadManagerListener listener)
void	removeListener(DownloadManagerListener listener)
void	removePeer(PEPeer peer)
void	removePeerListener(DownloadManagerPeerListener listener)
void	removePiece(PEPiece piece)
void	removePieceListener(DownloadManagerPieceListener listener)
void	removeRateLimiter(LimitedRateGroup group, boolean upload)
void	removeTPSListener(DownloadManagerTPSListener listener)
void	removeTrackerListener(DownloadManagerTrackerListener listener)
void	rename(String name)	Renames the save file, torrent file and the displayed name.
void	renameDownload(String new_name)	Rename the download - this means the name of the file being downloaded (for single file torrents), or the name of the directory holding the files (in a multi-file torrent).
void	renameTorrent(String name)
void	renameTorrentSafe(String name)	Same as renameTorrent, but appends numbers if torrent already exists
void	requestAllocation(List<DiskManagerFileInfo> files)	Instructions that file given files need allocation - used when switching file storage types/skipped state Will pause and resume the download if it is active
boolean	requestAssumedCompleteMode()	Will set this download to be "assumed complete" for if the download is already complete (excluding DND)
protected boolean	requestAssumedCompleteMode(boolean filePriorityChanged)
void	requestAttention()
void	requestTrackerAnnounce(boolean force)
void	requestTrackerScrape(boolean force)
void	resetFile(DiskManagerFileInfo file)	Reset the file download state to totally undownloaded.
protected void	restoreResumeData(Map data)
void	resume()
boolean	resume(int target_state)	resume the download and wait until it reaches the target state.
void	saveDownload(boolean interim)	persist any general download related information, excluding resume data which is managed separately by saveResumeData
void	saveResumeData()	persist resume data
boolean	seedPieceRecheck()	Gives the download an opportunity to schedule seeding mode piece rechecks if desired
void	setAnnounceResult(DownloadAnnounceResult result)
protected void	setAssumedComplete(boolean _assumedComplete)
protected void	setAssumedComplete(boolean _assumedComplete, boolean filePriorityChanged)
void	setAutoResumeTime(long time)
void	setConstructed()
void	setCreationTime(long t)
void	setCryptoLevel(int level)
void	setDataAlreadyAllocated(boolean already_allocated)	Set whether data allocation has already been done, so we know when to allocate and when to throw a missing-data error message.
void	setErrorState(int errorType, String errorDetails, int errorFlags)	Download must be stopped - used at start-of-day to recover error state
protected void	setFailed(int error, String str)
protected void	setFailed(String str)
protected void	setFailed(String str, Throwable e)
void	setForceStart(boolean forceStart)
void	setManualUploadPriority(int priority)
void	setMaxUploads(int max)
void	setMoveState(int state)
void	setPieceCheckingEnabled(boolean enabled)	Use with care - introduced to support speed tests whereby we want to avoid checking the virtual torrent used for the test
void	setPosition(int new_position)
void	setQueueReason(String reason)
void	setScrapeResult(DownloadScrapeResult result)
void	setSeedingRank(Download.SeedingRank rank)
void	setStartReason(String reason)
void	setStateFinishing()
void	setStateQueued()
void	setStateWaiting()
void	setStopReason(String reason)
void	setTaggableTransientProperty(String key, Object value)
void	setTorrentFile(File new_parent_dir, String new_name)	Sets the torrent file name (will perform a move of the torrent file) - this shouldn't be used unless you know what you are doing (it requires the download to be stopped!) - it is safer to use moveTorrentFile instead.
void	setTorrentFileName(String string)
protected void	setTorrentInvalid(Throwable cause)
void	setTorrentSaveDir(File _new_location, boolean locationIncludesName)	changes the save directory.
protected void	setTrackerRefreshDelayOverrides(int percent)
void	setTrackerScrapeResponse(TRTrackerScraperResponse response)
void	setUserData(Object key, Object value)	To store arbitrary objects against a download.
void	startDownload()
private void	startQueuedTrackerClient()
void	stopIt(int state_after_stopping, boolean remove_torrent, boolean remove_data)	Stop the download manager, and do any file/torrent removals.
void	stopIt(int state_after_stopping, boolean remove_torrent, boolean remove_data, boolean for_removal)	As above but definitely indicates that the stop is for removal (if for_removal is true) and therefore that any removal specific actions such as removing partial files should be performed
boolean	stopPausedDownload()
private void	stopQueuedTrackerClient()
void	syncGlobalConfig()	Called for certain config change events so that individual managers don't have to separately listener for changes
String	toString()
void	updateAutoUploadPriority(Object key, boolean inc)
private void	updateFileLink(int file_index, File old_path, File new_path, File from_loc_maybe_null, File to_loc, List<Integer> from_indexes, List<File> from_links, List<File> to_links)
private void	updateFileLinks(File old_save_path, File new_save_path)
void	updateTagMutationCount()

Methods inherited from class LogRelation

propogatedRelationText, queryForClass

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface DataSourceResolver.ExportableDataSource

getBooleanOption

Methods inherited from interface DownloadManager

filesExist, fireGlobalManagerEvent, isMetadataDownload, setTorrentSaveDir

Field Details

SCRAPE_DELAY_ERROR_TORRENTS

private static final long SCRAPE_DELAY_ERROR_TORRENTS

See Also:

• Constant Field Values

SCRAPE_DELAY_STOPPED_TORRENTS

private static final long SCRAPE_DELAY_STOPPED_TORRENTS

See Also:

• Constant Field Values

SCRAPE_INITDELAY_ERROR_TORRENTS

private static final long SCRAPE_INITDELAY_ERROR_TORRENTS

See Also:

• Constant Field Values

SCRAPE_INITDELAY_STOPPED_TORRENTS

private static final long SCRAPE_INITDELAY_STOPPED_TORRENTS

See Also:

• Constant Field Values

upload_when_busy_min_secs

private static int upload_when_busy_min_secs

max_connections_npp_extra

private static int max_connections_npp_extra

default_light_seeding_status

private static int default_light_seeding_status

client_id_manager

private static final ClientIDManagerImpl client_id_manager

CFG_MOVE_COMPLETED_TOP

private static final String CFG_MOVE_COMPLETED_TOP

See Also:

• Constant Field Values

LDT_STATECHANGED

private static final int LDT_STATECHANGED

See Also:

• Constant Field Values

LDT_DOWNLOADCOMPLETE

private static final int LDT_DOWNLOADCOMPLETE

See Also:

• Constant Field Values

LDT_COMPLETIONCHANGED

private static final int LDT_COMPLETIONCHANGED

See Also:

• Constant Field Values

LDT_POSITIONCHANGED

private static final int LDT_POSITIONCHANGED

See Also:

• Constant Field Values

LDT_FILEPRIORITYCHANGED

private static final int LDT_FILEPRIORITYCHANGED

See Also:

• Constant Field Values

LDT_FILELOCATIONCHANGED

private static final int LDT_FILELOCATIONCHANGED

See Also:

• Constant Field Values

port_init_lock

private static Object port_init_lock

listeners_mon

private final AEMonitor listeners_mon

listeners_aggregator

static final ListenerManager<DownloadManagerListener> listeners_aggregator

global_dm_listeners

static final CopyOnWriteList<DownloadManagerListener> global_dm_listeners

global_dm_listener

private static final DownloadManagerListener global_dm_listener

defaultSeedingRank

private static final Download.SeedingRank defaultSeedingRank

all_trackers

private static final AllTrackersManager.AllTrackers all_trackers

listeners

private final ListenerManager<DownloadManagerListener> listeners

LDT_TL_ANNOUNCERESULT

private static final int LDT_TL_ANNOUNCERESULT

See Also:

• Constant Field Values

LDT_TL_SCRAPERESULT

private static final int LDT_TL_SCRAPERESULT

See Also:

• Constant Field Values

tracker_listeners

final ListenerManager<DownloadManagerTrackerListener> tracker_listeners

LDT_PE_PEER_ADDED

private static final int LDT_PE_PEER_ADDED

See Also:

• Constant Field Values

LDT_PE_PEER_REMOVED

private static final int LDT_PE_PEER_REMOVED

See Also:

• Constant Field Values

LDT_PE_PM_ADDED

private static final int LDT_PE_PM_ADDED

See Also:

• Constant Field Values

LDT_PE_PM_REMOVED

private static final int LDT_PE_PM_REMOVED

See Also:

• Constant Field Values

peer_listeners_aggregator

static final ListenerManager<DownloadManagerPeerListener> peer_listeners_aggregator

TPS_Key

static final Object TPS_Key

dnd_subfolder

public static volatile String dnd_subfolder

dnd_alt_loc

public static volatile String dnd_alt_loc

save_dir_check_cache

private static Map<String,Boolean> save_dir_check_cache

save_dir_check_timer

private static TimerEventPeriodic save_dir_check_timer

peer_listeners

private final ListenerManager<DownloadManagerPeerListener> peer_listeners

peer_listeners_mon

final AEMonitor peer_listeners_mon

current_peers

final Map<PEPeer,String> current_peers

current_peers_unmatched_removal

private final Map<PEPeer,Long> current_peers_unmatched_removal

LDT_PE_PIECE_ADDED

private static final int LDT_PE_PIECE_ADDED

See Also:

• Constant Field Values

LDT_PE_PIECE_REMOVED

private static final int LDT_PE_PIECE_REMOVED

See Also:

• Constant Field Values

piece_listeners_aggregator

static final ListenerManager<DownloadManagerPieceListener> piece_listeners_aggregator

piece_listeners

private final ListenerManager<DownloadManagerPieceListener> piece_listeners

constructed

private boolean constructed

init_lock

private Object init_lock

initialised

private boolean initialised

post_init_tasks

private List<Runnable> post_init_tasks

tps_listeners

private List<DownloadManagerTPSListener> tps_listeners

piece_listeners_mon

private final AEMonitor piece_listeners_mon

current_pieces

private final List<PEPiece> current_pieces

controller

final DownloadManagerController controller

stats

private final DownloadManagerStatsImpl stats

this_mon

protected final AEMonitor this_mon

persistent

private final boolean persistent

assumedComplete

private volatile boolean assumedComplete

Pretend this download is complete while not running, even if it has no data. When the torrent starts up, the real complete level will be checked (probably by DiskManager), and if the torrent actually does have missing data at that point, the download will be thrown into error state.

Only a forced-recheck should clear this flag.

Current Implementation:
- implies that the user completed the download at one point
- Checks if there's Data Missing when torrent is done (or torrent load)

last_informed_state

private int last_informed_state

forceStarted torrents can't/shouldn't be automatically stopped

latest_informed_force_start

private boolean latest_informed_force_start

resume_time

private long resume_time

globalManager

final GlobalManager globalManager

torrentFileName

private String torrentFileName

torrentFileExplicitlyDeleted

private boolean torrentFileExplicitlyDeleted

open_for_seeding

private boolean open_for_seeding

display_name

private String display_name

internal_name

private String internal_name

torrent_save_location

private File torrent_save_location

position

private int position

read_torrent_state

private Object[] read_torrent_state

download_manager_state

DownloadManagerState download_manager_state

torrent

private TOTorrent torrent

torrent_comment

private String torrent_comment

torrent_created_by

private String torrent_created_by

url_group_map

private volatile Map<String,Object[]> url_group_map

url_group_map_uid

private volatile long url_group_map_uid

_tracker_client

private volatile TRTrackerAnnouncer _tracker_client

_tracker_client_for_queued_download

private volatile TRTrackerAnnouncer _tracker_client_for_queued_download

light_seeding_status

private volatile int light_seeding_status

tracker_client_listener

private final TRTrackerAnnouncerListener tracker_client_listener

tracker_client_stats_listener

private final TRTrackerAnnouncerListener tracker_client_stats_listener

activation_listeners

private final CopyOnWriteList<DownloadManagerActivationListener> activation_listeners

scrape_random_seed

private final long scrape_random_seed

data

private volatile Map<Object,Object> data

data_already_allocated

private boolean data_already_allocated

creation_time

private long creation_time

seedingRank

private Download.SeedingRank seedingRank

dl_identity_obtained

private boolean dl_identity_obtained

dl_identity

private byte[] dl_identity

dl_identity_hashcode

private int dl_identity_hashcode

max_uploads

private int max_uploads

max_connections

private int max_connections

max_connections_when_seeding

private int max_connections_when_seeding

max_connections_when_seeding_enabled

private boolean max_connections_when_seeding_enabled

max_seed_connections

private int max_seed_connections

max_uploads_when_seeding

private int max_uploads_when_seeding

max_uploads_when_seeding_enabled

private boolean max_uploads_when_seeding_enabled

max_upload_when_busy_bps

private int max_upload_when_busy_bps

current_upload_when_busy_bps

private int current_upload_when_busy_bps

last_upload_when_busy_update

private long last_upload_when_busy_update

last_upload_when_busy_dec_time

private long last_upload_when_busy_dec_time

upload_priority_manual

private int upload_priority_manual

upload_priority_auto

private int upload_priority_auto

crypto_level

private int crypto_level

message_mode

private int message_mode

tcp_port_override

private volatile int tcp_port_override

set_file_priority_high_pieces_rem

private volatile int set_file_priority_high_pieces_rem

set_file_priority_high_percent_rem

private volatile int set_file_priority_high_percent_rem

tagMutationCounter

private AtomicLong tagMutationCounter

removing

private volatile boolean removing

destroyed

private volatile boolean destroyed

links_changing

private static final ThreadLocal<Boolean> links_changing

cached_save_location

private File cached_save_location

cached_save_location_result

private File cached_save_location_result

TTP_KEY

private static Object TTP_KEY

move_progress

private volatile long[] move_progress

move_subtask

private volatile String move_subtask

move_state

private volatile int move_state

Constructor Details

DownloadManagerImpl

public DownloadManagerImpl(GlobalManager _gm,
 byte[] _torrent_hash,
 String _torrentFileName,
 String _torrent_save_dir,
 String _torrent_save_file,
 int _initialState,
 boolean _persistent,
 boolean _recovered,
 boolean _open_for_seeding,
 boolean _has_ever_been_started,
 List _file_priorities)

Method Details

addGlobalDownloadListener

public static void addGlobalDownloadListener(DownloadManagerListener listener)

removeGlobalDownloadListener

public static void removeGlobalDownloadListener(DownloadManagerListener listener)

setConstructed

public void setConstructed()

Specified by:

setConstructed in interface DownloadManager

isConstructed

public boolean isConstructed()

Specified by:

isConstructed in interface DownloadManager

buildURLGroupMap

private void buildURLGroupMap(TOTorrent torrent)

getLightSeedTrackerStatus

private int getLightSeedTrackerStatus(String name)

getTrackerURLGroup

protected int getTrackerURLGroup(String key)

getTaggableType

public int getTaggableType()

Specified by:

getTaggableType in interface Taggable

getTaggableResolver

public TaggableResolver getTaggableResolver()

Specified by:

getTaggableResolver in interface Taggable

getTagMutationCount

public long getTagMutationCount()

Specified by:

getTagMutationCount in interface Taggable

updateTagMutationCount

public void updateTagMutationCount()

Specified by:

updateTagMutationCount in interface Taggable

getTaggableID

public String getTaggableID()

Specified by:

getTaggableID in interface Taggable

getTaggableName

public String getTaggableName()

Specified by:

getTaggableName in interface Taggable

exportDataSource

public DataSourceResolver.ExportedDataSource exportDataSource()

Specified by:

exportDataSource in interface DataSourceResolver.ExportableDataSource

readTorrent

private void readTorrent(String torrent_save_dir,
 String torrent_save_file,
 byte[] torrent_hash,
 boolean new_torrent,
 boolean for_seeding,
 boolean has_ever_been_started,
 int initial_state)

readTorrent

protected void readTorrent()

syncGlobalConfig

public void syncGlobalConfig()

Description copied from interface: DownloadManager

Called for certain config change events so that individual managers don't have to separately listener for changes

Specified by:

syncGlobalConfig in interface DownloadManager

readParameters

protected void readParameters()

readFilePriorityConfig

private void readFilePriorityConfig(boolean init,
 boolean global_change)

getMaxConnections

protected int[] getMaxConnections(boolean mixed)

getMaxConnectionsWhenSeeding

protected int[] getMaxConnectionsWhenSeeding(boolean mixed)

isMaxConnectionsWhenSeedingEnabled

protected boolean isMaxConnectionsWhenSeedingEnabled()

getMaxSeedConnections

protected int[] getMaxSeedConnections(boolean mixed)

isMaxUploadsWhenSeedingEnabled

protected boolean isMaxUploadsWhenSeedingEnabled()

getMaxUploadsWhenSeeding

protected int getMaxUploadsWhenSeeding()

updateAutoUploadPriority

public void updateAutoUploadPriority(Object key,
 boolean inc)

Specified by:

updateAutoUploadPriority in interface DownloadManager

getEffectiveUploadPriority

public int getEffectiveUploadPriority()

Specified by:

getEffectiveUploadPriority in interface DownloadManager

getMaxUploads

public int getMaxUploads()

Specified by:

getMaxUploads in interface DownloadManager

setMaxUploads

public void setMaxUploads(int max)

Specified by:

setMaxUploads in interface DownloadManager

setManualUploadPriority

public void setManualUploadPriority(int priority)

getEffectiveMaxUploads

public int getEffectiveMaxUploads()

Description copied from interface: DownloadManager

Returns the max uploads depending on whether the download is seeding and it has a separate rate for this

Specified by:

getEffectiveMaxUploads in interface DownloadManager

Returns:

rateLimitChanged

protected void rateLimitChanged()

getEffectiveUploadRateLimitBytesPerSecond

public int getEffectiveUploadRateLimitBytesPerSecond()

Description copied from interface: DownloadManager

returns the currently in force upload speed limit which may vary from the stats. value as this gives the fixed per-torrent limit

Specified by:

getEffectiveUploadRateLimitBytesPerSecond in interface DownloadManager

Returns:

fileLinksUpdated

protected void fileLinksUpdated()

clearFileLinks

protected void clearFileLinks()

updateFileLinks

private void updateFileLinks(File old_save_path,
 File new_save_path)

updateFileLink

private void updateFileLink(int file_index,
 File old_path,
 File new_path,
 File from_loc_maybe_null,
 File to_loc,
 List<Integer> from_indexes,
 List<File> from_links,
 List<File> to_links)

filesExist

public boolean filesExist(boolean expected_to_be_allocated,
 boolean test_only)

Specified by:

filesExist in interface DownloadManager

isPersistent

public boolean isPersistent()

Specified by:

isPersistent in interface DownloadManager

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface DownloadManager

getInternalName

public String getInternalName()

Description copied from interface: DownloadManager

returns a name based on the torrent hash or an empty string if torrent invalid

Specified by:

getInternalName in interface DownloadManager

Returns:

setErrorState

public void setErrorState(int errorType,
 String errorDetails,
 int errorFlags)

Description copied from interface: DownloadManager

Download must be stopped - used at start-of-day to recover error state

Specified by:

setErrorState in interface DownloadManager

Parameters:

errorType -

errorDetails -

getErrorDetails

public String getErrorDetails()

Specified by:

getErrorDetails in interface DownloadManager

getErrorType

public int getErrorType()

Specified by:

getErrorType in interface DownloadManager

getErrorFlags

public int getErrorFlags()

Specified by:

getErrorFlags in interface DownloadManager

getSize

public long getSize()

Specified by:

getSize in interface DownloadManager

setFailed

protected void setFailed(String str)

setFailed

protected void setFailed(int error,
 String str)

setFailed

protected void setFailed(String str,
 Throwable e)

setTorrentInvalid

protected void setTorrentInvalid(Throwable cause)

getTCPPortOverride

protected int getTCPPortOverride(boolean only_if_allocated)

getTorrentHashOverride

protected HashWrapper getTorrentHashOverride()

getTCPListeningPortNumber

public int getTCPListeningPortNumber()

Specified by:

getTCPListeningPortNumber in interface DownloadManager

saveResumeData

public void saveResumeData()

Description copied from interface: DownloadManager

persist resume data

Specified by:

saveResumeData in interface DownloadManager

saveDownload

public void saveDownload(boolean interim)

Description copied from interface: DownloadManager

persist any general download related information, excluding resume data which is managed separately by saveResumeData

Specified by:

saveDownload in interface DownloadManager

initialize

public void initialize()

Specified by:

initialize in interface DownloadManager

checkLightSeeding

public void checkLightSeeding(boolean full_sync)

Specified by:

checkLightSeeding in interface DownloadManager

isLightSeedTracker

protected boolean isLightSeedTracker(InetSocketAddress isa)

startQueuedTrackerClient

private void startQueuedTrackerClient()

stopQueuedTrackerClient

private void stopQueuedTrackerClient()

setStateWaiting

public void setStateWaiting()

Specified by:

setStateWaiting in interface DownloadManager

setStateFinishing

public void setStateFinishing()

setStateQueued

public void setStateQueued()

Specified by:

setStateQueued in interface DownloadManager

getState

public int getState()

Specified by:

getState in interface DownloadManager

getSubState

public int getSubState()

Description copied from interface: DownloadManager

For stopping this returns the target state after stopping (stopped/queued)

Specified by:

getSubState in interface DownloadManager

Returns:

canForceRecheck

public boolean canForceRecheck()

Specified by:

canForceRecheck in interface DownloadManager

restoreResumeData

protected void restoreResumeData(Map data)

forceRecheck

public void forceRecheck()

Specified by:

forceRecheck in interface DownloadManager

isForceRechecking

public boolean isForceRechecking()

Specified by:

isForceRechecking in interface DownloadManager

setPieceCheckingEnabled

public void setPieceCheckingEnabled(boolean enabled)

Description copied from interface: DownloadManager

Use with care - introduced to support speed tests whereby we want to avoid checking the virtual torrent used for the test

Specified by:

setPieceCheckingEnabled in interface DownloadManager

Parameters:

enabled -

resetFile

public void resetFile(DiskManagerFileInfo file)

Description copied from interface: DownloadManager

Reset the file download state to totally undownloaded. Download must be stopped

Specified by:

resetFile in interface DownloadManager

Parameters:

file -

recheckFile

public void recheckFile(DiskManagerFileInfo file)

Description copied from interface: DownloadManager

Recheck a particular file. Download must be stopped

Specified by:

recheckFile in interface DownloadManager

Parameters:

file -

requestAllocation

public void requestAllocation(List<DiskManagerFileInfo> files)

Description copied from interface: DownloadManager

Instructions that file given files need allocation - used when switching file storage types/skipped state Will pause and resume the download if it is active

Specified by:

requestAllocation in interface DownloadManager

Parameters:

files -

startDownload

public void startDownload()

Specified by:

startDownload in interface DownloadManager

stopIt

public void stopIt(int state_after_stopping,
 boolean remove_torrent,
 boolean remove_data)

Description copied from interface: DownloadManager

Stop the download manager, and do any file/torrent removals.

Specified by:

stopIt in interface DownloadManager

Parameters:

state_after_stopping -

remove_torrent - remove the .torrent file after stopping

remove_data - remove the data file after stopping

setStartReason

public void setStartReason(String reason)

Specified by:

setStartReason in interface DownloadManager

getStartReason

public String getStartReason()

Specified by:

getStartReason in interface DownloadManager

setQueueReason

public void setQueueReason(String reason)

Specified by:

setQueueReason in interface DownloadManager

getQueueReason

public String getQueueReason()

Specified by:

getQueueReason in interface DownloadManager

setStopReason

public void setStopReason(String reason)

Specified by:

setStopReason in interface DownloadManager

getStopReason

public String getStopReason()

Specified by:

getStopReason in interface DownloadManager

stopIt

public void stopIt(int state_after_stopping,
 boolean remove_torrent,
 boolean remove_data,
 boolean for_removal)

Description copied from interface: DownloadManager

As above but definitely indicates that the stop is for removal (if for_removal is true) and therefore that any removal specific actions such as removing partial files should be performed

Specified by:

stopIt in interface DownloadManager

Parameters:

state_after_stopping -

remove_torrent -

remove_data -

for_removal -

checkResuming

private boolean checkResuming()

pause

public boolean pause(boolean only_if_active)

Specified by:

pause in interface DownloadManager

Parameters:

only_if_active -

Returns:

true -> download was placed into a paused state (including if it was already paused)

pause

public boolean pause(boolean only_if_active,
 long _resume_time)

Specified by:

pause in interface DownloadManager

Parameters:

_resume_time -

Returns:

true -> download was placed into a paused state (including if it was already paused)

getAutoResumeTime

public long getAutoResumeTime()

Specified by:

getAutoResumeTime in interface DownloadManager

setAutoResumeTime

public void setAutoResumeTime(long time)

Specified by:

setAutoResumeTime in interface DownloadManager

stopPausedDownload

public boolean stopPausedDownload()

Specified by:

stopPausedDownload in interface DownloadManager

isPaused

public boolean isPaused()

Specified by:

isPaused in interface DownloadManager

resume

public void resume()

Specified by:

resume in interface DownloadManager

resume

public boolean resume(int target_state)

Description copied from interface: DownloadManager

resume the download and wait until it reaches the target state. It may fail to reach this state (e.g. goes into an error state). It will however block if it looks like progress towards the state is being made (allocating/checking)

Specified by:

resume in interface DownloadManager

Parameters:

target_state -

Returns:

whether or not the state was reached

getAssumedComplete

public boolean getAssumedComplete()

Description copied from interface: DownloadManager

Retrieve whether this download is assumed complete.

Assumed complete status is kept while the torrent is in a non-running state, even if it has no data.

When the torrent starts up, the real complete level will be checked, and if the torrent actually does have missing data, the download will be thrown into error state.

Only a forced-recheck should clear this flag.

Specified by:

getAssumedComplete in interface DownloadManager

requestAssumedCompleteMode

public boolean requestAssumedCompleteMode()

Description copied from interface: DownloadManager

Will set this download to be "assumed complete" for if the download is already complete (excluding DND)

Specified by:

requestAssumedCompleteMode in interface DownloadManager

Returns:

true- success; false- failure, download not complete

requestAssumedCompleteMode

protected boolean requestAssumedCompleteMode(boolean filePriorityChanged)

setAssumedComplete

protected void setAssumedComplete(boolean _assumedComplete)

setAssumedComplete

protected void setAssumedComplete(boolean _assumedComplete,
 boolean filePriorityChanged)

getNbSeeds

public int getNbSeeds()

Specified by:

getNbSeeds in interface DownloadManager

getNbPeers

public int getNbPeers()

Specified by:

getNbPeers in interface DownloadManager

getTrackerStatus

public String getTrackerStatus()

Specified by:

getTrackerStatus in interface DownloadManager

getTrackerClient

public TRTrackerAnnouncer getTrackerClient()

Specified by:

getTrackerClient in interface DownloadManager

setAnnounceResult

public void setAnnounceResult(DownloadAnnounceResult result)

Specified by:

setAnnounceResult in interface DownloadManager

setScrapeResult

public void setScrapeResult(DownloadScrapeResult result)

Specified by:

setScrapeResult in interface DownloadManager

getNbPieces

public int getNbPieces()

Specified by:

getNbPieces in interface DownloadManager

getTrackerTime

public int getTrackerTime()

Description copied from interface: DownloadManager

When the next call to the tracker will occur (in seconds)

Specified by:

getTrackerTime in interface DownloadManager

getTorrent

public TOTorrent getTorrent()

Specified by:

getTorrent in interface DownloadManager

getSaveLocation

public File getSaveLocation()

Specified by:

getSaveLocation in interface DownloadManager

getAbsoluteSaveLocation

public File getAbsoluteSaveLocation()

Description copied from interface: DownloadManager

Returns the file location where we save the torrent, this includes the parent directory and the actual file name.

Specified by:

getAbsoluteSaveLocation in interface DownloadManager

setTorrentSaveDir

public void setTorrentSaveDir(File _new_location,
 boolean locationIncludesName)

Description copied from interface: DownloadManager

changes the save directory. Only call this if you know what you are doing!!!!

When locationIncludesName, torrent name will also change (Data files will be stored under new_location)
When !locationIncludesName, only save dire is changed, name remains (Data files will be stored under new_location + / + old_location.getName())

Specified by:

setTorrentSaveDir in interface DownloadManager

getPieceLength

public String getPieceLength()

Specified by:

getPieceLength in interface DownloadManager

getTorrentFileName

public String getTorrentFileName()

Description copied from interface: DownloadManager

This includes the full path to the torrent file.

Specified by:

getTorrentFileName in interface DownloadManager

Returns:

setTorrentFileName

public void setTorrentFileName(String string)

Specified by:

setTorrentFileName in interface DownloadManager

setTrackerScrapeResponse

public void setTrackerScrapeResponse(TRTrackerScraperResponse response)

Specified by:

setTrackerScrapeResponse in interface DownloadManager

getTrackerScrapeResponse

public TRTrackerScraperResponse getTrackerScrapeResponse()

Specified by:

getTrackerScrapeResponse in interface DownloadManager

getActiveScrapeResponse

protected Object[] getActiveScrapeResponse()

Returns the "first" online scrape response found, and its active URL, otherwise one of the failing scrapes

Returns:

getGoodTrackerScrapeResponses

public List<TRTrackerScraperResponse> getGoodTrackerScrapeResponses()

Specified by:

getGoodTrackerScrapeResponses in interface DownloadManager

requestTrackerAnnounce

public void requestTrackerAnnounce(boolean force)

Specified by:

requestTrackerAnnounce in interface DownloadManager

requestTrackerScrape

public void requestTrackerScrape(boolean force)

Specified by:

requestTrackerScrape in interface DownloadManager

setTrackerRefreshDelayOverrides

protected void setTrackerRefreshDelayOverrides(int percent)

activateRequest

protected boolean activateRequest(int count)

getActivationCount

public int getActivationCount()

Specified by:

getActivationCount in interface DownloadManager

getTorrentComment

public String getTorrentComment()

Specified by:

getTorrentComment in interface DownloadManager

getTorrentCreatedBy

public String getTorrentCreatedBy()

Specified by:

getTorrentCreatedBy in interface DownloadManager

getTorrentCreationDate

public long getTorrentCreationDate()

Specified by:

getTorrentCreationDate in interface DownloadManager

getGlobalManager

public GlobalManager getGlobalManager()

Specified by:

getGlobalManager in interface DownloadManager

getDiskManager

public DiskManager getDiskManager()

Specified by:

getDiskManager in interface DownloadManager

getDiskManagerPiecesSnapshot

public DiskManagerPiece[] getDiskManagerPiecesSnapshot()

Specified by:

getDiskManagerPiecesSnapshot in interface DownloadManager

getDiskManagerFileInfoSet

public DiskManagerFileInfoSet getDiskManagerFileInfoSet()

Specified by:

getDiskManagerFileInfoSet in interface DownloadManager

getDiskManagerFileInfo

public DiskManagerFileInfo[] getDiskManagerFileInfo()

Deprecated.

use getDiskManagerFileInfoSet() instead

Specified by:

getDiskManagerFileInfo in interface DownloadManager

getNumFileInfos

public int getNumFileInfos()

Specified by:

getNumFileInfos in interface DownloadManager

getPeerManager

public PEPeerManager getPeerManager()

Specified by:

getPeerManager in interface DownloadManager

isDownloadComplete

public boolean isDownloadComplete(boolean bIncludeDND)

Description copied from interface: DownloadManager

Retrieves whether the download is complete

Specified by:

isDownloadComplete in interface DownloadManager

Parameters:

bIncludeDND - true- include files marked as Do Not Download.
false- don't include files marked DND.

If there are DND files and you choose to include DND in the calculation, false will always be returned.

Returns:

whether download is complete

addListener

public void addListener(DownloadManagerListener listener)

Specified by:

addListener in interface DownloadManager

addListener

public void addListener(DownloadManagerListener listener,
 boolean triggerStateChange)

Specified by:

addListener in interface DownloadManager

Parameters:

listener -

triggerStateChange -

removeListener

public void removeListener(DownloadManagerListener listener)

Specified by:

removeListener in interface DownloadManager

checkFilePriorities

private void checkFilePriorities(boolean global_change)

informStateChanged

protected void informStateChanged()

Doesn't not inform if state didn't change from last inform call

informDownloadEnded

protected void informDownloadEnded()

informPrioritiesChange

protected void informPrioritiesChange(List files)

informLocationChange

protected void informLocationChange(int file_index)

informLocationChange

protected void informLocationChange(DiskManagerFileInfo file)

informPriorityChange

protected void informPriorityChange(List<DiskManagerFileInfo> files)

informPieceDoneChanged

protected void informPieceDoneChanged(DiskManagerPiece piece)

informFileCompletionChange

protected void informFileCompletionChange(DiskManagerFileInfo file)

informPositionChanged

protected void informPositionChanged(int new_position)

addPeerListener

public void addPeerListener(DownloadManagerPeerListener listener)

Specified by:

addPeerListener in interface DownloadManager

addPeerListener

public void addPeerListener(DownloadManagerPeerListener listener,
 boolean bDispatchForExisting)

Specified by:

addPeerListener in interface DownloadManager

removePeerListener

public void removePeerListener(DownloadManagerPeerListener listener)

Specified by:

removePeerListener in interface DownloadManager

addPieceListener

public void addPieceListener(DownloadManagerPieceListener listener)

Specified by:

addPieceListener in interface DownloadManager

addPieceListener

public void addPieceListener(DownloadManagerPieceListener listener,
 boolean bDispatchForExisting)

Specified by:

addPieceListener in interface DownloadManager

removePieceListener

public void removePieceListener(DownloadManagerPieceListener listener)

Specified by:

removePieceListener in interface DownloadManager

addPeer

public void addPeer(PEPeer peer)

removePeer

public void removePeer(PEPeer peer)

getCurrentPeers

public PEPeer[] getCurrentPeers()

Specified by:

getCurrentPeers in interface DownloadManager

addPiece

public void addPiece(PEPiece piece)

removePiece

public void removePiece(PEPiece piece)

getCurrentPieces

public PEPiece[] getCurrentPieces()

Specified by:

getCurrentPieces in interface DownloadManager

informWillBeStarted

protected void informWillBeStarted(PEPeerManager pm)

informStarted

protected void informStarted(PEPeerManager pm)

informStopped

protected void informStopped(PEPeerManager pm,
 boolean for_queue)

getStats

public DownloadManagerStats getStats()

Specified by:

getStats in interface DownloadManager

calcFilePriorityStats

private void calcFilePriorityStats()

isForceStart

public boolean isForceStart()

Specified by:

isForceStart in interface DownloadManager

setForceStart

public void setForceStart(boolean forceStart)

Specified by:

setForceStart in interface DownloadManager

downloadEnded

protected void downloadEnded(boolean never_downloaded)

Is called when a download is finished. Activates alerts for the user.

Parameters:

never_downloaded - true indicates that we never actually downloaded anything in this session, but we determined that the download is complete (usually via startDownload())

addDiskListener

public void addDiskListener(DownloadManagerDiskListener listener)

Specified by:

addDiskListener in interface DownloadManager

removeDiskListener

public void removeDiskListener(DownloadManagerDiskListener listener)

Specified by:

removeDiskListener in interface DownloadManager

addActivationListener

public void addActivationListener(DownloadManagerActivationListener listener)

Specified by:

addActivationListener in interface DownloadManager

removeActivationListener

public void removeActivationListener(DownloadManagerActivationListener listener)

Specified by:

removeActivationListener in interface DownloadManager

getHealthStatus

public int getHealthStatus()

Specified by:

getHealthStatus in interface DownloadManager

Returns:

the wealthy status of this download

getNATStatus

public Object[] getNATStatus()

Description copied from interface: DownloadManager

See plugin ConnectionManager.NAT_ constants for return values

Specified by:

getNATStatus in interface DownloadManager

Returns:

getPosition

public int getPosition()

Specified by:

getPosition in interface DownloadManager

setPosition

public void setPosition(int new_position)

Specified by:

setPosition in interface DownloadManager

addTrackerListener

public void addTrackerListener(DownloadManagerTrackerListener listener)

Specified by:

addTrackerListener in interface DownloadManager

removeTrackerListener

public void removeTrackerListener(DownloadManagerTrackerListener listener)

Specified by:

removeTrackerListener in interface DownloadManager

deleteDataFiles

protected void deleteDataFiles()

deletePartialDataFiles

protected void deletePartialDataFiles()

deleteDNDAltLoc

private void deleteDNDAltLoc()

deleteTorrentFile

protected void deleteTorrentFile()

getDownloadState

public DownloadManagerState getDownloadState()

Specified by:

getDownloadState in interface DownloadManager

getUserData

public Object getUserData(Object key)

To retreive arbitrary objects against a download.

Specified by:

getUserData in interface DownloadManager

setUserData

public void setUserData(Object key,
 Object value)

To store arbitrary objects against a download.

Specified by:

setUserData in interface DownloadManager

getTaggableTransientProperty

public Object getTaggableTransientProperty(String key)

Specified by:

getTaggableTransientProperty in interface Taggable

setTaggableTransientProperty

public void setTaggableTransientProperty(String key,
 Object value)

Specified by:

setTaggableTransientProperty in interface Taggable

isDataAlreadyAllocated

public boolean isDataAlreadyAllocated()

Description copied from interface: DownloadManager

Determine whether disk allocation has already been done. Used for checking if data is missing on a previously-loaded torrent.

Specified by:

isDataAlreadyAllocated in interface DownloadManager

Returns:

true if data files have already been allocated

setDataAlreadyAllocated

public void setDataAlreadyAllocated(boolean already_allocated)

Description copied from interface: DownloadManager

Set whether data allocation has already been done, so we know when to allocate and when to throw a missing-data error message.

Specified by:

setDataAlreadyAllocated in interface DownloadManager

Parameters:

already_allocated -

setSeedingRank

public void setSeedingRank(Download.SeedingRank rank)

Specified by:

setSeedingRank in interface DownloadManager

getSeedingRank

public Download.SeedingRank getSeedingRank()

Specified by:

getSeedingRank in interface DownloadManager

getCreationTime

public long getCreationTime()

Description copied from interface: DownloadManager

gives the time this download was created (not the torrent but the download itself)

Specified by:

getCreationTime in interface DownloadManager

Returns:

setCreationTime

public void setCreationTime(long t)

Specified by:

setCreationTime in interface DownloadManager

isSwarmMerging

public boolean isSwarmMerging()

Specified by:

isSwarmMerging in interface DownloadManager

getSwarmMergingInfo

public String getSwarmMergingInfo()

Specified by:

getSwarmMergingInfo in interface DownloadManager

getExtendedMessagingMode

public int getExtendedMessagingMode()

Specified by:

getExtendedMessagingMode in interface DownloadManager

Returns:

messaging mode = az, lt or bt

setCryptoLevel

public void setCryptoLevel(int level)

Specified by:

setCryptoLevel in interface DownloadManager

getCryptoLevel

public int getCryptoLevel()

Specified by:

getCryptoLevel in interface DownloadManager

getMoveProgress

public long[] getMoveProgress()

Description copied from interface: DownloadManager

Progress of a move operation

Specified by:

getMoveProgress in interface DiskManagerUtil.MoveTaskAapter

Specified by:

getMoveProgress in interface DownloadManager

Returns:

null: not moving otherwise [ 0->1000, size ]

getMoveSubTask

public String getMoveSubTask()

Specified by:

getMoveSubTask in interface DiskManagerUtil.MoveTaskAapter

setMoveState

public void setMoveState(int state)

Specified by:

setMoveState in interface DiskManagerUtil.MoveTaskAapter

moveDataFiles

public void moveDataFiles(File new_parent_dir)
                   throws DownloadManagerException

Description copied from interface: DownloadManager

Move data files to new location. Torrent must be in stopped/error state

Specified by:

moveDataFiles in interface DownloadManager

Parameters:

new_parent_dir -

Throws:

DownloadManagerException

moveDataFilesLive

public void moveDataFilesLive(File new_parent_dir)
                       throws DownloadManagerException

Description copied from interface: DownloadManager

At some point someone made the file-move operations stop+restart the download when it was designed to work without doing this (see move-on-complete for example). As I don't know the reason for this change I've (parg) added a new method to do this in the hope that we might in time migrate back to the 'proper' behaviour. grrr

Specified by:

moveDataFilesLive in interface DownloadManager

Parameters:

new_parent_dir -

Throws:

DownloadManagerException

renameDownload

public void renameDownload(String new_name)
                    throws DownloadManagerException

Description copied from interface: DownloadManager

Rename the download - this means the name of the file being downloaded (for single file torrents), or the name of the directory holding the files (in a multi-file torrent). This does not alter the displayed name of the download.

Specified by:

renameDownload in interface DownloadManager

Parameters:

new_name -

Throws:

DownloadManagerException

moveDataFiles

public void moveDataFiles(File destination,
 String new_name)
                   throws DownloadManagerException

Description copied from interface: DownloadManager

Move the files and rename a download in one go. For convenience - either argument can be null, but not both.

Specified by:

moveDataFiles in interface DownloadManager

Parameters:

destination - new location to move torrent data files to. If null, and simple torrent, torrent data file will be renamed new_name. If null, and not simple torrent, torrent end path will be changed to new_name.

new_name - For simple torrent, changes the filename of the downloaded file. For non-simple torrent, changes the end path for the downloaded files. If null, torrent data files will be moved to new_parent_dir, with a subfolder of the existing name.

Throws:

DownloadManagerException

See Also:

• DownloadManager.moveDataFiles(File)
• DownloadManager.renameDownload(String)

moveDataFiles

public void moveDataFiles(File destination,
 String new_name,
 boolean live)
                   throws DownloadManagerException

Throws:

DownloadManagerException

moveDataFilesSupport

void moveDataFilesSupport(File new_parent_dir,
 String new_filename)
                   throws DownloadManagerException

Throws:

DownloadManagerException

moveDataFilesSupport0

void moveDataFilesSupport0(File new_parent_dir,
 String new_filename)
                    throws DownloadManagerException

Throws:

DownloadManagerException

copyDataFiles

public void copyDataFiles(File dest_parent_dir,
 CoreOperationTask.ProgressCallback cb)
                   throws DownloadManagerException

Specified by:

copyDataFiles in interface DownloadManager

Throws:

DownloadManagerException

copyTorrentFile

private void copyTorrentFile(File parent_dir)
                      throws DownloadManagerException

Throws:

DownloadManagerException

canExportDownload

public boolean canExportDownload()

Specified by:

canExportDownload in interface DownloadManager

exportDownload

public void exportDownload(File parent_dir)
                    throws DownloadManagerException

Specified by:

exportDownload in interface DownloadManager

Throws:

DownloadManagerException

moveTorrentFile

public void moveTorrentFile(File new_parent_dir)
                     throws DownloadManagerException

Description copied from interface: DownloadManager

Move torrent file to new location. Download must be stopped/error

Specified by:

moveTorrentFile in interface DownloadManager

Parameters:

new_parent_dir -

Throws:

DownloadManagerException

moveTorrentFile

public void moveTorrentFile(File new_parent_dir,
 String new_name)
                     throws DownloadManagerException

Specified by:

moveTorrentFile in interface DownloadManager

Throws:

DownloadManagerException

moveTorrentFile0

private void moveTorrentFile0(File new_parent_dir,
 String new_name)
                       throws DownloadManagerException

Throws:

DownloadManagerException

setTorrentFile

public void setTorrentFile(File new_parent_dir,
 String new_name)
                    throws DownloadManagerException

Description copied from interface: DownloadManager

Sets the torrent file name (will perform a move of the torrent file) - this shouldn't be used unless you know what you are doing (it requires the download to be stopped!) - it is safer to use moveTorrentFile instead.

Specified by:

setTorrentFile in interface DownloadManager

Throws:

DownloadManagerException

isInDefaultSaveDir

public boolean isInDefaultSaveDir()

Description copied from interface: DownloadManager

Returns true if the download is being saved to one of the default save directories.

Specified by:

isInDefaultSaveDir in interface DownloadManager

seedPieceRecheck

public boolean seedPieceRecheck()

Description copied from interface: DownloadManager

Gives the download an opportunity to schedule seeding mode piece rechecks if desired

Specified by:

seedPieceRecheck in interface DownloadManager

Returns:

true if a piece has been rechecked

addRateLimiter

public void addRateLimiter(LimitedRateGroup group,
 boolean upload)

Specified by:

addRateLimiter in interface DownloadManager

getRateLimiters

public LimitedRateGroup[] getRateLimiters(boolean upload)

Specified by:

getRateLimiters in interface DownloadManager

removeRateLimiter

public void removeRateLimiter(LimitedRateGroup group,
 boolean upload)

Specified by:

removeRateLimiter in interface DownloadManager

isTrackerError

public boolean isTrackerError()

Specified by:

isTrackerError in interface DownloadManager

isUnauthorisedOnTracker

public boolean isUnauthorisedOnTracker()

Specified by:

isUnauthorisedOnTracker in interface DownloadManager

getTrackerPeerSources

public List<TrackerPeerSource> getTrackerPeerSources()

Specified by:

getTrackerPeerSources in interface DownloadManager

addTPSListener

public void addTPSListener(DownloadManagerTPSListener listener)

Specified by:

addTPSListener in interface DownloadManager

removeTPSListener

public void removeTPSListener(DownloadManagerTPSListener listener)

Specified by:

removeTPSListener in interface DownloadManager

informTPSChanged

public void informTPSChanged()

Specified by:

informTPSChanged in interface DownloadManager

getIdentity

private byte[] getIdentity()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Returns:

true, if the other DownloadManager has the same hash

See Also:

• Object.equals(java.lang.Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRelationText

public String getRelationText()

Description copied from class: LogRelation

A short description of what your class holds that can be printed by the logger

Overrides:

getRelationText in class LogRelation

Returns:

getQueryableInterfaces

public Object[] getQueryableInterfaces()

Description copied from class: LogRelation

Query this class for a reference to another class that it may hold

Overrides:

getQueryableInterfaces in class LogRelation

Returns:

If found, the class desired. Otherwise, null.

toString

public String toString()

Overrides:

toString in class Object

generateEvidence

public void generateEvidence(IndentWriter writer,
 boolean full)

Specified by:

generateEvidence in interface DownloadManager

destroy

public void destroy(boolean is_duplicate)

Description copied from interface: DownloadManager

Indicates that the download manager is no longer needed

Specified by:

destroy in interface DownloadManager

Parameters:

is_duplicate - indicates whether this dm is being destroyed because it is a duplicate

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface DownloadManager

getStorageType

public int[] getStorageType(DiskManagerFileInfo[] info)

Specified by:

getStorageType in interface DownloadManager

canMoveDataFiles

public boolean canMoveDataFiles()

Specified by:

canMoveDataFiles in interface DownloadManager

rename

public void rename(String name)
            throws DownloadManagerException

Description copied from interface: DownloadManager

Renames the save file, torrent file and the displayed name.

Specified by:

rename in interface DownloadManager

Throws:

DownloadManagerException

renameTorrent

public void renameTorrent(String name)
                   throws DownloadManagerException

Specified by:

renameTorrent in interface DownloadManager

Throws:

DownloadManagerException

renameTorrentSafe

public void renameTorrentSafe(String name)
                       throws DownloadManagerException

Description copied from interface: DownloadManager

Same as renameTorrent, but appends numbers if torrent already exists

Specified by:

renameTorrentSafe in interface DownloadManager

Throws:

DownloadManagerException

requestAttention

public void requestAttention()

Specified by:

requestAttention in interface DownloadManager

fireGlobalManagerEvent

public void fireGlobalManagerEvent(int eventType,
 Object eventData)

Specified by:

fireGlobalManagerEvent in interface DownloadManager