bt.torrent.TorrentSession Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bt-core Show documentation

BitTorrent Client Library (Core)

There is a newer version: 1.10

package bt.torrent;

import bt.metainfo.Torrent;
import bt.metainfo.TorrentId;
import bt.net.PeerActivityListener;

/**
 * Torrent processing session.
 *
 * @since 1.0
 */
public interface TorrentSession extends PeerActivityListener {

    /**
     * Returns torrent, that this session is processing.
     * Note that in some cases (e.g. when using magnet links) the torrent may be absent in the beginning.
     * In such case this method will return a fake Torrent object, containing reasonable "stub" values
     * (falses, zeroes, empty collections).
     *
     * @return Torrent, that this session is processing, or a fake Torrent object, if the torrent hasn't been fetched yet
     * @see #getTorrentId()
     * @since 1.0
     */
    Torrent getTorrent();

    /**
     * Returns torrent ID, that this session is processing.
     * Note that in some cases (e.g. when using magnet links) the torrent itself may be absent in the beginning.
     * Use {@link bt.runtime.BtRuntime#service(Class)} to get a {@link TorrentRegistry} and then use
     * {@link TorrentRegistry#getTorrent(TorrentId)} that returns an Optional
     *
     * @return Torrent ID, that this session is processing
     * @see TorrentRegistry
     * @see bt.runtime.BtRuntime#service(Class)
     * @since 1.3
     */
    TorrentId getTorrentId();

    /**
     * @return Current state of torrent processing session
     * @since 1.0
     */
    TorrentSessionState getState();
}