org.johnnei.javatorrent.torrent

Class Torrent

java.lang.Object

org.johnnei.javatorrent.torrent.Torrent

public class Torrent
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Torrent.Builder A builder to create new instances of Torrent

Constructor Summary

Constructors

Constructor and Description
Torrent(Torrent.Builder builder) Creates a new Torrent.

Method Summary

Modifier and Type	Method and Description
void	addDiskJob(IDiskJob task) Adds a task to the IOManager of this torrent
void	addPeer(Peer peer) Adds a peer to the torrent if not already registered to the torrent.
void	addUploadedBytes(long l) Adds the amount of bytes to the uploaded count
void	checkProgress() Calculates the current progress based on all available files on the HDD
boolean	equals(Object obj)
String	getDisplayName()
long	getDownloadedBytes() The amount of bytes downloaded
int	getDownloadRate() Sums the download rates of all peers.
AbstractFileSet	getFileSet() Gets the files which are being downloaded within this torrent.
String	getHash() Gets the getHashArray() formatted as hexadecimal.
byte[]	getHashArray() Gets the 20 byte BTIH hash of the torrent.
int	getLeecherCount() Counts the amount of peers which don't have all pieces yet.
Optional<MetadataFileSet>	getMetadata()
List<Peer>	getPeers() Creates a copy of the list of connected peers.
IPieceSelector	getPieceSelector() The regulator which is managing this download
int	getSeedCount() Counts the amount of peers which have all pieces.
long	getUploadedBytes() The amount of bytes we have uploaded this session
int	getUploadRate() Sums the upload rates of all peers.
int	hashCode()
boolean	isDownloadingMetadata() If the Torrent should be downloading the metadata information.
void	onReceivedBlock(AbstractFileSet fileSet, int index, int offset, byte[] data) Tells the torrent to save a block of data
void	pollRates() Polls all peers transfer speeds.
void	removePeer(Peer peer) Removes a peer from the torrent.
void	setFileSet(AbstractFileSet files) Sets the current set of files this torrent is downloading.
void	setMetadata(MetadataFileSet metadata) Sets the associated metadata file of the torrent
void	setPieceSelector(IPieceSelector downloadRegulator)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Torrent

public Torrent(Torrent.Builder builder)

Creates a new Torrent.

Parameters:

builder - The builder with the components for the torrent.

Method Detail

addPeer

public void addPeer(Peer peer)
             throws IOException

Adds a peer to the torrent if not already registered to the torrent. Upon accepting the socket will be marked as passed handshake and the currently available message will be shared via either MessageBitfield or one or more MessageHave.

Parameters:

peer - The peer to add.

Throws:

IOException

removePeer

public void removePeer(Peer peer)

Removes a peer from the torrent. This will also clean up the peer state which affects the progress state of the torrent (ex. pending block requests).

Parameters:

peer - the peer to remove.

getDisplayName

public String getDisplayName()

getHashArray

public byte[] getHashArray()

Gets the 20 byte BTIH hash of the torrent.

Returns:

The 20 byte BTIH hash.

getHash

public String getHash()

Gets the getHashArray() formatted as hexadecimal.

Returns:

The BTIH hash in hexadecimal.

See Also:

getHashArray()

isDownloadingMetadata

public boolean isDownloadingMetadata()

If the Torrent should be downloading the metadata information. Depending on the installed modules the torrent might be stuck at this point. BEP 10 and UT_METADATA extension must be available to download metadata.

Returns:

true when the torrent is currently downloading the metadata, otherwise false

onReceivedBlock

public void onReceivedBlock(AbstractFileSet fileSet,
                            int index,
                            int offset,
                            byte[] data)

Tells the torrent to save a block of data

Parameters:

fileSet - The fileset for which the block of data has been received.

index - The piece index

offset - The offset within the piece

data - The bytes to be stored

addDiskJob

public void addDiskJob(IDiskJob task)

Adds a task to the IOManager of this torrent

Parameters:

task - The task to add

checkProgress

public void checkProgress()

Calculates the current progress based on all available files on the HDD

addUploadedBytes

public void addUploadedBytes(long l)

Adds the amount of bytes to the uploaded count

Parameters:

l - The amount of bytes to add

setFileSet

public void setFileSet(AbstractFileSet files)

Sets the current set of files this torrent is downloading.

Parameters:

files - The file set.

setMetadata

public void setMetadata(MetadataFileSet metadata)

Sets the associated metadata file of the torrent

Parameters:

metadata - the metadata which is backing this torrent

getMetadata

public Optional<MetadataFileSet> getMetadata()

toString

public String toString()

Overrides:

toString in class Object

pollRates

public void pollRates()

Polls all peers transfer speeds.

getFileSet

public AbstractFileSet getFileSet()

Gets the files which are being downloaded within this torrent. This could be the metadata of the torrent (.torrent file), the files in the torrent or something else if a module changed it with setFileSet(AbstractFileSet).

Returns:

The set of files being downloaded.

See Also:

setFileSet(AbstractFileSet)

getDownloadRate

public int getDownloadRate()

Sums the download rates of all peers.

Returns:

The sum of all download rates

See Also:

pollRates()

getUploadRate

public int getUploadRate()

Sums the upload rates of all peers.

Returns:

The sum of all upload rates

See Also:

pollRates()

getSeedCount

public int getSeedCount()

Counts the amount of peers which have all pieces.

Returns:

The amount of connected seeders.

getLeecherCount

public int getLeecherCount()

Counts the amount of peers which don't have all pieces yet.

Returns:

The amount of connected leechers.

getPeers

public List<Peer> getPeers()

Creates a copy of the list of connected peers.

Returns:

The list of connected peers.

getDownloadedBytes

public long getDownloadedBytes()

The amount of bytes downloaded

Returns:

The amount of bytes downloaded this session

getUploadedBytes

public long getUploadedBytes()

The amount of bytes we have uploaded this session

Returns:

The amount of bytes uploaded this session.

getPieceSelector

public IPieceSelector getPieceSelector()

The regulator which is managing this download

Returns:

The current assigned regulator

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

setPieceSelector

public void setPieceSelector(IPieceSelector downloadRegulator)