bt.torrent

Interface TorrentDescriptor

public interface TorrentDescriptor

Provides an interface for controlling the state of a torrent processing session.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
void	complete() Signal that the torrent has been successfully downloaded and verified
DataDescriptor	getDataDescriptor()
Optional<TorrentSessionState>	getSessionState() Get the session state of this torrent.
boolean	isActive()
void	start() Issue a request to begin torrent processing
void	stop() Issue a request to stop torrent processing

Method Detail

isActive

boolean isActive()

Returns:

true if the torrent is currently being processed

Since:

1.0

start

void start()

Issue a request to begin torrent processing

Since:

1.0

stop

void stop()

Issue a request to stop torrent processing

Since:

1.0

complete

void complete()

Signal that the torrent has been successfully downloaded and verified

Since:

1.0

getDataDescriptor

DataDescriptor getDataDescriptor()

Returns:

Torrent data descriptor or null, if it hasn't been created yet

Since:

1.0

getSessionState

Optional<TorrentSessionState> getSessionState()

Get the session state of this torrent. May be null depending upon the state of torrent processing

Returns:

the session state of this torrent

Since:

1.10