4 "github.com/anacrolix/missinggo/pubsub"
6 "github.com/anacrolix/torrent/metainfo"
9 // This file contains Torrent, until I decide where the private, lower-case
10 // "torrent" type belongs. That type is currently mostly in torrent.go.
12 // The public handle to a live torrent within a Client.
18 // The torrent's infohash. This is fixed and cannot change. It uniquely
19 // identifies a torrent.
20 func (t Torrent) InfoHash() InfoHash {
21 return t.torrent.InfoHash
24 // Closed when the info (.Info()) for the torrent has become available. Using
25 // features of Torrent that require the info before it is available will have
26 // undefined behaviour.
27 func (t Torrent) GotInfo() <-chan struct{} {
28 return t.torrent.gotMetainfo
31 // Returns the metainfo, or nil if it's not yet available.
32 func (t Torrent) Info() *metainfo.Info {
36 // Returns a Reader bound to the torrent's data. All read calls block until
37 // the data requested is actually available. Priorities are set to ensure the
38 // data requested will be downloaded as soon as possible.
39 func (t Torrent) NewReader() (ret *Reader) {
42 readahead: 5 * 1024 * 1024,
47 // Returns the state of pieces of the torrent. They are grouped into runs of
48 // same state. The sum of the state run lengths is the number of pieces
50 func (t Torrent) PieceStateRuns() []PieceStateRun {
52 defer t.stateMu.Unlock()
53 return t.torrent.pieceStateRuns()
56 func (t Torrent) NumPieces() int {
60 // Drop the torrent from the client, and close it.
61 func (t Torrent) Drop() {
63 t.cl.dropTorrent(t.torrent.InfoHash)
67 // Number of bytes of the entire torrent we have completed.
68 func (t Torrent) BytesCompleted() int64 {
70 defer t.cl.mu.RUnlock()
71 return t.bytesCompleted()
74 // The subscription emits as (int) the index of pieces as their state changes.
75 // A state change is when the PieceState for a piece alters in value.
76 func (t Torrent) SubscribePieceStateChanges() *pubsub.Subscription {
77 return t.torrent.pieceStateChanges.Subscribe()
80 // Returns true if the torrent is currently being seeded. This occurs when the
81 // client is willing to upload without wanting anything in return.
82 func (t Torrent) Seeding() bool {
84 defer t.cl.mu.Unlock()
85 return t.cl.seeding(t.torrent)
88 // Clobbers the torrent display name. The display name is used as the torrent
89 // name if the metainfo is not available.
90 func (t Torrent) SetDisplayName(dn string) {
92 defer t.cl.mu.Unlock()
93 t.torrent.setDisplayName(dn)